Gui::WorkbenchManager Class Reference

The WorkbenchManager class manages all workbench objects. More...

#include <WorkbenchManager.h>

Public Member Functions
bool	activate (const std::string &name, const std::string &className)
	Activates the workbench with name name. More...
Workbench *	active () const
	Returns the active workbench. More...
Workbench *	createWorkbench (const std::string &name, const std::string &className)
	Searches for and returns an existing workbench object with name name. More...
Workbench *	getWorkbench (const std::string &name) const
	Returns an instance of the workbench with name name. More...
void	removeWorkbench (const std::string &name)
	Removes the workbench with name name. More...
std::list< std::string >	workbenches () const
	Returns a list of all created workbench objects. More...

Static Public Member Functions
static void	destruct ()
static WorkbenchManager *	instance ()
	Creates the only instance of the WorkbenchManager. More...

Protected Member Functions
	WorkbenchManager ()
	~WorkbenchManager ()

Detailed Description

The WorkbenchManager class manages all workbench objects.

Author

Werner Mayer

Constructor & Destructor Documentation

WorkbenchManager()

WorkbenchManager::WorkbenchManager ( )

protected

Referenced by instance().

~WorkbenchManager()

WorkbenchManager::~WorkbenchManager ( )

protected

References Gui::DockWindowManager::destruct(), Gui::MenuManager::destruct(), and Gui::ToolBarManager::destruct().

Member Function Documentation

activate()

bool WorkbenchManager::activate	(	const std::string &	name,
		const std::string &	className
	)

Activates the workbench with name name.

References Gui::Workbench::activate(), and createWorkbench().

Referenced by ArchBuildingPart.ViewProviderBuildingPart::doubleClicked(), and draftviewproviders.view_layer.ViewProviderLayer::setupContextMenu().

active()

Workbench * WorkbenchManager::active

(

)

const

Returns the active workbench.

Referenced by draftguitools.gui_shapestrings.ShapeString::action(), draftguitools.gui_texts.Text::action(), Gui::Application::activateWorkbench(), Gui::Dialog::DlgCustomToolbarsImp::addCustomCommand(), Gui::Dialog::DlgCustomToolbarsImp::addCustomToolbar(), Gui::MainWindow::changeEvent(), Gui::MainWindow::createPopupMenu(), Gui::Dialog::DlgCustomToolbars::DlgCustomToolbars(), Gui::Dialog::DlgCustomToolbarsImp::moveDownCustomCommand(), Gui::Dialog::DlgCustomToolbarsImp::moveUpCustomCommand(), Gui::Dialog::DlgSettingsLazyLoadedImp::onLoadClicked(), Gui::Dialog::DlgCustomToolbarsImp::removeCustomCommand(), Gui::Dialog::DlgCustomToolbarsImp::removeCustomToolbar(), Gui::Dialog::DlgCustomToolbarsImp::renameCustomToolbar(), Gui::Application::sActiveWorkbenchHandler(), and Gui::Application::setupContextMenu().

createWorkbench()

Workbench * WorkbenchManager::createWorkbench	(	const std::string &	name,
		const std::string &	className
	)

Searches for and returns an existing workbench object with name name.

If no such workbench exists then a workbench of class className gets created, if possible. If the workbench cannot be created 0 is returned.

References Base::BaseClass::getClassTypeId(), Base::Type::getTypeIfDerivedFrom(), getWorkbench(), and Gui::Workbench::setName().

Referenced by activate(), and Gui::Application::activateWorkbench().

destruct()

void WorkbenchManager::destruct ( void  )

static

Referenced by Gui::Application::~Application().

getWorkbench()

Workbench * WorkbenchManager::getWorkbench

(

const std::string &

name

)

const

Returns an instance of the workbench with name name.

If there is no such workbench 0 is returned.

Referenced by Gui::Application::activateWorkbench(), and createWorkbench().

instance()

WorkbenchManager * WorkbenchManager::instance ( void  )

static

Creates the only instance of the WorkbenchManager.

References WorkbenchManager().

Referenced by Gui::Application::activateWorkbench(), Gui::Dialog::DlgCustomToolbarsImp::addCustomCommand(), Gui::Dialog::DlgCustomToolbarsImp::addCustomToolbar(), Gui::Dialog::DlgSettingsLazyLoadedImp::buildUnloadedWorkbenchList(), Gui::MainWindow::changeEvent(), Gui::MainWindow::closeEvent(), Gui::MainWindow::createPopupMenu(), Gui::Dialog::DlgCustomToolbars::DlgCustomToolbars(), Gui::Dialog::DlgCustomToolbarsImp::moveDownCustomCommand(), Gui::Dialog::DlgCustomToolbarsImp::moveUpCustomCommand(), Gui::Dialog::DlgSettingsLazyLoadedImp::onLoadClicked(), Gui::Dialog::DlgCustomToolbarsImp::removeCustomCommand(), Gui::Dialog::DlgCustomToolbarsImp::removeCustomToolbar(), Gui::Dialog::DlgCustomToolbarsImp::renameCustomToolbar(), Gui::Application::sActiveWorkbenchHandler(), Gui::Application::setupContextMenu(), and Gui::Application::sRemoveWorkbenchHandler().

removeWorkbench()

void WorkbenchManager::removeWorkbench

(

const std::string &

name

)

Removes the workbench with name name.

If there is no such workbench exists nothing happens.

Referenced by Gui::Application::sRemoveWorkbenchHandler().

workbenches()

std::list< std::string > WorkbenchManager::workbenches

(

void

)

const

Returns a list of all created workbench objects.

---

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

• FreeCAD/src/Gui/WorkbenchManager.h
• FreeCAD/src/Gui/WorkbenchManager.cpp