The PythonWorkbench class allows the manipulation of the workbench from Python. More...
#include <Workbench.h>
Public Member Functions | |
virtual void createMainWindowPopupMenu (MenuItem *) const | |
Sets up the contextmenu for the main window for this workbench. More... | |
PythonWorkbench () | |
virtual void setupContextMenu (const char *recipient, MenuItem *) const | |
Defines the standard context menu. More... | |
~PythonWorkbench () | |
![]() | |
PyObject * getPyObject () | |
Creates and returns immediately the corresponding Python workbench object. More... | |
PythonBaseWorkbench () | |
~PythonBaseWorkbench () | |
void appendMenu (const std::list< std::string > &menu, const std::list< std::string > &items) const | |
Appends a new menu. More... | |
void removeMenu (const std::string &menu) const | |
Removes a menu. More... | |
void appendContextMenu (const std::list< std::string > &menu, const std::list< std::string > &items) const | |
Appends new context menu items. More... | |
void removeContextMenu (const std::string &menu) const | |
Removes a context menu. More... | |
void clearContextMenu () | |
void appendToolbar (const std::string &bar, const std::list< std::string > &items) const | |
Appends a new toolbar. More... | |
void removeToolbar (const std::string &bar) const | |
Removes a toolbar. More... | |
void appendCommandbar (const std::string &bar, const std::list< std::string > &items) const | |
Appends a new command bar. More... | |
void removeCommandbar (const std::string &bar) const | |
Removes a command bar. More... | |
![]() | |
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 deactivated () | |
Run some actions when the workbench gets deactivated. 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... | |
virtual ~Workbench () | |
![]() | |
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 | |
ToolBarItem * setupCommandBars () const | |
Returns a ToolBarItem tree structure of command bars for this workbench. More... | |
DockWindowItems * setupDockWindows () const | |
Returns a DockWindowItems structure of dock windows this workbench. More... | |
MenuItem * setupMenuBar () const | |
Returns a MenuItem tree structure of menus for this workbench. More... | |
ToolBarItem * setupToolBars () const | |
Returns a ToolBarItem tree structure of toolbars for this workbench. More... | |
![]() |
Additional Inherited Members | |
![]() | |
static void createLinkMenu (MenuItem *) | |
![]() | |
static void * create (void) | |
static Type getClassTypeId (void) | |
static void init (void) | |
![]() | |
static void initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=nullptr) | |
Detailed Description
The PythonWorkbench class allows the manipulation of the workbench from Python.
Therefore PythonWorkbenchPy provides the required Python interface.
Constructor & Destructor Documentation
◆ PythonWorkbench()
PythonWorkbench::PythonWorkbench | ( | ) |
References Gui::StdWorkbench::setupMenuBar(), and Gui::StdWorkbench::setupToolBars().
◆ ~PythonWorkbench()
PythonWorkbench::~PythonWorkbench | ( | ) |
Member Function Documentation
◆ createMainWindowPopupMenu()
|
virtual |
Sets up the contextmenu for the main window for this workbench.
The default implementation does nothing.
Reimplemented from Gui::Workbench.
References Gui::StdWorkbench::createMainWindowPopupMenu().
◆ setupCommandBars()
|
protectedvirtual |
Returns a ToolBarItem tree structure of command bars for this workbench.
Reimplemented from Gui::PythonBaseWorkbench.
References Gui::ToolBarItem::copy().
◆ setupContextMenu()
|
virtual |
Defines the standard context menu.
Reimplemented from Gui::PythonBaseWorkbench.
References Gui::StdWorkbench::setupContextMenu(), and Gui::PythonBaseWorkbench::setupContextMenu().
◆ setupDockWindows()
|
protectedvirtual |
Returns a DockWindowItems structure of dock windows this workbench.
Reimplemented from Gui::PythonBaseWorkbench.
References Gui::StdWorkbench::setupDockWindows().
◆ setupMenuBar()
|
protectedvirtual |
Returns a MenuItem tree structure of menus for this workbench.
Reimplemented from Gui::PythonBaseWorkbench.
References Gui::MenuItem::copy().
◆ setupToolBars()
|
protectedvirtual |
Returns a ToolBarItem tree structure of toolbars for this workbench.
Reimplemented from Gui::PythonBaseWorkbench.
References Gui::ToolBarItem::copy().
The documentation for this class was generated from the following files:
- src/Gui/Workbench.h
- src/Gui/Workbench.cpp