src/ModuleBase/ModuleBase_WidgetChoice.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef ModuleBase_WidgetChoice_H
  22 #define ModuleBase_WidgetChoice_H
  23
  24 #include "ModuleBase.h"
  25 #include "ModuleBase_ModelWidget.h"
  26
  27 class QWidget;
  28 class QLabel;
  29 class QComboBox;
  30 class QButtonGroup;
  31
  32 /**
  33 * \ingroup GUI
  34 * Implementation of model widget for choice widget definition (combo box)
  35 * It can be defined as following:
  36 * \code
  37 *   <choice id="bool_type"
  38 *     label="Type"
  39 *     tooltip="Type of boolean operation"
  40 *     string_list="Cut Fuse Common Smash"
  41 *   />
  42 * \endcode
  43 * Aditionally can be used:
  44 * A key "widget_type". It can have values "combobox" or "radiobuttons".
  45 * By default it uses "combobox".
  46 * A key "buttons_dir" which is applicable only for "radiobuttons" mode.
  47 * It defines direction of radiobuttons layout. it can be "vertical" or "horizontal"
  48 * Default value is "vertical"
  49 */
  50 class MODULEBASE_EXPORT ModuleBase_WidgetChoice : public ModuleBase_ModelWidget
  51 {
  52 Q_OBJECT
  53  public:
  54   /// Constructor
  55   /// \param theParent the parent object
  56   /// \param theData the widget configuation. The attribute of the model widget is obtained from
  57   ModuleBase_WidgetChoice(QWidget* theParent, const Config_WidgetAPI* theData);
  58
  59   virtual ~ModuleBase_WidgetChoice();
  60
  61   /// Defines if it is supported to set the value in this widget
  62   /// It returns false because this is an info widget
  63   virtual bool canAcceptFocus() const { return false; };
  64
  65   virtual bool focusTo();
  66
  67   /// Returns list of widget controls
  68   /// \return a controls list
  69   virtual QList<QWidget*> getControls() const;
  70
  71   /// Returns text value for the property panel title
  72   /// \param theIndex a button index
  73   /// \return the title value
  74   QString getPropertyPanelTitle(int theIndex);
  75
  76 signals:
  77   /// Segnal about selected item
  78   /// \param theWidget selected widget
  79   /// \param theIndex selected index
  80   void itemSelected(ModuleBase_ModelWidget* theWidget, int theIndex);
  81
  82 protected:
  83   /// Saves the internal parameters to the given feature
  84   /// \return True in success
  85   virtual bool storeValueCustom();
  86
  87   virtual bool restoreValueCustom();
  88
  89 private slots:
  90   /// Slot called on combo box index change
  91   void onCurrentIndexChanged(int theIndex);
  92
  93 private:
  94   /// The label
  95   QLabel* myLabel;
  96
  97   /// The control
  98   QComboBox* myCombo;
  99   QButtonGroup* myButtons;
 100
 101   // XML definition of titles
 102   QStringList myButtonTitles;
 103   std::string myStringListAttribute;
 104 };
 105
 106 #endif