ITabDialogPluginTab Class Reference

ITabDialogPluginTab Class Referenceabstract

#include <ITabDialog.h>

+ Inheritance diagram for ITabDialogPluginTab:

Public Member Functions

virtual void AddTabToDialog (ITabbedDialog *dialog)=0
 Add your tab(s) to the dialog. More...
 
virtual int AcceptDialog (ITabDialogFilter *filter)
 Test to accept this tab in this dialog. More...
 
virtual ReferenceMakerGetReferenceMaker ()
 The following functions return various information that is likely to be interesting when deciding whether or not to use this tab. More...
 
virtual AnimatableGetAnimatable ()
 Otherwise, if this tab is the UI for an Animatable, return it here. More...
 
virtual Class_ID GetClassID ()
 Otherwise, If this tab has some known class ID and super class ID. More...
 
virtual SClass_ID GetSuperClassID ()
 
virtual BaseInterfaceGetInterface (const Interface_ID &id)
 Otherwise, you will need to define a special interface. More...
 
- Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor. More...
 
UtilExport BaseInterfaceGetInterface (Interface_ID id)
 
virtual UtilExport Interface_ID GetID ()
 
virtual LifetimeType LifetimeControl ()
 
virtual bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual BaseInterfaceAcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterfaceCloneInterface (void *remapDir=NULL)
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor. More...
 

Additional Inherited Members

- Public Types inherited from BaseInterface
enum  LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }
 
- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary. More...
 
static UtilExport voidaligned_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...
 

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)
inlinevirtual

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.
175  { return TAB_DIALOG_ADD_TAB; }
Definition: ITabDialog.h:136
virtual ReferenceMaker* GetReferenceMaker ( )
inlinevirtual

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.
180 { return NULL; }
#define NULL
Definition: autoptr.h:18
virtual Animatable* GetAnimatable ( )
inlinevirtual

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

183 { return (Animatable*)GetReferenceMaker(); }
Definition: Animatable.h:121
virtual ReferenceMaker * GetReferenceMaker()
The following functions return various information that is likely to be interesting when deciding whe...
Definition: ITabDialog.h:180
virtual Class_ID GetClassID ( )
inlinevirtual

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

186  {
187  Animatable* a = GetAnimatable();
188  return a ? a->ClassID() : Class_ID(0, 0);
189  }
virtual CoreExport Class_ID ClassID()
Retrieves a constant that uniquely identifies the plugin class.
virtual Animatable * GetAnimatable()
Otherwise, if this tab is the UI for an Animatable, return it here.
Definition: ITabDialog.h:183
Definition: Animatable.h:121
Definition: maxtypes.h:140
virtual SClass_ID GetSuperClassID ( )
inlinevirtual
190  {
191  Animatable* a = GetAnimatable();
192  return a ? a->SuperClassID() : 0;
193  }
virtual Animatable * GetAnimatable()
Otherwise, if this tab is the UI for an Animatable, return it here.
Definition: ITabDialog.h:183
Definition: Animatable.h:121
virtual CoreExport SClass_ID SuperClassID()=0
Retrieves a constant representing the type of the plugin.
virtual BaseInterface* GetInterface ( const Interface_ID id)
inlinevirtual

Otherwise, you will need to define a special interface.

196 { return NULL; }
#define NULL
Definition: autoptr.h:18