The python export class for PythonBaseWorkbench. More...
#include <PythonWorkbenchPy.h>
Public Types | |
typedef PythonBaseWorkbench * | PointerType |
Public Types inherited from Gui::WorkbenchPy | |
typedef Workbench * | PointerType |
Public Types inherited from Base::BaseClassPy | |
typedef BaseClass * | PointerType |
Public Types inherited from Base::PyObjectBase | |
typedef void * | PointerType |
enum | Status { Valid = 0, Immutable = 1, Notify = 2, NoTrack = 3 } |
Public Member Functions | |
virtual PyTypeObject * | GetType (void) |
virtual int | PyInit (PyObject *args, PyObject *k) |
PyInit method Override this method to initialize a newly created instance of the class (Constructor) More... | |
PythonWorkbenchPy (PythonBaseWorkbench *pcObject, PyTypeObject *T=&Type) | |
std::string | representation (void) const |
callbacks and implementers for the python object attributes | |
PyObject * | getCustomAttributes (const char *attr) const |
getter method for special attributes (e.g. dynamic ones) More... | |
int | setCustomAttributes (const char *attr, PyObject *obj) |
setter for special attributes (e.g. More... | |
PythonBaseWorkbench * | getPythonBaseWorkbenchPtr (void) const |
getter for the object handled by this class More... | |
Public Member Functions inherited from Gui::WorkbenchPy | |
std::string | representation (void) const |
WorkbenchPy (Workbench *pcObject, PyTypeObject *T=&Type) | |
PyObject * | getCustomAttributes (const char *attr) const |
getter method for special attributes (e.g. dynamic ones) More... | |
int | setCustomAttributes (const char *attr, PyObject *obj) |
setter for special attributes (e.g. More... | |
Workbench * | getWorkbenchPtr (void) const |
getter for the object handled by this class More... | |
PyObject * | name (PyObject *args) |
implementer for the name() method More... | |
PyObject * | activate (PyObject *args) |
implementer for the activate() method More... | |
Public Member Functions inherited from Base::BaseClassPy | |
BaseClassPy (BaseClass *pcObject, PyTypeObject *T=&Type) | |
std::string | representation (void) const |
PyObject * | isDerivedFrom (PyObject *args) |
implementer for the isDerivedFrom() method More... | |
PyObject * | getAllDerivedFrom (PyObject *args) |
implementer for the getAllDerivedFrom() method More... | |
Py::String | getTypeId (void) const |
getter for the TypeId attribute More... | |
Py::String | getModule (void) const |
getter for the Module attribute More... | |
PyObject * | getCustomAttributes (const char *attr) const |
getter method for special attributes (e.g. dynamic ones) More... | |
int | setCustomAttributes (const char *attr, PyObject *obj) |
setter for special attributes (e.g. More... | |
BaseClass * | getBaseClassPtr (void) const |
getter for the object handled by this class More... | |
Public Member Functions inherited from Base::PyObjectBase | |
PyObjectBase * | DecRef (void) |
decref method wrapper (see python extending manual) More... | |
PyObjectBase * | IncRef (void) |
incref method wrapper (see python extending manual) More... | |
bool | isConst () |
bool | isNotTracking () const |
bool | isValid () |
PyObjectBase (void *, PyTypeObject *T) | |
Constructor Sets the Type of the object (for inheritance) and decrease the the reference count of the PyObject. More... | |
void | setConst () |
void | setInvalid () |
void | setNotTracking (bool on=true) |
void | setShouldNotify (bool on) |
bool | shouldNotify () const |
void | startNotify () |
Static Public Member Functions | |
static PyObject * | PyMake (struct _typeobject *, PyObject *, PyObject *) |
Static Public Member Functions inherited from Gui::WorkbenchPy | |
static PyObject * | PyMake (struct _typeobject *, PyObject *, PyObject *) |
static PyObject * | staticCallback_name (PyObject *self, PyObject *args) |
callback for the name() method More... | |
static PyObject * | staticCallback_activate (PyObject *self, PyObject *args) |
callback for the activate() method More... | |
Static Public Member Functions inherited from Base::BaseClassPy | |
static PyObject * | PyMake (struct _typeobject *, PyObject *, PyObject *) |
static PyObject * | staticCallback_isDerivedFrom (PyObject *self, PyObject *args) |
callback for the isDerivedFrom() method More... | |
static PyObject * | staticCallback_getAllDerivedFrom (PyObject *self, PyObject *args) |
callback for the getAllDerivedFrom() method More... | |
static PyObject * | staticCallback_getTypeId (PyObject *self, void *closure) |
getter callback for the TypeId attribute More... | |
static int | staticCallback_setTypeId (PyObject *self, PyObject *value, void *closure) |
setter callback for the TypeId attribute More... | |
static PyObject * | staticCallback_getModule (PyObject *self, void *closure) |
getter callback for the Module attribute More... | |
static int | staticCallback_setModule (PyObject *self, PyObject *value, void *closure) |
setter callback for the Module attribute More... | |
Static Public Member Functions inherited from Base::PyObjectBase | |
static void | PyDestructor (PyObject *P) |
Wrapper for the Python destructor. More... | |
Static Public Attributes | |
static PyGetSetDef | GetterSetter [] |
Attribute structure of PythonWorkbenchPy. More... | |
static PyMethodDef | Methods [] |
Methods structure of PythonWorkbenchPy. More... | |
static PyTypeObject | Type |
Type structure of PythonWorkbenchPy. More... | |
Static Public Attributes inherited from Gui::WorkbenchPy | |
static PyGetSetDef | GetterSetter [] |
Attribute structure of WorkbenchPy. More... | |
static PyMethodDef | Methods [] |
Methods structure of WorkbenchPy. More... | |
static PyTypeObject | Type |
Type structure of WorkbenchPy. More... | |
Static Public Attributes inherited from Base::BaseClassPy | |
static PyGetSetDef | GetterSetter [] |
Attribute structure of BaseClassPy. More... | |
static PyMethodDef | Methods [] |
Methods structure of BaseClassPy. More... | |
static PyTypeObject | Type |
Type structure of BaseClassPy. More... | |
Static Public Attributes inherited from Base::PyObjectBase | |
static PyMethodDef | Methods [] |
static PyTypeObject | Type |
Py_Header struct from python.h. More... | |
Protected Member Functions | |
~PythonWorkbenchPy () | |
Protected Member Functions inherited from Gui::WorkbenchPy | |
~WorkbenchPy () | |
Protected Member Functions inherited from Base::BaseClassPy | |
~BaseClassPy () | |
Protected Member Functions inherited from Base::PyObjectBase | |
virtual | ~PyObjectBase () |
destructor More... | |
Additional Inherited Members | |
Protected Attributes inherited from Base::PyObjectBase | |
std::bitset< 32 > | StatusBits |
Detailed Description
The python export class for PythonBaseWorkbench.
Member Typedef Documentation
◆ PointerType
Constructor & Destructor Documentation
◆ ~PythonWorkbenchPy()
|
protected |
◆ PythonWorkbenchPy()
PythonWorkbenchPy::PythonWorkbenchPy | ( | PythonBaseWorkbench * | pcObject, |
PyTypeObject * | T = &Type |
||
) |
Member Function Documentation
◆ appendCommandbar()
implementer for the appendCommandbar() method
Appends a new command bar.
References Gui::PythonBaseWorkbench::appendCommandbar(), and getPythonBaseWorkbenchPtr().
Referenced by AppendCommandbar(), InitGui.TemplatePyModWorkbench::Initialize(), Mod.Test.InitGui.TestWorkbench::Initialize(), and staticCallback_appendCommandbar().
◆ AppendCommandbar()
implementer for the AppendCommandbar() method
References appendCommandbar().
Referenced by staticCallback_AppendCommandbar().
◆ appendContextMenu()
implementer for the appendContextMenu() method
Appends new context menu items.
References Gui::PythonBaseWorkbench::appendContextMenu(), and getPythonBaseWorkbenchPtr().
Referenced by AppendContextMenu(), InitGui.DraftWorkbench::ContextMenu(), InitGui.PathWorkbench::ContextMenu(), InitGui.ArchWorkbench::ContextMenu(), and staticCallback_appendContextMenu().
◆ AppendContextMenu()
implementer for the AppendContextMenu() method
References appendContextMenu().
Referenced by staticCallback_AppendContextMenu().
◆ appendMenu()
implementer for the appendMenu() method
Appends a new menu.
References Gui::PythonBaseWorkbench::appendMenu(), and getPythonBaseWorkbenchPtr().
Referenced by AppendMenu(), InitGui.TemplatePyModWorkbench::Initialize(), InitGui.PlotWorkbench::Initialize(), InitGui.ShipWorkbench::Initialize(), Mod.Test.InitGui.TestWorkbench::Initialize(), InitGui.OpenSCADWorkbench::Initialize(), and staticCallback_appendMenu().
◆ AppendMenu()
implementer for the AppendMenu() method
References appendMenu().
Referenced by staticCallback_AppendMenu().
◆ appendToolbar()
implementer for the appendToolbar() method
Appends a new toolbar.
References Gui::PythonBaseWorkbench::appendToolbar(), and getPythonBaseWorkbenchPtr().
Referenced by AppendToolbar(), InitGui.TemplatePyModWorkbench::Initialize(), InitGui.PlotWorkbench::Initialize(), InitGui.ShipWorkbench::Initialize(), Mod.Test.InitGui.TestWorkbench::Initialize(), InitGui.OpenSCADWorkbench::Initialize(), staticCallback_appendToolbar(), and Mod.Test.Workbench.WorkbenchTestCase::testHandler().
◆ AppendToolbar()
implementer for the AppendToolbar() method
References appendToolbar().
Referenced by staticCallback_AppendToolbar().
◆ getCustomAttributes()
PyObject * PythonWorkbenchPy::getCustomAttributes | ( | const char * | attr | ) | const |
getter method for special attributes (e.g. dynamic ones)
◆ getPythonBaseWorkbenchPtr()
PythonBaseWorkbench * PythonWorkbenchPy::getPythonBaseWorkbenchPtr | ( | void | ) | const |
getter for the object handled by this class
Referenced by appendCommandbar(), appendContextMenu(), appendMenu(), appendToolbar(), removeCommandbar(), removeContextMenu(), removeMenu(), and removeToolbar().
◆ GetType()
|
virtual |
Reimplemented from Gui::WorkbenchPy.
◆ listCommandbars()
implementer for the listCommandbars() method
Referenced by ListCommandbars(), and staticCallback_listCommandbars().
◆ ListCommandbars()
implementer for the ListCommandbars() method
References listCommandbars().
Referenced by staticCallback_ListCommandbars().
◆ listMenus()
implementer for the listMenus() method
Referenced by ListMenus(), and staticCallback_listMenus().
◆ ListMenus()
implementer for the ListMenus() method
References listMenus().
Referenced by staticCallback_ListMenus().
◆ listToolbars()
implementer for the listToolbars() method
Referenced by ListToolbars(), and staticCallback_listToolbars().
◆ ListToolbars()
implementer for the ListToolbars() method
References listToolbars().
Referenced by staticCallback_ListToolbars().
◆ PyInit()
PyInit method Override this method to initialize a newly created instance of the class (Constructor)
Reimplemented from Gui::WorkbenchPy.
◆ PyMake()
◆ removeCommandbar()
implementer for the removeCommandbar() method
Removes a command bar.
References getPythonBaseWorkbenchPtr(), and Gui::PythonBaseWorkbench::removeCommandbar().
Referenced by RemoveCommandbar(), and staticCallback_removeCommandbar().
◆ RemoveCommandbar()
implementer for the RemoveCommandbar() method
References removeCommandbar().
Referenced by staticCallback_RemoveCommandbar().
◆ removeContextMenu()
implementer for the removeContextMenu() method
Removes a context menu.
References getPythonBaseWorkbenchPtr(), and Gui::PythonBaseWorkbench::removeContextMenu().
Referenced by RemoveContextMenu(), and staticCallback_removeContextMenu().
◆ RemoveContextMenu()
implementer for the RemoveContextMenu() method
References removeContextMenu().
Referenced by staticCallback_RemoveContextMenu().
◆ removeMenu()
implementer for the removeMenu() method
Removes a menu.
References getPythonBaseWorkbenchPtr(), and Gui::PythonBaseWorkbench::removeMenu().
Referenced by RemoveMenu(), and staticCallback_removeMenu().
◆ RemoveMenu()
implementer for the RemoveMenu() method
References removeMenu().
Referenced by staticCallback_RemoveMenu().
◆ removeToolbar()
implementer for the removeToolbar() method
Removes a toolbar.
References getPythonBaseWorkbenchPtr(), and Gui::PythonBaseWorkbench::removeToolbar().
Referenced by RemoveToolbar(), and staticCallback_removeToolbar().
◆ RemoveToolbar()
implementer for the RemoveToolbar() method
References removeToolbar().
Referenced by staticCallback_RemoveToolbar().
◆ representation()
std::string PythonWorkbenchPy::representation | ( | void | ) | const |
Referenced by config_control_design.pcurve::wr1(), config_control_design.degenerate_pcurve::wr1(), automotive_design.motion_link_relationship::wr1(), automotive_design.pcurve::wr1(), automotive_design.degenerate_pcurve::wr1(), config_control_design.pcurve::wr2(), config_control_design.degenerate_pcurve::wr2(), automotive_design.pcurve::wr2(), and automotive_design.degenerate_pcurve::wr2().
◆ setCustomAttributes()
int PythonWorkbenchPy::setCustomAttributes | ( | const char * | attr, |
PyObject * | obj | ||
) |
setter for special attributes (e.g.
dynamic ones) Output: Success=1, Failure=-1, Ignore=0
◆ staticCallback_appendCommandbar()
◆ staticCallback_AppendCommandbar()
◆ staticCallback_appendContextMenu()
◆ staticCallback_AppendContextMenu()
◆ staticCallback_appendMenu()
◆ staticCallback_AppendMenu()
◆ staticCallback_appendToolbar()
◆ staticCallback_AppendToolbar()
◆ staticCallback_listCommandbars()
◆ staticCallback_ListCommandbars()
◆ staticCallback_listMenus()
◆ staticCallback_ListMenus()
◆ staticCallback_listToolbars()
◆ staticCallback_ListToolbars()
◆ staticCallback_removeCommandbar()
◆ staticCallback_RemoveCommandbar()
◆ staticCallback_removeContextMenu()
◆ staticCallback_RemoveContextMenu()
◆ staticCallback_removeMenu()
◆ staticCallback_RemoveMenu()
◆ staticCallback_removeToolbar()
◆ staticCallback_RemoveToolbar()
Member Data Documentation
◆ GetterSetter
|
static |
Attribute structure of PythonWorkbenchPy.
◆ Methods
|
static |
Methods structure of PythonWorkbenchPy.
◆ Type
|
static |
Type structure of PythonWorkbenchPy.
Referenced by ArchPanel.CommandPanelSheet::Activated(), ArchStructure.StructSelectionObserver::addSelection(), ArchSite.Compass::buildCoordinates(), ArchComponent.Component::execute(), DraftLayer.LayerContainer::execute(), ArchSchedule.CommandArchSchedule::IsActive(), ArchAxis.CommandArchGrid::IsActive(), draftobjects.draft_annotation.DraftAnnotation::onDocumentRestored(), ArchReference.ArchReference::setProperties(), and DraftLayer.Layer::setProperties().
The documentation for this class was generated from the following files:
- build/webdoc/src/Gui/PythonWorkbenchPy.h
- src/Gui/PythonWorkbenchPyImp.cpp
- build/webdoc/src/Gui/PythonWorkbenchPy.cpp