Inheritance diagram for iVlkWidgetTimeline:

Detailed Description

Vlk widget timeline interface.

Entity
virtual ni::tBool	SetEntity (vlk::iVlkEntity *apEntity)=0
	Set the entity to edit. {Property}. More...

virtual vlk::iVlkEntity *	GetEntity () const =0
	Get the entity edited. {Property}. More...

virtual ni::tBool	ExploreEntity (vlk::iVlkEntity *apEntity)=0
	Explore the specified entity. More...

virtual ni::tBool	ExploreEntityParent ()=0
	Explore the parent entity of the current entity. More...

virtual void	SetSelectionID (ni::iHString *ahspID)=0
	Set an the selection entity's id. {Property}. More...

virtual ni::iHString *	GetSelectionID () const =0
	Get the selection entity's id. {Property}. More...

View and filters
virtual void	SetViewMode (eVlkWidgetTimelineViewMode aVM)=0
	Set the view mode of the timeline. {Property}. More...

virtual eVlkWidgetTimelineViewMode	GetViewMode () const =0
	Get the view mode of the timeline. {Property}. More...

virtual void	SetViewModeTreeOnly (ni::tBool abTreeOnly)=0
	Set the tree only view mode. {Property}. More...

virtual ni::tBool	GetViewModeTreeOnly () const =0
	Get the tree only view mode. {Property}. More...

virtual void	SetInspectorID (ni::iHString *ahspID)=0
	Set an external inspector id. More...

virtual ni::iHString *	GetInspectorID () const =0
	Get the external inspector id. {Property}. More...

virtual ni::tBool	GetUseInternInspector () const =0
	Get whether the timeline is using the internal inspector. {Property}. More...

virtual void	SetFilterDisplayFlags (tVlkWidgetFilterDisplayFlags aFlags)=0
	Set the filter display flags. {Property}. More...

virtual tVlkWidgetFilterDisplayFlags	GetFilterDisplayFlags () const =0
	Get the filter display flags. {Property}. More...

virtual void	SetFilterEntityClass (ni::iRegex *ahspRegex)=0
	Set the entity class filter regex. {Property}. More...

virtual ni::iRegex *	GetFilterEntityClass () const =0
	Get the entity class filter regex. {Property}. More...

virtual void	SetFilterEntityName (ni::iRegex *ahspRegex)=0
	Set the entity class filter name. {Property}. More...

virtual ni::iRegex *	GetFilterEntityName () const =0
	Get the entity class filter name. {Property}. More...

virtual void	SetFilterEntityClassFlagsExclude (vlk::tVlkEntityClassFlags aFlags)=0
	Set the entity class flags exclude filter. {Property}. More...

virtual vlk::tVlkEntityClassFlags	GetFilterEntityClassFlagsExclude () const =0
	Get the entity class flags exclude filter. {Property}. More...

virtual void	SetFilterEntityClassFlagsRequired (vlk::tVlkEntityClassFlags aFlags)=0
	Set the entity flags required filter. {Property}. More...

virtual vlk::tVlkEntityClassFlags	GetFilterEntityClassFlagsRequired () const =0
	Get the entity flags required filter. {Property}. More...

Tree and low level access
virtual vlk::iVlkTimeline *	GetRootTimeline () const =0
	Get the currently assigned root timeline. {Property}. More...

virtual ni::iWidgetTreeNode *	GetTreeNodeFromWidget (ni::iWidget *apWidget) const =0
	Get the tree node associated with the specified widget/timebar. {Property}. More...

virtual ni::iWidgetTreeNode *	GetTreeNodeFromEntity (vlk::iVlkEntity *apEntity) const =0
	Get the tree node associated with the specified entity. {Property}. More...

virtual vlk::iVlkEntity *	GetEntityFromTreeNode (ni::iWidgetTreeNode *apTreeNode) const =0
	Get the entity of the specified tree node. {Property}. More...

virtual vlk::iVlkEntity *	GetEntityFromWidget (ni::iWidget *apWidget) const =0
	Get the entity of the specified widget/timebar. {Property}. More...

virtual ni::iWidget *	GetWidgetFromEntity (vlk::iVlkEntity *apEntity) const =0
	Get the widget/timebar associated with the specified entity. {Property}. More...

virtual ni::iWidget *	GetTree () const =0
	Get the tree view widget of the timeline. {Property}. More...

virtual void	TreeClearSelection ()=0
	Clear the selection of the tree. More...

virtual ni::tU32	TreeNumSelected () const =0
	Get the number of selections in the tree view. More...

virtual ni::iWidgetTreeNode *	TreeGetSelection (ni::tU32 anIndex) const =0
	Get the tree selection at the specified index. More...

virtual iVlkWidgetTimeBar *	TreeGetSelectionTimebar (ni::tU32 anIndex) const =0
	Get the timebar of the specified item. More...

virtual ni::tU32	TreeIsTreeNodeSelected (ni::iWidgetTreeNode *apNode) const =0
	Check whether the specified tree node is selected. More...

virtual ni::tU32	TreeIsWidgetSelected (ni::iWidget *apW) const =0
	Check whether the specified widget/timebar is selected. More...

virtual ni::tU32	TreeIsEntitySelected (vlk::iVlkEntity *apE) const =0
	Check whether the specified entity is selected. More...

virtual iVlkWidgetTimeBar *	TreeGetSingleSelectedTimebar () const =0
	Get the time bar only if one item is selected. More...

virtual ni::iWidget *	GetToolbar () const =0
	Get the toolbar of the timeline. {Property}. More...

virtual void	DefaultUpdateToolbar ()=0
	Default toolbar update, called by the timeline if the message vlk::eVlkWidgetTimelineMessage_UpdateToolbar is not intercepted. More...

virtual ni::iWidget *	GetTreeContextMenu () const =0
	Get the tree context menu widget. {Property}. More...

virtual void	DefaultUpdateTreeContextMenu ()=0
	Default tree context menu update, called by the timeline if the message vlk::eVlkWidgetTimelineMessage_UpdateTreeContextMenu is not intercepted. More...

Commands
virtual void	Command (eVlkWidgetTimelineCmd aCmd, const ni::Var &avarA=niVarNull, const ni::Var &avarB=niVarNull)=0
	Call a command. More...

virtual ni::tBool	CmdPlay ()=0
	Play the root timeline. More...

virtual ni::tBool	CmdPause ()=0
	Pause the root timeline. More...

virtual ni::tBool	CmdStop ()=0
	Stop the root timeline. More...

virtual ni::tBool	CmdAddAction (ni::iDataTable *apDT)=0
	Add an action in the selected timeline. More...

virtual ni::tBool	CmdAddTimelineEx (ni::iHString ahspName, ni::iHString ahspEvent)=0
	Add a new timeline in the selected entity. More...

virtual ni::tBool	CmdAddEvent (ni::iHString *ahspName)=0
	Add a new timeline in the selected entity. More...

virtual ni::tBool	CmdAddTimeline (ni::iHString *ahspName)=0
	Add a new timeline in the selected entity. More...

virtual ni::tBool	CmdDeleteSelection ()=0
	Delete the selection. More...

virtual ni::tBool	CmdReloadSelection ()=0
	Reload the selection. More...

virtual ni::tBool	CmdSetEnabled (ni::tBool abEnabled)=0
	Set the selection's enabled status. More...

virtual ni::tBool	CmdExplore ()=0
	Explore the selected entity. More...

virtual ni::tBool	CmdExploreUp ()=0
	Explore the parent's entity. More...

virtual ni::tBool	CmdZoomIn ()=0
	Zoom in the timeline. More...

virtual ni::tBool	CmdZoomOut ()=0
	Zoom out the timeline. More...

virtual ni::tBool	CmdZoomDefault ()=0
	Zoom to default the timeline. More...

virtual void	DoCopy (ni::iDataTable *apDT)=0

virtual void	DoPaste (ni::iDataTable apDT, ni::iWidgetTreeNode apDefaultDropNode)=0

virtual ni::tBool	CopySecondarySelection (ni::iDataTable *apDT) const =0

virtual ni::tU32	CopySelectedNodes (ni::iDataTable *apDT) const =0

virtual ni::tBool	CopySingleSelectedNode (ni::iDataTable *apDT) const =0

Additional Inherited Members
Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...

virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...

virtual tI32	Release ()=0
	Release a reference of the object. More...

virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...

virtual void	Invalidate ()=0
	Invalidate the object. More...

virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...

virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...

virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...

virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual ni::tBool SetEntity ( vlk::iVlkEntity * apEntity )

pure virtual

Set the entity to edit. {Property}.

virtual vlk::iVlkEntity* GetEntity ( ) const

pure virtual

Get the entity edited. {Property}.

virtual ni::tBool ExploreEntity ( vlk::iVlkEntity * apEntity )

pure virtual

Explore the specified entity.

Remarks: The entity must be a child of the set entity.

virtual ni::tBool ExploreEntityParent ( )

pure virtual

Explore the parent entity of the current entity.

Remarks: The set entity's parent cant be explored even if available.

virtual void SetSelectionID ( ni::iHString * ahspID )

pure virtual

Set an the selection entity's id. {Property}.

Remarks: "Vlk_Selection" by default.

virtual ni::iHString* GetSelectionID ( ) const

pure virtual

Get the selection entity's id. {Property}.

virtual void SetViewMode ( eVlkWidgetTimelineViewMode aVM )

pure virtual

Set the view mode of the timeline. {Property}.

virtual eVlkWidgetTimelineViewMode GetViewMode ( ) const

pure virtual

Get the view mode of the timeline. {Property}.

virtual void SetViewModeTreeOnly ( ni::tBool abTreeOnly )

pure virtual

Set the tree only view mode. {Property}.

virtual ni::tBool GetViewModeTreeOnly ( ) const

pure virtual

Get the tree only view mode. {Property}.

virtual void SetInspectorID ( ni::iHString * ahspID )

pure virtual

Set an external inspector id.

Remarks: By default an internal inspector will switch with the timebars, set this to null to get back to the internal inspector.; If the external inspector id cant be found the internal inspector will be used. {Property}

virtual ni::iHString* GetInspectorID ( ) const

pure virtual

Get the external inspector id. {Property}.

virtual ni::tBool GetUseInternInspector ( ) const

pure virtual

Get whether the timeline is using the internal inspector. {Property}.

virtual void SetFilterDisplayFlags ( tVlkWidgetFilterDisplayFlags aFlags )

pure virtual

Set the filter display flags. {Property}.

virtual tVlkWidgetFilterDisplayFlags GetFilterDisplayFlags ( ) const

pure virtual

Get the filter display flags. {Property}.

virtual void SetFilterEntityClass ( ni::iRegex * ahspRegex )

pure virtual

Set the entity class filter regex. {Property}.

virtual ni::iRegex* GetFilterEntityClass ( ) const

pure virtual

Get the entity class filter regex. {Property}.

virtual void SetFilterEntityName ( ni::iRegex * ahspRegex )

pure virtual

Set the entity class filter name. {Property}.

virtual ni::iRegex* GetFilterEntityName ( ) const

pure virtual

Get the entity class filter name. {Property}.

virtual void SetFilterEntityClassFlagsExclude ( vlk::tVlkEntityClassFlags aFlags )

pure virtual

Set the entity class flags exclude filter. {Property}.

virtual vlk::tVlkEntityClassFlags GetFilterEntityClassFlagsExclude ( ) const

pure virtual

Get the entity class flags exclude filter. {Property}.

virtual void SetFilterEntityClassFlagsRequired ( vlk::tVlkEntityClassFlags aFlags )

pure virtual

Set the entity flags required filter. {Property}.

virtual vlk::tVlkEntityClassFlags GetFilterEntityClassFlagsRequired ( ) const

pure virtual

Get the entity flags required filter. {Property}.

virtual vlk::iVlkTimeline* GetRootTimeline ( ) const

pure virtual

Get the currently assigned root timeline. {Property}.

virtual ni::iWidgetTreeNode* GetTreeNodeFromWidget ( ni::iWidget * apWidget ) const

pure virtual

Get the tree node associated with the specified widget/timebar. {Property}.

virtual ni::iWidgetTreeNode* GetTreeNodeFromEntity ( vlk::iVlkEntity * apEntity ) const

pure virtual

Get the tree node associated with the specified entity. {Property}.

virtual vlk::iVlkEntity* GetEntityFromTreeNode ( ni::iWidgetTreeNode * apTreeNode ) const

pure virtual

Get the entity of the specified tree node. {Property}.

virtual vlk::iVlkEntity* GetEntityFromWidget ( ni::iWidget * apWidget ) const

pure virtual

Get the entity of the specified widget/timebar. {Property}.

virtual ni::iWidget* GetWidgetFromEntity ( vlk::iVlkEntity * apEntity ) const

pure virtual

Get the widget/timebar associated with the specified entity. {Property}.

virtual ni::iWidget* GetTree ( ) const

pure virtual

Get the tree view widget of the timeline. {Property}.

virtual void TreeClearSelection ( )

pure virtual

Clear the selection of the tree.

virtual ni::tU32 TreeNumSelected ( ) const

pure virtual

Get the number of selections in the tree view.

virtual ni::iWidgetTreeNode* TreeGetSelection ( ni::tU32 anIndex ) const

pure virtual

Get the tree selection at the specified index.

virtual iVlkWidgetTimeBar* TreeGetSelectionTimebar ( ni::tU32 anIndex ) const

pure virtual

Get the timebar of the specified item.

Remarks: This is equivalent to retrieving the selection and getting the timebar from ni::iWidgetTreeNode::GetWidget()->QueryInterface(niInterfaceID(iVlkWidgetTimebar))

virtual ni::tU32 TreeIsTreeNodeSelected ( ni::iWidgetTreeNode * apNode ) const

pure virtual

Check whether the specified tree node is selected.

virtual ni::tU32 TreeIsWidgetSelected ( ni::iWidget * apW ) const

pure virtual

Check whether the specified widget/timebar is selected.

virtual ni::tU32 TreeIsEntitySelected ( vlk::iVlkEntity * apE ) const

pure virtual

Check whether the specified entity is selected.

virtual iVlkWidgetTimeBar* TreeGetSingleSelectedTimebar ( ) const

pure virtual

Get the time bar only if one item is selected.

virtual ni::iWidget* GetToolbar ( ) const

pure virtual

Get the toolbar of the timeline. {Property}.

virtual void DefaultUpdateToolbar ( )

pure virtual

Default toolbar update, called by the timeline if the message vlk::eVlkWidgetTimelineMessage_UpdateToolbar is not intercepted.

virtual ni::iWidget* GetTreeContextMenu ( ) const

pure virtual

Get the tree context menu widget. {Property}.

virtual void DefaultUpdateTreeContextMenu ( )

pure virtual

Default tree context menu update, called by the timeline if the message vlk::eVlkWidgetTimelineMessage_UpdateTreeContextMenu is not intercepted.

virtual void Command	(	eVlkWidgetTimelineCmd	aCmd,
		const ni::Var &	avarA = `niVarNull`,
		const ni::Var &	avarB = `niVarNull`
	)

pure virtual

Call a command.

Remarks: This should be prefered to a direct call to the Cmd* methods as it will call the sinks that might have been added by the user. The Cmd* methods are there to be used by the user that implements a custom sink to change the behavior of the timeline's UI.

virtual ni::tBool CmdPlay ( )

pure virtual

Play the root timeline.

virtual ni::tBool CmdPause ( )

pure virtual

Pause the root timeline.

virtual ni::tBool CmdStop ( )

pure virtual

Stop the root timeline.

virtual ni::tBool CmdAddAction ( ni::iDataTable * apDT )

pure virtual

Add an action in the selected timeline.

virtual ni::tBool CmdAddTimelineEx	(	ni::iHString *	ahspName,
		ni::iHString *	ahspEvent
	)

pure virtual

Add a new timeline in the selected entity.

virtual ni::tBool CmdAddEvent ( ni::iHString * ahspName )

pure virtual

Add a new timeline in the selected entity.

virtual ni::tBool CmdAddTimeline ( ni::iHString * ahspName )

pure virtual

Add a new timeline in the selected entity.

virtual ni::tBool CmdDeleteSelection ( )

pure virtual

Delete the selection.

virtual ni::tBool CmdReloadSelection ( )

pure virtual

Reload the selection.

virtual ni::tBool CmdSetEnabled ( ni::tBool abEnabled )

pure virtual

Set the selection's enabled status.

virtual ni::tBool CmdExplore ( )

pure virtual

Explore the selected entity.

virtual ni::tBool CmdExploreUp ( )

pure virtual

Explore the parent's entity.

virtual ni::tBool CmdZoomIn ( )

pure virtual

Zoom in the timeline.

virtual ni::tBool CmdZoomOut ( )

pure virtual

Zoom out the timeline.

virtual ni::tBool CmdZoomDefault ( )

pure virtual

Zoom to default the timeline.

virtual void DoCopy ( ni::iDataTable * apDT )

pure virtual

virtual void DoPaste	(	ni::iDataTable *	apDT,
		ni::iWidgetTreeNode *	apDefaultDropNode
	)

pure virtual

virtual ni::tBool CopySecondarySelection ( ni::iDataTable * apDT ) const

pure virtual

virtual ni::tU32 CopySelectedNodes ( ni::iDataTable * apDT ) const

pure virtual

virtual ni::tBool CopySingleSelectedNode ( ni::iDataTable * apDT ) const

pure virtual

Detailed Description

Entity

View and filters

Tree and low level access

Commands

Additional Inherited Members

Member Function Documentation