StartGui::Workbench Class Reference

#include <Workbench.h>

Public Member Functions

virtual void activated ()
 Run some actions when the workbench gets activated. More...
 
virtual void setupContextMenu (const char *recipient, Gui::MenuItem *) const
 Defines the standard context menu. More...
 
 Workbench ()
 
virtual ~Workbench ()
 
- Public Member Functions inherited from Gui::StdWorkbench
virtual void createMainWindowPopupMenu (MenuItem *) const
 Sets up the contextmenu for the main window for this workbench. More...
 
virtual void setupContextMenu (const char *recipient, MenuItem *) const
 Defines the standard context menu. More...
 
 StdWorkbench ()
 
virtual ~StdWorkbench ()
 
- Public Member Functions inherited from Gui::Workbench
bool activate ()
 Activates the workbench and adds/removes GUI elements. More...
 
virtual void activated ()
 Run some actions when the workbench gets activated. More...
 
void addTaskWatcher (const std::vector< Gui::TaskView::TaskWatcher * > &Watcher)
 helper to add TaskWatcher to the TaskView More...
 
virtual void createMainWindowPopupMenu (MenuItem *) const
 Sets up the contextmenu for the main window for this workbench. More...
 
virtual void deactivated ()
 Run some actions when the workbench gets deactivated. More...
 
PyObjectgetPyObject ()
 The default implementation returns an instance of WorkbenchPy. More...
 
std::list< std::pair< std::string, std::list< std::string > > > getToolbarItems () const
 Shows a list of all toolbars and their commands. More...
 
std::list< std::string > listCommandbars () const
 
std::list< std::string > listMenus () const
 
std::list< std::string > listToolbars () const
 
std::string name () const
 Returns the name of the workbench object. More...
 
void removeTaskWatcher (void)
 remove the added TaskWatcher More...
 
void retranslate () const
 Translates the window titles of all menus, toolbars and dock windows. More...
 
void setName (const std::string &)
 Set the name to the workbench object. More...
 
virtual void setupContextMenu (const char *recipient, MenuItem *) const
 Sets up the contextmenu for this workbench. More...
 
 Workbench ()
 Constructs a workbench object. More...
 
virtual ~Workbench ()
 
- Public Member Functions inherited from Base::BaseClass
 BaseClass ()
 Construction. More...
 
 BaseClass (const BaseClass &)=default
 
virtual PyObjectgetPyObject ()
 This method returns the Python wrapper for a C++ object. More...
 
virtual Type getTypeId () const
 
bool isDerivedFrom (const Type type) const
 
BaseClassoperator= (const BaseClass &)=default
 
virtual void setPyObject (PyObject *)
 
virtual ~BaseClass ()
 Destruction. More...
 

Static Public Member Functions

static void loadStartPage ()
 
- Static Public Member Functions inherited from Gui::Workbench
static void addPermanentMenuItem (const std::string &cmd, const std::string &after)
 Add a permanent menu item cmd after an existing command after. More...
 
static void createLinkMenu (MenuItem *)
 
static void removePermanentMenuItem (const std::string &cmd)
 Removes the command cmd from the permanent menu items. More...
 
- Static Public Member Functions inherited from Base::BaseClass
static void * create ()
 
static Type getClassTypeId ()
 
static void init ()
 

Protected Member Functions

virtual Gui::ToolBarItemsetupCommandBars () const
 Defines the standard command bars. More...
 
virtual Gui::DockWindowItemssetupDockWindows () const
 Returns a DockWindowItems structure of dock windows this workbench. More...
 
virtual Gui::MenuItemsetupMenuBar () const
 Defines the standard menus. More...
 
virtual Gui::ToolBarItemsetupToolBars () const
 Defines the standard toolbars. More...
 
virtual ToolBarItemsetupCommandBars () const
 Defines the standard command bars. More...
 
virtual DockWindowItemssetupDockWindows () const
 Returns a DockWindowItems structure of dock windows this workbench. More...
 
virtual MenuItemsetupMenuBar () const
 Defines the standard menus. More...
 
virtual ToolBarItemsetupToolBars () const
 Defines the standard toolbars. More...
 
- Protected Member Functions inherited from Gui::Workbench
void addPermanentMenuItems (MenuItem *) const
 Add permanent menu items to the structure. More...
 
virtual ToolBarItemsetupCommandBars () const =0
 Returns a ToolBarItem tree structure of command bars for this workbench. More...
 
virtual DockWindowItemssetupDockWindows () const =0
 Returns a DockWindowItems structure of dock windows this workbench. More...
 
virtual MenuItemsetupMenuBar () const =0
 Returns a MenuItem tree structure of menus for this workbench. More...
 
virtual ToolBarItemsetupToolBars () const =0
 Returns a ToolBarItem tree structure of toolbars for this workbench. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from Base::BaseClass
static void initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=nullptr)
 

Detailed Description

Author
Werner Mayer

Constructor & Destructor Documentation

◆ Workbench()

Workbench::Workbench ( )

◆ ~Workbench()

Workbench::~Workbench ( )
virtual

Reimplemented from Gui::Workbench.

Member Function Documentation

◆ activated()

void Workbench::activated ( )
virtual

Run some actions when the workbench gets activated.

Reimplemented from Gui::Workbench.

◆ loadStartPage()

◆ setupCommandBars()

Gui::ToolBarItem * Workbench::setupCommandBars ( ) const
protectedvirtual

Defines the standard command bars.

Reimplemented from Gui::StdWorkbench.

◆ setupContextMenu()

void Workbench::setupContextMenu ( const char *  recipient,
Gui::MenuItem item 
) const
virtual

Defines the standard context menu.

Reimplemented from Gui::StdWorkbench.

◆ setupDockWindows()

Gui::DockWindowItems * Workbench::setupDockWindows ( ) const
protectedvirtual

Returns a DockWindowItems structure of dock windows this workbench.

Reimplemented from Gui::StdWorkbench.

References Gui::StdWorkbench::setupDockWindows(), and Gui::DockWindowItems::setVisibility().

◆ setupMenuBar()

Gui::MenuItem * Workbench::setupMenuBar ( ) const
protectedvirtual

Defines the standard menus.

Reimplemented from Gui::StdWorkbench.

References Gui::StdWorkbench::setupMenuBar().

◆ setupToolBars()

Gui::ToolBarItem * Workbench::setupToolBars ( ) const
protectedvirtual

Defines the standard toolbars.

Reimplemented from Gui::StdWorkbench.

References Gui::ToolBarItem::setCommand().


The documentation for this class was generated from the following files: