Gui::ViewProviderDocumentObjectPy Class Reference

The python export class for ViewProviderDocumentObject. More...

#include <ViewProviderDocumentObjectPy.h>

Inheritance diagram for Gui::ViewProviderDocumentObjectPy:
Gui::ViewProviderPy App::PropertyContainerPy Base::PersistencePy Base::BaseClassPy Base::PyObjectBase Gui::ViewProviderPythonFeaturePy

List of all members.

Public Types

typedef
ViewProviderDocumentObject
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.
PyObjectgetCustomAttributes (const char *attr) const
 getter method for special attributes (e.g. dynamic ones)
virtual PyParentObjectGetParents (void)
virtual PyTypeObject * GetType (void)
ViewProviderDocumentObjectgetViewProviderDocumentObjectPtr (void) const
 getter for the object handled by this class
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
int setCustomAttributes (const char *attr, PyObject *obj)
 setter for special attributes (e.g. dynamic ones)
 ViewProviderDocumentObjectPy (ViewProviderDocumentObject *pcObject, PyTypeObject *T=&Type)
 ~ViewProviderDocumentObjectPy ()

Static Public Member Functions

static PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)

Static Public Attributes

static PyGetSetDef GetterSetter []
 Attribute structure of ViewProviderDocumentObjectPy.
static PyMethodDef Methods []
 Methods structure of ViewProviderDocumentObjectPy.
static PyParentObject Parents [] = { PARENTSGuiViewProviderDocumentObjectPy }
static PyTypeObject Type
 Type structure of ViewProviderDocumentObjectPy.

callbacks and implementers for the python object attributes



Py::Object getObject (void) const
 getter for the Object attribute
static PyObjectstaticCallback_getObject (PyObject *self, void *closure)
 getter callback for the Object attribute
static int staticCallback_setObject (PyObject *self, PyObject *value, void *closure)
 setter callback for the Object attribute

callbacks and implementers for the python object methods



PyObjectupdate (PyObject *args)
 implementer for the update() method
static PyObjectstaticCallback_update (PyObject *self, PyObject *args)
 callback for the update() method

Detailed Description

The python export class for ViewProviderDocumentObject.

Definition at line 20 of file ViewProviderDocumentObjectPy.h.


Member Typedef Documentation

Reimplemented from Gui::ViewProviderPy.

Reimplemented in Gui::ViewProviderPythonFeaturePy.

Definition at line 36 of file ViewProviderDocumentObjectPy.h.


Constructor & Destructor Documentation

ViewProviderDocumentObjectPy::ViewProviderDocumentObjectPy ( ViewProviderDocumentObject pcObject,
PyTypeObject *  T = &Type 
)

Definition at line 214 of file ViewProviderDocumentObjectPy.cpp.

ViewProviderDocumentObjectPy::~ViewProviderDocumentObjectPy (  ) 

Definition at line 235 of file ViewProviderDocumentObjectPy.cpp.


Member Function Documentation

PyObject * ViewProviderDocumentObjectPy::_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 Gui::ViewProviderPy.

Reimplemented in Gui::ViewProviderPythonFeaturePy.

Definition at line 250 of file ViewProviderDocumentObjectPy.cpp.

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

PyObject * ViewProviderDocumentObjectPy::_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 Gui::ViewProviderPy.

Reimplemented in Gui::ViewProviderPythonFeaturePy.

Definition at line 242 of file ViewProviderDocumentObjectPy.cpp.

References representation().

int ViewProviderDocumentObjectPy::_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 Gui::ViewProviderPy.

Reimplemented in Gui::ViewProviderPythonFeaturePy.

Definition at line 318 of file ViewProviderDocumentObjectPy.cpp.

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

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

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

Reimplemented from Gui::ViewProviderPy.

Reimplemented in Gui::ViewProviderPythonFeaturePy.

Definition at line 64 of file ViewProviderDocumentObjectPyImp.cpp.

Referenced by _getattr().

Py::Object ViewProviderDocumentObjectPy::getObject ( void   )  const
virtual PyParentObject* Gui::ViewProviderDocumentObjectPy::GetParents ( void   )  [inline, virtual]

Reimplemented from Gui::ViewProviderPy.

Reimplemented in Gui::ViewProviderPythonFeaturePy.

Definition at line 28 of file ViewProviderDocumentObjectPy.h.

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

Reimplemented from Gui::ViewProviderPy.

Reimplemented in Gui::ViewProviderPythonFeaturePy.

Definition at line 27 of file ViewProviderDocumentObjectPy.h.

ViewProviderDocumentObject * ViewProviderDocumentObjectPy::getViewProviderDocumentObjectPtr ( void   )  const

getter for the object handled by this class

Definition at line 377 of file ViewProviderDocumentObjectPy.cpp.

References Base::PyObjectBase::_pcTwinPointer.

Referenced by getObject(), representation(), and update().

int ViewProviderDocumentObjectPy::PyInit ( PyObject ,
PyObject  
) [virtual]

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

Reimplemented from Gui::ViewProviderPy.

Reimplemented in Gui::ViewProviderPythonFeaturePy.

Definition at line 227 of file ViewProviderDocumentObjectPy.cpp.

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

Reimplemented from Gui::ViewProviderPy.

Reimplemented in Gui::ViewProviderPythonFeaturePy.

Definition at line 219 of file ViewProviderDocumentObjectPy.cpp.

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

Reimplemented from Gui::ViewProviderPy.

Reimplemented in Gui::ViewProviderPythonFeaturePy.

Definition at line 40 of file ViewProviderDocumentObjectPyImp.cpp.

References getViewProviderDocumentObjectPtr().

Referenced by _repr().

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

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

Reimplemented from Gui::ViewProviderPy.

Reimplemented in Gui::ViewProviderPythonFeaturePy.

Definition at line 69 of file ViewProviderDocumentObjectPyImp.cpp.

Referenced by _setattr().

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

getter callback for the Object attribute

Definition at line 175 of file ViewProviderDocumentObjectPy.cpp.

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

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

setter callback for the Object attribute

Definition at line 193 of file ViewProviderDocumentObjectPy.cpp.

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

PyObject * ViewProviderDocumentObjectPy::staticCallback_update ( PyObject self,
PyObject args 
) [static]
PyObject * ViewProviderDocumentObjectPy::update ( PyObject args  ) 

Member Data Documentation

Initial value:
 {
    {"Object",
        (getter) staticCallback_getObject,
        (setter) staticCallback_setObject, 
        "Return the associated data object",
        NULL
    },
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of ViewProviderDocumentObjectPy.

Reimplemented from Gui::ViewProviderPy.

Reimplemented in Gui::ViewProviderPythonFeaturePy.

Definition at line 25 of file ViewProviderDocumentObjectPy.h.

Initial value:
 {
    {"update",
        (PyCFunction) staticCallback_update,
        METH_VARARGS,
        "Update the view representation of the object"
    },
    {NULL, NULL, 0, NULL}               
}

Methods structure of ViewProviderDocumentObjectPy.

Reimplemented from Gui::ViewProviderPy.

Reimplemented in Gui::ViewProviderPythonFeaturePy.

Definition at line 24 of file ViewProviderDocumentObjectPy.h.

Referenced by _getattr().

PyParentObject ViewProviderDocumentObjectPy::Parents = { PARENTSGuiViewProviderDocumentObjectPy } [static]

Reimplemented from Gui::ViewProviderPy.

Reimplemented in Gui::ViewProviderPythonFeaturePy.

Definition at line 26 of file ViewProviderDocumentObjectPy.h.

PyTypeObject ViewProviderDocumentObjectPy::Type [static]

Type structure of ViewProviderDocumentObjectPy.

Reimplemented from Gui::ViewProviderPy.

Reimplemented in Gui::ViewProviderPythonFeaturePy.

Definition at line 23 of file ViewProviderDocumentObjectPy.h.


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

Generated on Wed Nov 23 19:02:04 2011 for FreeCAD by  doxygen 1.6.1