Public Member Functions

ITabDialogPluginTab Class Reference

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


Search for all occurrences

#include <ITabDialog.h>

Inheritance diagram for ITabDialogPluginTab:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual void  AddTabToDialog (ITabbedDialog *dialog)=0
  Add your tab(s) to the dialog.
virtual int  AcceptDialog (ITabDialogFilter *filter)
  Test to accept this tab in this dialog.
virtual ReferenceMaker *  GetReferenceMaker ()
  The following functions return various information that is likely to be interesting when deciding whether or not to use this tab.
virtual Animatable *  GetAnimatable ()
  Otherwise, if this tab is the UI for an Animatable, return it here.
virtual Class_ID  GetClassID ()
  Otherwise, If this tab 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 void AddTabToDialog ( ITabbedDialog *  dialog ) [pure virtual]

Add your tab(s) to the dialog.

This will only be called if both this object and the dialog agree that the tab should be added.

Parameters:
dialog - a pointer to the dialog.
virtual int AcceptDialog ( ITabDialogFilter *  filter ) [inline, virtual]

Test to accept this tab in this dialog.

Parameters:
filter - the dialog filter.
Returns:
Return true if the tab should be added. Return false if the tab should not be added or should be removed if it was added previously.
     { return TAB_DIALOG_ADD_TAB; }
virtual ReferenceMaker* GetReferenceMaker ( ) [inline, virtual]

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

Returns:
If this tab is the UI for a ReferenceMaker, return it here.
{ return NULL; }
virtual Animatable* GetAnimatable ( ) [inline, virtual]

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

{ return (Animatable*)GetReferenceMaker(); }
virtual Class_ID GetClassID ( ) [inline, virtual]

Otherwise, If this tab 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]
virtual BaseInterface* GetInterface ( const Interface_ID &  id ) [inline, virtual]

Otherwise, you will need to define a special interface.

{ return NULL; }

ITabDialogPluginTab ITabDialogPluginTab ITabDialogPluginTab ITabDialogPluginTab ITabDialogPluginTab ITabDialogPluginTab ITabDialogPluginTab ITabDialogPluginTab ITabDialogPluginTab ITabDialogPluginTab
ITabDialogPluginTab ITabDialogPluginTab ITabDialogPluginTab ITabDialogPluginTab ITabDialogPluginTab ITabDialogPluginTab ITabDialogPluginTab ITabDialogPluginTab ITabDialogPluginTab ITabDialogPluginTab