ITreeView Class Reference
 
 
 
ITreeView Class Reference

#include <itreevw.h>

Inheritance diagram for ITreeView:
IObject ITreeViewOps BaseInterfaceServer FPMixinInterface InterfaceServer FPInterface MaxHeapOperators BaseInterface InterfaceServer MaxHeapOperators

Class Description

See also:
Class ITreeViewOps, Class IObject, Class ITrackViewArray, Class TrackViewActionCallback, Class TrackViewFilter, Class ReferenceTarget, Class Animatable

Description:
While this is the main TreeView class used for trackview operations, most of the operations for TreeView's are inherited through the ITreeViewOps class.

Public Member Functions

virtual  ~ITreeView ()
virtual void  SetPos (int x, int y, int w, int h)=0
virtual void  Show ()=0
virtual void  Hide ()=0
virtual BOOL  IsVisible ()=0
virtual BOOL  InViewPort ()=0
virtual void  SetTreeRoot (ReferenceTarget *root, ReferenceTarget *client=NULL, int subNum=0)=0
virtual void  SetLabelOnly (BOOL only)=0
virtual void  SetMultiSel (BOOL on)=0
virtual void  SetSelFilter (TrackViewFilter *f=NULL)=0
virtual void  SetActive (BOOL active)=0
virtual BOOL  IsActive ()=0
virtual HWND  GetHWnd ()=0
virtual int  GetTrackViewParent (int index)=0
virtual void  Flush ()=0
virtual void  UnFlush ()=0
virtual void  SetMatBrowse ()=0
virtual DWORD  GetTVID ()=0
virtual const MCHAR *  GetIObjectName ()
virtual int  NumInterfaces ()
virtual BaseInterface GetInterfaceAt (int index)
virtual BaseInterface GetInterface (Interface_ID id)

Constructor & Destructor Documentation

virtual ~ITreeView ( ) [inline, virtual]
Remarks:
Constructor
{}

Member Function Documentation

virtual void SetPos ( int  x,
int  y,
int  w,
int  h 
) [pure virtual]
Remarks:
This method will position the TreeView window at the specified position using the specified size.
Parameters:
int x, int y

The x and y position of the TreeView window, in screen pixels.

int w, int h

The width and height of the TreeView window, in screen pixels.
virtual void Show ( ) [pure virtual]
Remarks:
This method shows the TreeView window.
virtual void Hide ( ) [pure virtual]
Remarks:
This method hides the TreeView window.
virtual BOOL IsVisible ( ) [pure virtual]
Remarks:
This method allows you to enquire if the TreeView window is currently visible.
Returns:
TRUE if the TreeView window is visible, otherwise FALSE.
virtual BOOL InViewPort ( ) [pure virtual]
Remarks:
This method allows you to enquire whether the TreeView is being displayed in a viewport.
Returns:
TRUE if the TreeView is displayed in a viewport, otherwise FALSE.
virtual void SetTreeRoot ( ReferenceTarget root,
ReferenceTarget client = NULL,
int  subNum = 0 
) [pure virtual]
Remarks:
This method allows you to set the TreeView root which represents the initial tree branch.
Parameters:
ReferenceTarget *root

A pointer to a reference target to use as the root in the TreeView.

ReferenceTarget *client

A pointer to the reference target which is the root's client.

int subNum

The sub-animatable number of the root you wish to set.
virtual void SetLabelOnly ( BOOL  only ) [pure virtual]
Remarks:
This method will instruct the TreeView to show the labels only.
Parameters:
BOOL only

The only parameter specifies if the label only flag should be set (TRUE) or not (FALSE).
virtual void SetMultiSel ( BOOL  on ) [pure virtual]
Remarks:
This method controls the state of the TreeView's multi-select capability and allows you to enable or disable the selection of multiple selections.
Parameters:
BOOL on

Set this parameter to TRUE to enable multi-select. FALSE to disable multi-select.
virtual void SetSelFilter ( TrackViewFilter f = NULL ) [pure virtual]
Remarks:
This method allows you to set set a TreeView selection filter which controls the amount of information displayed in the TreeView.
Parameters:
TrackViewFilter *f

A pointer to a trackview filter which defines the displayable sub-set.
virtual void SetActive ( BOOL  active ) [pure virtual]
Remarks:
This method allows you to activate or inactivate the treeview.
Parameters:
BOOL active

TRUE to activate, FALSE to deactivate.
virtual BOOL IsActive ( ) [pure virtual]
Remarks:
This method returns whether the TreeView is active (TRUE) or inactive (FALSE).
virtual HWND GetHWnd ( ) [pure virtual]
Remarks:
This method returns the handle to the TreeView window.
virtual int GetTrackViewParent ( int  index ) [pure virtual]
Remarks:
This method

This method returns the parent index of a specific TrackView entry. If no parent is found, -1 will be returned.
Parameters:
int index

The index of the TrackView entry for which to return the parent index.
virtual void Flush ( ) [pure virtual]
Remarks:
This method will flush the TreeView and resets its size to 0.
virtual void UnFlush ( ) [pure virtual]
Remarks:
This method will recalculate the sub-tree and signal the list has changed.
virtual void SetMatBrowse ( ) [pure virtual]
Remarks:
This method will set the material browser flag.
virtual DWORD GetTVID ( ) [pure virtual]
Remarks:
This method returns the TrackView ID.
virtual const MCHAR* GetIObjectName ( ) [inline, virtual]
Remarks:
Returns the object/class name.
Default Implementation:
{ return _M(""); }

Reimplemented from IObject.

{return _M("ITrackView");}
virtual int NumInterfaces ( ) [inline, virtual]
virtual BaseInterface* GetInterfaceAt ( int  index ) [inline, virtual]
                                                                 {
                                                        if (index == 0)
                                                                return (ITreeViewOps*)this; 
                                                        return IObject::GetInterfaceAt(index-1);
                                                }
virtual BaseInterface* GetInterface ( Interface_ID  id ) [inline, virtual]
Remarks:
This method returns a pointer to the BaseInterface of the specified interface.
Parameters:
Interface_ID id

The interface ID for which to return the BaseInterface.

Reimplemented from BaseInterfaceServer.

                                { 
                                        if (id == TREEVIEW_OPS_INTERFACE) 
                                                return (BaseInterface*)this; 
                                        else { 
                                                return IObject::GetInterface(id);
                                        }
                                }