Update classes documentation

[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetChoice.h

diff --git a/src/ModuleBase/ModuleBase_WidgetChoice.h b/src/ModuleBase/ModuleBase_WidgetChoice.h
index 72f6df4cd2e15eebbe100559cd7b8e4d6f7ba0d8..f88a56e7f57690911f73070c5f8a469ab484a7fc 100644 (file)
--- a/src/ModuleBase/ModuleBase_WidgetChoice.h
+++ b/src/ModuleBase/ModuleBase_WidgetChoice.h
@@ -13,6 +13,7 @@
 class QWidget;
 class QLabel;
 class QComboBox;
+class QButtonGroup;
 
 /**
 * \ingroup GUI
@@ -22,9 +23,15 @@ class QComboBox;
 *   <choice id="bool_type" 
 *     label="Type" 
 *     tooltip="Type of boolean operation"
-*     string_list="Cut Fuse Common"
+*     string_list="Cut Fuse Common Smash"
 *   />
 * \endcode
+* Aditionally can be used: 
+* A key "widget_type". It can have values "combobox" or "radiobuttons".
+* By default it uses "combobox".
+* A key "buttons_dir" which is applicable only for "radiobuttons" mode.
+* It defines direction of radiobuttons layout. it can be "vertical" or "horizontal"
+* Default value is "vertical"
 */
 class MODULEBASE_EXPORT ModuleBase_WidgetChoice : public ModuleBase_ModelWidget
 {
@@ -33,22 +40,35 @@ Q_OBJECT
   /// Constructor
   /// \param theParent the parent object
   /// \param theData the widget configuation. The attribute of the model widget is obtained from
-  /// \param theParentId is Id of a parent of the current attribute
-  ModuleBase_WidgetChoice(QWidget* theParent, const Config_WidgetAPI* theData, 
-                          const std::string& theParentId);
+  ModuleBase_WidgetChoice(QWidget* theParent, const Config_WidgetAPI* theData);
 
   virtual ~ModuleBase_WidgetChoice();
-  
+
+  /// Defines if it is supported to set the value in this widget
+  /// It returns false because this is an info widget
+  virtual bool canAcceptFocus() const { return false; };
+
   virtual bool focusTo();
 
   /// Returns list of widget controls
   /// \return a controls list
   virtual QList<QWidget*> getControls() const;
 
+  /// Returns text value for the property panel title
+  /// \param theIndex a button index
+  /// \return the title value
+  QString getPropertyPanelTitle(int theIndex);
+
+signals:
+  /// Segnal about selected item
+  /// \param theWidget selected widget
+  /// \param theIndex selected index
+  void itemSelected(ModuleBase_ModelWidget* theWidget, int theIndex);
+
 protected:
   /// Saves the internal parameters to the given feature
   /// \return True in success
-  virtual bool storeValueCustom() const;
+  virtual bool storeValueCustom();
 
   virtual bool restoreValueCustom();
 
@@ -62,6 +82,10 @@ private:
 
   /// The control
   QComboBox* myCombo;
+  QButtonGroup* myButtons;
+
+  // XML definition of titles
+  QStringList myButtonTitles;
 };
 
 #endif