Issue #1303 Re-ordering of Sketcher menus: Delete to be the last

[modules/shaper.git] / src / ModuleBase / ModuleBase_IPropertyPanel.h

diff --git a/src/ModuleBase/ModuleBase_IPropertyPanel.h b/src/ModuleBase/ModuleBase_IPropertyPanel.h
index fdac20d135efb252e1fbd54b82a3ac17938d5fc5..f463cefbed9bf7fd657e2eecc3d90455d9859da9 100644 (file)
--- a/src/ModuleBase/ModuleBase_IPropertyPanel.h
+++ b/src/ModuleBase/ModuleBase_IPropertyPanel.h
@@ -17,11 +17,20 @@
 
 class ModuleBase_ModelWidget;
 
+/**
+* \ingroup GUI
+* A class for Property panel object definition
+*/
 class MODULEBASE_EXPORT ModuleBase_IPropertyPanel : public QDockWidget
 {
 Q_OBJECT
 public:
-  ModuleBase_IPropertyPanel(QWidget* theParent) : QDockWidget(theParent), myIsEditing(false) {}
+  /// Constructor
+  /// \param theParent is a parent of the property panel
+  ModuleBase_IPropertyPanel(QWidget* theParent);
+
+  /// Returns header widget
+  virtual QWidget* headerWidget() const = 0;
 
   /// Returns currently active widget
   virtual ModuleBase_ModelWidget* activeWidget() const = 0;
@@ -29,33 +38,58 @@ public:
   /// Returns all property panel's widget created by WidgetFactory
   virtual const QList<ModuleBase_ModelWidget*>& modelWidgets() const = 0;
 
+  /// Removes all widgets in the widget area of the property panel
+  virtual void cleanContent() = 0;
+
   /// Editing mode depends on mode of current operation. This value is defined by it.
-  void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
-  bool isEditingMode() const { return myIsEditing; }
+  /// \param isEditing state of editing mode flag
+  virtual void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
 
-  /// Set Enable/Disable state of Ok button
-  virtual void setOkEnabled(bool theEnabled) = 0;
+  /// \return State of editing mode flag
+  bool isEditingMode() const { return myIsEditing; }
 
-  /// Returns state of Ok button
-  virtual bool isOkEnabled() const = 0;
+  /// Set focus on the Ok button
+  virtual void setFocusOnOkButton() = 0;
 
-  /// Set Enable/Disable state of Ok button
+  /// Set Enable/Disable state of Cancel button
+  /// \param theEnabled Enable/Disable state of Cancel button
   virtual void setCancelEnabled(bool theEnabled) = 0;
 
-  /// Returns state of Ok button
+  /// \return Enable/Disable state of Cancel button
   virtual bool isCancelEnabled() const = 0;
 
+  /// Returns widget processed by preselection
+  virtual ModuleBase_ModelWidget* preselectionWidget() const = 0;
+
+  /// Sets widget processed by preselection
+  virtual void setPreselectionWidget(ModuleBase_ModelWidget* theWidget) = 0;
+
+  /// Returns the first widget, where canAcceptFocus returns true 
+  /// \return a widget or null
+  ModuleBase_ModelWidget* findFirstAcceptingValueWidget();
+
+  /// Returns the first widget, where canAcceptFocus returns true 
+  /// \return a widget or null
+  static ModuleBase_ModelWidget* findFirstAcceptingValueWidget(
+                          const QList<ModuleBase_ModelWidget*>& theWidgets);
+
 signals:
   /// 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 about the widget activation
+  /// \param theWidget the activated widget
+  void beforeWidgetActivated(ModuleBase_ModelWidget* theWidget);
 
   /// The signal about the widget activation
   /// \param theWidget the activated widget
   void widgetActivated(ModuleBase_ModelWidget* theWidget);
 
   /// Emited when there is no next widget
-  void noMoreWidgets();
+  /// \param thePreviousAttributeID an attribute key of the previous active widget
+  void noMoreWidgets(const std::string& thePreviousAttributeID);
 
 public slots:
   /// Activate the next widget in the property panel
@@ -65,12 +99,19 @@ public slots:
   /// Activate the next from current widget in the property panel
   virtual void activateNextWidget() = 0;
 
-  // Makes the given widget active, highlights it and removes
-  // highlighting from the previous active widget
-  // emits widgetActivated(theWidget) signal
-  virtual void activateWidget(ModuleBase_ModelWidget* theWidget) = 0;
+  /**
+  * Makes the given widget active, highlights it and removes
+  * highlighting from the previous active widget
+  * emits widgetActivated(theWidget) signal
+  * \param theWidget which has to be activated
+  * \param theEmitSignal a flag to prohibit signal emit
+  */
+  virtual void activateWidget(ModuleBase_ModelWidget* theWidget,
+                              const bool theEmitSignal = true) = 0;
 
 protected:
+
+  /// Flag which shows that current operation is in editing mode
   bool myIsEditing;
 };