App::DocumentObjectExtensionPy Class Reference

The python export class for DocumentObjectExtension. More...

#include <DocumentObjectExtensionPy.h>

Public Types
typedef DocumentObjectExtension *	PointerType
Public Types inherited from App::ExtensionPy
typedef Extension *	PointerType
Public Types inherited from Base::PyObjectBase
typedef void *	PointerType
enum	Status { Valid = 0, Immutable = 1, Notify = 2, NoTrack = 3 }

Public Member Functions
	DocumentObjectExtensionPy (DocumentObjectExtension *pcObject, PyTypeObject *T=&Type)
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
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...
DocumentObjectExtension *	getDocumentObjectExtensionPtr (void) const
	getter for the object handled by this class More...
Public Member Functions inherited from App::ExtensionPy
	ExtensionPy (Extension *pcObject, PyTypeObject *T=&Type)
std::string	representation (void) const
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...
Extension *	getExtensionPtr (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 App::ExtensionPy
static PyObject *	PyMake (struct _typeobject *, PyObject *, PyObject *)
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 DocumentObjectExtensionPy. More...
static PyMethodDef	Methods []
	Methods structure of DocumentObjectExtensionPy. More...
static PyTypeObject	Type
	Type structure of DocumentObjectExtensionPy. More...
Static Public Attributes inherited from App::ExtensionPy
static PyGetSetDef	GetterSetter []
	Attribute structure of ExtensionPy. More...
static PyMethodDef	Methods []
	Methods structure of ExtensionPy. More...
static PyTypeObject	Type
	Type structure of ExtensionPy. More...
Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef	Methods []
static PyTypeObject	Type
	Py_Header struct from python.h. More...

Protected Member Functions
	~DocumentObjectExtensionPy ()
Protected Member Functions inherited from App::ExtensionPy
	~ExtensionPy ()
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 DocumentObjectExtension.

Member Typedef Documentation

PointerType

typedef DocumentObjectExtension* App::DocumentObjectExtensionPy::PointerType

Constructor & Destructor Documentation

~DocumentObjectExtensionPy()

DocumentObjectExtensionPy::~DocumentObjectExtensionPy ( )

protected

DocumentObjectExtensionPy()

DocumentObjectExtensionPy::DocumentObjectExtensionPy	(	DocumentObjectExtension *	pcObject,
		PyTypeObject *	T = &Type
	)

Member Function Documentation

getCustomAttributes()

PyObject * DocumentObjectExtensionPy::getCustomAttributes

(

const char *

attr

)

const

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

getDocumentObjectExtensionPtr()

DocumentObjectExtension * DocumentObjectExtensionPy::getDocumentObjectExtensionPtr

(

void

)

const

getter for the object handled by this class

GetType()

virtual PyTypeObject* App::DocumentObjectExtensionPy::GetType ( void  )

virtual

Reimplemented from App::ExtensionPy.

Reimplemented in App::LinkBaseExtensionPy, TechDraw::CosmeticExtensionPy, App::GeoFeatureGroupExtensionPy, App::GroupExtensionPy, App::OriginGroupExtensionPy, and Part::AttachExtensionPy.

PyInit()

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

virtual

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

Reimplemented from App::ExtensionPy.

Reimplemented in App::LinkBaseExtensionPy, TechDraw::CosmeticExtensionPy, App::GeoFeatureGroupExtensionPy, App::GroupExtensionPy, App::OriginGroupExtensionPy, and Part::AttachExtensionPy.

PyMake()

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

static

representation()

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

setter for special attributes (e.g.

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

Member Data Documentation

GetterSetter

PyGetSetDef DocumentObjectExtensionPy::GetterSetter

static

Initial value:

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

Attribute structure of DocumentObjectExtensionPy.

Methods

PyMethodDef DocumentObjectExtensionPy::Methods

static

Initial value:

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

Methods structure of DocumentObjectExtensionPy.

Type

PyTypeObject DocumentObjectExtensionPy::Type

static

Type structure of DocumentObjectExtensionPy.

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/App/DocumentObjectExtensionPy.h
• src/App/DocumentObjectExtensionPyImp.cpp
• build/webdoc/src/App/DocumentObjectExtensionPy.cpp