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

Detailed Description

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

#include <ITabDialog.h>

Inheritance diagram for ITabDialogFilter:

Public Member Functions
virtual int	AcceptTab (ITabDialogPluginTab *tab)
	Test if the passed tab is acceptable to the dialog being filtered.
virtual int	LaunchDialog (const Class_ID &page=Class_ID(0, 0))
	Launch the dialog for this filter, open the dialog at a specific page.
virtual ReferenceMaker *	GetReferenceMaker ()
	The following functions return various information that is likely to be interesting when deciding whether or not to add a tab.
virtual Animatable *	GetAnimatable ()
	Otherwise, if this dialog is the UI for an Animatable, return it here.
virtual Class_ID	GetClassID ()
	Otherwise, If this dialog has some known class ID and super class ID.
virtual SClass_ID	GetSuperClassID ()
virtual BaseInterface *	GetInterface (const Interface_ID &id)
	Otherwise, you will need to define a special interface.

Member Function Documentation

virtual int AcceptTab ( ITabDialogPluginTab * tab ) [inline, virtual]

Test if the passed tab is acceptable to the dialog being filtered.

Parameters:

tab	The Dialog tab to test

Returns:: true if the tabs added by the ITabDialogPluginTab tab are acceptable for this dialog.

     { return TAB_DIALOG_ADD_TAB; }

virtual int LaunchDialog ( const Class_ID & page = Class_ID(0,0) ) [inline, virtual]

Launch the dialog for this filter, open the dialog at a specific page.

Parameters:

page	The ID of the dialog page to open

{ return IDOK; }

virtual ReferenceMaker* GetReferenceMaker ( ) [inline, virtual]

The following functions return various information that is likely to be interesting when deciding whether or not to add a tab.

{ return NULL; }

virtual Animatable* GetAnimatable ( ) [inline, virtual]

Otherwise, if this dialog is the UI for an Animatable, return it here.

{ return (Animatable*)GetReferenceMaker(); }

virtual Class_ID GetClassID ( ) [inline, virtual]

Otherwise, If this dialog has some known class ID and super class ID.

                                 {
      Animatable* a = GetAnimatable();
      return a ? a->ClassID() : Class_ID(0, 0);
   }

virtual SClass_ID GetSuperClassID ( ) [inline, virtual]

                                       {
      Animatable* a = GetAnimatable();
      return a ? a->SuperClassID() : 0;
   }

virtual BaseInterface* GetInterface ( const Interface_ID & id ) [inline, virtual]

Otherwise, you will need to define a special interface.

{ return NULL; }