src/ModuleBase/ModuleBase_IPropertyPanel.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 /*
   4  * ModuleBase_IPropertyPanel.h
   5  *
   6  *  Created on: Oct 01, 2014
   7  *      Author: vsv
   8  */
   9
  10 #ifndef ModuleBase_PROPERTYPANEL_H_
  11 #define ModuleBase_PROPERTYPANEL_H_
  12
  13 #include "ModuleBase.h"
  14
  15 #include <QDockWidget>
  16 #include <QKeyEvent>
  17
  18 class ModuleBase_ModelWidget;
  19
  20 /**
  21 * \ingroup GUI
  22 * A class for Property panel object definition
  23 */
  24 class MODULEBASE_EXPORT ModuleBase_IPropertyPanel : public QDockWidget
  25 {
  26 Q_OBJECT
  27 public:
  28   /// Constructor
  29   /// \param theParent is a parent of the property panel
  30   ModuleBase_IPropertyPanel(QWidget* theParent);
  31
  32   /// Returns header widget
  33   virtual QWidget* headerWidget() const = 0;
  34
  35   /// Returns currently active widget
  36   virtual ModuleBase_ModelWidget* activeWidget() const = 0;
  37
  38   /// Returns all property panel's widget created by WidgetFactory
  39   virtual const QList<ModuleBase_ModelWidget*>& modelWidgets() const = 0;
  40
  41   /// Removes all widgets in the widget area of the property panel
  42   virtual void cleanContent() = 0;
  43
  44   /// Editing mode depends on mode of current operation. This value is defined by it.
  45   /// \param isEditing state of editing mode flag
  46   virtual void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
  47
  48   /// \return State of editing mode flag
  49   bool isEditingMode() const { return myIsEditing; }
  50
  51   /// Set focus on the Ok button
  52   virtual void setFocusOnOkButton() = 0;
  53
  54   /// Set Enable/Disable state of Cancel button
  55   /// \param theEnabled Enable/Disable state of Cancel button
  56   virtual void setCancelEnabled(bool theEnabled) = 0;
  57
  58   /// \return Enable/Disable state of Cancel button
  59   virtual bool isCancelEnabled() const = 0;
  60
  61   /// Returns widget processed by preselection
  62   virtual ModuleBase_ModelWidget* preselectionWidget() const = 0;
  63
  64   /// Sets widget processed by preselection
  65   virtual void setPreselectionWidget(ModuleBase_ModelWidget* theWidget) = 0;
  66
  67   /// Returns the first widget, where canSetValue returns true
  68   /// \return a widget or null
  69   ModuleBase_ModelWidget* findFirstAcceptingValueWidget();
  70
  71   /// Returns the first widget, where canSetValue returns true
  72   /// \return a widget or null
  73   static ModuleBase_ModelWidget* findFirstAcceptingValueWidget(
  74                           const QList<ModuleBase_ModelWidget*>& theWidgets);
  75
  76 signals:
  77   /// The signal about key release on the control, that corresponds to the attribute
  78   /// \param theObject a sender of the event
  79   /// \param theEvent key release event
  80   void keyReleased(QObject* theObject, QKeyEvent* theEvent);
  81
  82   /// The signal about the widget activation
  83   /// \param theWidget the activated widget
  84   void beforeWidgetActivated(ModuleBase_ModelWidget* theWidget);
  85
  86   /// The signal about the widget activation
  87   /// \param theWidget the activated widget
  88   void widgetActivated(ModuleBase_ModelWidget* theWidget);
  89
  90   /// Emited when there is no next widget
  91   /// \param thePreviousAttributeID an attribute key of the previous active widget
  92   void noMoreWidgets(const std::string& thePreviousAttributeID);
  93
  94 public slots:
  95   /// Activate the next widget in the property panel
  96   /// \param theWidget a widget. The next widget should be activated
  97   virtual void activateNextWidget(ModuleBase_ModelWidget* theWidget) = 0;
  98
  99   /// Activate the next from current widget in the property panel
 100   virtual void activateNextWidget() = 0;
 101
 102   /**
 103   * Makes the given widget active, highlights it and removes
 104   * highlighting from the previous active widget
 105   * emits widgetActivated(theWidget) signal
 106   * \param theWidget which has to be activated
 107   * \param theEmitSignal a flag to prohibit signal emit
 108   */
 109   virtual void activateWidget(ModuleBase_ModelWidget* theWidget,
 110                               const bool theEmitSignal = true) = 0;
 111
 112 protected:
 113
 114   /// Flag which shows that current operation is in editing mode
 115   bool myIsEditing;
 116 };
 117
 118 #endif