ITabPageProc Class Reference

ITabPageProc Class Reference

#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...
 
ITabPageGetTabPage () 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 voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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...
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary. More...
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary. More...
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
 

Constructor & Destructor Documentation

ITabPageProc ( )
inline
683 : mpPage(NULL) {}
#define NULL
Definition: autoptr.h:18
virtual ~ITabPageProc ( )
inlinevirtual
684 {;}

Member Function Documentation

void SetTabPage ( ITabPage page)
inline

Set the dialog page we are handling messages for.

Parameters
pageThe new dialog page
688 { mpPage = page; }
ITabPage* GetTabPage ( ) const
inline

Get the dialog page we are handling messages for.

Returns
The current dialog page
691 { 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.

697 {}
INT_PTR InitPage ( HWND  focus,
LPARAM  lparam 
)
inline

Initialize the dialog.

700  {
701  return dialogProc(WM_INITDIALOG, reinterpret_cast<WPARAM>(focus), lparam);
702  }
virtual INT_PTR dialogProc(UINT msg, WPARAM wParam, LPARAM lParam)
The general message proc.
Definition: ITabDialog.h:746
void Invalidate ( )
inline

Invalidate the dialog.

705  {
707  }
virtual INT_PTR dialogProc(UINT msg, WPARAM wParam, LPARAM lParam)
The general message proc.
Definition: ITabDialog.h:746
The underlying data has changed.
Definition: ITabDialog.h:263
bool OkToCommit ( )
inline

Used for modal dialogs with IDOK and IDCANCEL.

710  {
711  bool commit = true;
712  dialogProc(TABDLG_PRECOMMIT, 0, reinterpret_cast<LPARAM>(&commit));
713  return commit;
714  }
virtual INT_PTR dialogProc(UINT msg, WPARAM wParam, LPARAM lParam)
The general message proc.
Definition: ITabDialog.h:746
Check your values, but don't close the dialog;.
Definition: ITabDialog.h:258
void Commit ( )
inline

Used for modal dialogs with IDOK and IDCANCEL.

716  {
717  dialogProc(TABDLG_COMMIT, 0, 0);
718  }
virtual INT_PTR dialogProc(UINT msg, WPARAM wParam, LPARAM lParam)
The general message proc.
Definition: ITabDialog.h:746
Commit the page's working values for real.
Definition: ITabDialog.h:257
void Close ( )
inline

The dialog is being closed.

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

722  {
723  dialogProc(TABDLG_CLOSE, 0, 0);
724  }
virtual INT_PTR dialogProc(UINT msg, WPARAM wParam, LPARAM lParam)
The general message proc.
Definition: ITabDialog.h:746
User is closing a modeless dialog.
Definition: ITabDialog.h:262
void Cancel ( )
inline

The dialog is being canceled.

727  {
728  dialogProc(TABDLG_CANCEL, 0, 0);
729  }
virtual INT_PTR dialogProc(UINT msg, WPARAM wParam, LPARAM lParam)
The general message proc.
Definition: ITabDialog.h:746
User is cancelling out of the dialog.
Definition: ITabDialog.h:261
void SwitchFrom ( )
inline

Switch from this page.

732  {
734  }
virtual INT_PTR dialogProc(UINT msg, WPARAM wParam, LPARAM lParam)
The general message proc.
Definition: ITabDialog.h:746
Switching from this page.
Definition: ITabDialog.h:255
void SwitchTo ( )
inline

Switch to this page.

737  {
739  }
Switching to this page.
Definition: ITabDialog.h:256
virtual INT_PTR dialogProc(UINT msg, WPARAM wParam, LPARAM lParam)
The general message proc.
Definition: ITabDialog.h:746
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
wParam,lParam- the meaning and usage of these parameters depends on the message.
Returns
TRUE if the message was handled, else FALSE to allow further processing
750  { return FALSE; }