Public Member Functions

ITabDialogProc Class Reference

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


Search for all occurrences

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

#include <ITabDialog.h>

Inheritance diagram for ITabDialogProc:
Inheritance graph
[legend]

List of all members.

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.

Constructor & Destructor Documentation

ITabDialogProc ( ) [inline]
: mpDlg(NULL) {}

Member Function Documentation

void SetTabDialog ( ITabbedDialog dlg ) [inline]

Set the dialog we are handling messages for.

Parameters:
dlg Our new tabbed dialog
{ mpDlg = dlg; }
ITabbedDialog* GetTabDialog ( ) const [inline]

Get the dialog we are handling messages for.

Returns:
the current dialog
{ return mpDlg; }
virtual void DeleteThis ( ) [inline, virtual]

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.

{}
INT_PTR InitDialog ( HWND  focus ) [inline]

Initialize the dialog.

                                  {
      return dialogProc(WM_INITDIALOG, reinterpret_cast<WPARAM>(focus), 0);
   }
void Invalidate ( ) [inline]

Invalidate the dialog.

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.

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.

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;

   };
virtual INT_PTR dialogProc ( UINT  msg,
WPARAM  wParam,
LPARAM  lParam 
) [inline, virtual]

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; }
virtual BaseInterface* GetInterface ( const Interface_ID id ) [inline, virtual]

Get extension interfaces, if there are any.

{ return NULL; }

ITabDialogProc ITabDialogProc ITabDialogProc ITabDialogProc ITabDialogProc ITabDialogProc ITabDialogProc ITabDialogProc ITabDialogProc ITabDialogProc
ITabDialogProc ITabDialogProc ITabDialogProc ITabDialogProc ITabDialogProc ITabDialogProc ITabDialogProc ITabDialogProc ITabDialogProc ITabDialogProc