ITabbedDialog Class Reference

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

---

Search for all occurrences

---

Detailed Description

See also:

Class ITabDialogPluginTab, Class ITabDialogManager

Description:

This interface is used to manage a tabbed dialog. You can add pages and either display a modal or modeless dialog. You can add a rollout page, that can contain MAX rollouts

#include <ITabDialog.h>

Inheritance diagram for ITabbedDialog:

List of all members.

Public Types
enum	{ kSystemPage = 20, kNormalPage = 50, kMaxPage = 100 }
Public Member Functions
virtual void	DeleteThis ()=0
	Delete yourself.
virtual Class_ID	GetDialogID () const =0
	Return the dialogID for this dialog.
virtual ITabPage *	AddPage (const MCHAR *text, HINSTANCE instance, const MCHAR *tmplt, ITabPageProc *proc, const Class_ID &pageID, ITabDialogPluginTab *plugin=NULL, DWORD helpID=0, int order=kNormalPage, int image=-1)=0
	Add a page to the dialog.
virtual ITabPage *	AddRollout (const MCHAR *text, ITabPageProc *proc, const Class_ID &pageID, ITabDialogPluginTab *plugin=NULL, int controlID=-1, int width=0, int bottomMargin=0, DWORD helpID=0, int order=kNormalPage, int image=-1)=0
	Add a rollout page to the dialog.
virtual void	SyncRegisteredTabs ()=0
	Add and remove registered tabs to the dialog.
virtual ITabDialogFilter *	GetTabFilter () const =0
	Get the filter for this dialog.
virtual ITabDialogProc *	GetProc () const =0
	Get the dialog proc.
virtual ITabDialogProc *	SetProc (ITabDialogProc *newProc)=0
	Set the dialog proc.
virtual INT_PTR	DoModal (const Class_ID &page)=0
	Display and process modal dialog.
virtual bool	DoFloater (const Class_ID &page)=0
	Display and process modeless dialog.
virtual void	Switch (const Class_ID &page)=0
	Switch to the given page.
virtual void	Invalidate ()=0
	Invalidate all pages in the dialog.
virtual void	SetImageList (HIMAGELIST list)=0
	Set the image list for the tab control.
virtual int	CurrentPage () const =0
	Get the index of the current page.
virtual void	SetMargins (int left, int top, int right, int bottom)=0
	Set the margins for the tab in the dialog.
virtual void	SetTabbedRect (const RECT &rect)=0
	Set the margins for the tab in the dialog.
virtual int	GetNbPages () const =0
	Get the number of pages.
virtual ITabPage *	GetPage (int index) const =0
	return the page at index
virtual ITabPage *	GetPage (const Class_ID &id) const =0
	return the page with the passed class ID
virtual HWND	GetHWND () const =0
	Get the window for the tabbed dialog.
virtual bool	OkToCommit ()=0
	Used for modal dialogs with IDOK and IDCANCEL.
virtual bool	CommitPages ()=0
	Used for modal dialogs with IDOK and IDCANCEL.
virtual void	CloseDialog ()=0
	Used for modeless dialogs.
virtual void	ClosePages ()=0
	Used for modeless dialogs.
virtual void	CancelDialog ()=0
	Used for both modal and modeless dialogs.
virtual void	CancelPages ()=0
	Used for both modal and modeless dialogs.
virtual HWND	GetTabHWND () const =0
	Get the window for the tab control.
Static Public Member Functions
static ITabbedDialog *	GetPointer (HWND dialog)
Protected Member Functions
virtual	~ITabbedDialog ()

---

Member Enumeration Documentation

anonymous enum

Search for all occurrences

Enumerator:

kSystemPage	Search for all occurrences
kNormalPage	Search for all occurrences
kMaxPage	Search for all occurrences

        {
      kSystemPage = 20,
      kNormalPage = 50,
      kMaxPage = 100
   };

---

Constructor & Destructor Documentation

virtual ~ITabbedDialog

(

)

[inline, protected, virtual]

{}

---

Member Function Documentation

static ITabbedDialog* GetPointer

(

HWND

dialog

)

[inline, static]

Search for all occurrences

                                                 {
      return DLGetWindowLongPtr<ITabbedDialog*>(dialog);
   }

virtual void DeleteThis

(

)

[pure virtual]

Search for all occurrences

Delete yourself.

virtual Class_ID GetDialogID

(

)

const [pure virtual]

Search for all occurrences

Return the dialogID for this dialog.

virtual ITabPage* AddPage	(	const MCHAR *	text,
		HINSTANCE	instance,
		const MCHAR *	tmplt,
		ITabPageProc *	proc,
		const Class_ID &	pageID,
		ITabDialogPluginTab *	plugin = NULL,
		DWORD	helpID = 0,
		int	order = kNormalPage,
		int	image = -1
	)		[pure virtual]

Search for all occurrences

Add a page to the dialog.

Parameters:

text	- the tab text.
instance	- instance for the dialog template. If instance is NULL, the tmplt is a pointer to the dialog template in memory.
tmplt	- The resource for the dialog template.
proc	- The message handler for the page.
helpID	is ID used for context sensitive help.
order	- The order that the tab will appear in the tabs. Two pages with the same order are ordered by the order they are added.
image	- An image for the tab in the image list set by SetImageList.

Returns:

The created page

virtual ITabPage* AddRollout	(	const MCHAR *	text,
		ITabPageProc *	proc,
		const Class_ID &	pageID,
		ITabDialogPluginTab *	plugin = NULL,
		int	controlID = -1,
		int	width = 0,
		int	bottomMargin = 0,
		DWORD	helpID = 0,
		int	order = kNormalPage,
		int	image = -1
	)		[pure virtual]

Search for all occurrences

Add a rollout page to the dialog.

Parameters:

text	- the tab text.
proc	- the message handler for the page.
pageID	- The ID of the page to add the rollout to
plugin	- The plugin to set as the tab pages plugin
controlID	- The ID of the control window
width	- The width of the rollout to create
bottomMargin	- The margins give additional space between the rollout control and the client.
helpID	- ID used for context sensitive help.
Order	- the order that the tab will appear in the tabs. Two pages with the same order are ordered by the order they are added.
image	- an image for the tab in the image list set by SetImageList.

virtual void SyncRegisteredTabs

(

)

[pure virtual]

Search for all occurrences

Add and remove registered tabs to the dialog.

virtual ITabDialogFilter* GetTabFilter

(

)

const [pure virtual]

Search for all occurrences

Get the filter for this dialog.

Returns:

This dialogs filter

virtual ITabDialogProc* GetProc

(

)

const [pure virtual]

Search for all occurrences

Get the dialog proc.

Returns:

The current dialog proc

virtual ITabDialogProc* SetProc

(

ITabDialogProc *

newProc

)

[pure virtual]

Search for all occurrences

Set the dialog proc.

Returns:

The previous dialog proc

virtual INT_PTR DoModal

(

const Class_ID &

page

)

[pure virtual]

Search for all occurrences

Display and process modal dialog.

virtual bool DoFloater

(

const Class_ID &

page

)

[pure virtual]

Search for all occurrences

Display and process modeless dialog.

virtual void Switch

(

const Class_ID &

page

)

[pure virtual]

Search for all occurrences

Switch to the given page.

virtual void Invalidate

(

)

[pure virtual]

Search for all occurrences

Invalidate all pages in the dialog.

virtual void SetImageList

(

HIMAGELIST

list

)

[pure virtual]

Search for all occurrences

Set the image list for the tab control.

virtual int CurrentPage

(

)

const [pure virtual]

Search for all occurrences

Get the index of the current page.

virtual void SetMargins	(	int	left,
		int	top,
		int	right,
		int	bottom
	)		[pure virtual]

Search for all occurrences

Set the margins for the tab in the dialog.

This is only applicable if the tabCtrl is not part of the dialog template. If SetTabbedRect is called with a nonempty rectangle, it is used, otherwise the margins are used.

Parameters:

left	- The left margin
top	- the top margin
right	- the right margin
bottom	- the bottom margin

virtual void SetTabbedRect

(

const RECT &

rect

)

[pure virtual]

Search for all occurrences

Set the margins for the tab in the dialog.

This is only applicable if the tabCtrl is not part of the dialog template. If SetTabbedRect is called with a nonempty rectangle, it is used, otherwise the margins are used.

virtual int GetNbPages

(

)

const [pure virtual]

Search for all occurrences

Get the number of pages.

virtual ITabPage* GetPage

(

int

index

)

const [pure virtual]

Search for all occurrences

return the page at index

virtual ITabPage* GetPage

(

const Class_ID &

id

)

const [pure virtual]

Search for all occurrences

return the page with the passed class ID

virtual HWND GetHWND

(

)

const [pure virtual]

Search for all occurrences

Get the window for the tabbed dialog.

virtual bool OkToCommit

(

)

[pure virtual]

Search for all occurrences

Used for modal dialogs with IDOK and IDCANCEL.

virtual bool CommitPages

(

)

[pure virtual]

Search for all occurrences

Used for modal dialogs with IDOK and IDCANCEL.

virtual void CloseDialog

(

)

[pure virtual]

Search for all occurrences

Used for modeless dialogs.

note that if the user hits the X in the upper right corner, a cancel message will be sent.

virtual void ClosePages

(

)

[pure virtual]

Search for all occurrences

Used for modeless dialogs.

note that if the user hits the X in the upper right corner, a cancel message will be sent.

virtual void CancelDialog

(

)

[pure virtual]

Search for all occurrences

Used for both modal and modeless dialogs.

virtual void CancelPages

(

)

[pure virtual]

Search for all occurrences

Used for both modal and modeless dialogs.

virtual HWND GetTabHWND

(

)

const [pure virtual]

Search for all occurrences

Get the window for the tab control.