Salome HOME
Issue #2388: Remember last user choice for all dialog boxes with a choice
[modules/shaper.git] / src / ModuleBase / ModuleBase_ModelWidget.h
index 29dc34733703637174f7e38f1a32ced3624fb384..d2d0fd804b4d7337f486c23d3334ee329c7d43a2 100644 (file)
 #define MODULEBASE_MODELWIDGET_H
 
 #include <ModuleBase.h>
+#include <ModuleBase_ActionType.h>
+#include <ModuleBase_Definitions.h>
 #include <ModuleBase_OperationFeature.h>
+#include <ModuleBase_ActionInfo.h>
+#include <ModuleBase_ActionParameter.h>
 #include <ModelAPI_Feature.h>
 
+#include <SelectMgr_ListOfFilter.hxx>
+
 #include <QWidget>
 
 #include <memory>
@@ -80,6 +86,17 @@ Q_OBJECT
   /// \return the boolean result
   bool isInitialized(ObjectPtr theObject) const;
 
+  /// Fills given container with selection modes if the widget has it
+  /// \param [out] theModuleSelectionModes module additional modes, -1 means all default modes
+  /// \param [out] theModes a container of modes
+  virtual void selectionModes(int& theModuleSelectionModes, QIntList& theModes);
+
+  /// Appends into container of workshop selection filters
+  /// \param [out] theModuleSelectionFilters module additional modes, -1 means all default modes
+  /// \param [out] theSelectionFilters selection filters
+  virtual void selectionFilters(QIntList& theModuleSelectionFilters,
+                                SelectMgr_ListOfFilter& theSelectionFilters);
+
   /// Returns true, if default value of the widget should be computed
   /// on operation's execute, like radius for circle's constraint (can not be zero)
   bool isComputedDefault() const { return myIsComputedDefault; }
@@ -183,6 +200,14 @@ Q_OBJECT
   /// The method called when widget is deactivated
   virtual void deactivate();
 
+  /// Opportunity to do something after the active widget of the property panel changed
+  virtual void updateAfterDeactivation() {}
+  /// Opportunity to do something after the active widget of the property panel changed
+  virtual void updateAfterActivation() {}
+
+  /// The method called if widget should be activated always
+  virtual bool needToBeActiated() { return false; }
+
   /// Returns list of widget controls
   /// \return a control list
   virtual QList<QWidget*> getControls() const = 0;
@@ -240,20 +265,24 @@ Q_OBJECT
   /// \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 action can be processed. By default it is empty and returns false.
+  /// \param theActionType an action type
+  /// \param isActionEnabled if true, the enable state of the action
+  virtual bool canProcessAction(ModuleBase_ActionType theActionType, bool& isActionEnabled);
 
   /// Returns true if the event is processed. The default implementation is empty, returns false.
-  virtual bool processDelete();
+  virtual bool processAction(ModuleBase_ActionType theActionType,
+                             const ActionParamPtr& theParam = ActionParamPtr());
+
+  /// Returns list of accessible actions for Undo/Redo commands. By default it returns empty list.
+  /// \param theActionType type of action. It can be ActionUndo or ActionRedo.
+  virtual QList<ActionInfo> actionsList(ModuleBase_ActionType theActionType) const
+  { return QList<ActionInfo>(); }
 
   /// Sends Update and Redisplay for the given object
   /// \param theObj is updating object
   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;
 
@@ -266,6 +295,15 @@ Q_OBJECT
   /// \return a model widget or NULL
   static ModuleBase_ModelWidget* findModelWidget(ModuleBase_IPropertyPanel* theProp,
                                                  QWidget* theWidget);
+
+  /// Returns True if the widget uses feature attribute.
+  /// If not then it means that the widget do not need attribute at all.
+  virtual bool usesAttribute() const { return true; }
+
+  /// It is called when user press Ok or OkPlus buttons in the parent property panel
+  /// By default this slot does nothing
+  virtual void onFeatureAccepted() {}
+
 signals:
   /// The signal about widget values are to be changed
   void beforeValuesChanged();
@@ -344,7 +382,19 @@ protected:
   /// The method called when widget is activated
   virtual void activateCustom() {};
 
-protected slots:
+    //// 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 processEscape();
+
+  //// Returns true if the event is processed. The default implementation is empty, returns false.
+  virtual bool processDelete();
+
+  /// Returns true if envent is processed. It applyes workshop selection for the widget attribute.
+  virtual bool processSelection();
+
+  protected slots:
   /// Processing of values changed in model widget by store the current value to the feature
   void onWidgetValuesChanged();