The python export class for PythonBaseWorkbench. More...

#include <PythonWorkbenchPy.h>

Public Types

typedef PythonBaseWorkbenchPointerType
 
- Public Types inherited from Gui::WorkbenchPy
typedef WorkbenchPointerType
 
- Public Types inherited from Base::BaseClassPy
typedef BaseClassPointerType
 
- 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
PyObjectgetCustomAttributes (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...
 
PythonBaseWorkbenchgetPythonBaseWorkbenchPtr (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)
 
PyObjectgetCustomAttributes (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...
 
WorkbenchgetWorkbenchPtr (void) const
 getter for the object handled by this class More...
 
PyObjectname (PyObject *args)
 implementer for the name() method More...
 
PyObjectactivate (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
 
PyObjectisDerivedFrom (PyObject *args)
 implementer for the isDerivedFrom() method More...
 
PyObjectgetAllDerivedFrom (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...
 
PyObjectgetCustomAttributes (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...
 
BaseClassgetBaseClassPtr (void) const
 getter for the object handled by this class More...
 
- Public Member Functions inherited from Base::PyObjectBase
PyObjectBaseDecRef (void)
 decref method wrapper (see python extending manual)
More...
 
PyObjectBaseIncRef (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 PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)
 
- Static Public Member Functions inherited from Gui::WorkbenchPy
static PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObjectstaticCallback_name (PyObject *self, PyObject *args)
 callback for the name() method More...
 
static PyObjectstaticCallback_activate (PyObject *self, PyObject *args)
 callback for the activate() method More...
 
- Static Public Member Functions inherited from Base::BaseClassPy
static PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObjectstaticCallback_isDerivedFrom (PyObject *self, PyObject *args)
 callback for the isDerivedFrom() method More...
 
static PyObjectstaticCallback_getAllDerivedFrom (PyObject *self, PyObject *args)
 callback for the getAllDerivedFrom() method More...
 
static PyObjectstaticCallback_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 PyObjectstaticCallback_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...
 

callbacks and implementers for the python object methods

PyObjectappendMenu (PyObject *args)
 implementer for the appendMenu() method More...
 
PyObjectremoveMenu (PyObject *args)
 implementer for the removeMenu() method More...
 
PyObjectlistMenus (PyObject *args)
 implementer for the listMenus() method More...
 
PyObjectappendContextMenu (PyObject *args)
 implementer for the appendContextMenu() method More...
 
PyObjectremoveContextMenu (PyObject *args)
 implementer for the removeContextMenu() method More...
 
PyObjectappendToolbar (PyObject *args)
 implementer for the appendToolbar() method More...
 
PyObjectremoveToolbar (PyObject *args)
 implementer for the removeToolbar() method More...
 
PyObjectlistToolbars (PyObject *args)
 implementer for the listToolbars() method More...
 
PyObjectappendCommandbar (PyObject *args)
 implementer for the appendCommandbar() method More...
 
PyObjectremoveCommandbar (PyObject *args)
 implementer for the removeCommandbar() method More...
 
PyObjectlistCommandbars (PyObject *args)
 implementer for the listCommandbars() method More...
 
PyObjectAppendMenu (PyObject *args)
 implementer for the AppendMenu() method More...
 
PyObjectRemoveMenu (PyObject *args)
 implementer for the RemoveMenu() method More...
 
PyObjectListMenus (PyObject *args)
 implementer for the ListMenus() method More...
 
PyObjectAppendContextMenu (PyObject *args)
 implementer for the AppendContextMenu() method More...
 
PyObjectRemoveContextMenu (PyObject *args)
 implementer for the RemoveContextMenu() method More...
 
PyObjectAppendToolbar (PyObject *args)
 implementer for the AppendToolbar() method More...
 
PyObjectRemoveToolbar (PyObject *args)
 implementer for the RemoveToolbar() method More...
 
PyObjectListToolbars (PyObject *args)
 implementer for the ListToolbars() method More...
 
PyObjectAppendCommandbar (PyObject *args)
 implementer for the AppendCommandbar() method More...
 
PyObjectRemoveCommandbar (PyObject *args)
 implementer for the RemoveCommandbar() method More...
 
PyObjectListCommandbars (PyObject *args)
 implementer for the ListCommandbars() method More...
 
static PyObjectstaticCallback_appendMenu (PyObject *self, PyObject *args)
 callback for the appendMenu() method More...
 
static PyObjectstaticCallback_removeMenu (PyObject *self, PyObject *args)
 callback for the removeMenu() method More...
 
static PyObjectstaticCallback_listMenus (PyObject *self, PyObject *args)
 callback for the listMenus() method More...
 
static PyObjectstaticCallback_appendContextMenu (PyObject *self, PyObject *args)
 callback for the appendContextMenu() method More...
 
static PyObjectstaticCallback_removeContextMenu (PyObject *self, PyObject *args)
 callback for the removeContextMenu() method More...
 
static PyObjectstaticCallback_appendToolbar (PyObject *self, PyObject *args)
 callback for the appendToolbar() method More...
 
static PyObjectstaticCallback_removeToolbar (PyObject *self, PyObject *args)
 callback for the removeToolbar() method More...
 
static PyObjectstaticCallback_listToolbars (PyObject *self, PyObject *args)
 callback for the listToolbars() method More...
 
static PyObjectstaticCallback_appendCommandbar (PyObject *self, PyObject *args)
 callback for the appendCommandbar() method More...
 
static PyObjectstaticCallback_removeCommandbar (PyObject *self, PyObject *args)
 callback for the removeCommandbar() method More...
 
static PyObjectstaticCallback_listCommandbars (PyObject *self, PyObject *args)
 callback for the listCommandbars() method More...
 
static PyObjectstaticCallback_AppendMenu (PyObject *self, PyObject *args)
 callback for the AppendMenu() method More...
 
static PyObjectstaticCallback_RemoveMenu (PyObject *self, PyObject *args)
 callback for the RemoveMenu() method More...
 
static PyObjectstaticCallback_ListMenus (PyObject *self, PyObject *args)
 callback for the ListMenus() method More...
 
static PyObjectstaticCallback_AppendContextMenu (PyObject *self, PyObject *args)
 callback for the AppendContextMenu() method More...
 
static PyObjectstaticCallback_RemoveContextMenu (PyObject *self, PyObject *args)
 callback for the RemoveContextMenu() method More...
 
static PyObjectstaticCallback_AppendToolbar (PyObject *self, PyObject *args)
 callback for the AppendToolbar() method More...
 
static PyObjectstaticCallback_RemoveToolbar (PyObject *self, PyObject *args)
 callback for the RemoveToolbar() method More...
 
static PyObjectstaticCallback_ListToolbars (PyObject *self, PyObject *args)
 callback for the ListToolbars() method More...
 
static PyObjectstaticCallback_AppendCommandbar (PyObject *self, PyObject *args)
 callback for the AppendCommandbar() method More...
 
static PyObjectstaticCallback_RemoveCommandbar (PyObject *self, PyObject *args)
 callback for the RemoveCommandbar() method More...
 
static PyObjectstaticCallback_ListCommandbars (PyObject *self, PyObject *args)
 callback for the ListCommandbars() method 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()

PythonWorkbenchPy::~PythonWorkbenchPy ( )
protected

◆ PythonWorkbenchPy()

PythonWorkbenchPy::PythonWorkbenchPy ( PythonBaseWorkbench pcObject,
PyTypeObject *  T = &Type 
)

Member Function Documentation

◆ appendCommandbar()

◆ AppendCommandbar()

PyObject * PythonWorkbenchPy::AppendCommandbar ( PyObject args)

implementer for the AppendCommandbar() method

References appendCommandbar().

Referenced by staticCallback_AppendCommandbar().

◆ appendContextMenu()

◆ AppendContextMenu()

PyObject * PythonWorkbenchPy::AppendContextMenu ( PyObject args)

implementer for the AppendContextMenu() method

References appendContextMenu().

Referenced by staticCallback_AppendContextMenu().

◆ appendMenu()

◆ AppendMenu()

PyObject * PythonWorkbenchPy::AppendMenu ( PyObject args)

implementer for the AppendMenu() method

References appendMenu().

Referenced by staticCallback_AppendMenu().

◆ appendToolbar()

◆ AppendToolbar()

PyObject * PythonWorkbenchPy::AppendToolbar ( PyObject args)

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

◆ GetType()

virtual PyTypeObject* Gui::PythonWorkbenchPy::GetType ( void  )
virtual

Reimplemented from Gui::WorkbenchPy.

◆ listCommandbars()

PyObject* Gui::PythonWorkbenchPy::listCommandbars ( PyObject args)

implementer for the listCommandbars() method

Referenced by ListCommandbars(), and staticCallback_listCommandbars().

◆ ListCommandbars()

PyObject * PythonWorkbenchPy::ListCommandbars ( PyObject args)

implementer for the ListCommandbars() method

References listCommandbars().

Referenced by staticCallback_ListCommandbars().

◆ listMenus()

PyObject* Gui::PythonWorkbenchPy::listMenus ( PyObject args)

implementer for the listMenus() method

Referenced by ListMenus(), and staticCallback_listMenus().

◆ ListMenus()

PyObject * PythonWorkbenchPy::ListMenus ( PyObject args)

implementer for the ListMenus() method

References listMenus().

Referenced by staticCallback_ListMenus().

◆ listToolbars()

PyObject* Gui::PythonWorkbenchPy::listToolbars ( PyObject args)

implementer for the listToolbars() method

Referenced by ListToolbars(), and staticCallback_listToolbars().

◆ ListToolbars()

PyObject * PythonWorkbenchPy::ListToolbars ( PyObject args)

implementer for the ListToolbars() method

References listToolbars().

Referenced by staticCallback_ListToolbars().

◆ PyInit()

int PythonWorkbenchPy::PyInit ( PyObject ,
PyObject  
)
virtual

PyInit method Override this method to initialize a newly created instance of the class (Constructor)

Reimplemented from Gui::WorkbenchPy.

◆ PyMake()

PyObject * PythonWorkbenchPy::PyMake ( struct _typeobject *  ,
PyObject ,
PyObject  
)
static

◆ removeCommandbar()

PyObject * PythonWorkbenchPy::removeCommandbar ( PyObject args)

◆ RemoveCommandbar()

PyObject * PythonWorkbenchPy::RemoveCommandbar ( PyObject args)

implementer for the RemoveCommandbar() method

References removeCommandbar().

Referenced by staticCallback_RemoveCommandbar().

◆ removeContextMenu()

PyObject * PythonWorkbenchPy::removeContextMenu ( PyObject args)

◆ RemoveContextMenu()

PyObject * PythonWorkbenchPy::RemoveContextMenu ( PyObject args)

implementer for the RemoveContextMenu() method

References removeContextMenu().

Referenced by staticCallback_RemoveContextMenu().

◆ removeMenu()

PyObject * PythonWorkbenchPy::removeMenu ( PyObject args)

implementer for the removeMenu() method

Removes a menu.

References getPythonBaseWorkbenchPtr(), and Gui::PythonBaseWorkbench::removeMenu().

Referenced by RemoveMenu(), and staticCallback_removeMenu().

◆ RemoveMenu()

PyObject * PythonWorkbenchPy::RemoveMenu ( PyObject args)

implementer for the RemoveMenu() method

References removeMenu().

Referenced by staticCallback_RemoveMenu().

◆ removeToolbar()

PyObject * PythonWorkbenchPy::removeToolbar ( PyObject args)

implementer for the removeToolbar() method

Removes a toolbar.

References getPythonBaseWorkbenchPtr(), and Gui::PythonBaseWorkbench::removeToolbar().

Referenced by RemoveToolbar(), and staticCallback_removeToolbar().

◆ RemoveToolbar()

PyObject * PythonWorkbenchPy::RemoveToolbar ( PyObject args)

implementer for the RemoveToolbar() method

References removeToolbar().

Referenced by staticCallback_RemoveToolbar().

◆ representation()

◆ 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

PyGetSetDef PythonWorkbenchPy::GetterSetter
static
Initial value:
= {
{NULL, NULL, NULL, NULL, NULL}
}

Attribute structure of PythonWorkbenchPy.

◆ Methods

PyMethodDef PythonWorkbenchPy::Methods
static

Methods structure of PythonWorkbenchPy.

◆ Type


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