ito::AbstractFigure Class Reference

Inheritance diagram for ito::AbstractFigure:

Classes
struct	ToolBarItem
struct	ToolboxItem

Public Types
enum	WindowMode { ModeInItomFigure, ModeStandaloneInUi, ModeStandaloneWindow }
enum	UnitLabelStyle { UnitLabelSlash, UnitLabelKeywordIn, UnitLabelSquareBrackets }
Public Types inherited from ito::AbstractNode
typedef QPair< QString, QString >	ParamNamePair

Public Slots
int	getPlotID ()
void	refreshPlot ()

Signals
void	windowTitleModified (QString windowTitleSuffix)

Public Member Functions
	AbstractFigure (const QString &itomSettingsFile, WindowMode windowMode=ModeStandaloneInUi, QWidget *parent=0)
virtual bool	event (QEvent *e)
void	setApiFunctionGraphBasePtr (void **apiFunctionGraphBasePtr)
void	setApiFunctionBasePtr (void **apiFunctionBasePtr)
void **	getApiFunctionGraphBasePtr (void)
void **	getApiFunctionBasePtr (void)
virtual RetVal	update (void)=0
	update of this node if the values of all changed input channels are propgated to the corresponding input parameters of this node More...
virtual void	setToolbarVisible (bool visible)
virtual bool	getToolbarVisible () const
virtual void	setContextMenuEnabled (bool show)=0
virtual bool	getContextMenuEnabled () const =0
QDockWidget *	getPropertyDockWidget () const
virtual bool	getLegendRender () const
virtual void	setLegendRender (const bool val)
QList< QMenu * >	getMenus () const
QList< AbstractFigure::ToolBarItem >	getToolbars () const
QList< AbstractFigure::ToolboxItem >	getToolboxes () const
void	setWindowTitleExtension (const QString &title)
Public Member Functions inherited from ito::AbstractNode
	AbstractNode ()
	constructor
virtual	~AbstractNode ()
	destructor
virtual RetVal	applyUpdate (void)=0
RetVal	createChannel (const QString &senderParamName, AbstractNode *receiver, const QString &receiverParamName, bool replaceChannelIfExists=false)
	creates a new channel from this node as sender and a specific sender parameter (output) to a receiver node and its specific receiver (input) parameter. More...
RetVal	removeChannel (QSharedPointer< Channel > channel)
	removes the channel from the list of channels, forces the partner node to detach the channel and destroys the channel object
RetVal	removeAllChannelsToReceiver (const AbstractNode *receiver, QList< ParamNamePair > excludedConnections=QList< ParamNamePair >())
	>
QList< QSharedPointer< Channel > >	getConnectedInputChannels (const QString &inputParamName) const
	returns a list of channels, that are connected to an input param with a given name. This node must be the receiver of the returned channels.
QList< QSharedPointer< Channel > >	getConnectedInputChannels (const ito::Param *inputParam) const
	returns a list of channels, that are connected to a given input parameter. This node must be the receiver of the returned channels.
QList< QSharedPointer< Channel > >	getConnectedOutputChannels (const QString &outputParamName) const
	returns a list of channels, that are connected to an ouput param with a given name. This node must be the sender of the returned channels.
QList< QSharedPointer< Channel > >	getConnectedOutputChannels (const ito::Param *outputParam) const
	returns a list of channels, that are connected to a given output parameter. This node must be the sender of the returned channels.
RetVal	updateChannelData (QSharedPointer< Channel > updatedChannel)
	This method is called, if the sender parameter of the channel changed its value.
RetVal	setUpdatePending (QSharedPointer< ito::Channel > singleOutputChannel=QSharedPointer< ito::Channel >())
	>propagates information about a soon, future update to all (or one selected) output channel(s) of this node
ito::Param *	getInputParam (const QString &paramName) const
	returns the input parameter whose name is equal to paramName or returns NULL if the parameter is not found.
ito::Param *	getOutputParam (const QString &paramName) const
	returns the output parameter whose name is equal to paramName or returns NULL if the parameter is not found.
RetVal	addOutputParam (ito::Param *param)
	adds the given parameter to the list of output parameters of this node.
RetVal	removeAndDeleteOutputParam (const QString &paramName)
RetVal	addInputParam (ito::Param *param)
	adds the given parameter to the list of input parameters of this node.
RetVal	removeAndDeleteInputParam (const QString &paramName)
RetVal	updateChannels (const QList< QString > &outputParamNames)
	triggers updates of all channels that are connected to the given output parameter names of the sender.
rttiNodeType	getType () const
	returns the type of this node
bool	isConnected () const
	returns true if at least one channel is connected to this node
unsigned int	getUniqueID (void) const
	return a unique, auto-incremented UID of this node (beginning with 1)

Protected Member Functions
virtual RetVal	init ()
virtual void	importItomApi (void **apiPtr)=0
virtual void	importItomApiGraph (void **apiPtr)=0
void	addToolBar (QToolBar *toolbar, const QString &key, Qt::ToolBarArea area=Qt::TopToolBarArea, int section=1)
void	addToolBarBreak (const QString &key, Qt::ToolBarArea area=Qt::TopToolBarArea)
void	addToolbox (QDockWidget *toolbox, const QString &key, Qt::DockWidgetArea area=Qt::RightDockWidgetArea)
bool	removeToolbox (const QString &key)
void	showToolBar (const QString &key)
void	hideToolBar (const QString &key)
void	addMenu (QMenu *menu)
void	updatePropertyDock ()
void	setPropertyObservedObject (QObject *obj)
RetVal	initialize ()
RetVal	registerShortcutActions ()
WindowMode	getWindowMode () const
QString	getItomSettingsFile () const
Protected Member Functions inherited from ito::AbstractNode
RetVal	detachChannel (QSharedPointer< Channel > channel)
	removes the given channel from the list of chnanels of this node.
RetVal	attachChannel (QSharedPointer< Channel > channel)
	attaches the given channel to the list of channels (either input or output, depending if this is sender or receiver)
RetVal	inputParamChanged (const ito::ParamBase *updatedInputParam)
	indicates that an input parameter of the node has been changed and initializes the update pipline to child nodes if necessary. This is the source of an update. More...

Protected Attributes
void **	m_apiFunctionsGraphBasePtr
void **	m_apiFunctionsBasePtr

Properties
bool	toolbarVisible
bool	contextMenuEnabled
bool	renderLegend

Private Slots
void	mnuShowToolbar (bool)
void	mnuShowProperties (bool checked)
void	toolBoxDestroyed (QObject *object)
void	toolBarDestroyed (QObject *object)
void	actionChanged ()

Private Member Functions
	Q_DECLARE_PRIVATE (AbstractFigure)
	self-managed pointer to the private class container (deletes itself if d_ptr is destroyed). pointer to private class of AbstractFigure defined in AbstractFigure.cpp. This container is used to allow flexible changes in the interface without destroying the binary compatibility

Private Attributes
QScopedPointer< AbstractFigurePrivate >	d_ptr

Additional Inherited Members
Static Protected Attributes inherited from ito::AbstractNode
static unsigned int	UID = 1
	highest used UID of any node. This value is auto-incremented upon every More...

Member Function Documentation

void ito::AbstractFigure::addMenu ( QMenu *  menu )

protected

append a menu to the figure. AbstractFigure then takes care about the menu. Only use this method to add menus since the menu bar of figures is differently handled depending on the window mode of the figure.

void ito::AbstractFigure::addToolBar ( QToolBar *  toolbar, const QString &  key, Qt::ToolBarArea  area = Qt::TopToolBarArea, int  section = 1  )

protected

Register any toolbar of the plot widget using this method.

void ito::AbstractFigure::addToolBarBreak ( const QString &  key, Qt::ToolBarArea  area = Qt::TopToolBarArea  )

protected

Add a toolbar break, hence a new line for the following toolbars to the indicated area.

void ito::AbstractFigure::addToolbox ( QDockWidget *  toolbox, const QString &  key, Qt::DockWidgetArea  area = Qt::RightDockWidgetArea  )

protected

Every plot widget is automatically equipped with a property toolbox. If you want to add further toolboxes (dock widgets), register and append them using this method.

void ito::AbstractFigure::hideToolBar ( const QString &  key )

protected

hide a toolbar with given key. This toolbar must first be registered using addToolBar.

virtual void ito::AbstractFigure::importItomApi ( void **  apiPtr )

protectedpure virtual

function to provide access to the itom API functions. this methods are implemented in the plugin itsself. Therefore put the macro DESIGNER_PLUGIN_ITOM_API before the public section in the designer plugin class.

virtual void ito::AbstractFigure::importItomApiGraph ( void **  apiPtr )

protectedpure virtual

function to provide access to the itom API functions. this methods are implemented in the plugin itsself. Therefore put the macro DESIGNER_PLUGIN_ITOM_API before the public section in the designer plugin class.

void ito::AbstractFigure::mnuShowProperties ( bool  checked )

privateslot

set the visibility of the property toolbox

void ito::AbstractFigure::mnuShowToolbar ( bool  )

inlineprivateslot

shows all registered toolbars

RetVal ito::AbstractFigure::registerShortcutActions ( )

protected

call this method once after all actions with shortcuts are created and after that the content widget has been created. The shortcuts of the actions will then be redirected to overall shortcuts that can be handled even if the plot is docked into the main window of itom

bool ito::AbstractFigure::removeToolbox ( const QString &  key )

protected

If you added further toolboxes (dock widgets), remove them using this method.

void ito::AbstractFigure::setPropertyObservedObject ( QObject *  obj )

protected

registeres obj for a property observation of the property toolbox. All readable properties are then listed in the property toolbox.

void ito::AbstractFigure::setToolbarVisible ( bool  visible )

virtual

Calls apply () and updates all children

void ito::AbstractFigure::showToolBar ( const QString &  key )

protected

show a toolbar with given key. This toolbar must first be registered using addToolBar.

virtual RetVal ito::AbstractFigure::update ( void  )

pure virtual

update of this node if the values of all changed input channels are propgated to the corresponding input parameters of this node

Performs the in INTERNAL operations necessary in updating the node and displaying the data. This has to implemented

in each final successor in the inheritance structure. Anyway the "displayed" parameter MUST be filled adequately as this can only be done by the node itself.

Implements ito::AbstractNode.

Implemented in ito::AbstractDObjPclFigure, and ito::AbstractDObjFigure.

void ito::AbstractFigure::updatePropertyDock ( )

protected

call this method if any property of the figure changed such that the property toolbox is synchronized and updated.

void ito::AbstractFigure::windowTitleModified ( QString  windowTitleSuffix )

signal

this signal is emitted if the title of the plot has been changed. windowTitleSuffix is the new suffix that should be appended to the base window title

---

The documentation for this class was generated from the following files:

• C:/itom/sources/itom/plot/AbstractFigure.h
• C:/itom/sources/itom/plot/sources/AbstractFigure.cpp