Computer Assisted Medical Intervention Tool Kit  version 5.1
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-2023 Univ. Grenoble Alpes, CNRS, Grenoble INP, TIMC, 38000 Grenoble, France
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
33namespace camitk {
34class Property;
35
43class InterfaceProperty : public QObject {
44 Q_OBJECT
45public:
47 ~InterfaceProperty() = default;
48
50 virtual QStringList getHierarchy() const = 0;
51
55 virtual bool isInstanceOf(QString className) const = 0;
56
63 Q_INVOKABLE virtual camitk::Property* getProperty(QString name) = 0;
64
73 virtual bool addProperty(Property*) = 0;
74
79 virtual unsigned int getNumberOfPropertyWidget() = 0;
80
87 virtual QWidget* getPropertyWidgetAt(unsigned int i) = 0;
88
97 virtual QObject* getPropertyObject() = 0;
98
105 virtual void updateProperty(QString name, QVariant value) = 0;
106
113 virtual void setIndexOfPropertyExplorerTab(unsigned int index) = 0;
114
121 virtual unsigned int getIndexOfPropertyExplorerTab() = 0;
122};
123
124}
125
126#endif // INTERFACEPROPERTY_H
This class describe what are the methods to implement in order to manage dynamic properties.
Definition: InterfaceProperty.h:43
virtual unsigned int getNumberOfPropertyWidget()=0
get the number of alternative property widgets
virtual QWidget * getPropertyWidgetAt(unsigned int i)=0
get the ith alternative property widget override this method and use the method setObjectName of QWid...
virtual bool addProperty(Property *)=0
Add a new CamiTK property to the component.
virtual QStringList getHierarchy() const =0
Get the inheritance hierachy of this Component instance as a list of QString.
~InterfaceProperty()=default
empty virtual destructor, to avoid memory leak
virtual QObject * getPropertyObject()=0
get the property object that could be understood by PropertyEditor.
virtual void updateProperty(QString name, QVariant value)=0
update property: if you this method, do not forget to call the superclass method for the property not...
virtual bool isInstanceOf(QString className) const =0
Assert that a Component instance really inherits from a given className.
virtual unsigned int getIndexOfPropertyExplorerTab()=0
Get the index of the tab in the PropertyExplorer to select for display.
virtual Q_INVOKABLE camitk::Property * getProperty(QString name)=0
Get a Property given its name.
virtual void setIndexOfPropertyExplorerTab(unsigned int index)=0
Set the index of the tab in the PropertyExplorer to select for display.
This class describes a property that can be used in components and actions or any class that needs to...
Definition: Property.h:280
Definition: Action.cpp:35