X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_ModelWidget.h;h=b08a0a55122549bd5e61a8ba5559986029c0cbba;hb=450d1bd65c11870d3942a30164518037b9a7503e;hp=8adb5bc7682306b89c2037bff1b43af353ecc8a0;hpb=ef21d3a2bf6bf7d922b4ecfa114128b0a7fde161;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_ModelWidget.h b/src/ModuleBase/ModuleBase_ModelWidget.h index 8adb5bc76..b08a0a551 100644 --- a/src/ModuleBase/ModuleBase_ModelWidget.h +++ b/src/ModuleBase/ModuleBase_ModelWidget.h @@ -9,7 +9,7 @@ #include #include - +#include #include #include @@ -17,6 +17,7 @@ #include class Config_WidgetAPI; +class ModuleBase_IWorkshop; class QKeyEvent; /**\class ModuleBase_ModelWidget @@ -32,9 +33,15 @@ class MODULEBASE_EXPORT ModuleBase_ModelWidget : public QWidget { Q_OBJECT public: - /// Constructor + /// State of the widget + enum ValueState { Stored, /// modification is finished and applyed to the model + ModifiedInPP, /// modification has not been finished and set to the model yet + ModifiedInViewer, /// modification performed by viewer events + Reset }; /// the value is reset + + /// Constructor /// \param theParent the parent object - /// \param theData the widget configuation. The attribute of the model widget is obtained from + /// \param theData the widget configuration. The attribute of the model widget is obtained from /// \param theParentId is Id of a parent of the current attribute ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData, const std::string& theParentId); @@ -43,8 +50,10 @@ Q_OBJECT { } - /// Fills the widget with default values - virtual void reset() {}; + /// Fills the widget with default values. It calls the resetCustom method and change + /// the widget state to Reset if the reset is performed. + /// \return true if the widget current value is reset + bool reset(); /// Returns the state whether the attribute of the feature is initialized /// \param theObject a model feature to be checked @@ -60,10 +69,26 @@ Q_OBJECT /// \return the boolean result std::string getDefaultValue() const { return myDefaultValue; } + /// Returns true, if widget is internal + /// \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 /// \return the boolean result bool isObligatory() const { return myIsObligatory; } + /// Returns this parameter value in the xml file + /// \return the boolean result + bool isUseReset() const { return myUseReset; } + + /// Returns this widget value state + /// \return the enumeration result + ValueState getValueState() const { return myState; } + + /// Returns an attribute error according to the value state + /// It exists in all cases excepring the "Store" case + QString getValueStateError() const; + /// Defines if it is supposed that the widget should interact with the viewer. virtual bool isViewerSelector() { return false; } @@ -71,32 +96,48 @@ Q_OBJECT /// By default it returns true virtual bool canSetValue() const { return true; }; + //! 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 + //! \return string value + QString getError() const; + /// 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 theToValidate the boolean value whether the value should be checked by filters + virtual bool setSelection(QList& theValues, + const bool theToValidate) { return false; } - /// Restore value from attribute data to the widget's control - virtual bool restoreValue() = 0; + /// 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. /// If the widget has the NonFocus focus policy, it is skipped. /// \return the state whether the widget can accept the focus virtual bool focusTo(); - /// The methiod called when widget is activated + /// Select the internal content if it can be selected. It is empty in the default realization + virtual void selectContent() {} + + /// The method called when widget is activated void activate(); - /// The methiod called when widget is deactivated - virtual void deactivate() {} + /// The method called when widget is deactivated + virtual void deactivate(); /// Returns list of widget controls /// \return a control list virtual QList getControls() const = 0; + /// Returns the first or the last control that can accept the focus + /// \param isFirst if true, the first controls is returned or the last one + /// \return a control from a list of controls + QWidget* getControlAcceptingFocus(const bool isFirst); + /// FocusIn events processing virtual bool eventFilter(QObject* theObject, QEvent *theEvent); @@ -128,6 +169,7 @@ 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); @@ -137,18 +179,39 @@ Q_OBJECT /// \return Current Editing mode bool isEditingMode() const { return myIsEditing; } + /// Returns true if the event is processed. + virtual bool processEnter(); + + /// Sends Update and Redisplay for the given object + /// \param theObj is updating object + static void updateObject(ObjectPtr theObj); + + /// Sends Move event for the given object + /// \param theObj is object for moving + static void moveObject(ObjectPtr theObj); + 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 modified + void valuesModified(); /// The signal about widget values are to be changed void afterValuesChanged(); + /// The signal about widget values are to be restored + void beforeValuesRestored(); + /// The signal about widget values are to be restored + void afterValuesRestored(); + /// The signal about key release on the control, that corresponds to the attribute /// \param theEvent key release event void keyReleased(QKeyEvent* theEvent); + /// The signal is emitted if the enter is clicked in the control of the widget + void enterClicked(); + /// The signal about the widget is get focus /// \param theWidget the model base widget void focusInWidget(ModuleBase_ModelWidget* theWidget); @@ -157,8 +220,11 @@ signals: /// \param theWidget the model base widget void focusOutWidget(ModuleBase_ModelWidget* theWidget); - protected: - /// Sets default value of widget. Nornaly, widget should fetch this value + /// The signal about value state modification + void valueStateChanged(int theState); + +protected: + /// Sets default value of widget. Normally, 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 @@ -168,6 +234,21 @@ signals: myAttributeID = theAttribute; } + /// Sets the current value state. If the value is changed, the signal is emitted + /// If the current value state is Blocked, this method do nothing + /// \param theState a new state + /// \return the previous value state + ValueState setValueState(const ValueState& theState); + + /// Blocks the value state change. + /// \param theBlocked a block state + /// \return the previous value + bool blockValueState(const bool theBlocked); + + /// Compute the feature default value and fill the controls with it + /// 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(); @@ -176,31 +257,37 @@ signals: /// \return True in success virtual bool storeValueCustom() const = 0; - /// The methiod called when widget is activated - virtual void activateCustom() {}; + /// Restore value from attribute data to the widget's control + virtual bool restoreValueCustom() = 0; - /// Sends Update and Redisplay for the given object - /// \param theObj is updating object - void updateObject(ObjectPtr theObj) const; + /// Fills the widget with default values + /// \return true if the widget current value is reset + virtual bool resetCustom() { return false; }; - /// Sends Move event for the given object - /// \param theObj is object for moving - void moveObject(ObjectPtr theObj) const; + /// The method called when widget is activated + virtual void activateCustom() {}; + + /// Sends a message about block/unblock viewer updating + /// \param theValue a boolean value + static void blockUpdateViewer(const bool theValue); protected slots: /// Processing of values changed in model widget by store the current value to the feature void onWidgetValuesChanged(); + /// Changes widget state. + void onWidgetValuesModified(); + protected: /// The attribute name of the model feature - std::string myAttributeID; + std::string myAttributeID; /// Name of parent - std::string myParentId; + std::string myParentId; /// A feature which is processing by active operation - FeaturePtr myFeature; + FeaturePtr myFeature; /// Flag which shows that current operation is in editing mode bool myIsEditing; @@ -209,12 +296,25 @@ protected slots: /// The non-obligatory widgets should not accept the focus in the property panel bool myIsObligatory; + /// The widget value state + ValueState myState; + private: /// Value should be computed on execute, like radius for circle's constraint (can not be zero) - bool myIsComputedDefault; - + bool myIsComputedDefault; + /// the default value, which is defined in the XML for this attribute - std::string myDefaultValue; + std::string myDefaultValue; + + /// an XML internal state + bool myIsInternal; + + /// the reset state. If it is false, the reset method of the widget is not performed + 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 }; #endif