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...
PyObject * getPyObject ()
	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::ToolBarItem * setupCommandBars () const
	Defines the standard command bars. More...
Gui::MenuItem * setupMenuBar () const
	Defines the standard menus. More...
Gui::ToolBarItem * setupToolBars () const
	Defines the standard toolbars. More...
Protected Member Functions inherited from Gui::StdWorkbench
virtual DockWindowItems * setupDockWindows () 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

Reimplemented from Gui::Workbench.

References PartDesignGui::WorkflowManager::destruct().

Member Function Documentation

activated()

void Workbench::activated ( )

virtual

Run some actions when the workbench gets activated.

Reimplemented from Gui::Workbench.

References Gui::Workbench::activated(), Gui::Workbench::addTaskWatcher(), Gui::Control(), App::GetApplication(), PartDesignGui::WorkflowManager::init(), Gui::Application::Instance, Gui::ControlSingleton::showTaskView(), Gui::Application::signalActiveDocument, App::Application::signalDeleteDocument, App::Application::signalFinishRestoreDocument, and App::Application::signalNewDocument.

deactivated()

void Workbench::deactivated ( )

virtual

Run some actions when the workbench gets deactivated.

Reimplemented from Gui::Workbench.

References Gui::Workbench::deactivated(), Gui::Command::Doc, App::GetApplication(), Gui::Application::Instance, Gui::Workbench::removeTaskWatcher(), Gui::Application::signalActiveDocument, App::Application::signalDeleteDocument, App::Application::signalFinishRestoreDocument, and App::Application::signalNewDocument.

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

Add custom entries to the context menu.

Reimplemented from Gui::StdWorkbench.

References Gui::Application::activeView(), Part::BodyBase::BaseFeature, App::Document::countObjectsOfType(), Gui::SelectionSingleton::countObjectsOfType(), Gui::BaseView::getAppDocument(), PartDesignGui::getBodyFor(), Base::Persistence::getClassTypeId(), App::DocumentObject::getDocument(), Gui::SelectionSingleton::getSelection(), App::PropertyLink::getValue(), Gui::MenuItem::hasItems(), App::OriginGroupExtension::hasObject(), Gui::Application::Instance, PartDesign::Body::isAllowed(), Base::BaseClass::isDerivedFrom(), PartDesignGui::isModernWorkflow(), Gui::Selection(), and Gui::StdWorkbench::setupContextMenu().

setupMenuBar()

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

protectedvirtual

Defines the standard menus.

Reimplemented from Gui::StdWorkbench.

References Gui::MenuItem::findItem(), Gui::MenuItem::insertItem(), Gui::Application::Instance, and Gui::MenuItem::setCommand().

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:

• src/Mod/PartDesign/Gui/Workbench.h
• src/Mod/PartDesign/Gui/Workbench.cpp