ITabPageProc Class Reference

This reference page is linked to from the following overview topics:

---

#include <ITabDialog.h>

Class Description

See Also

Class ITabPage

Description:

This interface is used to filter plugin tabs in a tabbed dialog.

Inheritance diagram for ITabPageProc:

Public Member Functions
	ITabPageProc ()
virtual	~ITabPageProc ()
void	SetTabPage (ITabPage *page)
	Set the dialog page we are handling messages for. More...
ITabPage *	GetTabPage () const
	Get the dialog page we are handling messages for. More...
virtual void	DeleteThis ()
	Delete this page proc. More...
INT_PTR	InitPage (HWND focus, LPARAM lparam)
	Initialize the dialog. More...
void	Invalidate ()
	Invalidate the dialog. More...
bool	OkToCommit ()
	Used for modal dialogs with IDOK and IDCANCEL. More...
void	Commit ()
	Used for modal dialogs with IDOK and IDCANCEL. More...
void	Close ()
	The dialog is being closed. More...
void	Cancel ()
	The dialog is being canceled. More...
void	SwitchFrom ()
	Switch from this page. More...
void	SwitchTo ()
	Switch to this page. More...
virtual INT_PTR	dialogProc (UINT msg, WPARAM wParam, LPARAM lParam)
	The general message proc. More...

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...

Constructor & Destructor Documentation

ITabPageProc ( )

inline

: mpPage(NULL) {}

virtual ~ITabPageProc ( )

inlinevirtual

{;}

Member Function Documentation

void SetTabPage ( ITabPage *  page )

inline

Set the dialog page we are handling messages for.

Parameters

page	The new dialog page

{ mpPage = page; }

ITabPage* GetTabPage ( ) const

inline

Get the dialog page we are handling messages for.

Returns

The current dialog page

{ return mpPage; }

virtual void DeleteThis ( )

inlinevirtual

Delete this page proc.

This method does nothing, because most page procs are not scoped by their page, but you can override it if you want your page proc deleted when the page is deleted.

{}

INT_PTR InitPage ( HWND  focus, LPARAM  lparam  )

inline

Initialize the dialog.

                                               {
      return dialogProc(WM_INITDIALOG, reinterpret_cast<WPARAM>(focus), lparam);
   }

void Invalidate ( )

inline

Invalidate the dialog.

                     {
      dialogProc(TABDLG_INVALIDATE, 0, 0);
   }

bool OkToCommit ( )

inline

Used for modal dialogs with IDOK and IDCANCEL.

                     {
      bool commit = true;
      dialogProc(TABDLG_PRECOMMIT, 0, reinterpret_cast<LPARAM>(&commit));
      return commit;
   }

void Commit ( )

inline

Used for modal dialogs with IDOK and IDCANCEL.

                 {
      dialogProc(TABDLG_COMMIT, 0, 0);
   }

void Close ( )

inline

The dialog is being closed.

This is called after all of the pages have been committed.

                {
      dialogProc(TABDLG_CLOSE, 0, 0);
   }

void Cancel ( )

inline

The dialog is being canceled.

                 {
      dialogProc(TABDLG_CANCEL, 0, 0);
   }

void SwitchFrom ( )

inline

Switch from this page.

                     {
      dialogProc(TABDLG_SWITCH_FROM, 0, 0);
   }

void SwitchTo ( )

inline

Switch to this page.

                   {
      dialogProc(TABDLG_SWITCH_TO, 0, 0);
   }

virtual INT_PTR dialogProc ( UINT  msg, WPARAM  wParam, LPARAM  lParam  )

inlinevirtual

The general message proc.

This proc is like a dialog proc, not a window proc

Parameters

msg	- See the list of dialog messages

Returns

TRUE if the message was handled, else FALSE to allow further processing

     { return FALSE; }