Salome HOME
Issue 1299 Angle constraint: support of additional and complementary angles. Test...
[modules/shaper.git] / src / ModuleBase / ModuleBase_ToolBox.h
index 2b48b0849d7fe9c436a2d955678a5ec17c82800d..cab3a788d93399d0a0a5fd2777e24943c1ec8817 100644 (file)
@@ -14,24 +14,51 @@ class QButtonGroup;
 class QFrame;
 class QHBoxLayout;
 class QStackedWidget;
+class ModuleBase_ModelWidget;
 
+/**
+ * \class ModuleBase_ToolBox
+ * \ingroup GUI
+ * \brief An extension of QFrame object
+ */
 class MODULEBASE_EXPORT ModuleBase_ToolBox : public QFrame
 {
   Q_OBJECT
 
 public:
+  /// Constructor
+  /// \param theParent a parent widget
   ModuleBase_ToolBox( QWidget* theParent );
   virtual ~ModuleBase_ToolBox();
 
-  void addItem( QWidget* thePage, const QString& theName, const QIcon& theIcon );
+  ///  Add a new item to the tool box
+  /// \param thePage a widget of the new item
+  /// \param theName a name of the item
+  /// \param theIcon an icon of the item
+  void addItem( QWidget* thePage, const QString& theName, const QPixmap& theIcon );
+
+  /// \return number of items
   int count() const;
+
+  /// \return index of current widget
   int currentIndex() const;
-  void setCurrentIndex( const int );
+
+  /// Set current item
+  /// \param theIdx an index
+  void setCurrentIndex( const int theIdx);
+
+  /// Found in the controls of the model widget parent in Stacked Widget
+  /// returns whether this controls are in the current widget of the stacked widgets
+  /// \param theWidget a model widget
+  /// \return boolean result
+  static bool isOffToolBoxParent(ModuleBase_ModelWidget* theWidget);
 
 signals:
+  /// A signal which is emited on current item changed
   void currentChanged( int );
 
 private slots:
+  /// A slot called on button press
   void onButton( int );
 
 private: