ITabDialogProc Class Reference

#include <ITabDialog.h>

Inheritance diagram for ITabDialogProc:

Public Member Functions
	ITabDialogProc ()
void	SetTabDialog (ITabbedDialog *dlg)
	Set the dialog we are handling messages for.
ITabbedDialog *	GetTabDialog () const
	Get the dialog we are handling messages for.
virtual void	DeleteThis ()
	Delete this dialog proc.
INT_PTR	InitDialog (HWND focus)
	Initialize the dialog.
void	Invalidate ()
	Invalidate the dialog.
bool	OkToCommit ()
	Used for modal dialogs with IDOK and IDCANCEL.
void	Commit ()
	Used for modal dialogs with IDOK and IDCANCEL.
void	Close ()
	The dialog is being closed.
void	Cancel ()
	The dialog is being canceled.
bool	ResizeDialog (SIZE *delta)
	Resize the dialog.
virtual INT_PTR	dialogProc (UINT msg, WPARAM wParam, LPARAM lParam)
	The general message proc.
virtual BaseInterface *	GetInterface (const Interface_ID &id)
	Get extension interfaces, if there are any.
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor.
UtilExport BaseInterface *	GetInterface (Interface_ID id) override
virtual UtilExport Interface_ID	GetID ()
virtual LifetimeType	LifetimeControl ()
virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=nullptr)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Additional Inherited Members
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Detailed Description

See also

Class ITabbedDialog

Description

This interface is implemented by the code that wants to use the tab dialog. The implementer can choose whether to respond to the methods or to messages

Constructor & Destructor Documentation

ITabDialogProc()

ITabDialogProc ( )

inline

: mpDlg(NULL) {}

Member Function Documentation

SetTabDialog()

void SetTabDialog ( ITabbedDialog *  dlg )

inline

Set the dialog we are handling messages for.

Parameters

dlg	Our new tabbed dialog

{ mpDlg = dlg; }

GetTabDialog()

ITabbedDialog * GetTabDialog ( ) const

inline

Get the dialog we are handling messages for.

Returns

the current dialog

{ return mpDlg; }

DeleteThis()

virtual void DeleteThis ( )

inlinevirtual

Delete this dialog proc.

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

{}

InitDialog()

INT_PTR InitDialog ( HWND  focus )

inline

Initialize the dialog.

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

Invalidate()

void Invalidate ( )

inline

Invalidate the dialog.

                     {
      dialogProc(TABDLG_INVALIDATE, 0, 0);
   }

OkToCommit()

bool OkToCommit ( )

inline

Used for modal dialogs with IDOK and IDCANCEL.

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

Commit()

void Commit ( )

inline

Used for modal dialogs with IDOK and IDCANCEL.

                 {
      dialogProc(TABDLG_COMMIT, 0, 0);
   }

Close()

void Close ( )

inline

The dialog is being closed.

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

                {
      dialogProc(TABDLG_CLOSE, 0, 0);
   }

Cancel()

void Cancel ( )

inline

The dialog is being canceled.

                 {
      dialogProc(TABDLG_CANCEL, 0, 0);
   }

ResizeDialog()

bool ResizeDialog ( SIZE *  delta )

inline

Resize the dialog.

This method is only called if the size needs to be increased. If the dialog was resize, the dialog manager will resize the tab control and the content. The dialog proc may change the delta values to correspond the the amount the dialog was resized.

Parameters

delta

- The required change in size.

Returns

true if the dialog was resized.

                                  {
      return dialogProc(TABDLG_RESIZE_DIALOG, 0,
         reinterpret_cast<LPARAM>(delta)) != 0;
 
   };

dialogProc()

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

     { return FALSE; }

GetInterface()

virtual BaseInterface * GetInterface ( const Interface_ID &  id )

inlinevirtual

Get extension interfaces, if there are any.

{ return NULL; }