Computer Assited Medical Intervention Tool Kit  version 3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
InterfaceProperty.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * $CAMITK_LICENCE_BEGIN$
3  *
4  * CamiTK - Computer Assisted Medical Intervention ToolKit
5  * (c) 2001-2014 UJF-Grenoble 1, CNRS, TIMC-IMAG UMR 5525 (GMCAO)
6  *
7  * Visit http://camitk.imag.fr for more information
8  *
9  * This file is part of CamiTK.
10  *
11  * CamiTK is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * CamiTK is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Lesser General Public License version 3 for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * version 3 along with CamiTK. If not, see <http://www.gnu.org/licenses/>.
22  *
23  * $CAMITK_LICENCE_END$
24  ****************************************************************************/
25 
26 #ifndef INTERFACEPROPERTY_H
27 #define INTERFACEPROPERTY_H
28 
29 #include "CamiTKAPI.h"
30 
31 #include <QObject>
32 
33 namespace camitk
34 {
35 class Property;
36 
44 class InterfaceProperty : public QObject {
45  Q_OBJECT
46 public:
48  virtual ~InterfaceProperty() {};
49 
51  virtual QStringList getHierarchy() = 0;
52 
56  virtual bool isInstanceOf(QString className) = 0;
57 
59  // TODO CAMITK_DEPRECATED. This section list all the methods marked as deprecated. They are to be removed in CamiTK 4.0
71  virtual bool setDynamicProperty(const char *name, const QVariant &value, const char *description = "", bool isReadOnly=false) = 0;
73 
80  Q_INVOKABLE virtual Property* getProperty(QString name) = 0;
81 
90  virtual bool addProperty(Property*) = 0;
91 
93  // TODO CAMITK_DEPRECATED. This section list all the methods marked as deprecated. They are to be removed in CamiTK 4.0
102  virtual QWidget * getPropertyWidget(QWidget* parent = 0) = 0;
104 
109  virtual unsigned int getNumberOfPropertyWidget() = 0;
110 
117  virtual QWidget * getPropertyWidgetAt(unsigned int i, QWidget* parent = 0) = 0;
118 
127  virtual QObject * getPropertyObject() = 0;
128 
135  virtual void updateProperty(QString name, QVariant value) = 0;
136 };
137 
138 }
139 
140 #endif // INTERFACEPROPERTY_H
This class describe what are the methods to implement in order to manage dynamic properties.
Definition: InterfaceProperty.h:44
virtual bool addProperty(Property *)=0
Add a new CamiTK property to the component.
virtual Q_INVOKABLE Property * getProperty(QString name)=0
Get a Property given its name.
virtual QWidget * getPropertyWidgetAt(unsigned int i, QWidget *parent=0)=0
get the ith alternative property widget overwrtite this method and use the method setAccessibleName o...
virtual bool isInstanceOf(QString className)=0
Assert that a Component instance really inherits from a given className.
virtual QStringList getHierarchy()=0
Get the inheritance hierachy of this Component instance as a list of QString.
virtual unsigned int getNumberOfPropertyWidget()=0
get the number of alternative property widgets
virtual void updateProperty(QString name, QVariant value)=0
update property: if you override this method, do not forget to call the superclass method for the pro...
virtual ~InterfaceProperty()
empty virtual destructor, to avoid memory leak
Definition: InterfaceProperty.h:48
virtual QObject * getPropertyObject()=0
get the property object that could be understood by PropertyEditor.
This class describes a property that can be used in components and actions or any class that needs to...
Definition: Property.h:188