Property pannel refactoring: focus processing in paged widgets

[modules/shaper.git] / src / XGUI / XGUI_PropertyPanel.h

diff --git a/src/XGUI/XGUI_PropertyPanel.h b/src/XGUI/XGUI_PropertyPanel.h
index 04c4d1ed3c5521bfe40ab28368bc5de21968f906..cc9ba8aeb45453793c1b5cf1f08d4e9c64cedfa1 100644 (file)
--- a/src/XGUI/XGUI_PropertyPanel.h
+++ b/src/XGUI/XGUI_PropertyPanel.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 /*
  * XGUI_PropertyPanel.h
  *
@@ -15,19 +17,42 @@
 
 #include <QList>
 
+class XGUI_ActionsMgr;
 class QKeyEvent;
-class QVBoxLayout;
+class QGridLayout;
+class ModuleBase_PageBase;
+class ModuleBase_PageWidget;
+
+/// Internal name of property panel widget
+const static char* PROP_PANEL = "property_panel_dock";
+
+/// Internal name of Ok button
+const static char* PROP_PANEL_OK = "property_panel_ok";
+
+/// Internal name of Cancel button
+const static char* PROP_PANEL_CANCEL = "property_panel_cancel";
 
+/// Internal name of Help button
+const static char* PROP_PANEL_HELP = "property_panel_help";
+
+/**
+* \ingroup GUI
+* Realization of Property panel object.
+*/
 class XGUI_EXPORT XGUI_PropertyPanel : public ModuleBase_IPropertyPanel
 {
 Q_OBJECT
  public:
+
+  /// Constructor
+  /// \param theParent is a parent of the property panel
   XGUI_PropertyPanel(QWidget* theParent);
+
   virtual ~XGUI_PropertyPanel();
 
   /// Returns main widget of the property panel, which children will be created
   /// by WidgetFactory using the XML definition
-  QWidget* contentWidget();
+  ModuleBase_PageBase* contentWidget();
 
   /// Brings back all widget created by widget factory for signal/slot
   /// connections and further processing
@@ -49,28 +74,39 @@ Q_OBJECT
   /// Activate the next from current widget in the property panel
   virtual void activateNextWidget();
 
- public slots:
-  void updateContentWidget(FeaturePtr theFeature);
-  // Enables / disables "ok" ("accept") button
-  void setAcceptEnabled(bool);
+  /// Set Enable/Disable state of Cancel button
+  /// \param theEnabled Enable/Disable state of Cancel button
+  virtual void setCancelEnabled(bool theEnabled);
+
+  /// \return Enable/Disable state of Cancel button
+  virtual bool isCancelEnabled() const;
 
- protected slots:
-  // Makes the given widget active, highlights it and removes
-  // highlighting from the previous active widget
-  // emits widgetActivated(theWidget) signal
-  void activateWidget(ModuleBase_ModelWidget* theWidget);
+  /// Editing mode depends on mode of current operation. This value is defined by it.
+  /// \param isEditing state of editing mode flag
+  virtual void setEditingMode(bool isEditing);
 
- signals:
-  /// Signal about the point 2d set to the feature
-  /// \param the feature
-  /// \param the attribute of the feature
-  void storedPoint2D(ObjectPtr theFeature, const std::string& theAttribute);
+  //! Allows to set predefined actions for the property panel fetched from the ActionsMgr
+  void setupActions(XGUI_ActionsMgr* theMgr);
 
+ public slots:
+
+   /// \brief Update all widgets in property panel with values from the given feature
+   /// \param theFeature a Feature to update values in widgets
+  void updateContentWidget(FeaturePtr theFeature);
+
+  /**
+  * 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
+  */
+  virtual void activateWidget(ModuleBase_ModelWidget* theWidget);
 
  private:
-  QWidget* myCustomWidget;
+  ModuleBase_PageWidget* myPanelPage;
   QList<ModuleBase_ModelWidget*> myWidgets;
-  QVBoxLayout* myMainLayout;
+
+  /// Currently active widget
   ModuleBase_ModelWidget* myActiveWidget;
 };