+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
/*
* XGUI_PropertyPanel.h
*
#include "XGUI.h"
#include <ModuleBase_ModelWidget.h>
+#include <ModuleBase_IPropertyPanel.h>
-#include <QDockWidget>
#include <QList>
+class XGUI_ActionsMgr;
class QKeyEvent;
-class QVBoxLayout;
+class QGridLayout;
+class ModuleBase_PageBase;
+class ModuleBase_PageWidget;
+class XGUI_OperationMgr;
+
+/// 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";
-class XGUI_EXPORT XGUI_PropertyPanel: public QDockWidget
+/// 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:
- XGUI_PropertyPanel(QWidget* theParent);
+Q_OBJECT
+ public:
+
+ /// Constructor
+ /// \param theParent is a parent of the property panel
+ XGUI_PropertyPanel(QWidget* theParent, XGUI_OperationMgr* theMgr);
+
virtual ~XGUI_PropertyPanel();
- QWidget* contentWidget();
+ /// Returns header widget
+ virtual QWidget* headerWidget() const { return myHeaderWidget; }
+
+ /// 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);
- const QList<ModuleBase_ModelWidget*>& modelWidgets() const;
- void cleanContent();
+ /// Returns all property panel's widget created by WidgetFactory
+ virtual const QList<ModuleBase_ModelWidget*>& modelWidgets() const;
-protected:
- virtual bool eventFilter(QObject *theObject, QEvent *theEvent);
+ /// Removes all widgets in the widget area of the property panel
+ virtual 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 focus on the Ok button
+ virtual void setFocusOnOkButton();
+
+ /// 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);
+
+ /// Returns widget processed by preselection
+ virtual ModuleBase_ModelWidget* preselectionWidget() const;
+
+ /// Sets widget processed by preselection
+ virtual void setPreselectionWidget(ModuleBase_ModelWidget* theWidget);
+
+ /// Returns operation manager
+ XGUI_OperationMgr* operationMgr() const { return myOperationMgr; }
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);
- /// slot to activate the next widget in the property panel
- /// \param theWidget a widget. The next widget should be activated
- void onActivateNextWidget(ModuleBase_ModelWidget* theWidget);
- // Enables / disables "ok" ("accept") button
- void setAcceptEnabled(bool);
-
-signals:
- /// The signal about key release on the control, that corresponds to the attribute
- /// \param theAttributeName a name of the attribute
- /// \param theEvent key release event
- void keyReleased(const std::string& theAttributeName, QKeyEvent* theEvent);
- /// The signal about the widget activation
- /// \param theWidget the activated widget
- void widgetActivated(ModuleBase_ModelWidget* theWidget);
-
- /// 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);
-
-private:
- QWidget* myCustomWidget;
+ /**
+ * 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);
+
+ void onFocusNextPrev();
+
+protected:
+ /// Makes the widget active, deactivate the previous, activate and hightlight the given one
+ /// \param theWidget a widget
+ void setActiveWidget(ModuleBase_ModelWidget* theWidget);
+
+ /// The parent method that processes the "Tab"/"SHIF + Tab" keyboard events
+ /// Emits a signal about focus change
+ /// If theIsNext is true, this function searches forward, if next is false, it searches backward.
+ virtual bool focusNextPrevChild(bool theIsNext);
+
+ protected:
+ /// A method called on the property panel closed
+ /// \param theEvent a close event
+ void closeEvent(QCloseEvent* theEvent);
+
+ /// A header widget
+ QWidget* myHeaderWidget;
+
+ private:
+ ModuleBase_PageWidget* myPanelPage;
QList<ModuleBase_ModelWidget*> myWidgets;
- QVBoxLayout* myMainLayout;
+ /// Currently active widget
+ ModuleBase_ModelWidget* myActiveWidget;
+ /// Currently widget processed by preselection
+ ModuleBase_ModelWidget* myPreselectionWidget;
+
+ XGUI_OperationMgr* myOperationMgr;
};
#endif /* XGUI_PROPERTYPANEL_H_ */
