ActionViewer is the viewer used to manage the actions. More...

#include <ActionViewer.h>

Inheritance diagram for ActionViewer:

Collaboration diagram for ActionViewer:

Public Member Functions
General
Q_INVOKABLE	ActionViewer (QString name)

virtual	~ActionViewer ()
	destructor

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

QString	getDescription () const
	get the name of the viewer

virtual QDockWidget *	getDockWidget () const
	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)

virtual QLayout *	getEmbedder () const
	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)

virtual QPixmap	getIcon () const
	get the viewer icon

QString	getName () const
	get the name of the viewer

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

virtual bool	getToolBarVisibility () const
	get the current value of the toolbar visibility

ViewerType	getType () const
	get the viewer layout

QUuid	getUuid () const
	get the Uuid of this viewer

	Q_ENUM (ViewerType) Viewer(QString name
	default constructor

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

void	setDescription (QString)
	set the viewer's description

virtual 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.

virtual 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)

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

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

bool	setUuid (QUuid id)
	set the Uuid of this viewer

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

virtual	~Viewer () override
	default destructor

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

virtual QWidget *	getWidget () override
	get the viewer widget

camitk::PropertyObject *	getPropertyObject () override
	get the InteractiveViewer propertyObject (only non-null for GEOMETRY_VIEWER)

QMenu *	getMenu () override
	get the explorer menu

void	setSearchPanelVisible (bool)
	show/hide the search panel (visible by default)

void	changeName ()
	Method used to change the action selected.

void	changeFamily ()
	Method used to change the action family selected.

void	changeTag ()
	Method used to change the tag.

Additional Inherited Members
Public Types inherited from camitk::Viewer
enum	ViewerType { EMBEDDED , DOCKED }
	describes where this viewer should appear More...

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

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

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

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

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

void	setComponentClassNames (QStringList)
	set the list of component class names managed by this viewer

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

Detailed Description

ActionViewer is the viewer used to manage the actions.

By default all action widgets are displayed in this viewer widget (in the QStackedWidget). There is also a search panel to find an action to apply to the currently selected component. The search panel is shown by default. Use setSearchPanelVisible(false) to hide it.

Note: This is a very special viewer as it calls setComponentClassNames(...) method with an empty list. This means that this viewer is going to be notified/refreshed every time the current selected action is changed (i.e., anytime an action is triggered).

Use Application::getViewer("Action Viewer") to get the default instance of this viewer.

See also: camitk::Action

Constructor & Destructor Documentation

◆ ActionViewer()

ActionViewer::ActionViewer ( QString name )

constructor

References camitk::PropertyObject::addProperty(), camitk::Application::getName(), camitk::Viewer::getName(), camitk::Application::getSettings(), camitk::Viewer::setComponentClassNames(), camitk::Viewer::setDescription(), and camitk::Viewer::setIcon().

Here is the call graph for this function:

◆ ~ActionViewer()

ActionViewer::~ActionViewer ( )

virtual

destructor

Member Function Documentation

◆ changeFamily

void ActionViewer::changeFamily ( )

protectedslot

Method used to change the action family selected.

Referenced by setSearchPanelVisible().

Here is the caller graph for this function:

◆ changeName

void ActionViewer::changeName ( )

protectedslot

Method used to change the action selected.

References camitk::Application::getAction().

Referenced by setSearchPanelVisible().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ changeTag

void ActionViewer::changeTag ( )

protectedslot

Method used to change the tag.

Referenced by setSearchPanelVisible().

Here is the caller graph for this function:

◆ getMenu()

QMenu * ActionViewer::getMenu ( )

overridevirtual

get the explorer menu

Reimplemented from camitk::Viewer.

◆ getPropertyObject()

PropertyObject * ActionViewer::getPropertyObject ( )

overridevirtual

get the InteractiveViewer propertyObject (only non-null for GEOMETRY_VIEWER)

Reimplemented from camitk::Viewer.

◆ getWidget()

QWidget * ActionViewer::getWidget ( )

overridevirtual

get the viewer widget

Implements camitk::Viewer.

References setSearchPanelVisible().

Here is the call graph for this function:

◆ refresh()

void ActionViewer::refresh ( Viewer * whoIsAsking = nullptr )

overridevirtual

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

References camitk::Application::getTriggeredAction().

Here is the call graph for this function:

◆ setSearchPanelVisible()

void ActionViewer::setSearchPanelVisible ( bool visibility )

show/hide the search panel (visible by default)

References changeFamily(), changeName(), and changeTag().

Referenced by getWidget().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Public Member Functions

Inherited from Viewer

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ActionViewer()

◆ ~ActionViewer()

Member Function Documentation

◆ changeFamily

◆ changeName

◆ changeTag

◆ getMenu()

◆ getPropertyObject()

◆ getWidget()

◆ refresh()

◆ setSearchPanelVisible()