ITabPageProc Class Reference

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

---

Search for all occurrences

---

Detailed Description

See also:

Class ITabPage

Description:

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

#include <ITabDialog.h>

Inheritance diagram for ITabPageProc:

List of all members.

Public Member Functions
	ITabPageProc ()
virtual	~ITabPageProc ()
void	SetTabPage (ITabPage *page)
	Set the dialog page we are handling messages for.
ITabPage *	GetTabPage () const
	Get the dialog page we are handling messages for.
virtual void	DeleteThis ()
	Delete this page proc.
INT_PTR	InitPage (HWND focus, LPARAM lparam)
	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.
void	SwitchFrom ()
	Switch from this page.
void	SwitchTo ()
	Switch to this page.
virtual INT_PTR	dialogProc (UINT msg, WPARAM wParam, LPARAM lParam)
	The general message proc.

---

Constructor & Destructor Documentation

ITabPageProc

(

)

[inline]

: mpPage(NULL) {}

virtual ~ITabPageProc

(

)

[inline, virtual]

{;}

---

Member Function Documentation

void SetTabPage

(

ITabPage *

page

)

[inline]

Search for all occurrences

Set the dialog page we are handling messages for.

Parameters:

page	The new dialog page

{ mpPage = page; }

ITabPage* GetTabPage

(

)

const [inline]

Search for all occurrences

Get the dialog page we are handling messages for.

Returns:

The current dialog page

{ return mpPage; }

virtual void DeleteThis

(

)

[inline, virtual]

Search for all occurrences

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]

Search for all occurrences

Initialize the dialog.

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

void Invalidate

(

)

[inline]

Search for all occurrences

Invalidate the dialog.

                     {
      dialogProc(TABDLG_INVALIDATE, 0, 0);
   }

bool OkToCommit

(

)

[inline]

Search for all occurrences

Used for modal dialogs with IDOK and IDCANCEL.

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

void Commit

(

)

[inline]

Search for all occurrences

Used for modal dialogs with IDOK and IDCANCEL.

                 {
      dialogProc(TABDLG_COMMIT, 0, 0);
   }

void Close

(

)

[inline]

Search for all occurrences

The dialog is being closed.

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

                {
      dialogProc(TABDLG_CLOSE, 0, 0);
   }

void Cancel

(

)

[inline]

Search for all occurrences

The dialog is being canceled.

                 {
      dialogProc(TABDLG_CANCEL, 0, 0);
   }

void SwitchFrom

(

)

[inline]

Search for all occurrences

Switch from this page.

                     {
      dialogProc(TABDLG_SWITCH_FROM, 0, 0);
   }

void SwitchTo

(

)

[inline]

Search for all occurrences

Switch to this page.

                   {
      dialogProc(TABDLG_SWITCH_TO, 0, 0);
   }

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

Search for all occurrences

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; }