Salome HOME
Property pannel refactoring: focus processing in paged widgets
[modules/shaper.git] / src / XGUI / XGUI_PropertyPanel.h
index 92de955c1be82289da83263a317104d10e7afb08..cc9ba8aeb45453793c1b5cf1f08d4e9c64cedfa1 100644 (file)
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 /*
  * XGUI_PropertyPanel.h
  *
 #ifndef XGUI_PROPERTYPANEL_H_
 #define XGUI_PROPERTYPANEL_H_
 
-#include <ModuleBase_IModelWidget.h>
+#include "XGUI.h"
+
+#include <ModuleBase_ModelWidget.h>
+#include <ModuleBase_IPropertyPanel.h>
 
-#include <QDockWidget>
 #include <QList>
 
-class XGUI_PropertyPanel: public QDockWidget
+class XGUI_ActionsMgr;
+class QKeyEvent;
+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:
+Q_OBJECT
+ public:
+
+  /// Constructor
+  /// \param theParent is a parent of the property panel
   XGUI_PropertyPanel(QWidget* theParent);
+
   virtual ~XGUI_PropertyPanel();
 
-  QWidget* contentWidget();
-  void setModelWidgets(const QList<ModuleBase_IModelWidget*>& theWidgets);
+  /// Returns main widget of the property panel, which children will be created
+  /// by WidgetFactory using the XML definition
+  ModuleBase_PageBase* contentWidget();
+
+  /// Brings back all widget created by widget factory for signal/slot
+  /// connections and further processing
+  void setModelWidgets(const QList<ModuleBase_ModelWidget*>& theWidgets);
+
+  /// Returns all property panel's widget created by WidgetFactory
+  virtual const QList<ModuleBase_ModelWidget*>& modelWidgets() const;
+
+  /// Removes all widgets in the widget area of the property panel
+  void cleanContent();
+
+  /// Returns currently active widget
+  virtual ModuleBase_ModelWidget* activeWidget() const { return myActiveWidget; }
+
+  /// Activate the next widget in the property panel
+  /// \param theWidget a widget. The next widget should be activated
+  virtual void activateNextWidget(ModuleBase_ModelWidget* theWidget);
+
+  /// Activate the next from current widget in the property panel
+  virtual void activateNextWidget();
+
+  /// 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;
+
+  /// 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);
+
+  //! 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);
 
-public slots:
-  void updateContentWidget();
+  /**
+  * 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;
+ private:
+  ModuleBase_PageWidget* myPanelPage;
+  QList<ModuleBase_ModelWidget*> myWidgets;
 
-  QList<ModuleBase_IModelWidget*> myWidgets;
+  /// Currently active widget
+  ModuleBase_ModelWidget* myActiveWidget;
 };
 
 #endif /* XGUI_PROPERTYPANEL_H_ */