IVisualisationWidget Class Referenceabstract

Interface of visualisation widgets that are handled by an IVisualisationTree These objects are stored in an IVisualisationTree object as they are being created and modified to suit the graphical needs of a scenario. More...

Inheritance diagram for IVisualisationWidget:
IAttributable

Public Member Functions

virtual OpenViBE::boolean initialize (const OpenViBE::CIdentifier &rIdentifier, const OpenViBE::CString &rName, OpenViBE::Kernel::EVisualisationWidgetType oType, const OpenViBE::CIdentifier &rParentIdentifier, const OpenViBE::CIdentifier &rBoxIdentifier, OpenViBE::uint32 ui32NbChildren)=0
 Initializes the widget. More...
 
virtual OpenViBE::CIdentifier getIdentifier (void) const =0
 Returns the identifier of the widget. More...
 
virtual const OpenViBE::CStringgetName (void) const =0
 Returns the name of the widget. More...
 
virtual void setName (const CString &rName)=0
 Sets the name of the widget. More...
 
virtual EVisualisationWidgetType getType (void) const =0
 Returns the type of the widget. More...
 
virtual OpenViBE::CIdentifier getParentIdentifier (void) const =0
 Returns the identifier of the widget's parent (if any) More...
 
virtual void setParentIdentifier (const OpenViBE::CIdentifier &rParentIdentifier)=0
 Sets the identifier of the widget's parent. More...
 
virtual OpenViBE::CIdentifier getBoxIdentifier (void) const =0
 Returns the identifier of the IBox associated to this widget. More...
 
virtual OpenViBE::uint32 getNbChildren (void) const =0
 Returns the number of children of this widget. More...
 
virtual OpenViBE::boolean getChildIndex (const OpenViBE::CIdentifier &rIdentifier, OpenViBE::uint32 &ui32Index) const =0
 Returns the index of a given child. More...
 
virtual OpenViBE::boolean addChild (const OpenViBE::CIdentifier &rChildIdentifier)=0
 Adds a child to a widget. More...
 
virtual OpenViBE::boolean removeChild (const OpenViBE::CIdentifier &rChildIdentifier)=0
 Removes a child from a widget. More...
 
virtual OpenViBE::boolean getChildIdentifier (OpenViBE::uint32 ui32ChildIndex, OpenViBE::CIdentifier &rChildIdentifier) const =0
 Returns the identifier of a given child. More...
 
virtual OpenViBE::boolean setChildIdentifier (OpenViBE::uint32 ui32ChildIndex, const OpenViBE::CIdentifier &rChildIdentifier)=0
 Sets the identifier of a child. More...
 

Detailed Description

Interface of visualisation widgets that are handled by an IVisualisationTree These objects are stored in an IVisualisationTree object as they are being created and modified to suit the graphical needs of a scenario.

Author
Vincent Delannoy (INRIA/IRISA)
Date
2007-11

Member Function Documentation

virtual OpenViBE::boolean initialize ( const OpenViBE::CIdentifier rIdentifier,
const OpenViBE::CString rName,
OpenViBE::Kernel::EVisualisationWidgetType  oType,
const OpenViBE::CIdentifier rParentIdentifier,
const OpenViBE::CIdentifier rBoxIdentifier,
OpenViBE::uint32  ui32NbChildren 
)
pure virtual

Initializes the widget.

Parameters
rIdentifier[in] identifier of the widget
rName[in] name of the widget (optional)
oType[in] type of the widget
rParentIdentifier[in] parent widget identifier (OV_Undefined for top-level widgets)
rBoxIdentifier[in] if widget type is EVisualisationWidget_VisualisationBox, identifier of corresponding IBox
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)
Returns
True if widget was successfully initialized, false otherwise
virtual OpenViBE::CIdentifier getIdentifier ( void  ) const
pure virtual

Returns the identifier of the widget.

Returns
Widget identifier
virtual const OpenViBE::CString& getName ( void  ) const
pure virtual

Returns the name of the widget.

Returns
Widget name
virtual void setName ( const CString rName)
pure virtual

Sets the name of the widget.

Parameters
rName[in] name to give to the widget
virtual EVisualisationWidgetType getType ( void  ) const
pure virtual

Returns the type of the widget.

Returns
Widget type
virtual OpenViBE::CIdentifier getParentIdentifier ( void  ) const
pure virtual

Returns the identifier of the widget's parent (if any)

Returns
Widget's parent identifier if any, OV_Undefined otherwise
virtual void setParentIdentifier ( const OpenViBE::CIdentifier rParentIdentifier)
pure virtual

Sets the identifier of the widget's parent.

Parameters
rParentIdentifier[in] identifier of the widget's parent
virtual OpenViBE::CIdentifier getBoxIdentifier ( void  ) const
pure virtual

Returns the identifier of the IBox associated to this widget.

This only applies to widgets of type EVisualisationWidget_VisualisationBox.

Returns
Identifier of IBox associated to this widget
virtual OpenViBE::uint32 getNbChildren ( void  ) const
pure virtual

Returns the number of children of this widget.

Returns
Number of child widgets
virtual OpenViBE::boolean getChildIndex ( const OpenViBE::CIdentifier rIdentifier,
OpenViBE::uint32 &  ui32Index 
) const
pure virtual

Returns the index of a given child.

Parameters
rIdentifier[in] identifier of a child widget
ui32Index[out] index at which the child widget is stored
Returns
True if the child was found, false otherwise
virtual OpenViBE::boolean addChild ( const OpenViBE::CIdentifier rChildIdentifier)
pure virtual

Adds a child to a widget.

Only useful for top-level widgets (EVisualisationWidget_VisualisationWindow) since the number of tabs their notebook may contain is unknown a priori. The child is added after existing children.

Parameters
rChildIdentifier[in] identifier of child to be added to widget
Returns
True if child was successfully added
virtual OpenViBE::boolean removeChild ( const OpenViBE::CIdentifier rChildIdentifier)
pure virtual

Removes a child from a widget.

Parameters
rChildIdentifier[in] identifier of child to be removed to the widget
Returns
True if the child was successfully removed
virtual OpenViBE::boolean getChildIdentifier ( OpenViBE::uint32  ui32ChildIndex,
OpenViBE::CIdentifier rChildIdentifier 
) const
pure virtual

Returns the identifier of a given child.

Parameters
ui32ChildIndex[in] index of child whose identifier is to be retrieved
rChildIdentifier[out] identifier of child
Returns
True if child identifier was successfully returned, false otherwise
virtual OpenViBE::boolean setChildIdentifier ( OpenViBE::uint32  ui32ChildIndex,
const OpenViBE::CIdentifier rChildIdentifier 
)
pure virtual

Sets the identifier of a child.

Parameters
ui32ChildIndex[in] index of child whose identifier is to be set
rChildIdentifier[in] identifier of the child to be added to the widget
Returns
True if the child was successfully set