Computer Assited Medical Intervention Tool Kit
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Signals | Public Member Functions | Protected Member Functions | List of all members
camitk::Viewer Class Reference

Viewer is an abstract viewer. More...

#include <Viewer.h>

+ Inheritance diagram for camitk::Viewer:

Signals

void selectionChanged ()
 this signal is emitted when the current selection was changed by the viewer

Public Member Functions

virtual QMenu * getMenu ()
 get the viewer menu (returns NULL by default, i.e. there are no default edit menu)
virtual QObject * getPropertyObject ()
 get the viewer property object (returns NULL by default, i.e. there are no property to edit)
virtual QToolBar * getToolBar ()
 get the viewer toolbar (returns NULL by default, i.e. there are no default toolbar)
virtual QWidget * getWidget (QWidget *parent=NULL)=0
 get the viewer widget.
virtual unsigned int numberOfViewedComponent ()=0
 returns the number of Component that are displayed by this viewer
virtual void refresh (Viewer *whoIsAsking=NULL)=0
 refresh the view (can be interesting to know which other viewer is calling this)
virtual void refreshInterfaceNode (Component *comp)
 Update the whole tree of the representation of the Component.
 Viewer (QString name)
 default constructor
virtual ~Viewer ()
 default destructor

Protected Member Functions

void clearSelection ()
 clear the selection
void selectionChanged (ComponentList &compSet)
 The selection has changed to the given ComponentList.
void selectionChanged (Component *comp)
 the selection has changed to be just one comp

Detailed Description

Viewer is an abstract viewer.

A viewer can contains other viewers, example of viewer are: Explorer, PropertyExplorer, MedicalImageViewer. A viewer can be added to MainWindow, MainWindow will include its menu in the "View" menu and its toolbar in the application toolbar.

Use QObject method getObjectName to get the viewer's name.

Constructor & Destructor Documentation

camitk::Viewer::Viewer ( QString  name)

default constructor

camitk::Viewer::~Viewer ( )
virtual

default destructor

Member Function Documentation

void camitk::Viewer::clearSelection ( )
protected
virtual QMenu* camitk::Viewer::getMenu ( )
inlinevirtual

get the viewer menu (returns NULL by default, i.e. there are no default edit menu)

Reimplemented in camitk::MedicalImageViewer, and camitk::Explorer.

Referenced by ImpMainWindow::updateViewMenu().

virtual QObject* camitk::Viewer::getPropertyObject ( )
inlinevirtual

get the viewer property object (returns NULL by default, i.e. there are no property to edit)

Reimplemented in camitk::MedicalImageViewer.

Referenced by ImpMainWindow::editSettings().

virtual QToolBar* camitk::Viewer::getToolBar ( )
inlinevirtual

get the viewer toolbar (returns NULL by default, i.e. there are no default toolbar)

Reimplemented in camitk::MedicalImageViewer.

Referenced by camitk::MainWindow::addViewer().

virtual QWidget* camitk::Viewer::getWidget ( QWidget *  parent = NULL)
pure virtual

get the viewer widget.

Parameters
parentthe parent widget for the viewer widget

Implemented in camitk::MedicalImageViewer, camitk::Explorer, camitk::ActionViewer, and ActionStateViewer.

Referenced by camitk::MainWindow::addDockViewer(), and camitk::MainWindow::setCentralViewer().

virtual unsigned int camitk::Viewer::numberOfViewedComponent ( )
pure virtual

returns the number of Component that are displayed by this viewer

Implemented in camitk::MedicalImageViewer, camitk::Explorer, camitk::ActionViewer, and ActionStateViewer.

virtual void camitk::Viewer::refresh ( Viewer whoIsAsking = NULL)
pure virtual
virtual void camitk::Viewer::refreshInterfaceNode ( Component comp)
inlinevirtual

Update the whole tree of the representation of the Component.

Is actually usefull (and defined) in Explorer.

Reimplemented in camitk::Explorer.

void camitk::Viewer::selectionChanged ( )
signal
void camitk::Viewer::selectionChanged ( camitk::ComponentList compSet)
protected

The selection has changed to the given ComponentList.

This method updates the Component::selection and emit the modified signal. This method should be called by the inheriting class which can select Components (e.g.: Explorer).

References selectionChanged(), and camitk::Component::setSelected().

void camitk::Viewer::selectionChanged ( Component comp)
protected

the selection has changed to be just one comp

References selectionChanged(), and camitk::Component::setSelected().


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