Salome HOME
ModuleBase_ViewerPrs is wrapped into shared_ptr: remove include of this class from...
[modules/shaper.git] / src / ModuleBase / ModuleBase_ModelWidget.h
index 25ccc5aa1abcf8d967e09a4791cef9d9fcc22969..6712bc0299d715372cd3edb805c5bece054dc25c 100644 (file)
@@ -8,8 +8,7 @@
 #define MODULEBASE_MODELWIDGET_H
 
 #include <ModuleBase.h>
-#include <ModuleBase_ViewerPrs.h>
-
+#include <ModuleBase_OperationFeature.h>
 #include <ModelAPI_Feature.h>
 
 #include <QWidget>
@@ -18,6 +17,7 @@
 
 class Config_WidgetAPI;
 class ModuleBase_IWorkshop;
+class ModuleBase_ViewerPrs;
 class QKeyEvent;
 
 /**\class ModuleBase_ModelWidget
@@ -39,12 +39,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);
+  /// \param theData a low-level API for reading xml definitions of widgets
+  ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData);
   /// Destructor
   virtual ~ModuleBase_ModelWidget()
   {
@@ -69,6 +68,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; }
@@ -90,18 +93,27 @@ Q_OBJECT
 
   /// 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
+  //! \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
   /// \param theToValidate the boolean value whether the value should be checked by filters
-  virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
+  virtual bool setSelection(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& 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<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues) {};
+
   /// Restore value from attribute data to the widget's control. Emits signals before and after store
   /// \return True in success
   bool restoreValue();
@@ -146,13 +158,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
   {
@@ -165,14 +170,17 @@ Q_OBJECT
   void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false);
 
   /// 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);
@@ -181,6 +189,10 @@ Q_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();
@@ -197,11 +209,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
-  void enterClicked();
+  /// \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
@@ -258,10 +272,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();
@@ -274,9 +284,6 @@ protected slots:
   /// 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;
 
@@ -297,10 +304,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