]> SALOME platform Git repositories - modules/shaper.git/blob - src/ModuleBase/ModuleBase_WidgetChoice.h
Salome HOME
Provide On Plane filter and reading of validators for filters GUI definition
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetChoice.h
1 // Copyright (C) 2014-2019  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
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 ModuleBase_ChoiceCtrl;
28
29 /**
30 * \ingroup GUI
31 * Implementation of model widget for choice widget definition (combo box)
32 * It can be defined as following:
33 * \code
34 *   <choice id="bool_type" 
35 *     label="Type" 
36 *     tooltip="Type of boolean operation"
37 *     string_list="Cut Fuse Common Smash"
38 *   />
39 * \endcode
40 * Aditionally can be used: 
41 * A key "widget_type". It can have values "combobox" or "radiobuttons".
42 * By default it uses "combobox".
43 * A key "buttons_dir" which is applicable only for "radiobuttons" mode.
44 * It defines direction of radiobuttons layout. it can be "vertical" or "horizontal"
45 * Default value is "vertical"
46 */
47 class MODULEBASE_EXPORT ModuleBase_WidgetChoice : public ModuleBase_ModelWidget
48 {
49 Q_OBJECT
50  public:
51   /// Constructor
52   /// \param theParent the parent object
53   /// \param theData the widget configuation. The attribute of the model widget is obtained from
54   ModuleBase_WidgetChoice(QWidget* theParent, const Config_WidgetAPI* theData);
55
56   virtual ~ModuleBase_WidgetChoice();
57
58   /// Defines if it is supported to set the value in this widget
59   /// It returns false because this is an info widget
60   virtual bool canAcceptFocus() const { return false; };
61
62   virtual bool focusTo();
63
64   /// Returns list of widget controls
65   /// \return a controls list
66   virtual QList<QWidget*> getControls() const;
67
68   /// Returns text value for the property panel title
69   /// \param theIndex a button index
70   /// \return the title value
71   QString getPropertyPanelTitle(int theIndex);
72
73   /// The slot is called when user press Ok or OkPlus buttons in the parent property panel
74   virtual void onFeatureAccepted();
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   ModuleBase_ChoiceCtrl* myChoiceCtrl;
95
96   // XML definition of titles
97   QStringList myButtonTitles;
98   std::string myStringListAttribute;
99
100   bool myIsFirst;
101   int myDefValue;
102   bool myHasValue;
103 };
104
105 #endif