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 email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  18 //
  19
  20 #ifndef ModuleBase_WidgetChoice_H
  21 #define ModuleBase_WidgetChoice_H
  22
  23 #include "ModuleBase.h"
  24 #include "ModuleBase_ModelWidget.h"
  25
  26 class QWidget;
  27 class QLabel;
  28 class QComboBox;
  29 class QButtonGroup;
  30
  31 /**
  32 * \ingroup GUI
  33 * Implementation of model widget for choice widget definition (combo box)
  34 * It can be defined as following:
  35 * \code
  36 *   <choice id="bool_type"
  37 *     label="Type"
  38 *     tooltip="Type of boolean operation"
  39 *     string_list="Cut Fuse Common Smash"
  40 *   />
  41 * \endcode
  42 * Aditionally can be used:
  43 * A key "widget_type". It can have values "combobox" or "radiobuttons".
  44 * By default it uses "combobox".
  45 * A key "buttons_dir" which is applicable only for "radiobuttons" mode.
  46 * It defines direction of radiobuttons layout. it can be "vertical" or "horizontal"
  47 * Default value is "vertical"
  48 */
  49 class MODULEBASE_EXPORT ModuleBase_WidgetChoice : public ModuleBase_ModelWidget
  50 {
  51 Q_OBJECT
  52  public:
  53   /// Constructor
  54   /// \param theParent the parent object
  55   /// \param theData the widget configuation. The attribute of the model widget is obtained from
  56   ModuleBase_WidgetChoice(QWidget* theParent, const Config_WidgetAPI* theData);
  57
  58   virtual ~ModuleBase_WidgetChoice();
  59
  60   /// Defines if it is supported to set the value in this widget
  61   /// It returns false because this is an info widget
  62   virtual bool canAcceptFocus() const { return false; };
  63
  64   virtual bool focusTo();
  65
  66   /// Returns list of widget controls
  67   /// \return a controls list
  68   virtual QList<QWidget*> getControls() const;
  69
  70   /// Returns text value for the property panel title
  71   /// \param theIndex a button index
  72   /// \return the title value
  73   QString getPropertyPanelTitle(int theIndex);
  74
  75 signals:
  76   /// Segnal about selected item
  77   /// \param theWidget selected widget
  78   /// \param theIndex selected index
  79   void itemSelected(ModuleBase_ModelWidget* theWidget, int theIndex);
  80
  81 protected:
  82   /// Saves the internal parameters to the given feature
  83   /// \return True in success
  84   virtual bool storeValueCustom();
  85
  86   virtual bool restoreValueCustom();
  87
  88 private slots:
  89   /// Slot called on combo box index change
  90   void onCurrentIndexChanged(int theIndex);
  91
  92 private:
  93   /// The label
  94   QLabel* myLabel;
  95
  96   /// The control
  97   QComboBox* myCombo;
  98   QButtonGroup* myButtons;
  99
 100   // XML definition of titles
 101   QStringList myButtonTitles;
 102 };
 103
 104 #endif