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

The object controller class. More...

#include <ObjectController.h>

+ Inheritance diagram for camitk::ObjectController:

Public Slots

void apply ()
 slot to apply change made by the user in the property editor More...
 
void revert ()
 slot to revert the values of all properties (revert to values in memory) More...
 

Private Member Functions

ViewMode getViewMode () const
 accessorMethod of the view mode More...
 
void initViewMode ()
 initialize the view mode depending on currentViewMode More...
 
bool isModified ()
 call this to check if a modification was done More...
 
QObject * object () const
 accessorMethod of the object contains in the property browser More...
 
 ObjectController (QWidget *parent=0, ViewMode viewMode=TREE)
 constructor of object controller with in parameters the parent widget and the view mode (default : TREE) More...
 
 Q_PRIVATE_SLOT (d_func(), void saveChange(QtProperty *, const QVariant &)) Q_PRIVATE_SLOT(d_func()
 
void setAutoUpdateProperty (bool)
 if set, the properties are immediatly updated in the managed object (default false) More...
 
void setObject (QObject *object)
 mutatorMethod of the object at unroll in the property browser More...
 
void setViewMode (ViewMode viewMode)
 mutator Method of the view mode More...
 
void valueChanged (QtProperty *, const QVariant &)) ViewMode currentViewMode
 variable to choose the type of property browser More...
 
 ~ObjectController ()
 destructor of object controller More...
 

Private Attributes

ObjectControllerPrivated_ptr
 private object controller wich contains pointer about object, browser and more More...
 
QVBoxLayout * layout
 layout which will contains the propertybrowser and, in view mode GROUPBOX and BUTTON, the scroll More...
 
QScrollArea * scroll
 scroll add to navigate in the property browser More...
 

Detailed Description

The object controller class.

This is a special "magical" widget. It allows to show the meta properties and dynamic property (see Qt Object Model / Property for lmore information on these).

A complete example that show the usability of object controller is available in applications "objectcontroller". The best way to learn how to use this Core facility is to look at this application and the given TestClass.

An object controller is a sort of property browser where each line represents a property. The object controller automatically build a GUI to access and optionally changed the properties you defined.

There could be many different types of properties, and as many as you want.

In order to handle a list of specific properties for your class, you have two choices:

The second choice does even not need a new class. You have to create a new QObject instance, and add as many dynamic properties as you wish using QObject::setProperty method. You also have to install an event monitor in your class to be notified when a property has changed (see TestClass in "objectcontroller" application).

Three different view mode are available to represent/interact with the property values:

The view mode can be changed at any time, even at run-time (see the "objectcontroller" application).

How to use this class:

Note
And... that's it! This method is easier, but does not work well for Q_ENUMS (enumerator). If you have an enum/Q_ENUMS property, you have to use the second method below.

The available property type are (see example in the "objectcontroller" application (tutorials), and see also QtVariantProperty in tools/qpropertybrowser for a complete list of associated constraints):

Property Type Property Type Id
int QVariant::Int
double QVariant::Double
bool QVariant::Bool
QString QVariant::String
QVector3D QVariant::QVector3D
QColor QVariant::Color
QDate QVariant::Date
QTime QVariant::Time
QChar QVariant::Char
QDateTime QVariant::DateTime
QPoint Variant::Point
QPointF QVariant::PointF
QKeySequence QVariant::KeySequence
QLocale QVariant::Locale
QSize QVariant::Size
QSizeF QVariant::SizeF
QRect QVariant::Rect
QRectF QVariant::RectF
QSizePolicy QVariant::SizePolicy
QFont QVariant::Font
QCursor QVariant::Cursor
enum enumTypeId()
flag flagTypeId()
group groupTypeId()
Note
in Q_PROPERTY if you don't specify a WRITE method, then the property is set as read only.

Constructor & Destructor Documentation

camitk::ObjectController::ObjectController ( QWidget *  parent = 0,
ViewMode  viewMode = TREE 
)
private
camitk::ObjectController::~ObjectController ( )
private

destructor of object controller

References d_ptr.

Member Function Documentation

void camitk::ObjectController::apply ( )
slot

slot to apply change made by the user in the property editor

References camitk::ObjectControllerPrivate::applyChange(), and d_ptr.

Referenced by camitk::SettingsDialog::accept(), and camitk::SettingsDialog::on_objectList_itemSelectionChanged().

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

accessorMethod of the view mode

void camitk::ObjectController::initViewMode ( )
private

initialize the view mode depending on currentViewMode

References d_ptr, layout, camitk::ObjectControllerPrivate::m_browser, and scroll.

Referenced by ObjectController(), and setViewMode().

bool camitk::ObjectController::isModified ( )
private
QObject * camitk::ObjectController::object ( ) const
private

accessorMethod of the object contains in the property browser

References d_ptr, and camitk::ObjectControllerPrivate::m_object.

Referenced by PropertyUI::print(), revert(), setObject(), and setViewMode().

camitk::ObjectController::Q_PRIVATE_SLOT ( d_func()  ,
void   saveChangeQtProperty *, const QVariant & 
)
private
void camitk::ObjectController::revert ( )
slot

slot to revert the values of all properties (revert to values in memory)

References d_ptr, object(), camitk::ObjectControllerPrivate::saveChangeValue, and setObject().

void camitk::ObjectController::setAutoUpdateProperty ( bool  autoUpdate)
private

if set, the properties are immediatly updated in the managed object (default false)

References d_ptr, camitk::ObjectControllerPrivate::m_manager, and valueChanged().

Referenced by ObjectController(), and camitk::ActionWidget::setAutoUpdateProperty().

void camitk::ObjectController::setObject ( QObject *  object)
private
void camitk::ObjectController::setViewMode ( ViewMode  viewMode)
private
void camitk::ObjectController::valueChanged ( QtProperty *  ,
const QVariant &   
)
private

variable to choose the type of property browser

Referenced by setAutoUpdateProperty().

Member Data Documentation

ObjectControllerPrivate* camitk::ObjectController::d_ptr
private

private object controller wich contains pointer about object, browser and more

Referenced by apply(), initViewMode(), isModified(), object(), ObjectController(), revert(), setAutoUpdateProperty(), setObject(), setViewMode(), and ~ObjectController().

QVBoxLayout* camitk::ObjectController::layout
private

layout which will contains the propertybrowser and, in view mode GROUPBOX and BUTTON, the scroll

Referenced by initViewMode(), ObjectController(), and setViewMode().

QScrollArea* camitk::ObjectController::scroll
private

scroll add to navigate in the property browser

Referenced by initViewMode(), ObjectController(), and setViewMode().


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