Salome HOME
Improve multi-selector control to provide items multi-selection and "Delete" context...
[modules/shaper.git] / src / ModuleBase / ModuleBase_ModelWidget.h
index 8804fdbeb0a95038d1713a3eb02eb3fde6f145da..b08a0a55122549bd5e61a8ba5559986029c0cbba 100644 (file)
@@ -9,7 +9,7 @@
 
 #include <ModuleBase.h>
 #include <ModuleBase_ViewerPrs.h>
-
+#include <ModuleBase_OperationFeature.h>
 #include <ModelAPI_Feature.h>
 
 #include <QWidget>
@@ -35,8 +35,9 @@ Q_OBJECT
  public:
    /// State of the widget
    enum ValueState { Stored, /// modification is finished and applyed to the model
-                     Modified, /// modification has not been finished and set to the model yet
-                     Reset };
+                     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
@@ -68,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; }
@@ -80,6 +85,10 @@ Q_OBJECT
   /// \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; }
 
@@ -87,6 +96,11 @@ 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 theValues the wrapped selection values
@@ -101,25 +115,29 @@ Q_OBJECT
   /// \return True in success
   bool restoreValue();
 
-  /// Saves the internal parameters to the given feature. Emits signals before and after store
-  /// \return True in success
-  void storeValueByApply();
-
   /// 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<QWidget*> 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);
 
@@ -162,7 +180,7 @@ Q_OBJECT
   bool isEditingMode() const { return myIsEditing; }
 
   /// Returns true if the event is processed.
-  virtual bool isEventProcessed(QKeyEvent* theEvent);
+  virtual bool processEnter();
 
   /// Sends Update and Redisplay for the given object
   /// \param theObj is updating object
@@ -191,6 +209,9 @@ signals:
   /// \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);
@@ -200,7 +221,7 @@ signals:
   void focusOutWidget(ModuleBase_ModelWidget* theWidget);
 
   /// The signal about value state modification
-  void valueStateChanged();
+  void valueStateChanged(int theState);
 
 protected:
   /// Sets default value of widget. Normally, widget should fetch this value
@@ -214,8 +235,19 @@ protected:
   }
 
   /// 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
-  void setValueState(const ValueState& theState);
+  /// \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
@@ -274,8 +306,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;
+
+  friend class ModuleBase_OperationFeature; // to call storeValue() by commit if value state is ModifiedInPP
 };
 
 #endif