Gui::SelectionObjectPy Class Reference

The python export class for SelectionObject. More...

#include <SelectionObjectPy.h>

Inheritance diagram for Gui::SelectionObjectPy:

Public Types
typedef SelectionObject *	PointerType
Public Member Functions
PyObject *	_getattr (char *attr)
	GetAttribute implementation This method implements the retriavel of object attributes.
virtual PyObject *	_repr (void)
	_repr method Overide this method to return a string object with some invormation about the object.
int	_setattr (char attr, PyObject value)
	SetAttribute implementation This method implements the seting of object attributes.
PyObject *	getCustomAttributes (const char *attr) const
	getter method for special attributes (e.g. dynamic ones)
virtual PyParentObject *	GetParents (void)
SelectionObject *	getSelectionObjectPtr (void) const
	getter for the object handled by this class
virtual PyTypeObject *	GetType (void)
virtual int	PyInit (PyObject args, PyObject k)
	PyInit method Overide this method to initialize a newly created instance of the class (Constuctor).
std::string	representation (void) const
	SelectionObjectPy (SelectionObject pcObject, PyTypeObject T=&Type)
int	setCustomAttributes (const char attr, PyObject obj)
	setter for special attributes (e.g. dynamic ones)
	~SelectionObjectPy ()
Static Public Member Functions
static PyObject *	PyMake (struct _typeobject , PyObject , PyObject *)
Static Public Attributes
static PyGetSetDef	GetterSetter []
	Attribute structure of SelectionObjectPy.
static PyMethodDef	Methods []
	Methods structure of SelectionObjectPy.
static PyParentObject	Parents [] = { PARENTSGuiSelectionObjectPy }
static PyTypeObject	Type
	Type structure of SelectionObjectPy.
callbacks and implementers for the python object attributes

Py::Object	getDocument (void) const
	getter for the Document attribute
Py::String	getDocumentName (void) const
	getter for the DocumentName attribute
Py::String	getFullName (void) const
	getter for the FullName attribute
Py::Boolean	getHasSubObjects (void) const
	getter for the HasSubObjects attribute
Py::Object	getObject (void) const
	getter for the Object attribute
Py::String	getObjectName (void) const
	getter for the ObjectName attribute
Py::List	getSubElementNames (void) const
	getter for the SubElementNames attribute
Py::List	getSubObjects (void) const
	getter for the SubObjects attribute
static PyObject *	staticCallback_getDocument (PyObject self, void closure)
	getter callback for the Document attribute
static PyObject *	staticCallback_getDocumentName (PyObject self, void closure)
	getter callback for the DocumentName attribute
static PyObject *	staticCallback_getFullName (PyObject self, void closure)
	getter callback for the FullName attribute
static PyObject *	staticCallback_getHasSubObjects (PyObject self, void closure)
	getter callback for the HasSubObjects attribute
static PyObject *	staticCallback_getObject (PyObject self, void closure)
	getter callback for the Object attribute
static PyObject *	staticCallback_getObjectName (PyObject self, void closure)
	getter callback for the ObjectName attribute
static PyObject *	staticCallback_getSubElementNames (PyObject self, void closure)
	getter callback for the SubElementNames attribute
static PyObject *	staticCallback_getSubObjects (PyObject self, void closure)
	getter callback for the SubObjects attribute
static int	staticCallback_setDocument (PyObject self, PyObject value, void *closure)
	setter callback for the Document attribute
static int	staticCallback_setDocumentName (PyObject self, PyObject value, void *closure)
	setter callback for the DocumentName attribute
static int	staticCallback_setFullName (PyObject self, PyObject value, void *closure)
	setter callback for the FullName attribute
static int	staticCallback_setHasSubObjects (PyObject self, PyObject value, void *closure)
	setter callback for the HasSubObjects attribute
static int	staticCallback_setObject (PyObject self, PyObject value, void *closure)
	setter callback for the Object attribute
static int	staticCallback_setObjectName (PyObject self, PyObject value, void *closure)
	setter callback for the ObjectName attribute
static int	staticCallback_setSubElementNames (PyObject self, PyObject value, void *closure)
	setter callback for the SubElementNames attribute
static int	staticCallback_setSubObjects (PyObject self, PyObject value, void *closure)
	setter callback for the SubObjects attribute
callbacks and implementers for the python object methods

PyObject *	isA (PyObject *args)
	implementer for the isA() method
PyObject *	remove (PyObject *args)
	implementer for the remove() method
static PyObject *	staticCallback_isA (PyObject self, PyObject args)
	callback for the isA() method
static PyObject *	staticCallback_remove (PyObject self, PyObject args)
	callback for the remove() method

Detailed Description

The python export class for SelectionObject.

Definition at line 20 of file SelectionObjectPy.h.

Member Typedef Documentation

typedef SelectionObject* Gui::SelectionObjectPy::PointerType

Reimplemented from Base::BaseClassPy.

Definition at line 36 of file SelectionObjectPy.h.

Constructor & Destructor Documentation

SelectionObjectPy::SelectionObjectPy	(	SelectionObject *	pcObject,
		PyTypeObject *	T = `&Type`
	)

Definition at line 561 of file SelectionObjectPy.cpp.

SelectionObjectPy::~SelectionObjectPy ( )

Definition at line 582 of file SelectionObjectPy.cpp.

References Base::PyObjectBase::_pcTwinPointer.

Member Function Documentation

PyObject * SelectionObjectPy::_getattr ( char * attr ) [virtual]

GetAttribute implementation This method implements the retriavel of object attributes.

If you want to implement attributes in your class, reimplement this method. You have to call the method of the base class. Note: if you reimplement _gettattr() in a inheriting class you need to call the method of the base class! Otherwise even the methods of the object will disapiear!

Reimplemented from Base::BaseClassPy.

Definition at line 600 of file SelectionObjectPy.cpp.

References Base::Console(), getCustomAttributes(), Methods, Base::Exception::ReportException(), and Base::Exception::what().

PyObject * SelectionObjectPy::_repr ( void ) [virtual]

_repr method Overide this method to return a string object with some invormation about the object.

 PyObject *MeshFeaturePy::_repr(void)
 {
   std::stringstream a;
   a << "MeshFeature: [ ";
   a << "some realy important info about the object!";
   a << "]" << std::endl;
   return Py_BuildValue("s", a.str().c_str());
 }

Reimplemented from Base::BaseClassPy.

Definition at line 592 of file SelectionObjectPy.cpp.

References representation().

int SelectionObjectPy::_setattr	(	char *	attr,
		PyObject *	value
	)			`[virtual]`

SetAttribute implementation This method implements the seting of object attributes.

If you want to implement attributes in your class, reimplement this method. You have to call the method of the base class.

Reimplemented from Base::BaseClassPy.

Definition at line 668 of file SelectionObjectPy.cpp.

References Base::Console(), Base::Exception::ReportException(), setCustomAttributes(), and Base::Exception::what().

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

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

Reimplemented from Base::BaseClassPy.

Definition at line 95 of file SelectionObjectPyImp.cpp.

Referenced by _getattr().

Py::Object SelectionObjectPy::getDocument ( void ) const

getter for the Document attribute

Definition at line 71 of file SelectionObjectPyImp.cpp.

References getObject(), and getSelectionObjectPtr().

Referenced by staticCallback_getDocument().

Py::String SelectionObjectPy::getDocumentName ( void ) const

getter for the DocumentName attribute

Definition at line 66 of file SelectionObjectPyImp.cpp.

References getSelectionObjectPtr().

Referenced by staticCallback_getDocumentName().

Py::String SelectionObjectPy::getFullName ( void ) const

getter for the FullName attribute

Definition at line 53 of file SelectionObjectPyImp.cpp.

Referenced by staticCallback_getFullName().

Py::Boolean SelectionObjectPy::getHasSubObjects ( void ) const

getter for the HasSubObjects attribute

Definition at line 90 of file SelectionObjectPyImp.cpp.

References getSelectionObjectPtr().

Referenced by staticCallback_getHasSubObjects().

Py::Object SelectionObjectPy::getObject ( void ) const

getter for the Object attribute

Definition at line 76 of file SelectionObjectPyImp.cpp.

References getSelectionObjectPtr().

Referenced by getDocument(), and staticCallback_getObject().

Py::String SelectionObjectPy::getObjectName ( void ) const

getter for the ObjectName attribute

Definition at line 37 of file SelectionObjectPyImp.cpp.

References getSelectionObjectPtr().

Referenced by staticCallback_getObjectName().

virtual PyParentObject* Gui::SelectionObjectPy::GetParents ( void ) [inline, virtual]

Reimplemented from Base::BaseClassPy.

Definition at line 28 of file SelectionObjectPy.h.

SelectionObject * SelectionObjectPy::getSelectionObjectPtr ( void ) const

getter for the object handled by this class

Definition at line 727 of file SelectionObjectPy.cpp.

References Base::PyObjectBase::_pcTwinPointer.

Referenced by getDocument(), getDocumentName(), getHasSubObjects(), getObject(), getObjectName(), getSubElementNames(), and getSubObjects().

Py::List SelectionObjectPy::getSubElementNames ( void ) const

getter for the SubElementNames attribute

Definition at line 42 of file SelectionObjectPyImp.cpp.

References Py::List::append(), getSelectionObjectPtr(), and Gui::SelectionObject::getSubNames().

Referenced by staticCallback_getSubElementNames().

Py::List SelectionObjectPy::getSubObjects ( void ) const

getter for the SubObjects attribute

Definition at line 81 of file SelectionObjectPyImp.cpp.

References Py::List::append(), Gui::SelectionObject::getObject(), App::DocumentObject::getPySubObjects(), and getSelectionObjectPtr().

Referenced by staticCallback_getSubObjects().

virtual PyTypeObject* Gui::SelectionObjectPy::GetType ( void ) [inline, virtual]

Reimplemented from Base::BaseClassPy.

Definition at line 27 of file SelectionObjectPy.h.

PyObject * SelectionObjectPy::isA ( PyObject * args )

implementer for the isA() method

Definition at line 29 of file SelectionObjectPyImp.cpp.

int SelectionObjectPy::PyInit	(	PyObject *	,
		PyObject *
	)			`[virtual]`

PyInit method Overide this method to initialize a newly created instance of the class (Constuctor).

Reimplemented from Base::BaseClassPy.

Definition at line 574 of file SelectionObjectPy.cpp.

PyObject * SelectionObjectPy::PyMake	(	struct _typeobject *	,
		PyObject *	,
		PyObject *
	)			`[static]`

Reimplemented from Base::BaseClassPy.

Definition at line 566 of file SelectionObjectPy.cpp.

PyObject * SelectionObjectPy::remove ( PyObject * args )

implementer for the remove() method

Definition at line 23 of file SelectionObjectPyImp.cpp.

std::string SelectionObjectPy::representation ( void ) const

Reimplemented from Base::BaseClassPy.

Definition at line 16 of file SelectionObjectPyImp.cpp.

Referenced by _repr().

int SelectionObjectPy::setCustomAttributes	(	const char *	attr,
		PyObject *	obj
	)

setter for special attributes (e.g. dynamic ones)

Reimplemented from Base::BaseClassPy.

Definition at line 100 of file SelectionObjectPyImp.cpp.

Referenced by _setattr().

PyObject * SelectionObjectPy::staticCallback_getDocument	(	PyObject *	self,
		void *	closure
	)			`[static]`

getter callback for the Document attribute

Definition at line 426 of file SelectionObjectPy.cpp.

References getDocument(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

PyObject * SelectionObjectPy::staticCallback_getDocumentName	(	PyObject *	self,
		void *	closure
	)			`[static]`

getter callback for the DocumentName attribute

Definition at line 394 of file SelectionObjectPy.cpp.

References getDocumentName(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

PyObject * SelectionObjectPy::staticCallback_getFullName	(	PyObject *	self,
		void *	closure
	)			`[static]`

getter callback for the FullName attribute

Definition at line 362 of file SelectionObjectPy.cpp.

References getFullName(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

PyObject * SelectionObjectPy::staticCallback_getHasSubObjects	(	PyObject *	self,
		void *	closure
	)			`[static]`

getter callback for the HasSubObjects attribute

Definition at line 522 of file SelectionObjectPy.cpp.

References getHasSubObjects(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

PyObject * SelectionObjectPy::staticCallback_getObject	(	PyObject *	self,
		void *	closure
	)			`[static]`

getter callback for the Object attribute

Definition at line 458 of file SelectionObjectPy.cpp.

References getObject(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

PyObject * SelectionObjectPy::staticCallback_getObjectName	(	PyObject *	self,
		void *	closure
	)			`[static]`

getter callback for the ObjectName attribute

Definition at line 298 of file SelectionObjectPy.cpp.

References getObjectName(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

PyObject * SelectionObjectPy::staticCallback_getSubElementNames	(	PyObject *	self,
		void *	closure
	)			`[static]`

getter callback for the SubElementNames attribute

Definition at line 330 of file SelectionObjectPy.cpp.

References getSubElementNames(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

PyObject * SelectionObjectPy::staticCallback_getSubObjects	(	PyObject *	self,
		void *	closure
	)			`[static]`

getter callback for the SubObjects attribute

Definition at line 490 of file SelectionObjectPy.cpp.

References getSubObjects(), Base::PyObjectBase::isValid(), Py::new_reference_to(), and Base::PyObjectBase::PyObjectBase().

PyObject * SelectionObjectPy::staticCallback_isA	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the isA() method

Definition at line 222 of file SelectionObjectPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

PyObject * SelectionObjectPy::staticCallback_remove	(	PyObject *	self,
		PyObject *	args
	)			`[static]`

callback for the remove() method

Definition at line 146 of file SelectionObjectPy.cpp.

References Base::Console(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::Exception::ReportException(), and Base::Exception::what().

int SelectionObjectPy::staticCallback_setDocument	(	PyObject *	self,
		PyObject *	value,
		void *	closure
	)			`[static]`

setter callback for the Document attribute

Definition at line 444 of file SelectionObjectPy.cpp.

References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

int SelectionObjectPy::staticCallback_setDocumentName	(	PyObject *	self,
		PyObject *	value,
		void *	closure
	)			`[static]`

setter callback for the DocumentName attribute

Definition at line 412 of file SelectionObjectPy.cpp.

References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

int SelectionObjectPy::staticCallback_setFullName	(	PyObject *	self,
		PyObject *	value,
		void *	closure
	)			`[static]`

setter callback for the FullName attribute

Definition at line 380 of file SelectionObjectPy.cpp.

References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

int SelectionObjectPy::staticCallback_setHasSubObjects	(	PyObject *	self,
		PyObject *	value,
		void *	closure
	)			`[static]`

setter callback for the HasSubObjects attribute

Definition at line 540 of file SelectionObjectPy.cpp.

References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

int SelectionObjectPy::staticCallback_setObject	(	PyObject *	self,
		PyObject *	value,
		void *	closure
	)			`[static]`

setter callback for the Object attribute

Definition at line 476 of file SelectionObjectPy.cpp.

References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

int SelectionObjectPy::staticCallback_setObjectName	(	PyObject *	self,
		PyObject *	value,
		void *	closure
	)			`[static]`

setter callback for the ObjectName attribute

Definition at line 316 of file SelectionObjectPy.cpp.

References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

int SelectionObjectPy::staticCallback_setSubElementNames	(	PyObject *	self,
		PyObject *	value,
		void *	closure
	)			`[static]`

setter callback for the SubElementNames attribute

Definition at line 348 of file SelectionObjectPy.cpp.

References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

int SelectionObjectPy::staticCallback_setSubObjects	(	PyObject *	self,
		PyObject *	value,
		void *	closure
	)			`[static]`

setter callback for the SubObjects attribute

Definition at line 508 of file SelectionObjectPy.cpp.

References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

Member Data Documentation

PyGetSetDef SelectionObjectPy::GetterSetter [static]

Attribute structure of SelectionObjectPy.

Reimplemented from Base::BaseClassPy.

Definition at line 25 of file SelectionObjectPy.h.

PyMethodDef SelectionObjectPy::Methods [static]

Initial value:

 {
    {"remove",
        (PyCFunction) staticCallback_remove,
        METH_VARARGS,
        "Remove this selection item from the selection. This object becomes invalid."
    },
    {"isA",
        (PyCFunction) staticCallback_isA,
        METH_VARARGS,
        "Test for a certain father class."
    },
    {NULL, NULL, 0, NULL}               
}

Methods structure of SelectionObjectPy.

Reimplemented from Base::BaseClassPy.

Definition at line 24 of file SelectionObjectPy.h.

Referenced by _getattr().

PyParentObject SelectionObjectPy::Parents = { PARENTSGuiSelectionObjectPy } [static]

Reimplemented from Base::BaseClassPy.

Definition at line 26 of file SelectionObjectPy.h.

PyTypeObject SelectionObjectPy::Type [static]

Type structure of SelectionObjectPy.

Reimplemented from Base::BaseClassPy.

Definition at line 23 of file SelectionObjectPy.h.

The documentation for this class was generated from the following files:

Gui::SelectionObjectPy Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

callbacks and implementers for the python object attributes

callbacks and implementers for the python object methods

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation