ITreeViewUI Class Reference

Search for all occurrences

#include <itreevw.h>

Inheritance diagram for ITreeViewUI:

List of all members.

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_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 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 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 const MCHAR *	GetToolbarName (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.
virtual bool	IsUnlockedIconVisible ()=0
	Tells you wether or not the unlocked icon is on or off.
BEGIN_FUNCTION_MAP	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_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)
END_FUNCTION_MAP FPInterfaceDesc *	GetDesc ()
Interface_ID	GetID ()

---

Member Enumeration Documentation

anonymous enum

Search for all occurrences

Enumerator:

tv_getHWnd	Search for all occurrences
tv_getMenuBar	Search for all occurrences
tv_setMenuBar	Search for all occurrences
tv_getControllerQuadMenu	Search for all occurrences
tv_setControllerQuadMenu	Search for all occurrences
tv_getKeyQuadMenu	Search for all occurrences
tv_setKeyQuadMenu	Search for all occurrences
tv_getMenuBarVisible	Search for all occurrences
tv_setMenuBarVisible	Search for all occurrences
tv_getScrollBarsVisible	Search for all occurrences
tv_setScrollBarsVisible	Search for all occurrences
tv_getTrackWindowVisible	Search for all occurrences
tv_setTrackWindowVisible	Search for all occurrences
tv_getKeyWindowVisible	Search for all occurrences
tv_setKeyWindowVisible	Search for all occurrences
tv_getTimeRulerVisible	Search for all occurrences
tv_setTimeRulerVisible	Search for all occurrences
tv_showAllToolbars	Search for all occurrences
tv_hideAllToolbars	Search for all occurrences
tv_showToolbar	Search for all occurrences
tv_hideToolbar	Search for all occurrences
tv_getToolbarName	Search for all occurrences
tv_deleteToolbar	Search for all occurrences
tv_addToolbar	Search for all occurrences
tv_toolbarCount	Search for all occurrences
tv_saveUILayout	Search for all occurrences
tv_saveCurrentUILayout	Search for all occurrences
tv_loadUILayout	Search for all occurrences
tv_layoutCount	Search for all occurrences
tv_getLayoutName	Search for all occurrences
tv_layoutName	Search for all occurrences
tv_isToolbarVisible	Search for all occurrences
tv_getKeyPropertyVisible	Search for all occurrences
tv_setKeyPropertyVisible	Search for all occurrences
tv_getIconsByClass	Search for all occurrences
tv_setIconsByClass	Search for all occurrences
tv_getUnlockedVisible	Search for all occurrences
tv_setUnlockedVisible	Search for all occurrences

         { 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_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
        };

---

Member Function Documentation

virtual HWND GetHWnd

(

)

[pure virtual]

Search for all occurrences

virtual MSTR GetMenuBar

(

)

[pure virtual]

Search for all occurrences

virtual void SetMenuBar

(

MSTR

name

)

[pure virtual]

Search for all occurrences

virtual MSTR GetControllerQuadMenu

(

)

[pure virtual]

Search for all occurrences

virtual void SetControllerQuadMenu

(

MSTR

name

)

[pure virtual]

Search for all occurrences

virtual MSTR GetKeyQuadMenu

(

)

[pure virtual]

Search for all occurrences

virtual void SetKeyQuadMenu

(

MSTR

name

)

[pure virtual]

Search for all occurrences

virtual int ToolbarCount

(

)

[pure virtual]

Search for all occurrences

virtual void AddToolbar

(

)

[pure virtual]

Search for all occurrences

virtual void DeleteToolbar

(

)

[pure virtual]

Search for all occurrences

virtual bool AddToolbar

(

const MCHAR *

name

)

[pure virtual]

Search for all occurrences

virtual bool DeleteToolbar

(

int

index

)

[pure virtual]

Search for all occurrences

virtual bool DeleteToolbar

(

const MCHAR *

name

)

[pure virtual]

Search for all occurrences

virtual const MCHAR* GetToolbarName

(

int

index

)

[pure virtual]

Search for all occurrences

virtual void ShowToolbar

(

const MCHAR *

name

)

[pure virtual]

Search for all occurrences

virtual void HideToolbar

(

const MCHAR *

name

)

[pure virtual]

Search for all occurrences

virtual bool IsToolbarVisible

(

const MCHAR *

name

)

[pure virtual]

Search for all occurrences

virtual void ShowAllToolbars

(

)

[pure virtual]

Search for all occurrences

virtual void HideAllToolbars

(

)

[pure virtual]

Search for all occurrences

virtual void ShowMenuBar

(

bool

visible

)

[pure virtual]

Search for all occurrences

virtual bool IsMenuBarVisible

(

)

[pure virtual]

Search for all occurrences

virtual void ShowScrollBars

(

bool

visible

)

[pure virtual]

Search for all occurrences

virtual bool IsScrollBarsVisible

(

)

[pure virtual]

Search for all occurrences

virtual void ShowTrackWindow

(

bool

visible

)

[pure virtual]

Search for all occurrences

virtual bool IsTrackWindowVisible

(

)

[pure virtual]

Search for all occurrences

virtual void ShowKeyWindow

(

bool

visible

)

[pure virtual]

Search for all occurrences

virtual bool IsKeyWindowVisible

(

)

[pure virtual]

Search for all occurrences

virtual void ShowTimeRuler

(

bool

visible

)

[pure virtual]

Search for all occurrences

virtual bool IsTimeRulerVisible

(

)

[pure virtual]

Search for all occurrences

virtual void ShowKeyPropertyIcon

(

bool

visible

)

[pure virtual]

Search for all occurrences

virtual bool IsKeyPropertyIconVisible

(

)

[pure virtual]

Search for all occurrences

virtual void ShowIconsByClass

(

bool

byClass

)

[pure virtual]

Search for all occurrences

virtual bool ShowIconsByClass

(

)

[pure virtual]

Search for all occurrences

virtual void SaveUILayout

(

)

[pure virtual]

Search for all occurrences

virtual void SaveUILayout

(

const MCHAR *

name

)

[pure virtual]

Search for all occurrences

virtual void LoadUILayout

(

const MCHAR *

name

)

[pure virtual]

Search for all occurrences

virtual int LayoutCount

(

)

[pure virtual]

Search for all occurrences

virtual MSTR GetLayoutName

(

int

index

)

[pure virtual]

Search for all occurrences

virtual MSTR GetLayoutName

(

)

[pure virtual]

Search for all occurrences

virtual void ShowUnlockedIcon

(

bool

visible

)

[pure virtual]

Search for all occurrences

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]

Search for all occurrences

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.

BEGIN_FUNCTION_MAP RO_PROP_FN	(	tv_getHWnd	,
		GetHWnd	,
		TYPE_HWND
	)

Search for all occurrences

RO_PROP_FN	(	tv_layoutName	,
		GetLayoutName	,
		TYPE_TSTR_BV
	)

Search for all occurrences

PROP_FNS	(	tv_getMenuBar	,
		GetMenuBar	,
		tv_setMenuBar	,
		SetMenuBar	,
		TYPE_TSTR_BV
	)

Search for all occurrences

PROP_FNS	(	tv_getControllerQuadMenu	,
		GetControllerQuadMenu	,
		tv_setControllerQuadMenu	,
		SetControllerQuadMenu	,
		TYPE_TSTR_BV
	)

Search for all occurrences

PROP_FNS	(	tv_getKeyQuadMenu	,
		GetKeyQuadMenu	,
		tv_setKeyQuadMenu	,
		SetKeyQuadMenu	,
		TYPE_TSTR_BV
	)

Search for all occurrences

PROP_FNS	(	tv_getMenuBarVisible	,
		IsMenuBarVisible	,
		tv_setMenuBarVisible	,
		ShowMenuBar	,
		TYPE_bool
	)

Search for all occurrences

PROP_FNS	(	tv_getScrollBarsVisible	,
		IsScrollBarsVisible	,
		tv_setScrollBarsVisible	,
		ShowScrollBars	,
		TYPE_bool
	)

Search for all occurrences

PROP_FNS	(	tv_getTrackWindowVisible	,
		IsTrackWindowVisible	,
		tv_setTrackWindowVisible	,
		ShowTrackWindow	,
		TYPE_bool
	)

Search for all occurrences

PROP_FNS	(	tv_getKeyWindowVisible	,
		IsKeyWindowVisible	,
		tv_setKeyWindowVisible	,
		ShowKeyWindow	,
		TYPE_bool
	)

Search for all occurrences

PROP_FNS	(	tv_getTimeRulerVisible	,
		IsTimeRulerVisible	,
		tv_setTimeRulerVisible	,
		ShowTimeRuler	,
		TYPE_bool
	)

Search for all occurrences

PROP_FNS	(	tv_getKeyPropertyVisible	,
		IsKeyPropertyIconVisible	,
		tv_setKeyPropertyVisible	,
		ShowKeyPropertyIcon	,
		TYPE_bool
	)

Search for all occurrences

PROP_FNS	(	tv_getIconsByClass	,
		ShowIconsByClass	,
		tv_setIconsByClass	,
		ShowIconsByClass	,
		TYPE_bool
	)

Search for all occurrences

PROP_FNS	(	tv_getUnlockedVisible	,
		IsUnlockedIconVisible	,
		tv_setUnlockedVisible	,
		ShowUnlockedIcon	,
		TYPE_bool
	)

Search for all occurrences

VFN_0	(	tv_showAllToolbars	,
		ShowAllToolbars
	)

Search for all occurrences

VFN_0	(	tv_hideAllToolbars	,
		HideAllToolbars
	)

Search for all occurrences

VFN_1	(	tv_showToolbar	,
		ShowToolbar	,
		TYPE_STRING
	)

Search for all occurrences

VFN_1	(	tv_hideToolbar	,
		HideToolbar	,
		TYPE_STRING
	)

Search for all occurrences

FN_1	(	tv_getToolbarName	,
		TYPE_STRING	,
		GetToolbarName	,
		TYPE_INDEX
	)

Search for all occurrences

FN_1	(	tv_deleteToolbar	,
		TYPE_bool	,
		fp_DeleteToolbar	,
		TYPE_FPVALUE
	)

Search for all occurrences

FN_1	(	tv_addToolbar	,
		TYPE_bool	,
		AddToolbar	,
		TYPE_STRING
	)

Search for all occurrences

FN_0	(	tv_toolbarCount	,
		TYPE_INT	,
		ToolbarCount
	)

Search for all occurrences

FN_1	(	tv_isToolbarVisible	,
		TYPE_bool	,
		IsToolbarVisible	,
		TYPE_STRING
	)

Search for all occurrences

VFN_0	(	tv_saveCurrentUILayout	,
		SaveUILayout
	)

Search for all occurrences

VFN_1	(	tv_saveUILayout	,
		SaveUILayout	,
		TYPE_STRING
	)

Search for all occurrences

VFN_1	(	tv_loadUILayout	,
		LoadUILayout	,
		TYPE_STRING
	)

Search for all occurrences

FN_0	(	tv_layoutCount	,
		TYPE_INT	,
		LayoutCount
	)

Search for all occurrences

FN_1	(	tv_getLayoutName	,
		TYPE_TSTR_BV	,
		GetLayoutName	,
		TYPE_INDEX
	)

Search for all occurrences

END_FUNCTION_MAP FPInterfaceDesc* GetDesc

(

)

[inline, virtual]

Search for all occurrences

Remarks:

Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

{ return GetDescByID(TREEVIEW_UI_INTERFACE); }

Interface_ID GetID

(

)

[inline, virtual]

Search for all occurrences

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.

{ return TREEVIEW_UI_INTERFACE; }