The python export class for Sheet. More...

#include <SheetPy.h>

Public Types
typedef Sheet * PointerType

Public Types inherited from App::DocumentObjectPy
typedef DocumentObject * PointerType

Public Types inherited from App::ExtensionContainerPy
typedef ExtensionContainer * PointerType

Public Types inherited from App::PropertyContainerPy
typedef PropertyContainer * PointerType

Public Types inherited from Base::PersistencePy
typedef Persistence * 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

SheetPy (Sheet 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...

Sheet * getSheetPtr (void) const
	getter for the object handled by this class More...

Public Member Functions inherited from App::DocumentObjectPy
DocumentObjectPy (DocumentObject pcObject, PyTypeObject T=&Type)

std::string representation (void) const

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

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

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

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

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

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

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

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

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

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

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

Py::List getOutList (void) const
	getter for the OutList attribute More...

Py::List getOutListRecursive (void) const
	getter for the OutListRecursive attribute More...

Py::List getInList (void) const
	getter for the InList attribute More...

Py::List getInListRecursive (void) const
	getter for the InListRecursive attribute More...

Py::String getName (void) const
	getter for the Name attribute More...

Py::Object getDocument (void) const
	getter for the Document attribute More...

Py::List getState (void) const
	getter for the State attribute More...

Py::Object getViewObject (void) const
	getter for the ViewObject 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...

DocumentObject * getDocumentObjectPtr (void) const
	getter for the object handled by this class More...

Public Member Functions inherited from App::ExtensionContainerPy
ExtensionContainerPy (ExtensionContainer pcObject, PyTypeObject T=&Type)

int finalization ()

int initialization ()

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

ExtensionContainer * getExtensionContainerPtr (void) const
	getter for the object handled by this class More...

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

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

Public Member Functions inherited from App::PropertyContainerPy
PropertyContainerPy (PropertyContainer pcObject, PyTypeObject T=&Type)

std::string representation (void) const

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

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

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

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

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

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

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

PyObject * dumpPropertyContent (PyObject args, PyObject kwd)
	implementer for the dumpPropertyContent() method More...

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

Py::List getPropertiesList (void) const
	getter for the PropertiesList 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...

PropertyContainer * getPropertyContainerPtr (void) const
	getter for the object handled by this class More...

Public Member Functions inherited from Base::PersistencePy
PersistencePy (Persistence pcObject, PyTypeObject T=&Type)

std::string representation (void) const

PyObject * dumpContent (PyObject args, PyObject kwd)
	implementer for the dumpContent() method More...

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

Py::String getContent (void) const
	getter for the Content attribute More...

Py::Int getMemSize (void) const
	getter for the MemSize 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...

Persistence * getPersistencePtr (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 App::DocumentObjectPy
static PyObject * PyMake (struct _typeobject , PyObject , PyObject *)

static PyObject * staticCallback_addProperty (PyObject self, PyObject args)
	callback for the addProperty() method More...

static PyObject * staticCallback_removeProperty (PyObject self, PyObject args)
	callback for the removeProperty() method More...

static PyObject * staticCallback_supportedProperties (PyObject self, PyObject args)
	callback for the supportedProperties() method More...

static PyObject * staticCallback_touch (PyObject self, PyObject args)
	callback for the touch() method More...

static PyObject * staticCallback_purgeTouched (PyObject self, PyObject args)
	callback for the purgeTouched() method More...

static PyObject * staticCallback_enforceRecompute (PyObject self, PyObject args)
	callback for the enforceRecompute() method More...

static PyObject * staticCallback_setExpression (PyObject self, PyObject args)
	callback for the setExpression() method More...

static PyObject * staticCallback_recompute (PyObject self, PyObject args)
	callback for the recompute() method More...

static PyObject * staticCallback_getParentGroup (PyObject self, PyObject args)
	callback for the getParentGroup() method More...

static PyObject * staticCallback_getParentGeoFeatureGroup (PyObject self, PyObject args)
	callback for the getParentGeoFeatureGroup() method More...

static PyObject * staticCallback_getPathsByOutList (PyObject self, PyObject args)
	callback for the getPathsByOutList() method More...

static PyObject * staticCallback_getOutList (PyObject self, void closure)
	getter callback for the OutList attribute More...

static int staticCallback_setOutList (PyObject self, PyObject value, void *closure)
	setter callback for the OutList attribute More...

static PyObject * staticCallback_getOutListRecursive (PyObject self, void closure)
	getter callback for the OutListRecursive attribute More...

static int staticCallback_setOutListRecursive (PyObject self, PyObject value, void *closure)
	setter callback for the OutListRecursive attribute More...

static PyObject * staticCallback_getInList (PyObject self, void closure)
	getter callback for the InList attribute More...

static int staticCallback_setInList (PyObject self, PyObject value, void *closure)
	setter callback for the InList attribute More...

static PyObject * staticCallback_getInListRecursive (PyObject self, void closure)
	getter callback for the InListRecursive attribute More...

static int staticCallback_setInListRecursive (PyObject self, PyObject value, void *closure)
	setter callback for the InListRecursive attribute More...

static PyObject * staticCallback_getName (PyObject self, void closure)
	getter callback for the Name attribute More...

static int staticCallback_setName (PyObject self, PyObject value, void *closure)
	setter callback for the Name attribute More...

static PyObject * staticCallback_getDocument (PyObject self, void closure)
	getter callback for the Document attribute More...

static int staticCallback_setDocument (PyObject self, PyObject value, void *closure)
	setter callback for the Document attribute More...

static PyObject * staticCallback_getState (PyObject self, void closure)
	getter callback for the State attribute More...

static int staticCallback_setState (PyObject self, PyObject value, void *closure)
	setter callback for the State attribute More...

static PyObject * staticCallback_getViewObject (PyObject self, void closure)
	getter callback for the ViewObject attribute More...

static int staticCallback_setViewObject (PyObject self, PyObject value, void *closure)
	setter callback for the ViewObject attribute More...

Static Public Member Functions inherited from App::ExtensionContainerPy
static PyObject * PyMake (struct _typeobject , PyObject , PyObject *)

static PyObject * staticCallback_addExtension (PyObject self, PyObject args)
	callback for the addExtension() method More...

static PyObject * staticCallback_hasExtension (PyObject self, PyObject args)
	callback for the hasExtension() method More...

Static Public Member Functions inherited from App::PropertyContainerPy
static PyObject * PyMake (struct _typeobject , PyObject , PyObject *)

static PyObject * staticCallback_getPropertyByName (PyObject self, PyObject args)
	callback for the getPropertyByName() method More...

static PyObject * staticCallback_getTypeOfProperty (PyObject self, PyObject args)
	callback for the getTypeOfProperty() method More...

static PyObject * staticCallback_getTypeIdOfProperty (PyObject self, PyObject args)
	callback for the getTypeIdOfProperty() method More...

static PyObject * staticCallback_setEditorMode (PyObject self, PyObject args)
	callback for the setEditorMode() method More...

static PyObject * staticCallback_getEditorMode (PyObject self, PyObject args)
	callback for the getEditorMode() method More...

static PyObject * staticCallback_getGroupOfProperty (PyObject self, PyObject args)
	callback for the getGroupOfProperty() method More...

static PyObject * staticCallback_getDocumentationOfProperty (PyObject self, PyObject args)
	callback for the getDocumentationOfProperty() method More...

static PyObject * staticCallback_dumpPropertyContent (PyObject self, PyObject args, PyObject *kwd)
	callback for the dumpPropertyContent() method More...

static PyObject * staticCallback_restorePropertyContent (PyObject self, PyObject args)
	callback for the restorePropertyContent() method More...

static PyObject * staticCallback_getPropertiesList (PyObject self, void closure)
	getter callback for the PropertiesList attribute More...

static int staticCallback_setPropertiesList (PyObject self, PyObject value, void *closure)
	setter callback for the PropertiesList attribute More...

Static Public Member Functions inherited from Base::PersistencePy
static PyObject * PyMake (struct _typeobject , PyObject , PyObject *)

static PyObject * staticCallback_dumpContent (PyObject self, PyObject args, PyObject *kwd)
	callback for the dumpContent() method More...

static PyObject * staticCallback_restoreContent (PyObject self, PyObject args)
	callback for the restoreContent() method More...

static PyObject * staticCallback_getContent (PyObject self, void closure)
	getter callback for the Content attribute More...

static int staticCallback_setContent (PyObject self, PyObject value, void *closure)
	setter callback for the Content attribute More...

static PyObject * staticCallback_getMemSize (PyObject self, void closure)
	getter callback for the MemSize attribute More...

static int staticCallback_setMemSize (PyObject self, PyObject value, void *closure)
	setter callback for the MemSize attribute More...

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

static PyMethodDef Methods []
	Methods structure of SheetPy. More...

static PyTypeObject Type
	Type structure of SheetPy. More...

Static Public Attributes inherited from App::DocumentObjectPy
static PyGetSetDef GetterSetter []
	Attribute structure of DocumentObjectPy. More...

static PyMethodDef Methods []
	Methods structure of DocumentObjectPy. More...

static PyTypeObject Type
	Type structure of DocumentObjectPy. More...

Static Public Attributes inherited from App::ExtensionContainerPy
static PyGetSetDef GetterSetter []
	Attribute structure of ExtensionContainerPy. More...

static PyMethodDef Methods []
	Methods structure of ExtensionContainerPy. More...

static PyTypeObject Type
	Type structure of ExtensionContainerPy. More...

Static Public Attributes inherited from App::PropertyContainerPy
static PyGetSetDef GetterSetter []
	Attribute structure of PropertyContainerPy. More...

static PyMethodDef Methods []
	Methods structure of PropertyContainerPy. More...

static PyTypeObject Type
	Type structure of PropertyContainerPy. More...

Static Public Attributes inherited from Base::PersistencePy
static PyGetSetDef GetterSetter []
	Attribute structure of PersistencePy. More...

static PyMethodDef Methods []
	Methods structure of PersistencePy. More...

static PyTypeObject Type
	Type structure of PersistencePy. 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
~SheetPy ()

Protected Member Functions inherited from App::DocumentObjectPy
~DocumentObjectPy ()

Protected Member Functions inherited from App::ExtensionContainerPy
~ExtensionContainerPy ()

Protected Member Functions inherited from App::PropertyContainerPy
~PropertyContainerPy ()

Protected Member Functions inherited from Base::PersistencePy
~PersistencePy ()

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 * set (PyObject *args)
	implementer for the set() method More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static PyObject * staticCallback_set (PyObject self, PyObject args)
	callback for the set() method More...

static PyObject * staticCallback_get (PyObject self, PyObject args)
	callback for the get() method More...

static PyObject * staticCallback_getContents (PyObject self, PyObject args)
	callback for the getContents() method More...

static PyObject * staticCallback_clear (PyObject self, PyObject args)
	callback for the clear() method More...

static PyObject * staticCallback_clearAll (PyObject self, PyObject args)
	callback for the clearAll() method More...

static PyObject * staticCallback_importFile (PyObject self, PyObject args)
	callback for the importFile() method More...

static PyObject * staticCallback_exportFile (PyObject self, PyObject args)
	callback for the exportFile() method More...

static PyObject * staticCallback_mergeCells (PyObject self, PyObject args)
	callback for the mergeCells() method More...

static PyObject * staticCallback_splitCell (PyObject self, PyObject args)
	callback for the splitCell() method More...

static PyObject * staticCallback_insertColumns (PyObject self, PyObject args)
	callback for the insertColumns() method More...

static PyObject * staticCallback_removeColumns (PyObject self, PyObject args)
	callback for the removeColumns() method More...

static PyObject * staticCallback_insertRows (PyObject self, PyObject args)
	callback for the insertRows() method More...

static PyObject * staticCallback_removeRows (PyObject self, PyObject args)
	callback for the removeRows() method More...

static PyObject * staticCallback_setAlignment (PyObject self, PyObject args)
	callback for the setAlignment() method More...

static PyObject * staticCallback_getAlignment (PyObject self, PyObject args)
	callback for the getAlignment() method More...

static PyObject * staticCallback_setStyle (PyObject self, PyObject args)
	callback for the setStyle() method More...

static PyObject * staticCallback_getStyle (PyObject self, PyObject args)
	callback for the getStyle() method More...

static PyObject * staticCallback_setDisplayUnit (PyObject self, PyObject args)
	callback for the setDisplayUnit() method More...

static PyObject * staticCallback_setAlias (PyObject self, PyObject args)
	callback for the setAlias() method More...

static PyObject * staticCallback_getAlias (PyObject self, PyObject args)
	callback for the getAlias() method More...

static PyObject * staticCallback_getCellFromAlias (PyObject self, PyObject args)
	callback for the getCellFromAlias() method More...

static PyObject * staticCallback_getDisplayUnit (PyObject self, PyObject args)
	callback for the getDisplayUnit() method More...

static PyObject * staticCallback_setForeground (PyObject self, PyObject args)
	callback for the setForeground() method More...

static PyObject * staticCallback_getForeground (PyObject self, PyObject args)
	callback for the getForeground() method More...

static PyObject * staticCallback_setBackground (PyObject self, PyObject args)
	callback for the setBackground() method More...

static PyObject * staticCallback_getBackground (PyObject self, PyObject args)
	callback for the getBackground() method More...

static PyObject * staticCallback_setColumnWidth (PyObject self, PyObject args)
	callback for the setColumnWidth() method More...

static PyObject * staticCallback_getColumnWidth (PyObject self, PyObject args)
	callback for the getColumnWidth() method More...

static PyObject * staticCallback_setRowHeight (PyObject self, PyObject args)
	callback for the setRowHeight() method More...

static PyObject * staticCallback_getRowHeight (PyObject self, PyObject args)
	callback for the getRowHeight() method More...

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

Detailed Description

The python export class for Sheet.

Member Typedef Documentation

◆ PointerType

typedef Sheet* Spreadsheet::SheetPy::PointerType

Constructor & Destructor Documentation

◆ ~SheetPy()

SheetPy::~SheetPy ( )

protected

◆ SheetPy()

SheetPy::SheetPy	(	Sheet *	pcObject,
		PyTypeObject *	T = `&Type`
	)

Member Function Documentation

◆ clear()

PyObject * SheetPy::clear ( PyObject * args )

implementer for the clear() method

References App::Range::next().

Referenced by staticCallback_clear().

◆ clearAll()

PyObject * SheetPy::clearAll ( PyObject * args )

implementer for the clearAll() method

Referenced by staticCallback_clearAll().

◆ exportFile()

PyObject * SheetPy::exportFile ( PyObject * args )

implementer for the exportFile() method

Referenced by staticCallback_exportFile().

◆ get()

PyObject * SheetPy::get ( PyObject * args )

implementer for the get() method

References Base::BaseClass::getPyObject().

Referenced by staticCallback_get().

◆ getAlias()

PyObject * SheetPy::getAlias ( PyObject * args )

implementer for the getAlias() method

References Spreadsheet::Cell::getAlias().

Referenced by staticCallback_getAlias().

◆ getAlignment()

PyObject * SheetPy::getAlignment ( PyObject * args )

implementer for the getAlignment() method

References Spreadsheet::Cell::ALIGNMENT_BOTTOM, Spreadsheet::Cell::ALIGNMENT_HCENTER, Spreadsheet::Cell::ALIGNMENT_LEFT, Spreadsheet::Cell::ALIGNMENT_RIGHT, Spreadsheet::Cell::ALIGNMENT_TOP, Spreadsheet::Cell::ALIGNMENT_VCENTER, Spreadsheet::Cell::getAlignment(), and App::stringToAddress().

Referenced by staticCallback_getAlignment().

◆ getBackground()

PyObject * SheetPy::getBackground ( PyObject * args )

implementer for the getBackground() method

References Spreadsheet::Cell::getBackground(), and App::stringToAddress().

Referenced by staticCallback_getBackground().

◆ getCellFromAlias()

PyObject * SheetPy::getCellFromAlias ( PyObject * args )

implementer for the getCellFromAlias() method

Referenced by staticCallback_getCellFromAlias().

◆ getColumnWidth()

PyObject * SheetPy::getColumnWidth ( PyObject * args )

implementer for the getColumnWidth() method

Referenced by staticCallback_getColumnWidth().

◆ getContents()

PyObject * SheetPy::getContents ( PyObject * args )

implementer for the getContents() method

References Spreadsheet::Cell::getStringContent(), and App::stringToAddress().

Referenced by staticCallback_getContents().

◆ getCustomAttributes()

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

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

References Base::BaseClass::getPyObject().

◆ getDisplayUnit()

PyObject * SheetPy::getDisplayUnit ( PyObject * args )

implementer for the getDisplayUnit() method

References Spreadsheet::Cell::getDisplayUnit(), and App::stringToAddress().

Referenced by staticCallback_getDisplayUnit().

◆ getForeground()

PyObject * SheetPy::getForeground ( PyObject * args )

implementer for the getForeground() method

References Spreadsheet::Cell::getForeground(), and App::stringToAddress().

Referenced by staticCallback_getForeground().

◆ getRowHeight()

PyObject * SheetPy::getRowHeight ( PyObject * args )

implementer for the getRowHeight() method

Referenced by staticCallback_getRowHeight().

◆ getSheetPtr()

Sheet * SheetPy::getSheetPtr ( void ) const

getter for the object handled by this class

◆ getStyle()

PyObject * SheetPy::getStyle ( PyObject * args )

implementer for the getStyle() method

References Spreadsheet::Cell::getStyle(), and App::stringToAddress().

Referenced by staticCallback_getStyle().

◆ GetType()

virtual PyTypeObject* Spreadsheet::SheetPy::GetType ( void )

virtual

Reimplemented from App::DocumentObjectPy.

◆ importFile()

PyObject * SheetPy::importFile ( PyObject * args )

implementer for the importFile() method

Referenced by staticCallback_importFile().

◆ insertColumns()

PyObject * SheetPy::insertColumns ( PyObject * args )

implementer for the insertColumns() method

References App::decodeColumn().

Referenced by staticCallback_insertColumns().

◆ insertRows()

PyObject * SheetPy::insertRows ( PyObject * args )

implementer for the insertRows() method

References App::decodeRow().

Referenced by staticCallback_insertRows().

◆ mergeCells()

PyObject * SheetPy::mergeCells ( PyObject * args )

implementer for the mergeCells() method

Referenced by staticCallback_mergeCells().

◆ PyInit()

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

virtual

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

Reimplemented from App::DocumentObjectPy.

◆ PyMake()

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

static

◆ removeColumns()

PyObject * SheetPy::removeColumns ( PyObject * args )

implementer for the removeColumns() method

References App::decodeColumn().

Referenced by staticCallback_removeColumns().

◆ removeRows()

PyObject * SheetPy::removeRows ( PyObject * args )

implementer for the removeRows() method

References App::decodeRow().

Referenced by staticCallback_removeRows().

◆ representation()

std::string SheetPy::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().

◆ set()

PyObject * SheetPy::set ( PyObject * args )

implementer for the set() method

References App::Range::address(), Spreadsheet::Sheet::getAddressFromAlias(), App::Range::next(), and Spreadsheet::Sheet::setCell().

Referenced by staticCallback_set().

◆ setAlias()

PyObject * SheetPy::setAlias ( PyObject * args )

implementer for the setAlias() method

References App::stringToAddress().

Referenced by staticCallback_setAlias().

◆ setAlignment()

PyObject * SheetPy::setAlignment ( PyObject * args )

implementer for the setAlignment() method

References Spreadsheet::Cell::ALIGNMENT_HORIZONTAL, Spreadsheet::Cell::ALIGNMENT_VERTICAL, Spreadsheet::Cell::decodeAlignment(), Spreadsheet::Cell::getAlignment(), App::Range::next(), and Spreadsheet::Cell::setAlignment().

Referenced by staticCallback_setAlignment().

◆ setBackground()

PyObject * SheetPy::setBackground ( PyObject * args )

implementer for the setBackground() method

References App::Range::next().

Referenced by staticCallback_setBackground().

◆ setColumnWidth()

PyObject * SheetPy::setColumnWidth ( PyObject * args )

implementer for the setColumnWidth() method

References App::stringToAddress().

Referenced by staticCallback_setColumnWidth().

◆ setCustomAttributes()

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

setter for special attributes (e.g.

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

◆ setDisplayUnit()

PyObject * SheetPy::setDisplayUnit ( PyObject * args )

implementer for the setDisplayUnit() method

References App::Range::next().

Referenced by staticCallback_setDisplayUnit().

◆ setForeground()

PyObject * SheetPy::setForeground ( PyObject * args )

implementer for the setForeground() method

References App::Range::next().

Referenced by staticCallback_setForeground().

◆ setRowHeight()

PyObject * SheetPy::setRowHeight ( PyObject * args )

implementer for the setRowHeight() method

Referenced by staticCallback_setRowHeight().

◆ setStyle()

PyObject * SheetPy::setStyle ( PyObject * args )

implementer for the setStyle() method

References Spreadsheet::Cell::getStyle(), and App::Range::next().

Referenced by staticCallback_setStyle().

◆ splitCell()

PyObject * SheetPy::splitCell ( PyObject * args )

implementer for the splitCell() method

References App::stringToAddress().

Referenced by staticCallback_splitCell().

◆ staticCallback_clear()

PyObject * SheetPy::staticCallback_clear	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the clear() method

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

◆ staticCallback_clearAll()

PyObject * SheetPy::staticCallback_clearAll	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the clearAll() method

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

◆ staticCallback_exportFile()

PyObject * SheetPy::staticCallback_exportFile	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the exportFile() method

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

◆ staticCallback_get()

PyObject * SheetPy::staticCallback_get	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the get() method

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

◆ staticCallback_getAlias()

PyObject * SheetPy::staticCallback_getAlias	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the getAlias() method

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

◆ staticCallback_getAlignment()

PyObject * SheetPy::staticCallback_getAlignment	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the getAlignment() method

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

◆ staticCallback_getBackground()

PyObject * SheetPy::staticCallback_getBackground	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the getBackground() method

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

◆ staticCallback_getCellFromAlias()

PyObject * SheetPy::staticCallback_getCellFromAlias	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the getCellFromAlias() method

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

◆ staticCallback_getColumnWidth()

PyObject * SheetPy::staticCallback_getColumnWidth	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the getColumnWidth() method

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

◆ staticCallback_getContents()

PyObject * SheetPy::staticCallback_getContents	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the getContents() method

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

◆ staticCallback_getDisplayUnit()

PyObject * SheetPy::staticCallback_getDisplayUnit	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the getDisplayUnit() method

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

◆ staticCallback_getForeground()

PyObject * SheetPy::staticCallback_getForeground	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the getForeground() method

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

◆ staticCallback_getRowHeight()

PyObject * SheetPy::staticCallback_getRowHeight	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the getRowHeight() method

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

◆ staticCallback_getStyle()

PyObject * SheetPy::staticCallback_getStyle	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the getStyle() method

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

◆ staticCallback_importFile()

PyObject * SheetPy::staticCallback_importFile	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the importFile() method

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

◆ staticCallback_insertColumns()

PyObject * SheetPy::staticCallback_insertColumns	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the insertColumns() method

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

◆ staticCallback_insertRows()

PyObject * SheetPy::staticCallback_insertRows	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the insertRows() method

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

◆ staticCallback_mergeCells()

PyObject * SheetPy::staticCallback_mergeCells	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the mergeCells() method

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

◆ staticCallback_removeColumns()

PyObject * SheetPy::staticCallback_removeColumns	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the removeColumns() method

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

◆ staticCallback_removeRows()

PyObject * SheetPy::staticCallback_removeRows	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the removeRows() method

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

◆ staticCallback_set()

PyObject * SheetPy::staticCallback_set	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the set() method

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

◆ staticCallback_setAlias()

PyObject * SheetPy::staticCallback_setAlias	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the setAlias() method

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

◆ staticCallback_setAlignment()

PyObject * SheetPy::staticCallback_setAlignment	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the setAlignment() method

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

◆ staticCallback_setBackground()

PyObject * SheetPy::staticCallback_setBackground	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the setBackground() method

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

◆ staticCallback_setColumnWidth()

PyObject * SheetPy::staticCallback_setColumnWidth	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the setColumnWidth() method

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

◆ staticCallback_setDisplayUnit()

PyObject * SheetPy::staticCallback_setDisplayUnit	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the setDisplayUnit() method

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

◆ staticCallback_setForeground()

PyObject * SheetPy::staticCallback_setForeground	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the setForeground() method

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

◆ staticCallback_setRowHeight()

PyObject * SheetPy::staticCallback_setRowHeight	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the setRowHeight() method

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

◆ staticCallback_setStyle()

PyObject * SheetPy::staticCallback_setStyle	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the setStyle() method

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

◆ staticCallback_splitCell()

PyObject * SheetPy::staticCallback_splitCell	(	PyObject *	self,
		PyObject *	args
	)

static

callback for the splitCell() method

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

Member Data Documentation

◆ GetterSetter

PyGetSetDef SheetPy::GetterSetter

static

Initial value:

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

Attribute structure of SheetPy.

◆ Methods

PyMethodDef SheetPy::Methods

static

Methods structure of SheetPy.

◆ Type

PyTypeObject SheetPy::Type

static

Type structure of SheetPy.

Referenced by ArchPanel.CommandPanelSheet::Activated(), ArchStructure.StructSelectionObserver::addSelection(), ArchSite.Compass::buildCoordinates(), ArchSchedule.CommandArchSchedule::IsActive(), and ArchAxis.CommandArchGrid::IsActive().

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

build/webdoc/src/Mod/Spreadsheet/App/SheetPy.h
src/Mod/Spreadsheet/App/SheetPyImp.cpp
build/webdoc/src/Mod/Spreadsheet/App/SheetPy.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

◆ ~SheetPy()

◆ SheetPy()

Member Function Documentation

◆ clear()

◆ clearAll()

◆ exportFile()

◆ get()

◆ getAlias()

◆ getAlignment()

◆ getBackground()

◆ getCellFromAlias()

◆ getColumnWidth()

◆ getContents()

◆ getCustomAttributes()

◆ getDisplayUnit()

◆ getForeground()

◆ getRowHeight()

◆ getSheetPtr()

◆ getStyle()

◆ GetType()

◆ importFile()

◆ insertColumns()

◆ insertRows()

◆ mergeCells()

◆ PyInit()

◆ PyMake()

◆ removeColumns()

◆ removeRows()

◆ representation()

◆ set()

◆ setAlias()

◆ setAlignment()

◆ setBackground()

◆ setColumnWidth()

◆ setCustomAttributes()

◆ setDisplayUnit()

◆ setForeground()

◆ setRowHeight()

◆ setStyle()

◆ splitCell()

◆ staticCallback_clear()

◆ staticCallback_clearAll()

◆ staticCallback_exportFile()

◆ staticCallback_get()

◆ staticCallback_getAlias()

◆ staticCallback_getAlignment()

◆ staticCallback_getBackground()

◆ staticCallback_getCellFromAlias()

◆ staticCallback_getColumnWidth()

◆ staticCallback_getContents()

◆ staticCallback_getDisplayUnit()

◆ staticCallback_getForeground()

◆ staticCallback_getRowHeight()

◆ staticCallback_getStyle()

◆ staticCallback_importFile()

◆ staticCallback_insertColumns()

◆ staticCallback_insertRows()

◆ staticCallback_mergeCells()

◆ staticCallback_removeColumns()

◆ staticCallback_removeRows()

◆ staticCallback_set()

◆ staticCallback_setAlias()

◆ staticCallback_setAlignment()

◆ staticCallback_setBackground()

◆ staticCallback_setColumnWidth()

◆ staticCallback_setDisplayUnit()

◆ staticCallback_setForeground()

◆ staticCallback_setRowHeight()

◆ staticCallback_setStyle()