PartDesignGui::Workbench Class Reference

#include <Workbench.h>

Public Member Functions

virtual void activated ()
 Run some actions when the workbench gets activated. More...
 
virtual void deactivated ()
 Run some actions when the workbench gets deactivated. More...
 
virtual void setupContextMenu (const char *recipient, Gui::MenuItem *) const
 Add custom entries to the 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...
 
 StdWorkbench ()
 
virtual ~StdWorkbench ()
 
- Public Member Functions inherited from Gui::Workbench
bool activate ()
 Activates the workbench and adds/removes GUI elements. More...
 
void addTaskWatcher (const std::vector< Gui::TaskView::TaskWatcher * > &Watcher)
 helper to add TaskWatcher to the TaskView 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...
 
 Workbench ()
 Constructs a workbench object. More...
 
- Public Member Functions inherited from Base::BaseClass
 BaseClass ()
 Construction. More...
 
virtual Type getTypeId (void) const
 
bool isDerivedFrom (const Type type) const
 
virtual void setPyObject (PyObject *)
 
virtual ~BaseClass ()
 Destruction. More...
 

Protected Member Functions

Gui::ToolBarItemsetupCommandBars () const
 Defines the standard command bars. More...
 
Gui::MenuItemsetupMenuBar () const
 Defines the standard menus. More...
 
Gui::ToolBarItemsetupToolBars () const
 Defines the standard toolbars. More...
 
- Protected Member Functions inherited from Gui::StdWorkbench
virtual DockWindowItemssetupDockWindows () const
 Returns a DockWindowItems structure of dock windows this workbench. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Gui::Workbench
static void createLinkMenu (MenuItem *)
 
- Static Public Member Functions inherited from Base::BaseClass
static void * create (void)
 
static Type getClassTypeId (void)
 
static void init (void)
 
- 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

Member Function Documentation

◆ activated()

◆ deactivated()

◆ setupCommandBars()

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

Defines the standard command bars.

Reimplemented from Gui::StdWorkbench.

◆ setupContextMenu()

◆ setupMenuBar()

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

◆ 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:
  • Sources/FreeCAD/src/Mod/PartDesign/Gui/Workbench.h
  • Sources/FreeCAD/src/Mod/PartDesign/Gui/Workbench.cpp