X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_ModelWidget.h;h=c21ef7e8a294424d050639b0321b3aea7337b956;hb=5446f2f59af5cb087347b8b83ef830e2d69128dd;hp=dd2c9edd3a1817899a8cddbdeafce020525f1005;hpb=f34fba2433c87ccdf824df0dc8c34099054b1715;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_ModelWidget.h b/src/ModuleBase/ModuleBase_ModelWidget.h index dd2c9edd3..c21ef7e8a 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 @@ -18,6 +17,8 @@ class Config_WidgetAPI; class ModuleBase_IWorkshop; +class ModuleBase_ViewerPrs; +class ModuleBase_WidgetValidator; class QKeyEvent; /**\class ModuleBase_ModelWidget @@ -39,12 +40,11 @@ Q_OBJECT ModifiedInViewer, /// modification performed by viewer events Reset }; /// the value is reset - /// Constructor + /// 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() { @@ -69,6 +69,10 @@ 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; } @@ -81,32 +85,64 @@ 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; + /// 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 theToValidate the boolean value whether the value should be checked by filters - virtual bool setSelection(QList& theValues, + virtual bool setSelection(QList>& theValues, const bool theToValidate) { return false; } + /// 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. /// 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(); @@ -139,13 +175,6 @@ 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 { @@ -155,20 +184,25 @@ 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. - 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. + /// 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 @@ -190,8 +224,13 @@ signals: 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 @@ -204,6 +243,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 @@ -230,13 +272,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; @@ -248,10 +286,6 @@ protected: /// 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(); @@ -260,13 +294,12 @@ 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; - /// Name of parent - std::string myParentId; - /// A feature which is processing by active operation FeaturePtr myFeature; @@ -287,10 +320,15 @@ private: /// the default value, which is defined in the XML for this attribute 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; + /// do not flush updated signal + bool myFlushUpdateBlocked; }; #endif