1 // File: ModuleBase_ModelWidget.h
2 // Created: 25 Apr 2014
3 // Author: Natalia ERMOLAEVA
5 #ifndef ModuleBase_ModelWidget_H
6 #define ModuleBase_ModelWidget_H
8 #include <ModuleBase.h>
12 #include <boost/shared_ptr.hpp>
14 class ModelAPI_Feature;
17 /**\class ModuleBase_ModelWidget
18 * \brief An abstract custom widget class. This class realization is assumed to create some controls.
19 * The controls values modification should send signal about values change.
21 * Common interface for widgets in the property panel.
22 * Every widget are able to save/restore data from the model and/or to contain other widgets.
25 class MODULEBASE_EXPORT ModuleBase_ModelWidget : public QObject
30 /// \theParent the parent object
31 ModuleBase_ModelWidget(QObject* theParent) :QObject(theParent) {};
33 virtual ~ModuleBase_ModelWidget() {};
35 /// Saves the internal parameters to the given feature
36 /// \param theFeature a model feature to be changed
37 virtual bool storeValue(boost::shared_ptr<ModelAPI_Feature> theFeature) = 0;
39 virtual bool restoreValue(boost::shared_ptr<ModelAPI_Feature> theFeature) = 0;
41 /// Set focus to the current widget if it corresponds to the given attribute
42 /// \param theAttribute name
43 virtual bool focusTo(const std::string& theAttributeName) = 0;
45 /// Returns list of widget controls
46 /// \return a control list
47 virtual QList<QWidget*> getControls() const = 0;
50 /// The signal about widget values changed
52 /// The signal about key release on the control, that corresponds to the attribute
53 /// \param theAttributeName a name of the attribute
54 /// \param theEvent key release event
55 void keyReleased(const std::string& theAttributeName, QKeyEvent* theEvent);