src/ModuleBase/ModuleBase_WidgetChoice.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModuleBase_WidgetChoice.h
   4 // Created:     03 Sept 2014
   5 // Author:      Vitaly Smetannikov
   6
   7 #ifndef ModuleBase_WidgetChoice_H
   8 #define ModuleBase_WidgetChoice_H
   9
  10 #include "ModuleBase.h"
  11 #include "ModuleBase_ModelWidget.h"
  12
  13 class QWidget;
  14 class QLabel;
  15 class QComboBox;
  16 class QButtonGroup;
  17
  18 /**
  19 * \ingroup GUI
  20 * Implementation of model widget for choice widget definition (combo box)
  21 * It can be defined as following:
  22 * \code
  23 *   <choice id="bool_type"
  24 *     label="Type"
  25 *     tooltip="Type of boolean operation"
  26 *     string_list="Cut Fuse Common"
  27 *   />
  28 * \endcode
  29 * Aditionally can be used:
  30 * A key "widget_type". It can have values "combobox" or "radiobuttons".
  31 * By default it uses "combobox".
  32 * A key "buttons_dir" which is applicable only for "radiobuttons" mode.
  33 * It defines direction of radiobuttons layout. it can be "vertical" or "horizontal"
  34 * Default value is "vertical"
  35 */
  36 class MODULEBASE_EXPORT ModuleBase_WidgetChoice : public ModuleBase_ModelWidget
  37 {
  38 Q_OBJECT
  39  public:
  40   /// Constructor
  41   /// \param theParent the parent object
  42   /// \param theData the widget configuation. The attribute of the model widget is obtained from
  43   ModuleBase_WidgetChoice(QWidget* theParent, const Config_WidgetAPI* theData);
  44
  45   virtual ~ModuleBase_WidgetChoice();
  46
  47   /// Defines if it is supported to set the value in this widget
  48   /// It returns false because this is an info widget
  49   virtual bool canSetValue() const { return false; };
  50
  51   virtual bool focusTo();
  52
  53   /// Returns list of widget controls
  54   /// \return a controls list
  55   virtual QList<QWidget*> getControls() const;
  56
  57   /// Returns text value for the property panel title
  58   /// \param theIndex a button index
  59   /// \return the title value
  60   QString getPropertyPanelTitle(int theIndex);
  61
  62 signals:
  63   void itemSelected(ModuleBase_ModelWidget* theWidget, int theIndex);
  64
  65 protected:
  66   /// Saves the internal parameters to the given feature
  67   /// \return True in success
  68   virtual bool storeValueCustom() const;
  69
  70   virtual bool restoreValueCustom();
  71
  72 private slots:
  73   /// Slot called on combo box index change
  74   void onCurrentIndexChanged(int theIndex);
  75
  76 private:
  77   /// The label
  78   QLabel* myLabel;
  79
  80   /// The control
  81   QComboBox* myCombo;
  82   QButtonGroup* myButtons;
  83
  84   // XML definition of titles
  85   QStringList myButtonTitles;
  86 };
  87
  88 #endif