The current action state viewer. More...

#include <ActionStateViewer.h>

Inheritance diagram for ActionStateViewer:

Collaboration diagram for ActionStateViewer:

Public Member Functions
Q_INVOKABLE	ActionStateViewer (QString name)

virtual QWidget *	getWidget ()
	get the viewer widget. More...

virtual void	refresh (Viewer *whoIsAsking=nullptr)
	refresh the view (can be interesting to know which other viewer is calling this) More...

void	setState (ActionState *actionState)
	set the current state More...

Public Member Functions inherited from camitk::Viewer
QStringList	getComponents ()
	get the list of Component class manages by this viewer (default is set to "Component", i.e. More...

QString	getDescription () const
	get the name of the viewer More...

QDockWidget *	getDockWidget ()
	Get the QDockWidget* where this viewer is currently docked (or nullptr if it is not docked anywhere or if the viewer is of type EMBEDDED) More...

QLayout *	getEmbedder ()
	Get the QLayout* where this viewer is currently embedded (or nullptr if it is not embedded anywhere or if the viewer is of type DOCKED) More...

virtual QPixmap	getIcon ()
	get the viewer icon More...

virtual QMenu *	getMenu ()
	get the viewer menu (returns nullptr by default, i.e. there are no default edit menu) More...

QString	getName () const
	get the name of the viewer More...

virtual QObject *	getPropertyObject ()
	get the viewer property object (returns nullptr by default, i.e. there are no property to edit) More...

virtual QToolBar *	getToolBar ()
	get the viewer toolbar (returns nullptr by default, i.e. there are no default toolbar) More...

bool	getToolBarVisibility ()
	get the current value of the toolbar visibility More...

ViewerType	getType ()
	get the viewer layout More...

	Q_ENUM (ViewerType) Viewer(QString name
	default constructor More...

virtual void	refresh (Viewer *whoIsAsking=nullptr)=0
	refresh the view (can be interesting to know which other viewer is calling this) More...

bool	setDockWidget (QDockWidget *)
	If the viewer type is DOCKED, dock the widget inside the given dock widget (do nothing if the type is EMBEDDED or if the viewer has already been docked before) Note that once set, the dock widget cannot be modified. More...

bool	setEmbedder (QLayout *)
	If the viewer type is EMBEDDED, embed the viewer widget in the given layout (do nothing if the type is DOCKED) Note that you can call this method any time you want to move the viewer's widget to another layout (but there is only one embedder at a time) More...

void	setToolBarVisibility (bool)
	set the visibility of the toolbar in the main window (true by default). More...

void	setType (ViewerType)
	set the viewer layout (the type can be changed dynamically to fit the developer's purpose) More...

void	setVisible (bool)
	set the visibility of the viewer (show or hide its widget) More...

virtual	~Viewer () override
	default destructor More...

Private Attributes
QStackedWidget *	actionStateWidgetStack
	actions stacked widget of the viewer More...

int	emptyActionWidgetIndex
	index of the empty widget, used when no action is active or when no action has been used for the currently selected components More...

QWidget *	myWidget
	the viewer's widget More...

QString	name
	the viewer's name More...

Additional Inherited Members
Public Types inherited from camitk::Viewer
enum	ViewerType { EMBEDDED, DOCKED }

Signals inherited from camitk::Viewer
void	selectionChanged ()
	this signal is emitted when the current selection was changed by the viewer More...

Public Attributes inherited from camitk::Viewer
ViewerType	type = EMBEDDED)
	this viewer's layout More...

Protected Member Functions inherited from camitk::Viewer
void	clearSelection ()
	clear the selection More...

void	selectionChanged (Component *comp)
	the selection has changed to be just one comp More...

void	selectionChanged (ComponentList &compSet)
	The selection has changed to the given ComponentList. More...

void	setComponents (QStringList)
	set the list of component class names managed by this viewer More...

void	setDescription (QString)
	set the viewer's description More...

void	setIcon (QPixmap icon)
	set the default icon for the viewer extension More...

Detailed Description

The current action state viewer.

Constructor & Destructor Documentation

◆ ActionStateViewer()

ActionStateViewer::ActionStateViewer ( QString name )

References myWidget, and camitk::Viewer::setComponents().

Here is the call graph for this function:

Member Function Documentation

◆ getWidget()

QWidget * ActionStateViewer::getWidget ( )

virtual

get the viewer widget.

Implements camitk::Viewer.

References actionStateWidgetStack, emptyActionWidgetIndex, and myWidget.

◆ refresh()

virtual void ActionStateViewer::refresh ( Viewer * whoIsAsking = nullptr )

inlinevirtual

refresh the view (can be interesting to know which other viewer is calling this)

◆ setState()

void ActionStateViewer::setState ( ActionState * actionState )

set the current state

References actionStateWidgetStack, and ActionState::getWidget().

Here is the call graph for this function:

Member Data Documentation

◆ actionStateWidgetStack

QStackedWidget* ActionStateViewer::actionStateWidgetStack

private

actions stacked widget of the viewer

Referenced by getWidget(), and setState().

◆ emptyActionWidgetIndex

int ActionStateViewer::emptyActionWidgetIndex

private

index of the empty widget, used when no action is active or when no action has been used for the currently selected components

Referenced by getWidget().

◆ myWidget

QWidget* ActionStateViewer::myWidget

private

the viewer's widget

Referenced by ActionStateViewer(), and getWidget().

◆ name

QString ActionStateViewer::name

private

the viewer's name

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ActionStateViewer()

Member Function Documentation

◆ getWidget()

◆ refresh()

◆ setState()

Member Data Documentation

◆ actionStateWidgetStack

◆ emptyActionWidgetIndex

◆ myWidget

◆ name