Handles visualisation widgets and their arrangement in space This interface lets applications configure visualisation widgets by adding them to windows and tabs, positioning them next to each other using paned widgets, and resizing them as the user sees fit. All widgets are saved in a symbolic way as IVisualisationWidget instances referenced in a tree store. Methods of this class are essentially meant to be called from an external class inheriting from the ITreeViewCB interface, for offline design or online use of the widgets. More...

Public Member Functions | |
virtual OpenViBE::boolean | init (const OpenViBE::Kernel::IScenario *pScenario)=0 |
Initializes the visualisation tree This method registers the scenario associated to this tree and creates a tree store. More... | |
virtual OpenViBE::boolean | reloadTree (void)=0 |
Recreates Gtk widgets based on the widgets description stored in the internal tree store. To be called upon widget creation, deletion or repositioning. Side effects : all tree iterators and GtkWidget pointers are invalidated and replaced with new values. More... | |
virtual OpenViBE::boolean | setToolbar (const OpenViBE::CIdentifier &rBoxIdentifier,::GtkWidget *pToolbarWidget)=0 |
Forward pointer to the toolbar of a visualisation plugin (if any) to the tree view. More... | |
virtual OpenViBE::boolean | setWidget (const OpenViBE::CIdentifier &rBoxIdentifier,::GtkWidget *pTopmostWidget)=0 |
Forward pointer to the main widget of a visualisation plugin to the tree view. More... | |
IVisualisationWidget management | |
virtual OpenViBE::boolean | getNextVisualisationWidgetIdentifier (OpenViBE::CIdentifier &rIdentifier) const =0 |
Iterates through IVisualisationWidget instances managed by this tree Upon first call, this method should be passed an identifier initialized with OV_UndefinedIdentifier. It is modified at each subsequent call until all widgets have been returned (in which case the identifier is reset to OV_Undefined) More... | |
virtual OpenViBE::boolean | getNextVisualisationWidgetIdentifier (OpenViBE::CIdentifier &rIdentifier, OpenViBE::Kernel::EVisualisationWidgetType oType) const =0 |
Iterates through IVisualisationWidget instances of type oType managed by this tree. More... | |
virtual OpenViBE::boolean | isVisualisationWidget (const OpenViBE::CIdentifier &rIdentifier) const =0 |
Tests whether an identifier corresponds to an IVisualisationWidget instance This method browses the internal tree store to look for a node whose EVisualisationTreeColumn_StringIdentifier field equals 'rIdentifier' once converted to CString format. More... | |
virtual OpenViBE::Kernel::IVisualisationWidget * | getVisualisationWidget (const OpenViBE::CIdentifier &rIdentifier) const =0 |
Returns the IVisualisationWidget instance whose identifier is passed in parameter. More... | |
virtual OpenViBE::Kernel::IVisualisationWidget * | getVisualisationWidgetFromBoxIdentifier (const OpenViBE::CIdentifier &rBoxIdentifier) const =0 |
Returns the IVisualisationWidget instance whose corresponding IBox identifier matches 'rBoxIdentifier' This method inherently restricts the search to nodes of type EVisualisationTreeNode_VisualisationBox since only these nodes are associated to an IBox instance. More... | |
virtual OpenViBE::boolean | addVisualisationWidget (OpenViBE::CIdentifier &rIdentifier, const OpenViBE::CString &rName, OpenViBE::Kernel::EVisualisationWidgetType oType, const OpenViBE::CIdentifier &rParentIdentifier, OpenViBE::uint32 ui32ParentIndex, const OpenViBE::CIdentifier &rBoxIdentifier, OpenViBE::uint32 ui32NbChildren, const OpenViBE::CIdentifier &rSuggestedIdentifier)=0 |
Adds an IVisualisationWidget instance to the tree Seven parameters describe the IVisualisationWidget to be created. Not all are relevant for every type of widget. More... | |
virtual OpenViBE::boolean | getVisualisationWidgetIndex (const OpenViBE::CIdentifier &rIdentifier, OpenViBE::uint32 &ui32Index) const =0 |
Returns the index where a widget is parented Irrelevant for top level windows. More... | |
virtual OpenViBE::boolean | unparentVisualisationWidget (const OpenViBE::CIdentifier &rIdentifier, OpenViBE::uint32 &ui32Index)=0 |
Unparents a widget from its parent, if any. More... | |
virtual OpenViBE::boolean | parentVisualisationWidget (const OpenViBE::CIdentifier &rIdentifier, const OpenViBE::CIdentifier &rParentIdentifier, OpenViBE::uint32 ui32Index)=0 |
Parents a widget to a parent widget. More... | |
virtual OpenViBE::boolean | destroyHierarchy (const OpenViBE::CIdentifier &rIdentifier, OpenViBE::boolean bDestroyVisualisationBoxes=true)=0 |
Destroys a widget hierarchy. More... | |
Tree view creation/registration | |
virtual ::GtkTreeView * | createTreeViewWithModel (void)=0 |
Creates a tree view from the internal tree store/model. More... | |
virtual OpenViBE::boolean | setTreeViewCB (OpenViBE::Kernel::ITreeViewCB *pTreeViewCB)=0 |
Sets the instance implementing the ITreeViewCB interface that is to be used with the visualisation tree. More... | |
Helper functions | |
virtual OpenViBE::boolean | getTreeSelection (::GtkTreeView *pTreeView,::GtkTreeIter *pIter)=0 |
Returns currently selected node. More... | |
virtual GtkTreePath * | getTreePath (::GtkTreeIter *pTreeIter) const =0 |
Returns tree path of a given node. More... | |
virtual unsigned long | getULongValueFromTreeIter (::GtkTreeIter *pTreeIter, OpenViBE::Kernel::EVisualisationTreeColumn eVisualisationTreeColumn) const =0 |
Returns unsigned long value stored in the 'eVisualisationTreeColumn' column of node 'pTreeIter'. More... | |
virtual OpenViBE::boolean | getStringValueFromTreeIter (::GtkTreeIter *pTreeIter, char *&rString, OpenViBE::Kernel::EVisualisationTreeColumn eVisualisationTreeColumn) const =0 |
Returns string stored in the 'eVisualisationTreeColumn' column of node 'pTreeIter'. More... | |
virtual OpenViBE::boolean | getPointerValueFromTreeIter (::GtkTreeIter *pTreeIter, void *&rPointer, OpenViBE::Kernel::EVisualisationTreeColumn eVisualisationTreeColumn) const =0 |
Returns pointer stored in the 'eVisualisationTreeColumn' column of node 'pTreeIter'. More... | |
virtual OpenViBE::boolean | getIdentifierFromTreeIter (::GtkTreeIter *pTreeIter, OpenViBE::CIdentifier &rIdentifier, OpenViBE::Kernel::EVisualisationTreeColumn eVisualisationTreeColumn) const =0 |
Returns identifier stored in the 'eVisualisationTreeColumn' column of node 'pTreeIter'. More... | |
Node searching | |
virtual OpenViBE::boolean | findChildNodeFromRoot (::GtkTreeIter *pIter, const char *pLabel, OpenViBE::Kernel::EVisualisationTreeNode eType)=0 |
Looks for a node of name 'label' and type 'eType' from the root of the internal tree store. More... | |
virtual OpenViBE::boolean | findChildNodeFromParent (::GtkTreeIter *pIter, const char *pLabel, OpenViBE::Kernel::EVisualisationTreeNode eType)=0 |
Looks for a node of name 'label' and type 'eType' from a given node in the internal tree store. More... | |
virtual OpenViBE::boolean | findChildNodeFromRoot (::GtkTreeIter *pIter, void *pWidget)=0 |
Looks for a node whose associated Gtk widget matches 'pWidget' from the root of the internal tree store. More... | |
virtual OpenViBE::boolean | findChildNodeFromParent (::GtkTreeIter *pIter, void *pWidget)=0 |
Looks for a node whose associated Gtk widget matches 'pWidget' from a given node in the internal tree store. More... | |
virtual OpenViBE::boolean | findChildNodeFromRoot (::GtkTreeIter *pIter, OpenViBE::CIdentifier oIdentifier)=0 |
Looks for a node whose identifier matches 'oIdentifier' from the root of the internal tree store. More... | |
virtual OpenViBE::boolean | findChildNodeFromParent (::GtkTreeIter *pIter, OpenViBE::CIdentifier oIdentifier)=0 |
Looks for a node whose identifier matches 'oIdentifier' from a given node in the internal tree store. More... | |
virtual OpenViBE::boolean | findParentNode (::GtkTreeIter *pIter, OpenViBE::Kernel::EVisualisationTreeNode eType)=0 |
Find first parent node of a given type Looks for first parent node of type 'eType' from a given node in the internal tree store. More... | |
Drag n' drop functions | |
virtual OpenViBE::boolean | dragDataReceivedInWidgetCB (const OpenViBE::CIdentifier &rSrcIdentifier,::GtkWidget *pDstWidget)=0 |
Handles drop of a widget in an existing widget This operation replaces the existing widget with the one passed in parameter. The existing widget is unaffected if it is of type EVisualisationTreeNode_VisualisationBox, or destroyed if it is of type EVisualisationTreeNode_Undefined (placeholder widget). More... | |
virtual OpenViBE::boolean | dragDataReceivedOutsideWidgetCB (const OpenViBE::CIdentifier &rSrcIdentifier,::GtkWidget *pDstWidget, OpenViBE::Kernel::EDragDataLocation eLocation)=0 |
Handles drop of a widget in an event box This operation adds a widget to the tree and changes the tree structure. If a widget is moved from one place to the other in the tree, it is automatically simplified to avoid placeholders creation. More... | |
Detailed Description
Handles visualisation widgets and their arrangement in space This interface lets applications configure visualisation widgets by adding them to windows and tabs, positioning them next to each other using paned widgets, and resizing them as the user sees fit. All widgets are saved in a symbolic way as IVisualisationWidget instances referenced in a tree store. Methods of this class are essentially meant to be called from an external class inheriting from the ITreeViewCB interface, for offline design or online use of the widgets.
- Date
- 2007-11
Member Function Documentation
|
pure virtual |
Initializes the visualisation tree This method registers the scenario associated to this tree and creates a tree store.
- Parameters
-
pScenario [in] scenario associated to this tree store
- Returns
- true if tree was successfully initialized, false otherwise
|
pure virtual |
Iterates through IVisualisationWidget instances managed by this tree Upon first call, this method should be passed an identifier initialized with OV_UndefinedIdentifier. It is modified at each subsequent call until all widgets have been returned (in which case the identifier is reset to OV_Undefined)
- Parameters
-
rIdentifier [in/out] identifier of current visualisation widget when calling the method and of next widget upon return
- Returns
- true if a widget was found, false if past beyond last one
|
pure virtual |
Iterates through IVisualisationWidget instances of type oType managed by this tree.
- Parameters
-
rIdentifier [in/out] identifier of current visualisation widget when calling the method and of next widget upon return oType [in] restricts search to IVisualisationWidget instances of type oType
- Returns
- true if a widget was found, false if past beyond last one
|
pure virtual |
Tests whether an identifier corresponds to an IVisualisationWidget instance This method browses the internal tree store to look for a node whose EVisualisationTreeColumn_StringIdentifier field equals 'rIdentifier' once converted to CString format.
- Parameters
-
rIdentifier [in] identifier to look for in the internal tree store
- Returns
- true if rIdentifier corresponds to an IVisualisationWidget instance stored in this tree, false otherwise
|
pure virtual |
Returns the IVisualisationWidget instance whose identifier is passed in parameter.
- Parameters
-
rIdentifier [in] identifier to look for in the internal tree store
- Returns
- pointer to IVisualisationWidget whose identifier matches 'rIdentifier' if any, NULL otherwise
|
pure virtual |
Returns the IVisualisationWidget instance whose corresponding IBox identifier matches 'rBoxIdentifier' This method inherently restricts the search to nodes of type EVisualisationTreeNode_VisualisationBox since only these nodes are associated to an IBox instance.
- Parameters
-
rBoxIdentifier [in] identifier of IBox whose associated IVisualisationWidget is to be retrieved
- Returns
- IVisualisationWidget whose associated IBox identifier matches 'rBoxIdentifier' if any, NULL otherwise
|
pure virtual |
Adds an IVisualisationWidget instance to the tree Seven parameters describe the IVisualisationWidget to be created. Not all are relevant for every type of widget.
- Parameters
-
rIdentifier [in] identifier of the widget to be created rName [in] name of the widget oType [in] type of the widget rParentIdentifier [in] parent widget identifier (OV_UndefinedIdentifier for top-level widgets) ui32ParentIndex [in] index where this widget is to be parented (irrelevant for top-level widgets) rBoxIdentifier [in] identifier of associated IBox (for widgets of type EVisualisationWidget_VisualisationBox only) ui32NbChildren [in] number of children of this widget (none for a visualisation box, 1 for a visualisation panel, 2 for split widgets, variable number for windows) rSuggestedIdentifier [in] a suggestion as to the rIdentifier to use
- Returns
- true if widget successfully added to the internal tree store, false otherwise
|
pure virtual |
Returns the index where a widget is parented Irrelevant for top level windows.
- Parameters
-
rIdentifier [in] identifier of the IVisualisationWidget whose index is to be retrieved ui32Index [out] index where the widget is parented
- Returns
- true if widget index could be determined, false otherwise
|
pure virtual |
Unparents a widget from its parent, if any.
- Parameters
-
rIdentifier [in] identifier of widget to be unparented ui32Index [out] index where this widget was parented
- Returns
- true if widget could be removed from its parent, false otherwise
|
pure virtual |
Parents a widget to a parent widget.
- Parameters
-
rIdentifier [in] identifier of widget to be parented rParentIdentifier [in] identifier of parent widget ui32Index [in] index where widget is to be parented
- Returns
- true if widget could be parented as desired, false otherwise
|
pure virtual |
Destroys a widget hierarchy.
- Parameters
-
rIdentifier [in] identifier of widget that is to be destroyed, along with all widgets in its subtree bDestroyVisualisationBoxes [in] if false, widgets of type EVisualisationTreeNode_VisualisationBox are unaffected only (as opposed to destroyed)
- Returns
- true if hierarchy was successfully destroyed, false otherwise
|
pure virtual |
Creates a tree view from the internal tree store/model.
- Returns
- pointer to newly created tree view
|
pure virtual |
Sets the instance implementing the ITreeViewCB interface that is to be used with the visualisation tree.
- Parameters
-
pTreeViewCB [in] pointer to an implementation of the ITreeViewCB interface
- Returns
- true if tree view was successfully registered, false otherwise
- See Also
- ITreeViewCB
|
pure virtual |
Recreates Gtk widgets based on the widgets description stored in the internal tree store. To be called upon widget creation, deletion or repositioning. Side effects : all tree iterators and GtkWidget pointers are invalidated and replaced with new values.
- Returns
- true if widgets were successfully reloaded, false otherwise
|
pure virtual |
Returns currently selected node.
- Parameters
-
pTreeView [in] pointer to tree view whose selected node is to be retrieved pIter [out] pointer to selected node
- Returns
- true if a node is selected, false otherwise
|
pure virtual |
Returns tree path of a given node.
- Parameters
-
pTreeIter [in] pointer to node whose path is to be retrieved
- Returns
- pointer to path of node
|
pure virtual |
Returns unsigned long value stored in the 'eVisualisationTreeColumn' column of node 'pTreeIter'.
- Parameters
-
pTreeIter [in] pointer to node eVisualisationTreeColumn [in] index of column where unsigned long value is stored
- Returns
- unsigned long value retrieved at the specified column of the specified node, if any, 0 otherwise.
|
pure virtual |
Returns string stored in the 'eVisualisationTreeColumn' column of node 'pTreeIter'.
- Parameters
-
pTreeIter [in] pointer to node rString [out] string to be retrieved eVisualisationTreeColumn [in] index of column where string is stored
- Returns
- true if string was successfully retrieved at the specified column of the specified node, 0 otherwise.
|
pure virtual |
Returns pointer stored in the 'eVisualisationTreeColumn' column of node 'pTreeIter'.
- Parameters
-
pTreeIter [in] pointer to node rPointer [out] pointer to be retrieved eVisualisationTreeColumn [in] index of column where pointer is stored
- Returns
- true if pointer was successfully retrieved at the specified column of the specified node, 0 otherwise.
|
pure virtual |
Returns identifier stored in the 'eVisualisationTreeColumn' column of node 'pTreeIter'.
- Parameters
-
pTreeIter [in] pointer to node rIdentifier [out] identifier to be retrieved eVisualisationTreeColumn [in] index of column where identifier is stored
- Returns
- true if identifier was successfully retrieved at the specified column of the specified node, 0 otherwise.
|
pure virtual |
Looks for a node of name 'label' and type 'eType' from the root of the internal tree store.
- Parameters
-
pIter [out] pointer to node to be retrieved pLabel [in] label of node to be retrieved, as stored in the EVisualisationTreeColumn_StringName column eType [in] type of node to be retrieved, as stored in the EVisualisationTreeColumn_ULongNodeType column
- Returns
- true if node was found, false otherwise
|
pure virtual |
Looks for a node of name 'label' and type 'eType' from a given node in the internal tree store.
- Parameters
-
pIter [in/out] pointer to node from which to start searching when calling function and to node found upon return pLabel [in] label of node to be retrieved, as stored in the EVisualisationTreeColumn_StringName column eType [in] type of node to be retrieved, as stored in the EVisualisationTreeColumn_ULongNodeType column
- Returns
- true if node was found, false otherwise
|
pure virtual |
Looks for a node whose associated Gtk widget matches 'pWidget' from the root of the internal tree store.
- Parameters
-
pIter [out] pointer to node to be retrieved pWidget [in] pointer to Gtk widget of node to be retrieved, as stored in the EVisualisationTreeColumn_PointerWidget column
- Returns
- true if node was found, false otherwise
|
pure virtual |
Looks for a node whose associated Gtk widget matches 'pWidget' from a given node in the internal tree store.
- Parameters
-
pIter [in/out] pointer to node from which to start searching when calling function and to node found upon return pWidget [in] pointer to Gtk widget of node to be retrieved, as stored in the EVisualisationTreeColumn_PointerWidget column
- Returns
- true if node was found, false otherwise
|
pure virtual |
Looks for a node whose identifier matches 'oIdentifier' from the root of the internal tree store.
- Parameters
-
pIter [out] pointer to node to be retrieved oIdentifier [in] identifier of node to be retrieved, as stored in the EVisualisationTreeColumn_StringIdentifier column
- Returns
- true if node was found, false otherwise
|
pure virtual |
Looks for a node whose identifier matches 'oIdentifier' from a given node in the internal tree store.
- Parameters
-
pIter [in/out] pointer to node from which to start searching when calling function and to node found upon return oIdentifier [in] identifier of node to be retrieved, as stored in the EVisualisationTreeColumn_StringIdentifier column
- Returns
- true if node was found, false otherwise
|
pure virtual |
Find first parent node of a given type Looks for first parent node of type 'eType' from a given node in the internal tree store.
- Parameters
-
pIter [in/out] pointer to node from which to start searching when calling function and to node found upon return eType [in] type of parent node looked for, as stored in the EVisualisationTreeColumn_ULongNodeType column
- Returns
- true if node was found, false otherwise
|
pure virtual |
Handles drop of a widget in an existing widget This operation replaces the existing widget with the one passed in parameter. The existing widget is unaffected if it is of type EVisualisationTreeNode_VisualisationBox, or destroyed if it is of type EVisualisationTreeNode_Undefined (placeholder widget).
- Parameters
-
rSrcIdentifier [in] identifier of widget being dropped pDstWidget [in] pointer to widget on which the drop operation is performed
- Returns
- true if drop operation was successfully completed, false otherwise
|
pure virtual |
Handles drop of a widget in an event box This operation adds a widget to the tree and changes the tree structure. If a widget is moved from one place to the other in the tree, it is automatically simplified to avoid placeholders creation.
- Parameters
-
rSrcIdentifier [in] identifier of widget being dropped pDstWidget [in] pointer to widget on which the drop operation is performed
- Returns
- true if drop operation was successfully completed, false otherwise
|
pure virtual |
Forward pointer to the toolbar of a visualisation plugin (if any) to the tree view.
- Parameters
-
rBoxIdentifier [in] Identifier of IBox whose toolbar pointer is being set pToolbarWidget [in] pointer to toolbar
- Returns
- true in case of success, false otherwise.
|
pure virtual |
Forward pointer to the main widget of a visualisation plugin to the tree view.
- Parameters
-
rBoxIdentifier [in] Identifier of IBox whose topmost widget pointer is being set pWidget [in] pointer to main window
- Returns
- true in case of success, false otherwise.
Generated on Tue Jun 26 2012 15:25:54 for Documentation by
