ITreeViewUI Class Reference

ITreeViewUI Class Referenceabstract

#include <itreevw.h>

+ Inheritance diagram for ITreeViewUI:

Public Types

enum  {
  tv_getHWnd, tv_getMenuBar, tv_setMenuBar, tv_getControllerQuadMenu,
  tv_setControllerQuadMenu, tv_getKeyQuadMenu, tv_setKeyQuadMenu, tv_getMenuBarVisible,
  tv_setMenuBarVisible, tv_getScrollBarsVisible, tv_setScrollBarsVisible, tv_getTrackWindowVisible,
  tv_setTrackWindowVisible, tv_getKeyWindowVisible, tv_setKeyWindowVisible, tv_getTimeRulerVisible,
  tv_setTimeRulerVisible, tv_showAllToolbars, tv_hideAllToolbars, tv_showToolbar,
  tv_hideToolbar, tv_getToolbarName, tv_getToolbarObjectName, tv_deleteToolbar,
  tv_addToolbar, tv_toolbarCount, tv_saveUILayout, tv_saveCurrentUILayout,
  tv_loadUILayout, tv_layoutCount, tv_getLayoutName, tv_layoutName,
  tv_isToolbarVisible, tv_getKeyPropertyVisible, tv_setKeyPropertyVisible, tv_getIconsByClass,
  tv_setIconsByClass, tv_getUnlockedVisible, tv_setUnlockedVisible
}
 
- Public Types inherited from BaseInterface
enum  LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }
 

Public Member Functions

virtual HWND GetHWnd ()=0
 
virtual MSTR GetMenuBar ()=0
 
virtual void SetMenuBar (MSTR name)=0
 
virtual MSTR GetControllerQuadMenu ()=0
 
virtual void SetControllerQuadMenu (MSTR name)=0
 
virtual MSTR GetKeyQuadMenu ()=0
 
virtual void SetKeyQuadMenu (MSTR name)=0
 
virtual void SetRetimerQuadMenu (const MSTR &name)=0
 Sets up the Retimer RMB quad menu for setting the span type \ param name Quad Menu name. More...
 
virtual int ToolbarCount ()=0
 
virtual void AddToolbar ()=0
 
virtual void DeleteToolbar ()=0
 
virtual bool AddToolbar (const MCHAR *name)=0
 
virtual bool DeleteToolbar (int index)=0
 
virtual bool DeleteToolbar (const MCHAR *name)=0
 
virtual MSTR GetToolbarName (int index)=0
 
virtual MSTR GetToolbarObjectName (int index)=0
 
virtual void ShowToolbar (const MCHAR *name)=0
 
virtual void HideToolbar (const MCHAR *name)=0
 
virtual bool IsToolbarVisible (const MCHAR *name)=0
 
virtual void ShowAllToolbars ()=0
 
virtual void HideAllToolbars ()=0
 
virtual void ShowMenuBar (bool visible)=0
 
virtual bool IsMenuBarVisible ()=0
 
virtual void ShowScrollBars (bool visible)=0
 
virtual bool IsScrollBarsVisible ()=0
 
virtual void ShowTrackWindow (bool visible)=0
 
virtual bool IsTrackWindowVisible ()=0
 
virtual void ShowKeyWindow (bool visible)=0
 
virtual bool IsKeyWindowVisible ()=0
 
virtual void ShowTimeRuler (bool visible)=0
 
virtual bool IsTimeRulerVisible ()=0
 
virtual void ShowKeyPropertyIcon (bool visible)=0
 
virtual bool IsKeyPropertyIconVisible ()=0
 
virtual void ShowIconsByClass (bool byClass)=0
 
virtual bool ShowIconsByClass ()=0
 
virtual void SaveUILayout ()=0
 
virtual void SaveUILayout (const MCHAR *name)=0
 
virtual void LoadUILayout (const MCHAR *name)=0
 
virtual int LayoutCount ()=0
 
virtual MSTR GetLayoutName (int index)=0
 
virtual MSTR GetLayoutName ()=0
 
virtual void ShowUnlockedIcon (bool visible)=0
 Turn the unlocked icon on and off before a trackview item. More...
 
virtual bool IsUnlockedIconVisible ()=0
 Tells you wether or not the unlocked icon is on or off. More...
 
 RO_PROP_FN (tv_getHWnd, GetHWnd, TYPE_HWND)
 
 RO_PROP_FN (tv_layoutName, GetLayoutName, TYPE_TSTR_BV)
 
 PROP_FNS (tv_getMenuBar, GetMenuBar, tv_setMenuBar, SetMenuBar, TYPE_TSTR_BV)
 
 PROP_FNS (tv_getControllerQuadMenu, GetControllerQuadMenu, tv_setControllerQuadMenu, SetControllerQuadMenu, TYPE_TSTR_BV)
 
 PROP_FNS (tv_getKeyQuadMenu, GetKeyQuadMenu, tv_setKeyQuadMenu, SetKeyQuadMenu, TYPE_TSTR_BV)
 
 PROP_FNS (tv_getMenuBarVisible, IsMenuBarVisible, tv_setMenuBarVisible, ShowMenuBar, TYPE_bool)
 
 PROP_FNS (tv_getScrollBarsVisible, IsScrollBarsVisible, tv_setScrollBarsVisible, ShowScrollBars, TYPE_bool)
 
 PROP_FNS (tv_getTrackWindowVisible, IsTrackWindowVisible, tv_setTrackWindowVisible, ShowTrackWindow, TYPE_bool)
 
 PROP_FNS (tv_getKeyWindowVisible, IsKeyWindowVisible, tv_setKeyWindowVisible, ShowKeyWindow, TYPE_bool)
 
 PROP_FNS (tv_getTimeRulerVisible, IsTimeRulerVisible, tv_setTimeRulerVisible, ShowTimeRuler, TYPE_bool)
 
 PROP_FNS (tv_getKeyPropertyVisible, IsKeyPropertyIconVisible, tv_setKeyPropertyVisible, ShowKeyPropertyIcon, TYPE_bool)
 
 PROP_FNS (tv_getIconsByClass, ShowIconsByClass, tv_setIconsByClass, ShowIconsByClass, TYPE_bool)
 
 PROP_FNS (tv_getUnlockedVisible, IsUnlockedIconVisible, tv_setUnlockedVisible, ShowUnlockedIcon, TYPE_bool)
 
 VFN_0 (tv_showAllToolbars, ShowAllToolbars)
 
 VFN_0 (tv_hideAllToolbars, HideAllToolbars)
 
 VFN_1 (tv_showToolbar, ShowToolbar, TYPE_STRING)
 
 VFN_1 (tv_hideToolbar, HideToolbar, TYPE_STRING)
 
 FN_1 (tv_getToolbarName, TYPE_STRING, GetToolbarName, TYPE_INDEX)
 
 FN_1 (tv_getToolbarObjectName, TYPE_STRING, GetToolbarObjectName, TYPE_INDEX)
 
 FN_1 (tv_deleteToolbar, TYPE_bool, fp_DeleteToolbar, TYPE_FPVALUE)
 
 FN_1 (tv_addToolbar, TYPE_bool, AddToolbar, TYPE_STRING)
 
 FN_0 (tv_toolbarCount, TYPE_INT, ToolbarCount)
 
 FN_1 (tv_isToolbarVisible, TYPE_bool, IsToolbarVisible, TYPE_STRING)
 
 VFN_0 (tv_saveCurrentUILayout, SaveUILayout)
 
 VFN_1 (tv_saveUILayout, SaveUILayout, TYPE_STRING)
 
 VFN_1 (tv_loadUILayout, LoadUILayout, TYPE_STRING)
 
 FN_0 (tv_layoutCount, TYPE_INT, LayoutCount)
 
 FN_1 (tv_getLayoutName, TYPE_TSTR_BV, GetLayoutName, TYPE_INDEX)
 
FPInterfaceDescGetDesc ()
 
Interface_ID GetID ()
 
- Public Member Functions inherited from FPMixinInterface
 FPMixinInterface ()
 
virtual LifetimeType LifetimeControl ()
 
virtual CoreExport bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
CoreExport ~FPMixinInterface ()
 
virtual BaseInterfaceGetInterface (Interface_ID id)
 
virtual FPInterfaceDescGetDescByID (Interface_ID 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)
 
virtual ActionTableGetActionTable ()
 
virtual void EnableActions (BOOL onOff)
 
- Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor. More...
 
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

- 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...
 
- Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc nullInterface
 
- Protected Member Functions inherited from FPMixinInterface
 FPMixinInterface (const FPMixinInterface &rhs)
 
FPMixinInterfaceoperator= (const FPMixinInterface &rhs)
 
- Protected Member Functions inherited from FPInterface
virtual FPStatus _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)
 
- Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > * interfaceNotifyCBs
 

Member Enumeration Documentation

anonymous enum
Enumerator
tv_getHWnd 
tv_getMenuBar 
tv_setMenuBar 
tv_getControllerQuadMenu 
tv_setControllerQuadMenu 
tv_getKeyQuadMenu 
tv_setKeyQuadMenu 
tv_getMenuBarVisible 
tv_setMenuBarVisible 
tv_getScrollBarsVisible 
tv_setScrollBarsVisible 
tv_getTrackWindowVisible 
tv_setTrackWindowVisible 
tv_getKeyWindowVisible 
tv_setKeyWindowVisible 
tv_getTimeRulerVisible 
tv_setTimeRulerVisible 
tv_showAllToolbars 
tv_hideAllToolbars 
tv_showToolbar 
tv_hideToolbar 
tv_getToolbarName 
tv_getToolbarObjectName 
tv_deleteToolbar 
tv_addToolbar 
tv_toolbarCount 
tv_saveUILayout 
tv_saveCurrentUILayout 
tv_loadUILayout 
tv_layoutCount 
tv_getLayoutName 
tv_layoutName 
tv_isToolbarVisible 
tv_getKeyPropertyVisible 
tv_setKeyPropertyVisible 
tv_getIconsByClass 
tv_setIconsByClass 
tv_getUnlockedVisible 
tv_setUnlockedVisible 
148  };
Definition: itreevw.h:139
Definition: itreevw.h:145
Definition: itreevw.h:144
Definition: itreevw.h:145
Definition: itreevw.h:147
Definition: itreevw.h:144
Definition: itreevw.h:142
Definition: itreevw.h:145
Definition: itreevw.h:146
Definition: itreevw.h:141
Definition: itreevw.h:144
Definition: itreevw.h:145
Definition: itreevw.h:143
Definition: itreevw.h:147
Definition: itreevw.h:140
Definition: itreevw.h:144
Definition: itreevw.h:144
Definition: itreevw.h:145
Definition: itreevw.h:146
Definition: itreevw.h:147
Definition: itreevw.h:146
Definition: itreevw.h:142
Definition: itreevw.h:143
Definition: itreevw.h:141
Definition: itreevw.h:139
Definition: itreevw.h:147
Definition: itreevw.h:139
Definition: itreevw.h:142
Definition: itreevw.h:145
Definition: itreevw.h:139
Definition: itreevw.h:144
Definition: itreevw.h:144
Definition: itreevw.h:139
Definition: itreevw.h:143
Definition: itreevw.h:141
Definition: itreevw.h:142
Definition: itreevw.h:141
Definition: itreevw.h:140
Definition: itreevw.h:143

Member Function Documentation

virtual HWND GetHWnd ( )
pure virtual
virtual MSTR GetMenuBar ( )
pure virtual
virtual void SetMenuBar ( MSTR  name)
pure virtual
virtual MSTR GetControllerQuadMenu ( )
pure virtual
virtual void SetControllerQuadMenu ( MSTR  name)
pure virtual
virtual MSTR GetKeyQuadMenu ( )
pure virtual
virtual void SetKeyQuadMenu ( MSTR  name)
pure virtual
virtual void SetRetimerQuadMenu ( const MSTR name)
pure virtual

Sets up the Retimer RMB quad menu for setting the span type \ param name Quad Menu name.

virtual int ToolbarCount ( )
pure virtual
virtual void AddToolbar ( )
pure virtual
virtual void DeleteToolbar ( )
pure virtual
virtual bool AddToolbar ( const MCHAR name)
pure virtual
virtual bool DeleteToolbar ( int  index)
pure virtual
virtual bool DeleteToolbar ( const MCHAR name)
pure virtual
virtual MSTR GetToolbarName ( int  index)
pure virtual
virtual MSTR GetToolbarObjectName ( int  index)
pure virtual
virtual void ShowToolbar ( const MCHAR name)
pure virtual
virtual void HideToolbar ( const MCHAR name)
pure virtual
virtual bool IsToolbarVisible ( const MCHAR name)
pure virtual
virtual void ShowAllToolbars ( )
pure virtual
virtual void HideAllToolbars ( )
pure virtual
virtual void ShowMenuBar ( bool  visible)
pure virtual
virtual bool IsMenuBarVisible ( )
pure virtual
virtual void ShowScrollBars ( bool  visible)
pure virtual
virtual bool IsScrollBarsVisible ( )
pure virtual
virtual void ShowTrackWindow ( bool  visible)
pure virtual
virtual bool IsTrackWindowVisible ( )
pure virtual
virtual void ShowKeyWindow ( bool  visible)
pure virtual
virtual bool IsKeyWindowVisible ( )
pure virtual
virtual void ShowTimeRuler ( bool  visible)
pure virtual
virtual bool IsTimeRulerVisible ( )
pure virtual
virtual void ShowKeyPropertyIcon ( bool  visible)
pure virtual
virtual bool IsKeyPropertyIconVisible ( )
pure virtual
virtual void ShowIconsByClass ( bool  byClass)
pure virtual
virtual bool ShowIconsByClass ( )
pure virtual
virtual void SaveUILayout ( )
pure virtual
virtual void SaveUILayout ( const MCHAR name)
pure virtual
virtual void LoadUILayout ( const MCHAR name)
pure virtual
virtual int LayoutCount ( )
pure virtual
virtual MSTR GetLayoutName ( int  index)
pure virtual
virtual MSTR GetLayoutName ( )
pure virtual
virtual void ShowUnlockedIcon ( bool  visible)
pure virtual

Turn the unlocked icon on and off before a trackview item.

\ This function is used to turn on or off the display of the unlocked icon before a trackview item. \ param visible If true the unlocked or locked icon is displayed before the track name, if false the icons are not shown.

virtual bool IsUnlockedIconVisible ( )
pure virtual

Tells you wether or not the unlocked icon is on or off.

Returns
If true then an unlocked or locked item will be displayed before a trackview item, if false then none will.
RO_PROP_FN ( tv_getHWnd  ,
GetHWnd  ,
TYPE_HWND   
)
RO_PROP_FN ( tv_layoutName  ,
GetLayoutName  ,
TYPE_TSTR_BV   
)
PROP_FNS ( tv_getMenuBar  ,
GetMenuBar  ,
tv_setMenuBar  ,
SetMenuBar  ,
TYPE_TSTR_BV   
)
VFN_0 ( tv_showAllToolbars  ,
ShowAllToolbars   
)
VFN_0 ( tv_hideAllToolbars  ,
HideAllToolbars   
)
VFN_1 ( tv_showToolbar  ,
ShowToolbar  ,
TYPE_STRING   
)
VFN_1 ( tv_hideToolbar  ,
HideToolbar  ,
TYPE_STRING   
)
FN_1 ( tv_deleteToolbar  ,
TYPE_bool  ,
fp_DeleteToolbar  ,
TYPE_FPVALUE   
)
FN_1 ( tv_addToolbar  ,
TYPE_bool  ,
AddToolbar  ,
TYPE_STRING   
)
FN_0 ( tv_toolbarCount  ,
TYPE_INT  ,
ToolbarCount   
)
VFN_1 ( tv_saveUILayout  ,
SaveUILayout  ,
TYPE_STRING   
)
VFN_1 ( tv_loadUILayout  ,
LoadUILayout  ,
TYPE_STRING   
)
FN_0 ( tv_layoutCount  ,
TYPE_INT  ,
LayoutCount   
)
FPInterfaceDesc* GetDesc ( )
inlinevirtual
Remarks
Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

virtual FPInterfaceDesc * GetDescByID(Interface_ID id)
Definition: ifnpub.h:613
#define TREEVIEW_UI_INTERFACE
Definition: itreevw.h:70
Interface_ID GetID ( )
inlinevirtual
Remarks
This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.
Returns
The Interface_ID.
Default Implementation:
{ return GetDesc()->ID; }

Reimplemented from FPMixinInterface.

185 { return TREEVIEW_UI_INTERFACE; }
#define TREEVIEW_UI_INTERFACE
Definition: itreevw.h:70