The python export class for Workbench. More...

#include <WorkbenchPy.h>

Public Types
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...

std::string	representation (void) const

	WorkbenchPy (Workbench pcObject, PyTypeObject T=&Type)

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...

Workbench *	getWorkbenchPtr (void) const
	getter for the object handled by this class 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 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 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
	~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
PyObject *	name (PyObject *args)
	implementer for the name() method More...

PyObject *	activate (PyObject *args)
	implementer for the activate() method More...

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...

Additional Inherited Members
Protected Attributes inherited from Base::PyObjectBase
std::bitset< 32 >	StatusBits

Detailed Description

The python export class for Workbench.

Member Typedef Documentation

◆ PointerType

typedef Workbench* Gui::WorkbenchPy::PointerType

Constructor & Destructor Documentation

◆ ~WorkbenchPy()

WorkbenchPy::~WorkbenchPy ( )

protected

◆ WorkbenchPy()

WorkbenchPy::WorkbenchPy	(	Workbench *	pcObject,
		PyTypeObject *	T = `&Type`
	)

Member Function Documentation

◆ activate()

PyObject * WorkbenchPy::activate ( PyObject * args )

implementer for the activate() method

Activates the workbench object.

References Gui::WorkbenchManager::activate(), Base::BaseClassPy::getTypeId(), getWorkbenchPtr(), Gui::WorkbenchManager::instance(), and Gui::Workbench::name().

Referenced by ArchBuildingPart.ViewProviderBuildingPart::doubleClicked(), DraftLayer.ViewProviderLayer::setupContextMenu(), and staticCallback_activate().

◆ getCustomAttributes()

PyObject * WorkbenchPy::getCustomAttributes ( const char * attr ) const

getter method for special attributes (e.g. dynamic ones)

◆ GetType()

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

virtual

Reimplemented from Base::BaseClassPy.

Reimplemented in Gui::PythonWorkbenchPy.

◆ getWorkbenchPtr()

Workbench * WorkbenchPy::getWorkbenchPtr ( void ) const

getter for the object handled by this class

Referenced by activate(), and name().

◆ name()

PyObject * WorkbenchPy::name ( PyObject * args )

implementer for the name() method

Retrieves the workbench name.

References getWorkbenchPtr().

Referenced by staticCallback_name().

◆ PyInit()

int WorkbenchPy::PyInit	(	PyObject *	,
		PyObject *
	)

virtual

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

Reimplemented from Base::BaseClassPy.

Reimplemented in Gui::PythonWorkbenchPy.

◆ PyMake()

PyObject * WorkbenchPy::PyMake	(	struct _typeobject *	,
		PyObject *	,
		PyObject *
	)

static

◆ representation()

std::string WorkbenchPy::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 WorkbenchPy::setCustomAttributes	(	const char *	attr,
		PyObject *	obj
	)

setter for special attributes (e.g.

dynamic ones) Output: Success=1, Failure=-1, Ignore=0

◆ staticCallback_activate()

PyObject * WorkbenchPy::staticCallback_activate	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the activate() method

References activate(), Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

◆ staticCallback_name()

PyObject * WorkbenchPy::staticCallback_name	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the name() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), name(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

Member Data Documentation

◆ GetterSetter

PyGetSetDef WorkbenchPy::GetterSetter

static

Initial value:

= {
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of WorkbenchPy.

◆ Methods

PyMethodDef WorkbenchPy::Methods

static

Initial value:

= {
    {"name",
        reinterpret_cast<PyCFunction>( staticCallback_name ),
        METH_VARARGS,
        "Return the workbench name"
    },
    {"activate",
        reinterpret_cast<PyCFunction>( staticCallback_activate ),
        METH_VARARGS,
        "Activate this workbench"
    },
    {NULL, NULL, 0, NULL}               
}

Methods structure of WorkbenchPy.

◆ Type

PyTypeObject WorkbenchPy::Type

static

Type structure of WorkbenchPy.

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/WorkbenchPy.h
src/Gui/WorkbenchPyImp.cpp
build/webdoc/src/Gui/WorkbenchPy.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

callbacks and implementers for the python object methods

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~WorkbenchPy()

◆ WorkbenchPy()

Member Function Documentation

◆ activate()

◆ getCustomAttributes()

◆ GetType()

◆ getWorkbenchPtr()

◆ name()

◆ PyInit()

◆ PyMake()

◆ representation()

◆ setCustomAttributes()

◆ staticCallback_activate()

◆ staticCallback_name()

Member Data Documentation

◆ GetterSetter

◆ Methods

◆ Type