Salome HOME
registerNotObligatory is not necessary if this property is set in XML.
[modules/shaper.git] / src / ModuleBase / ModuleBase_ModelWidget.h
index d84271454f638bb1c310d83e2ad700cc5739e449..a9f6530b92307f49101ca5cbd64cde7d8b2c1d0e 100644 (file)
@@ -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; }
@@ -92,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
@@ -102,6 +111,10 @@ Q_OBJECT
     return false;
   }
 
+  /// Returns values which should be highlighted when the whidget is active
+  /// \param theValues a list of presentations
+  virtual void getHighlighted(QList<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();
@@ -170,9 +183,12 @@ Q_OBJECT
   /// \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 +197,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 +217,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 +280,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();
@@ -297,12 +315,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 ModuleBase_OperationFeature; // to call storeValue() by commit if value state is ModifiedInPP
+  friend class ModuleBase_OperationFeature; // to call storeValue() by commit if value state is ModifiedInPP
 };
 
 #endif