Computer Assited Medical Intervention Tool Kit  version 3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Protected Slots | Private Types | Private Member Functions | Private Attributes | List of all members
camitk::ActionViewer Class Reference

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

#include <ActionViewer.h>

+ Inheritance diagram for camitk::ActionViewer:

Public Member Functions

Inherited from Viewer
virtual unsigned int numberOfViewedComponent ()
 returns the number of Component that are displayed by this viewer More...
 
virtual void refresh (Viewer *whoIsAsking=NULL)
 refresh the view (can be interesting to know which other viewer is calling this) More...
 
virtual QWidget * getWidget (QWidget *parent=NULL)
 get the viewer widget. More...
 
Specific to the Action viewer
void embedActionWidget (Action *)
 embed an action widget in the stacked widget More...
 
void setSearchPanelVisible (bool)
 show/hide the search panel (hidden by default) More...
 
- Public Member Functions inherited from camitk::Viewer
virtual QMenu * getMenu ()
 get the viewer menu (returns NULL by default, i.e. there are no default edit menu) More...
 
virtual QObject * getPropertyObject ()
 get the viewer property object (returns NULL by default, i.e. there are no property to edit) More...
 
virtual QToolBar * getToolBar ()
 get the viewer toolbar (returns NULL by default, i.e. there are no default toolbar) More...
 
virtual void refreshInterfaceNode (Component *comp)
 Update the whole tree of the representation of the Component. More...
 
 Viewer (QString name)
 default constructor More...
 
virtual ~Viewer ()
 default destructor More...
 

Protected Slots

void changeFamily ()
 Method used to change the action family selected. More...
 
void changeName ()
 Method used to change the action selected. More...
 
void changeTag ()
 Method used to change the tag. More...
 

Private Types

enum  UpdateReason { ActionFamilyChanged, ActionNameChanged, ActionTagChanged, ViewerRefresh }
 Enum the different fields of the action viewwer. More...
 

Private Member Functions

void updateActionViewer (UpdateReason)
 method used to update the viewer for a given update field More...
 

Private Attributes

Actionaction
 Current action. More...
 
QStackedWidget * actionWidgetStack
 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...
 
QComboBox * familyComboBox
 Family combo box. More...
 
QWidget * myWidget
 Main action widget of the viewer. More...
 
QComboBox * nameComboBox
 Action name combo box. More...
 
QFrame * searchFramePanel
 the search panel More...
 
QLineEdit * tagLineEdit
 action tags line edit More...
 
QMap< ComponentList, Action * > widgetHistory
 this map stores the list of selected component and the corresponding stack index of their embedded action More...
 

General

 ActionViewer ()
 
virtual ~ActionViewer ()
 destructor More...
 
static ActionViewergetInstance ()
 returns the unique instance of ActionViewer More...
 

Additional Inherited Members

- Signals inherited from camitk::Viewer
void selectionChanged ()
 this signal is emitted when the current selection was changed by the viewer More...
 
- Protected Member Functions inherited from camitk::Viewer
void clearSelection ()
 clear the selection More...
 
void selectionChanged (ComponentList &compSet)
 The selection has changed to the given ComponentList. More...
 
void selectionChanged (Component *comp)
 the selection has changed to be just one comp More...
 

Detailed Description

ActionViewer is the viewer used to manage the actions.

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

This viewer also manages a singleton (THE CamiTK action viewer). See getInstance() for more information. You do not have to use it, but it is convienent (and sometimes preferable) to use this instance instead of creating your own one.

Member Enumeration Documentation

Enum the different fields of the action viewwer.

Enumerator
ActionFamilyChanged 
ActionNameChanged 
ActionTagChanged 
ViewerRefresh 

Constructor & Destructor Documentation

camitk::ActionViewer::ActionViewer ( )

constructor

virtual camitk::ActionViewer::~ActionViewer ( )
virtual

destructor

Member Function Documentation

void camitk::ActionViewer::changeFamily ( )
protectedslot

Method used to change the action family selected.

void camitk::ActionViewer::changeName ( )
protectedslot

Method used to change the action selected.

void camitk::ActionViewer::changeTag ( )
protectedslot

Method used to change the tag.

void camitk::ActionViewer::embedActionWidget ( Action )

embed an action widget in the stacked widget

static ActionViewer* camitk::ActionViewer::getInstance ( )
static

returns the unique instance of ActionViewer

virtual QWidget* camitk::ActionViewer::getWidget ( QWidget *  parent = NULL)
virtual

get the viewer widget.

Parameters
parentthe parent widget for the viewer widget

Implements camitk::Viewer.

virtual unsigned int camitk::ActionViewer::numberOfViewedComponent ( )
inlinevirtual

returns the number of Component that are displayed by this viewer

Implements camitk::Viewer.

virtual void camitk::ActionViewer::refresh ( Viewer whoIsAsking = NULL)
virtual

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

Implements camitk::Viewer.

void camitk::ActionViewer::setSearchPanelVisible ( bool  )

show/hide the search panel (hidden by default)

void camitk::ActionViewer::updateActionViewer ( UpdateReason  )
private

method used to update the viewer for a given update field

Member Data Documentation

Action* camitk::ActionViewer::action
private

Current action.

QStackedWidget* camitk::ActionViewer::actionWidgetStack
private

actions stacked widget of the viewer

int camitk::ActionViewer::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

QComboBox* camitk::ActionViewer::familyComboBox
private

Family combo box.

QWidget* camitk::ActionViewer::myWidget
private

Main action widget of the viewer.

QComboBox* camitk::ActionViewer::nameComboBox
private

Action name combo box.

QFrame* camitk::ActionViewer::searchFramePanel
private

the search panel

QLineEdit* camitk::ActionViewer::tagLineEdit
private

action tags line edit

QMap<ComponentList, Action*> camitk::ActionViewer::widgetHistory
private

this map stores the list of selected component and the corresponding stack index of their embedded action


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