X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2FModuleBase%2FModuleBase_ModelWidget.h;h=91c83708ba3768d4d5c1690037fdb7a3d2ea8bf7;hb=423f6b0a08a86d5e47115b87603cddeae4468b49;hp=6712bc0299d715372cd3edb805c5bece054dc25c;hpb=9ddad7aadf48e6754d8ddeea4eaf0c37c66a9b8f;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_ModelWidget.h b/src/ModuleBase/ModuleBase_ModelWidget.h index 6712bc029..91c83708b 100644 --- a/src/ModuleBase/ModuleBase_ModelWidget.h +++ b/src/ModuleBase/ModuleBase_ModelWidget.h @@ -18,11 +18,13 @@ class Config_WidgetAPI; class ModuleBase_IWorkshop; class ModuleBase_ViewerPrs; +class ModuleBase_WidgetValidator; class QKeyEvent; /**\class ModuleBase_ModelWidget * \ingroup GUI - * \brief An abstract custom widget class. This class realization is assumed to create some controls. + * \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. * * Common interface for widgets in the property panel. @@ -39,15 +41,18 @@ Q_OBJECT ModifiedInViewer, /// modification performed by viewer events Reset }; /// the value is reset + enum EnableState { On, /// the widget value is always enabled + Off, /// the widget value is always disabled + /// the widget value enable state is defined in preferences + DefinedInPreferences }; + /// Constructor /// \param theParent the parent object /// \param theData the widget configuration. The attribute of the model widget is obtained from - /// \param theData a low-level API for reading xml definitions of widgets + /// a low-level API for reading xml definitions of widgets ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData); /// Destructor - virtual ~ModuleBase_ModelWidget() - { - } + virtual ~ModuleBase_ModelWidget(); /// Fills the widget with default values. It calls the resetCustom method and change /// the widget state to Reset if the reset is performed. @@ -72,10 +77,17 @@ Q_OBJECT /// \return the boolean result bool isInternal() const { return myIsInternal; } - /// Returns true, if the obligatory value of the widget is not defined in the XML or has true value + /// 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; } + /// Returns true, if the widget value is enabled and might be modified manualy. + /// It returns false if the application preferences allow having disabled value + /// and the internal state tells to disable + /// \return the boolean result + virtual bool isValueEnabled() const; + /// Returns this parameter value in the xml file /// \return the boolean result bool isUseReset() const { return myUseReset; } @@ -84,6 +96,9 @@ Q_OBJECT /// \return the enumeration result ValueState getValueState() const { return myState; } + /// Stores the widget value if it is modified + void processValueState(); + /// Returns an attribute error according to the value state /// It exists in all cases excepring the "Store" case QString getValueStateError() const; @@ -97,8 +112,9 @@ Q_OBJECT //! Returns the widget error, get it from the attribute validator and state of the widget //! If the feature is correct, it returns an empty value + //! \param theValueStateChecked the boolean flag if the state of the widget should be checked //! \return string value - QString getError() const; + QString getError(const bool theValueStateChecked = true) const; /// Set the given wrapped value to the current widget /// This value should be processed in the widget according to the needs @@ -114,11 +130,26 @@ Q_OBJECT /// \param theValues a list of presentations virtual void getHighlighted(QList>& theValues) {}; - /// Restore value from attribute data to the widget's control. Emits signals before and after store + /// Checks if the selection presentation is valid in widget + /// \param theValue a selected presentation in the view + /// \return a boolean value + virtual bool isValidSelectionCustom(const std::shared_ptr& theValue) + { return true; } + + /// Returns widget validator, by default it is NULL. To be created in a child if necessary + ModuleBase_WidgetValidator* widgetValidator() { return myWidgetValidator; } + + /// Restore value from attribute data to the widget's control. + /// Emits signals before and after store /// \return True in success bool restoreValue(); - /// Set focus to the first control of the current widget. The focus policy of the control is checked. + /// Saves the internal parameters to the given feature. Emits signals before and after store + /// \return True in success + bool storeValue(); + + /// Set focus to the first control of the current widget. + /// The focus policy of the control is checked. /// If the widget has the NonFocus focus policy, it is skipped. /// \return the state whether the widget can accept the focus virtual bool focusTo(); @@ -167,7 +198,9 @@ Q_OBJECT /// Set feature which is processing by active operation /// \param theFeature a feature object /// \param theToStoreValue a value about necessity to store the widget value to the feature - void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false); + /// \param isUpdateFlushed a flag if update should be flushed on store value + void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false, + const bool isUpdateFlushed = true); /// Editing mode depends on mode of current operation. This value is defined by it. virtual void setEditingMode(bool isEditing) { myIsEditing = isEditing; } @@ -183,16 +216,12 @@ Q_OBJECT /// Sends Update and Redisplay for the given object /// \param theObj is updating object - static void updateObject(ObjectPtr theObj); + void updateObject(ObjectPtr theObj); /// Sends Move event for the given object /// \param theObj is object for moving static void moveObject(ObjectPtr theObj); - /// Sends a message about block/unblock viewer updating - /// \param theValue a boolean value - static void blockUpdateViewer(const bool theValue); - signals: /// The signal about widget values are to be changed void beforeValuesChanged(); @@ -228,6 +257,9 @@ signals: /// The signal about value state modification void valueStateChanged(int theState); + /// The signal is emitted after flush of updates singal for the widget + void objectUpdated(); + protected: /// Sets default value of widget. Normally, widget should fetch this value /// from the xml. However, some widgets derived widgets could define it @@ -254,13 +286,9 @@ protected: /// or store the control value to the feature virtual void initializeValueByActivate(); - /// 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; + virtual bool storeValueCustom() = 0; /// Restore value from attribute data to the widget's control virtual bool restoreValueCustom() = 0; @@ -272,6 +300,8 @@ protected: /// The method called when widget is activated virtual void activateCustom() {}; + QString translateString(const QString& theMsg) const; + protected slots: /// Processing of values changed in model widget by store the current value to the feature void onWidgetValuesChanged(); @@ -280,6 +310,8 @@ protected slots: void onWidgetValuesModified(); protected: + /// own validator, by default it is zero + ModuleBase_WidgetValidator* myWidgetValidator; /// The attribute name of the model feature std::string myAttributeID; @@ -288,12 +320,15 @@ protected slots: FeaturePtr myFeature; /// Flag which shows that current operation is in editing mode - bool myIsEditing; + 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; + /// Flag about value of the control is enabled (can be modified) + EnableState myIsValueEnabled; + /// The widget value state ValueState myState; @@ -301,7 +336,7 @@ 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 + /// the default value, which is defined in the XML for this attribute std::string myDefaultValue; /// an XML internal state @@ -311,8 +346,8 @@ private: bool myUseReset; /// blocked flag of modification of the value state bool myIsValueStateBlocked; - - friend class ModuleBase_OperationFeature; // to call storeValue() by commit if value state is ModifiedInPP + /// do not flush updated signal + bool myFlushUpdateBlocked; }; #endif