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:
- ModuleBase_ToolBox( QWidget* theParent );
+ /// Constructor
+ /// \param theParent a parent widget
+ /// \param theUseFrameStyleBox a flag if the tool box should have box covered
+ /// buttons and current page
+ ModuleBase_ToolBox(QWidget* theParent, const bool theUseFrameStyleBox = false);
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:
- void currentChanged( int );
+ /// A signal which is emited on current item changed
+ void currentChanged(int);
private slots:
- void onButton( int );
+ /// A slot called on button press
+ void onButton(int);
private:
QButtonGroup* myButtonsGroup;
