Computer Assisted Medical Intervention Tool Kit  version 5.2
 
Loading...
Searching...
No Matches
ActionStateViewer Class Reference

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.
 
virtual void refresh (Viewer *whoIsAsking=nullptr)
 refresh the view (can be interesting to know which other viewer is calling this)
 
void setState (ActionState *actionState)
 set the current state
 
- Public Member Functions inherited from camitk::Viewer
*get the list of Component class manages by this viewer *default is set to i e all type of Component *QStringList getComponentClassNames ()
 
QString getDescription () const
 get the name of the viewer
 
virtual 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)
 
virtual 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)
 
virtual QPixmap getIcon ()
 get the viewer icon
 
virtual QMenu * getMenu ()
 get the viewer menu (returns nullptr by default, i.e. there are no default edit menu)
 
QString getName () const
 get the name of the viewer
 
virtual PropertyObjectgetPropertyObject ()
 get the viewer property object (returns nullptr by default, i.e. there are no property to edit)
 
virtual QToolBar * getToolBar ()
 get the viewer toolbar (returns nullptr by default, i.e. there are no default toolbar)
 
virtual bool getToolBarVisibility ()
 get the current value of the toolbar visibility
 
ViewerType getType ()
 get the viewer layout
 
 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)
 
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)
 
virtual void setVisible (bool)
 set the visibility of the viewer (show or hide its widget)
 
virtual ~Viewer () override
 default destructor
 

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
*get the list of Component class manages by this viewer *default is set to Component
 
ViewerType type = EMBEDDED)
 this viewer's layout
 
- Protected Member Functions inherited from camitk::Viewer
void clearSelection ()
 clear the selection
 
*set the list of component class names managed by this viewer *note Default is set to Component (all type of components) */void setComponentClassNames(QStringList)
 
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 setDescription (QString)
 set the viewer's description
 
void setIcon (QPixmap icon)
 set the default icon for the viewer extension
 

Detailed Description

The current action state viewer.

Constructor & Destructor Documentation

◆ ActionStateViewer()

ActionStateViewer::ActionStateViewer ( QString  name)

Member Function Documentation

◆ getWidget()

QWidget * ActionStateViewer::getWidget ( )
virtual

get the viewer widget.

Implements camitk::Viewer.

◆ 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 ActionState::getWidget().

+ Here is the call graph for this function:

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