#include <ITabDialog.h>

Class Description

See also: Class ITabbedDialog, Class ITabPage, Class ITabDialogProc, Class ITabPageProc

Description: This interface is used to create tabbed dialogs and to register tabs with dialogs that are created by the system or other plugins

Inheritance diagram for ITabDialogManager:

Public Member Functions
virtual ITabbedDialog *	CreateTabbedDialog (HWND parent, HINSTANCE instance, const MCHAR dlg, ITabDialogProc mainProc, bool multiline, DWORD helpID=0, int tabID=-1, const Class_ID &dialogID=Class_ID(0, 0))=0
	Create a tabbed dialog. More...

virtual bool	RegisterTab (const Class_ID &dialogID, ITabDialogPluginTab *tab)=0
	Register a tab for a dialog. More...

virtual void	UnRegisterTab (const Class_ID &dialogID, ITabDialogPluginTab *tab)=0
	UnRegister a tab for a dialog. More...

virtual void	SetTabFilter (const Class_ID &dialogID, ITabDialogFilter *filter)=0
	Set the current plugin tab filter for a dialog. More...

virtual ITabDialogFilter *	GetTabFilter (const Class_ID &dialogID)=0
	Get the current plugin tab filter for a dialog. More...

virtual ITabbedDialog *	GetTabbedDialog (const Class_ID &dialogID)=0
	Get the ITabbedDialog for the dialog id. More...

Public Member Functions inherited from FPInterfaceDesc
CoreExport	FPInterfaceDesc ()

CoreExport	FPInterfaceDesc (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc cd, ULONG flag,...)

CoreExport	~FPInterfaceDesc ()

virtual void	Init ()

LifetimeType	LifetimeControl ()

virtual BaseInterface *	GetInterface (Interface_ID id)

CoreExport void	LoadDescriptor (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc pCD, ULONG flag,...)

CoreExport void	AppendFunction (int id,...)
	Add a new function to this interface descriptor. More...

CoreExport void	AppendProperty (int id,...)
	Add a new property to this interface descriptor. More...

CoreExport void	AppendEnum (int id,...)
	Add a new enum to this interface descriptor. More...

CoreExport void	SetClassDesc (ClassDesc *i_cd)

CoreExport va_list	check_fn (va_list ap, int id)

CoreExport va_list	scan_fn (va_list ap, int id, int index)

CoreExport va_list	check_prop (va_list ap, int id)

CoreExport va_list	scan_prop (va_list ap, int id, int index)

CoreExport va_list	check_enum (va_list ap, EnumID id)

CoreExport va_list	scan_enum (va_list ap, EnumID id, int index)

FPInterfaceDesc *	GetDesc ()

Interface_ID	GetID ()

CoreExport FPFunctionDef *	GetFnDef (FunctionID fid)

ActionTable *	GetActionTable ()

CoreExport void	EnableActions (BOOL onOff)

virtual CoreExport HINSTANCE	HInstance ()

virtual CoreExport const MCHAR *	GetRsrcString (StringResID id)

Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPParams *params)

virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)

virtual CoreExport FunctionID	FindFn (const MCHAR *name)

virtual CoreExport BOOL	IsEnabled (FunctionID actionID)

virtual CoreExport BOOL	IsChecked (FunctionID actionID)

virtual CoreExport BOOL	IsVisible (FunctionID actionID)

virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)

virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)

virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)

Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...

virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual BaseInterface *	AcquireInterface ()

virtual void	ReleaseInterface ()

virtual void	DeleteInterface ()

virtual BaseInterface *	CloneInterface (void *remapDir=NULL)

Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

Static Public Member Functions
static int	AcceptTab (ITabDialogFilter filter, ITabDialogPluginTab tab)
	Test if the filter will accept the passed tab. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...

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. More...

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. More...

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. 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 void *	operator 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 void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...

static UtilExport void *	aligned_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...

Additional Inherited Members
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }

Public Attributes inherited from FPInterfaceDesc
Interface_ID	ID

MSTR	internal_name

StringResID	description

ClassDesc *	cd

USHORT	flags

Tab< FPFunctionDef * >	functions

Tab< FPPropDef * >	props

Tab< FPEnum * >	enumerations

MSPluginClass *	pc

Rollout *	rollout

ActionTable *	action_table

Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

Protected Member Functions inherited from FPInterfaceDesc
CoreExport void	load_descriptor (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc cd, USHORT flag, va_list ap)

Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Member Function Documentation

virtual ITabbedDialog* CreateTabbedDialog	(	HWND	parent,
		HINSTANCE	instance,
		const MCHAR *	dlg,
		ITabDialogProc *	mainProc,
		bool	multiline,
		DWORD	helpID = `0`,
		int	tabID = `-1`,
		const Class_ID &	dialogID = `Class_ID(0, 0)`
	)

pure virtual

Create a tabbed dialog.

Parameters

parent	- the parent window of the dialog
instance	- the instance where the dialog template is stored
dlg	- the name of the dialog template resource. If instance is NULL, then dlg is a pointer to the dialog template in memory.
mainProc	- the object that is used to handle messages for the dialog.
multiline	- true if the tab control should be multiline and is only applicable when tabID is -1.
helpID	- is used to bring up context sensitive help when the F1 key is pressed.
tabID	- the ID of a tab control in the dialog template that is to be used. If tabID is -1, then a tab control is created.
dialogID	- the id of the dialog this tab is to be used with.

Returns: The created ITabbedDialog

virtual bool RegisterTab	(	const Class_ID &	dialogID,
		ITabDialogPluginTab *	tab
	)

pure virtual

Register a tab for a dialog.

Parameters

dialogID	- the id of the dialog this tab is to be used with.
tab	- is the address of an object that is used to add the tab when the dialog is created. Tab must remain valid while it is registered.

Returns: true on success, false otherwise

virtual void UnRegisterTab	(	const Class_ID &	dialogID,
		ITabDialogPluginTab *	tab
	)

pure virtual

UnRegister a tab for a dialog.

Parameters

dialogID	- the id of the dialog this tab is to be used with.
tab	- is the address of an object that is used to add the tab when the dialog is created. Tab must remain valid while it is registered.

Returns: true on success, false otherwise

virtual void SetTabFilter	(	const Class_ID &	dialogID,
		ITabDialogFilter *	filter
	)

pure virtual

Set the current plugin tab filter for a dialog.

This filter is used to determine which tabs will be present when the dialog is created.

Parameters

dialogID	- the id of the dialog this filter is to be used with.
filter	- The filter to run over the tabs in the dialog

virtual ITabDialogFilter* GetTabFilter ( const Class_ID & dialogID )

pure virtual

Get the current plugin tab filter for a dialog.

This filter is used to determine which tabs will be present when the dialog is created.

Parameters

dialogID - the id of the dialog to return the filter off.

Returns: The current filter on the dialog

virtual ITabbedDialog* GetTabbedDialog ( const Class_ID & dialogID )

pure virtual

Get the ITabbedDialog for the dialog id.

Returns NULL if dialog not present. Assumes that only one dialog is present for a dialog id at a time. Note: NOTIFY_TABBED_DIALOG_CREATED and NOTIFY_TABBED_DIALOG_DELETED sent when a tabbed dialog is created or deleted.

Parameters

dialogID - the id of the dialog to return the ITabbedDialog of

Returns: The ITabbedDialog of the passed dialog if present, else NULL

int AcceptTab	(	ITabDialogFilter *	filter,
		ITabDialogPluginTab *	tab
	)

inlinestatic

Test if the filter will accept the passed tab.

Parameters

filter	- The filter to compare tab against
tab	- The dialog tab being filtered

Returns: The value can be a combination of TAB_DIALOG_REMOVE_TAB and TAB_DIALOG_ADD_TAB

 {
    int dlgResult = filter == NULL ? TAB_DIALOG_ADD_TAB : filter->AcceptTab(tab);
    if (dlgResult & TAB_DIALOG_ADD_TAB) {
       dlgResult &= ~TAB_DIALOG_ADD_TAB;
       dlgResult |= tab->AcceptDialog(filter);
    }
    return dlgResult;
 }

ITabDialogManager Class Reference

Class Description

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Function Documentation