X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_ModelWidget.h;h=a6ad2ca97fec81c3ff6e7b094fb99f6d4de81da1;hb=0cea3be102af7247b2fe2c8035a1bb38b7bf82ae;hp=35bd1632026d91a530505880b3f41c2c47746121;hpb=7632f7682b8b35390be660f5f2f0e44fff0f0108;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_ModelWidget.h b/src/ModuleBase/ModuleBase_ModelWidget.h index 35bd16320..a6ad2ca97 100644 --- a/src/ModuleBase/ModuleBase_ModelWidget.h +++ b/src/ModuleBase/ModuleBase_ModelWidget.h @@ -12,7 +12,7 @@ #include -#include +#include #include @@ -20,6 +20,7 @@ class Config_WidgetAPI; class QKeyEvent; /**\class ModuleBase_ModelWidget + * \ingroup GUI * \brief An abstract custom widget class. This class realization is assumed to create some controls. * The controls values modification should send signal about values change. * @@ -27,7 +28,7 @@ class QKeyEvent; * Every widget are able to save/restore data from the model and/or to contain other widgets. * */ -class MODULEBASE_EXPORT ModuleBase_ModelWidget : public QObject +class MODULEBASE_EXPORT ModuleBase_ModelWidget : public QWidget { Q_OBJECT public: @@ -42,6 +43,9 @@ Q_OBJECT { } + /// Fills the widget with default values + virtual void reset() {}; + /// Returns the state whether the attribute of the feature is initialized /// \param theObject a model feature to be checked /// \return the boolean result @@ -49,7 +53,16 @@ Q_OBJECT /// Returns true, if default value of the widget should be computed /// on operation's execute, like radius for circle's constraint (can not be zero) - bool isComputedDefault() { return myIsComputedDefault; } + bool isComputedDefault() const { return myIsComputedDefault; } + + /// Returns true, if default value of the widget is defined in the XML and it is not the + /// computed value + /// \return the boolean result + std::string getDefaultValue() const { return myDefaultValue; } + + /// Returns true, if the obligatory value of the widget is not defined in the XML or has true value + /// \return the boolean result + bool isObligatory() const { return myIsObligatory; } /// Defines if it is supposed that the widget should interact with the viewer. virtual bool isViewerSelector() { return false; } @@ -60,15 +73,13 @@ Q_OBJECT /// Set the given wrapped value to the current widget /// This value should be processed in the widget according to the needs - /// \param theValue the wrapped widget value - virtual bool setSelection(ModuleBase_ViewerPrs theValue) + /// \param theValues the wrapped selection values + /// \param thePosition an index in the list of values, the values should be get from the index + virtual bool setSelection(const QList& theValues, int& thePosition) { return false; } - /// Saves the internal parameters to the given feature - virtual bool storeValue() const = 0; - /// Restore value from attribute data to the widget's control virtual bool restoreValue() = 0; @@ -78,15 +89,11 @@ Q_OBJECT virtual bool focusTo(); /// The methiod called when widget is activated - virtual void activate() {} + void activate(); /// The methiod called when widget is deactivated virtual void deactivate() {} - /// Returns the internal parent wiget control, that can be shown anywhere - /// \returns the widget - virtual QWidget* getControl() const = 0; - /// Returns list of widget controls /// \return a control list virtual QList getControls() const = 0; @@ -94,11 +101,12 @@ Q_OBJECT /// FocusIn events processing virtual bool eventFilter(QObject* theObject, QEvent *theEvent); - //! \brief Enables processing of focus event on all controls by the widget - void enableFocusProcessing(); + /// \brief Enables processing of focus event on all controls by the widget + /// if this widget is not obligatory and set no-focus policy otherwise + virtual void enableFocusProcessing(); //! Switch On/Off highlighting of the widget - void setHighlighted(bool isHighlighted); + virtual void setHighlighted(bool isHighlighted); /// Returns the attribute name /// \returns the string value @@ -121,10 +129,8 @@ Q_OBJECT } /// Set feature which is processing by active operation - void setFeature(const FeaturePtr& theFeature) - { - myFeature = theFeature; - } + /// \param theToStoreValue a value about necessity to store the widget value to the feature + void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false); /// Editing mode depends on mode of current operation. This value is defined by it. void setEditingMode(bool isEditing) { myIsEditing = isEditing; } @@ -133,8 +139,12 @@ Q_OBJECT bool isEditingMode() const { return myIsEditing; } signals: + /// The signal about widget values are to be changed + void beforeValuesChanged(); /// The signal about widget values changed void valuesChanged(); + /// The signal about widget values are to be changed + void afterValuesChanged(); /// The signal about key release on the control, that corresponds to the attribute /// \param theEvent key release event @@ -149,6 +159,9 @@ signals: void focusOutWidget(ModuleBase_ModelWidget* theWidget); protected: + /// Sets default value of widget. Nornaly, widget should fetch this value + /// from the xml. However, some widgets derived widgets could define it + void setDefaultValue(const std::string& theValue); /// \brief Set the attribute name /// \param theAttribute the string value with attribute name void setAttributeID(const std::string& theAttribute) @@ -156,6 +169,17 @@ signals: myAttributeID = theAttribute; } + /// Saves the internal parameters to the given feature. Emits signals before and after store + /// \return True in success + bool storeValue(); + + /// Saves the internal parameters to the given feature + /// \return True in success + virtual bool storeValueCustom() const = 0; + + /// The methiod called when widget is activated + virtual void activateCustom() {}; + /// Sends Update and Redisplay for the given object /// \param theObj is updating object void updateObject(ObjectPtr theObj) const; @@ -164,6 +188,10 @@ signals: /// \param theObj is object for moving void moveObject(ObjectPtr theObj) const; +protected slots: + /// Processing of values changed in model widget by store the current value to the feature + void onWidgetValuesChanged(); + protected: /// The attribute name of the model feature @@ -175,11 +203,19 @@ signals: /// A feature which is processing by active operation FeaturePtr myFeature; - /// Value should be computed on execute, like radius for circle's constraint (can not be zero) - bool myIsComputedDefault; - /// Flag which shows that current operation is in editing mode bool myIsEditing; + + /// Flag which shows whether current widget is obligatory + /// The non-obligatory widgets should not accept the focus in the property panel + bool myIsObligatory; + +private: + /// Value should be computed on execute, like radius for circle's constraint (can not be zero) + bool myIsComputedDefault; + + /// the default value, which is defined in the XML for this attribute + std::string myDefaultValue; }; #endif