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

The property explorer. More...

#include <PropertyExplorer.h>

+ Inheritance diagram for camitk::PropertyExplorer:

Private Member Functions

void clear ()
 clear all the additional widgets, reset currentComponent (and update its visibility).
virtual Q_ENUMS(camitk::ObjectController::ViewMode)
Q_PROPERTY(camitk 
~PropertyExplorer ()
 destructor
Inherited from Viewer
virtual unsigned int numberOfViewedComponent ()
virtual void refresh (Viewer *whoIsAsking=NULL)
 refresh the property editor
virtual QWidget * getWidget (QWidget *parent=NULL)
 get the viewer widget.
virtual QObject * getPropertyObject ()
 add a property to change the ObjectController representation at run-time (user choice)
Manage View mode (user preference)
const ObjectController::ViewMode getViewMode ()
void setViewMode (ObjectController::ViewMode)
 set the view mode

Private Attributes

QPushButton * applyButton
ComponentcurrentComponent
 the viewed Component
QPushButton * revertButton
QTabWidget * tabWidget
ObjectControllertheController
 the widgets

Additional Inherited Members

- Signals inherited from camitk::Viewer
void selectionChanged ()
 this signal is emitted when the current selection was changed by the viewer
- 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)
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 inherited from camitk::Viewer
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

The property explorer.

The property explorer is a special container, placed generally bellow the explorer. It has a default tab (property editor) and can include any number of other tabs (where you can, of course, have any kind of widgets you want: slider, labels, text, ...).

The property editor is a "magic" widget (aka as "poOOowerful" widget) that use QObject derived class and build a property editor UI. It is presented as a list (automatically build from your QObject derived class Q_PROPERTY):

Note
When your property editor has modified something in the Component that can change the way it is viewed/rendered by one or all of the Component viewers, you have to call the Component's method refresh()...

See also ObjectController documentation for more informations and a complete example.

See Also
ObjectController

Constructor & Destructor Documentation

camitk::PropertyExplorer::~PropertyExplorer ( )
privatevirtual

destructor

Member Function Documentation

void camitk::PropertyExplorer::clear ( )
private

clear all the additional widgets, reset currentComponent (and update its visibility).

Note
this method does not delete the different widgets that were included in the tabs, the Component should do it.
QObject * camitk::PropertyExplorer::getPropertyObject ( )
privatevirtual

add a property to change the ObjectController representation at run-time (user choice)

const ObjectController::ViewMode camitk::PropertyExplorer::getViewMode ( )
private

get the current view mode

QWidget * camitk::PropertyExplorer::getWidget ( QWidget *  parent = NULL)
privatevirtual

get the viewer widget.

Parameters
parentthe parent widget for the viewer widget

Referenced by ImpMainWindow::resetWindows().

unsigned int camitk::PropertyExplorer::numberOfViewedComponent ( )
privatevirtual

returns the number of Component that are displayed by this viewer

void camitk::PropertyExplorer::refresh ( Viewer whoIsAsking = NULL)
privatevirtual

refresh the property editor

void camitk::PropertyExplorer::setViewMode ( ObjectController::ViewMode  mode)
private

set the view mode

Member Data Documentation

QPushButton* camitk::PropertyExplorer::applyButton
private
Component* camitk::PropertyExplorer::currentComponent
private

the viewed Component

QPushButton* camitk::PropertyExplorer::revertButton
private
QTabWidget* camitk::PropertyExplorer::tabWidget
private
ObjectController* camitk::PropertyExplorer::theController
private

the widgets


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