X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_WidgetToolbox.h;h=f92d79f4c2cc706f113825751ba72a488a64cd10;hb=561ec84c4405975d78d8cd7d50c5bfa6dba8d738;hp=348ecb248b921a104c3c9d410aaccde5c0ff878a;hpb=0a04bcd634373c65391611ca0e818d432e71ada5;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_WidgetToolbox.h b/src/ModuleBase/ModuleBase_WidgetToolbox.h index 348ecb248..f92d79f4c 100644 --- a/src/ModuleBase/ModuleBase_WidgetToolbox.h +++ b/src/ModuleBase/ModuleBase_WidgetToolbox.h @@ -14,19 +14,29 @@ class ModuleBase_PageBase; class ModuleBase_ToolBox; +/** +* \ingroup GUI +* Implements a model widget for switch as a container widget. It can be defined in XML with "toolbox" keyword +*/ class MODULEBASE_EXPORT ModuleBase_WidgetToolbox : public ModuleBase_PagedContainer { Q_OBJECT public: - ModuleBase_WidgetToolbox(QWidget* theParent, const Config_WidgetAPI* theData, - const std::string& theParentId); + /// Constructor + /// \param theParent the parent object + /// \param theData the widget configuration. The attribute of the model widget is obtained from + ModuleBase_WidgetToolbox(QWidget* theParent, const Config_WidgetAPI* theData); virtual ~ModuleBase_WidgetToolbox(); /// Defines if it is supported to set the value in this widget - /// It returns false because this is an info widget - virtual bool canSetValue() const { return false; }; - - /// Overrides ModuleBase_PagedContainer + /// \return false because this is an info widget + virtual bool canAcceptFocus() const { return false; }; + + /// Add a page to the widget + /// \param theWidget a page widget + /// \param theName a name of page + /// \param theCaseId an Id of the page + /// \param theIcon an icon of the page virtual int addPage( ModuleBase_PageBase* theWidget, const QString& theName, const QString& theCaseId, @@ -35,6 +45,7 @@ class MODULEBASE_EXPORT ModuleBase_WidgetToolbox : public ModuleBase_PagedContai protected: /// Implements ModuleBase_PagedContainer virtual int currentPageIndex() const; + /// Implements ModuleBase_PagedContainer virtual void setCurrentPageIndex(int);