X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_ModelWidget.h;h=0b409e6feedb9ce02cd32e60c6224b8e84a938e1;hb=38dd97c8f7a3605ec6c362c3aefdefa3ee2675be;hp=031c5dd421bd24cb9af75dfcb1581db2e2bd9fd5;hpb=055d3c94f677cdf74eca05711fe9dcae89035d58;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_ModelWidget.h b/src/ModuleBase/ModuleBase_ModelWidget.h index 031c5dd42..0b409e6fe 100644 --- a/src/ModuleBase/ModuleBase_ModelWidget.h +++ b/src/ModuleBase/ModuleBase_ModelWidget.h @@ -8,8 +8,7 @@ #define MODULEBASE_MODELWIDGET_H #include -#include - +#include #include #include @@ -17,12 +16,16 @@ #include class Config_WidgetAPI; +class Events_InfoMessage; 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. @@ -33,23 +36,29 @@ class MODULEBASE_EXPORT ModuleBase_ModelWidget : public QWidget { Q_OBJECT public: + /// 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 + + 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 theParentId is Id of a parent of the current attribute - ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData, - const std::string& theParentId); + /// a low-level API for reading xml definitions of widgets + ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData); /// Destructor - virtual ~ModuleBase_ModelWidget() - { - } - - //TODO: nds stabilization hotfix - virtual void disconnectSignals() {}; + virtual ~ModuleBase_ModelWidget(); - /// Fills the widget with default values + /// 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 - virtual bool reset() { return false; }; + bool reset(); /// Returns the state whether the attribute of the feature is initialized /// \param theObject a model feature to be checked @@ -65,49 +74,109 @@ Q_OBJECT /// \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 + /// 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 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; } + /// Returns this parameter value in the xml file + /// \return the boolean result + std::string isModifiedInEdit() const { return myIsModifiedInEdit; } + + /// Returns this widget value state + /// \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 + Events_InfoMessage getValueStateError() const; + /// Defines if it is supposed that the widget should interact with the viewer. virtual bool isViewerSelector() { return false; } /// Defines if it is supported to set the value in this widget /// By default it returns true - virtual bool canSetValue() const { return true; }; + virtual bool canAcceptFocus() 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 + //! \param theValueStateChecked the boolean flag if the state of the widget should be checked + //! \return string value + 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 /// \param theValues the wrapped selection values - /// \param toValidate the boolean value whether the value should be checked by filters - virtual bool setSelection(QList& theValues, + /// \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; + /// Returns values which should be highlighted when the whidget is active + /// \param theValues a list of presentations + virtual void getHighlighted(QList>& theValues) {}; + + /// 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(); + + /// 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. + /// 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(); + /// 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 method called when widget is deactivated - virtual void deactivate() {} + 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); @@ -125,48 +194,77 @@ Q_OBJECT return myAttributeID; } - /// Returns the parent of the attribute - /// \returns the string value - std::string parentID() const - { - return myParentId; - } - /// \return Current feature FeaturePtr feature() const { return myFeature; } + /// \return Context for translation + virtual std::string context() const { + + std::string aContext = myFeatureId; + if(!aContext.empty() && !myAttributeID.empty()) { + aContext += ":"; + } + aContext += myAttributeID; + + return aContext; + } + /// 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. - void setEditingMode(bool isEditing) { myIsEditing = isEditing; } + virtual void setEditingMode(bool isEditing) { myIsEditing = isEditing; } /// \return Current Editing mode bool isEditingMode() const { return myIsEditing; } + /// Returns true if the event is processed. The default implementation is empty, returns false. + virtual bool processEnter(); + + /// Returns true if the event is processed. The default implementation is empty, returns false. + virtual bool processDelete(); + /// 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); + /// Translate passed string with widget context() + virtual QString translate(const std::string& theStr) const; + 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 theObject a sender of the event /// \param theEvent key release event - void keyReleased(QKeyEvent* theEvent); + void keyReleased(QObject* theObject, QKeyEvent* theEvent); + + /// The signal is emitted if the enter is clicked in the control of the widget + /// \param theObject a sender of the event + void enterClicked(QObject* theObject); /// The signal about the widget is get focus /// \param theWidget the model base widget @@ -176,7 +274,13 @@ signals: /// \param theWidget the model base widget void focusOutWidget(ModuleBase_ModelWidget* theWidget); - protected: + /// 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 void setDefaultValue(const std::string& theValue); @@ -187,13 +291,31 @@ signals: myAttributeID = theAttribute; } - /// Saves the internal parameters to the given feature. Emits signals before and after store - /// \return True in success - bool storeValue(); + /// 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 /// \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; + + /// Fills the widget with default values + /// \return true if the widget current value is reset + virtual bool resetCustom() { return false; }; /// The method called when widget is activated virtual void activateCustom() {}; @@ -202,33 +324,54 @@ 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: + /// own validator, by default it is zero + ModuleBase_WidgetValidator* myWidgetValidator; /// The attribute name of the model feature - std::string myAttributeID; - - /// Name of parent - std::string myParentId; + std::string myAttributeID; /// A feature which is processing by active operation - FeaturePtr myFeature; + FeaturePtr myFeature; + + /// A feature ID + std::string myFeatureId; /// 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; + 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; + bool myIsComputedDefault; + + /// the default value, which is defined in the XML for this attribute + std::string myDefaultValue; + + /// an XML internal state + bool myIsInternal; + + // an XML state, the value is not stored into model if the widget is in edit mode + std::string myIsModifiedInEdit; /// 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; + /// do not flush updated signal + bool myFlushUpdateBlocked; }; #endif