Gui::DocumentPy Class Reference

The python export class for Document. More...

#include <DocumentPy.h>

Public Types
typedef Document *	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
	DocumentPy (Document *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
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 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 DocumentPy. More...
static PyMethodDef	Methods []
	Methods structure of DocumentPy. More...
static PyTypeObject	Type
	Type structure of DocumentPy. 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
	~DocumentPy ()
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 *	show (PyObject *args)
	implementer for the show() method More...
PyObject *	hide (PyObject *args)
	implementer for the hide() method More...
PyObject *	setPos (PyObject *args)
	implementer for the setPos() method More...
PyObject *	setEdit (PyObject *args)
	implementer for the setEdit() method More...
PyObject *	getInEdit (PyObject *args)
	implementer for the getInEdit() method More...
PyObject *	resetEdit (PyObject *args)
	implementer for the resetEdit() method More...
PyObject *	addAnnotation (PyObject *args)
	implementer for the addAnnotation() method More...
PyObject *	update (PyObject *args)
	implementer for the update() method More...
PyObject *	getObject (PyObject *args)
	implementer for the getObject() method More...
PyObject *	activeObject (PyObject *args)
	implementer for the activeObject() method More...
PyObject *	activeView (PyObject *args)
	implementer for the activeView() method More...
PyObject *	mdiViewsOfType (PyObject *args)
	implementer for the mdiViewsOfType() method More...
PyObject *	sendMsgToViews (PyObject *args)
	implementer for the sendMsgToViews() method More...
PyObject *	mergeProject (PyObject *args)
	implementer for the mergeProject() method More...
PyObject *	toggleTreeItem (PyObject *args)
	implementer for the toggleTreeItem() method More...
PyObject *	scrollToTreeItem (PyObject *args)
	implementer for the scrollToTreeItem() method More...
static PyObject *	staticCallback_show (PyObject *self, PyObject *args)
	callback for the show() method More...
static PyObject *	staticCallback_hide (PyObject *self, PyObject *args)
	callback for the hide() method More...
static PyObject *	staticCallback_setPos (PyObject *self, PyObject *args)
	callback for the setPos() method More...
static PyObject *	staticCallback_setEdit (PyObject *self, PyObject *args)
	callback for the setEdit() method More...
static PyObject *	staticCallback_getInEdit (PyObject *self, PyObject *args)
	callback for the getInEdit() method More...
static PyObject *	staticCallback_resetEdit (PyObject *self, PyObject *args)
	callback for the resetEdit() method More...
static PyObject *	staticCallback_addAnnotation (PyObject *self, PyObject *args)
	callback for the addAnnotation() method More...
static PyObject *	staticCallback_update (PyObject *self, PyObject *args)
	callback for the update() method More...
static PyObject *	staticCallback_getObject (PyObject *self, PyObject *args)
	callback for the getObject() method More...
static PyObject *	staticCallback_activeObject (PyObject *self, PyObject *args)
	callback for the activeObject() method More...
static PyObject *	staticCallback_activeView (PyObject *self, PyObject *args)
	callback for the activeView() method More...
static PyObject *	staticCallback_mdiViewsOfType (PyObject *self, PyObject *args)
	callback for the mdiViewsOfType() method More...
static PyObject *	staticCallback_sendMsgToViews (PyObject *self, PyObject *args)
	callback for the sendMsgToViews() method More...
static PyObject *	staticCallback_mergeProject (PyObject *self, PyObject *args)
	callback for the mergeProject() method More...
static PyObject *	staticCallback_toggleTreeItem (PyObject *self, PyObject *args)
	callback for the toggleTreeItem() method More...
static PyObject *	staticCallback_scrollToTreeItem (PyObject *self, PyObject *args)
	callback for the scrollToTreeItem() method More...

callbacks and implementers for the python object attributes
Py::Object	getActiveObject (void) const
	getter for the ActiveObject attribute More...
void	setActiveObject (Py::Object arg)
	setter for the ActiveObject attribute More...
Py::Object	getActiveView (void) const
	getter for the ActiveView attribute More...
void	setActiveView (Py::Object arg)
	setter for the ActiveView attribute More...
Py::Object	getDocument (void) const
	getter for the Document attribute More...
Py::Boolean	getModified (void) const
	getter for the Modified 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...
Document *	getDocumentPtr (void) const
	getter for the object handled by this class More...
static PyObject *	staticCallback_getActiveObject (PyObject *self, void *closure)
	getter callback for the ActiveObject attribute More...
static int	staticCallback_setActiveObject (PyObject *self, PyObject *value, void *closure)
	setter callback for the ActiveObject attribute More...
static PyObject *	staticCallback_getActiveView (PyObject *self, void *closure)
	getter callback for the ActiveView attribute More...
static int	staticCallback_setActiveView (PyObject *self, PyObject *value, void *closure)
	setter callback for the ActiveView 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_getModified (PyObject *self, void *closure)
	getter callback for the Modified attribute More...
static int	staticCallback_setModified (PyObject *self, PyObject *value, void *closure)
	setter callback for the Modified attribute More...

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

Detailed Description

The python export class for Document.

Member Typedef Documentation

PointerType

typedef Document* Gui::DocumentPy::PointerType

Constructor & Destructor Documentation

~DocumentPy()

DocumentPy::~DocumentPy ( )

protected

DocumentPy()

DocumentPy::DocumentPy	(	Document *	pcObject,
		PyTypeObject *	T = &Type
	)

Member Function Documentation

activeObject()

PyObject * DocumentPy::activeObject

(

PyObject *

args

)

implementer for the activeObject() method

References App::Document::getActiveObject(), Gui::Document::getDocument(), getDocumentPtr(), Gui::ViewProvider::getPyObject(), and Gui::Document::getViewProvider().

Referenced by staticCallback_activeObject().

activeView()

PyObject * DocumentPy::activeView

(

PyObject *

args

)

implementer for the activeView() method

References Gui::Document::getActiveView(), getDocumentPtr(), and Gui::MDIView::getPyObject().

Referenced by staticCallback_activeView().

addAnnotation()

PyObject * DocumentPy::addAnnotation

(

PyObject *

args

)

implementer for the addAnnotation() method

References Gui::ViewProviderExtern::adjustDocumentName(), getDocument(), getDocumentPtr(), Gui::Document::setAnnotationViewProvider(), and Gui::ViewProviderExtern::setModeByFile().

Referenced by staticCallback_addAnnotation().

getActiveObject()

Py::Object DocumentPy::getActiveObject

(

void

)

const

getter for the ActiveObject attribute

References App::Document::getActiveObject(), Gui::Document::getDocument(), getDocumentPtr(), Gui::ViewProvider::getPyObject(), and Gui::Document::getViewProvider().

Referenced by staticCallback_getActiveObject().

getActiveView()

Py::Object DocumentPy::getActiveView

(

void

)

const

getter for the ActiveView attribute

References Gui::Document::getActiveView(), and getDocumentPtr().

Referenced by staticCallback_getActiveView().

getCustomAttributes()

PyObject * DocumentPy::getCustomAttributes

(

const char *

attr

)

const

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

References getDocumentPtr(), and Gui::Document::getViewProviderByName().

getDocument()

Py::Object DocumentPy::getDocument

(

void

)

const

getter for the Document attribute

References Gui::Document::getDocument(), and getDocumentPtr().

Referenced by addAnnotation(), and staticCallback_getDocument().

getDocumentPtr()

Document * DocumentPy::getDocumentPtr

(

void

)

const

getter for the object handled by this class

Referenced by activeObject(), activeView(), addAnnotation(), getActiveObject(), getActiveView(), getCustomAttributes(), getDocument(), getInEdit(), getModified(), getObject(), hide(), mdiViewsOfType(), mergeProject(), representation(), resetEdit(), scrollToTreeItem(), sendMsgToViews(), setCustomAttributes(), setEdit(), setPos(), show(), toggleTreeItem(), and update().

getInEdit()

PyObject * DocumentPy::getInEdit

(

PyObject *

args

)

implementer for the getInEdit() method

References getDocumentPtr(), Gui::Document::getInEdit(), and Gui::ViewProvider::getPyObject().

Referenced by staticCallback_getInEdit().

getModified()

Py::Boolean DocumentPy::getModified

(

void

)

const

getter for the Modified attribute

References getDocumentPtr().

Referenced by staticCallback_getModified().

getObject()

PyObject * DocumentPy::getObject

(

PyObject *

args

)

implementer for the getObject() method

References getDocumentPtr(), Gui::ViewProvider::getPyObject(), and Gui::Document::getViewProviderByName().

Referenced by staticCallback_getObject().

GetType()

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

virtual

Reimplemented from Base::PersistencePy.

hide()

PyObject * DocumentPy::hide

(

PyObject *

args

)

implementer for the hide() method

References getDocumentPtr(), and Gui::Document::setHide().

Referenced by Mod.Show.mTempoVis.TempoVis::hide_all_dependencies(), Mod.Show.mTempoVis.TempoVis::hide_all_dependent(), and staticCallback_hide().

mdiViewsOfType()

PyObject * DocumentPy::mdiViewsOfType

(

PyObject *

args

)

implementer for the mdiViewsOfType() method

References Base::Type::badType(), Base::BaseExceptionFreeCADError, Base::Type::fromName(), getDocumentPtr(), and Gui::Document::getMDIViewsOfType().

Referenced by staticCallback_mdiViewsOfType().

mergeProject()

PyObject * DocumentPy::mergeProject

(

PyObject *

args

)

implementer for the mergeProject() method

References Gui::Document::getDocument(), getDocumentPtr(), and Gui::MergeDocuments::importObjects().

Referenced by staticCallback_mergeProject().

PyInit()

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

virtual

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

Reimplemented from Base::PersistencePy.

PyMake()

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

static

representation()

std::string DocumentPy::representation

(

void

)

const

References getDocumentPtr().

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

resetEdit()

PyObject * DocumentPy::resetEdit

(

PyObject *

args

)

implementer for the resetEdit() method

References getDocumentPtr(), and Gui::Document::resetEdit().

Referenced by staticCallback_resetEdit().

scrollToTreeItem()

PyObject * DocumentPy::scrollToTreeItem

(

PyObject *

args

)

implementer for the scrollToTreeItem() method

References getDocumentPtr(), Gui::Document::signalScrollToObject, and Gui::ViewProviderDocumentObjectPy::Type.

Referenced by staticCallback_scrollToTreeItem().

sendMsgToViews()

PyObject * DocumentPy::sendMsgToViews

(

PyObject *

args

)

implementer for the sendMsgToViews() method

References getDocumentPtr(), and Gui::Document::sendMsgToViews().

Referenced by staticCallback_sendMsgToViews().

setActiveObject()

void DocumentPy::setActiveObject

(

Py::Object

arg

)

setter for the ActiveObject attribute

Referenced by staticCallback_setActiveObject().

setActiveView()

void DocumentPy::setActiveView

(

Py::Object

arg

)

setter for the ActiveView attribute

Referenced by staticCallback_setActiveView().

setCustomAttributes()

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

setter for special attributes (e.g.

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

References getDocumentPtr(), and Gui::Document::getViewProviderByName().

setEdit()

PyObject * DocumentPy::setEdit

(

PyObject *

args

)

implementer for the setEdit() method

References Base::BaseExceptionFreeCADError, Gui::Document::getDocument(), getDocumentPtr(), App::Document::getObject(), Gui::Application::getViewProvider(), Gui::ViewProviderPy::getViewProviderPtr(), Gui::Application::Instance, Gui::Document::setEdit(), Gui::ViewProviderPy::Type, and App::DocumentObjectPy::Type.

Referenced by PathScripts.PathSetupSheetGui.ViewProvider::doubleClicked(), PathScripts.PathToolBitGui.ViewProvider::doubleClicked(), ArchReference.ViewProviderArchReference::doubleClicked(), Spreadsheet_legacy.ViewProviderSpreadsheet::doubleClicked(), ArchAxis.ViewProviderArchGrid::doubleClicked(), ArchSchedule.CommandArchSchedule::IsActive(), ArchAxis.CommandArchGrid::IsActive(), PathScripts.PathIconViewProvider.ViewProvider::setupContextMenu(), PathScripts.PathToolControllerGui.ViewProvider::setupContextMenu(), PathScripts.PathOpGui.ViewProvider::setupContextMenu(), PathScripts.PathJobGui.ViewProvider::setupContextMenu(), and staticCallback_setEdit().

setPos()

PyObject * DocumentPy::setPos

(

PyObject *

args

)

implementer for the setPos() method

References getDocumentPtr(), Gui::Document::setPos(), and Base::MatrixPy::Type.

Referenced by staticCallback_setPos().

show()

PyObject * DocumentPy::show

(

PyObject *

args

)

implementer for the show() method

References getDocumentPtr(), and Gui::Document::setShow().

Referenced by Mod.Show.mTempoVis.TempoVis::show_all_dependencies(), Mod.Show.mTempoVis.TempoVis::show_all_dependent(), and staticCallback_show().

staticCallback_activeObject()

PyObject * DocumentPy::staticCallback_activeObject ( PyObject *  self, PyObject *  args  )

static

callback for the activeObject() method

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

staticCallback_activeView()

PyObject * DocumentPy::staticCallback_activeView ( PyObject *  self, PyObject *  args  )

static

callback for the activeView() method

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

staticCallback_addAnnotation()

PyObject * DocumentPy::staticCallback_addAnnotation ( PyObject *  self, PyObject *  args  )

static

callback for the addAnnotation() method

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

staticCallback_getActiveObject()

PyObject * DocumentPy::staticCallback_getActiveObject ( PyObject *  self, void *  closure  )

static

getter callback for the ActiveObject attribute

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

staticCallback_getActiveView()

PyObject * DocumentPy::staticCallback_getActiveView ( PyObject *  self, void *  closure  )

static

getter callback for the ActiveView attribute

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

staticCallback_getDocument()

PyObject * DocumentPy::staticCallback_getDocument ( PyObject *  self, void *  closure  )

static

getter callback for the Document attribute

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

staticCallback_getInEdit()

PyObject * DocumentPy::staticCallback_getInEdit ( PyObject *  self, PyObject *  args  )

static

callback for the getInEdit() method

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

staticCallback_getModified()

PyObject * DocumentPy::staticCallback_getModified ( PyObject *  self, void *  closure  )

static

getter callback for the Modified attribute

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

staticCallback_getObject()

PyObject * DocumentPy::staticCallback_getObject ( PyObject *  self, PyObject *  args  )

static

callback for the getObject() method

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

staticCallback_hide()

PyObject * DocumentPy::staticCallback_hide ( PyObject *  self, PyObject *  args  )

static

callback for the hide() method

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

staticCallback_mdiViewsOfType()

PyObject * DocumentPy::staticCallback_mdiViewsOfType ( PyObject *  self, PyObject *  args  )

static

callback for the mdiViewsOfType() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isValid(), mdiViewsOfType(), and Base::PyObjectBase::PyObjectBase().

staticCallback_mergeProject()

PyObject * DocumentPy::staticCallback_mergeProject ( PyObject *  self, PyObject *  args  )

static

callback for the mergeProject() method

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

staticCallback_resetEdit()

PyObject * DocumentPy::staticCallback_resetEdit ( PyObject *  self, PyObject *  args  )

static

callback for the resetEdit() method

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

staticCallback_scrollToTreeItem()

PyObject * DocumentPy::staticCallback_scrollToTreeItem ( PyObject *  self, PyObject *  args  )

static

callback for the scrollToTreeItem() method

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

staticCallback_sendMsgToViews()

PyObject * DocumentPy::staticCallback_sendMsgToViews ( PyObject *  self, PyObject *  args  )

static

callback for the sendMsgToViews() method

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

staticCallback_setActiveObject()

int DocumentPy::staticCallback_setActiveObject ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the ActiveObject attribute

References Base::BaseExceptionFreeCADError, Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and setActiveObject().

staticCallback_setActiveView()

int DocumentPy::staticCallback_setActiveView ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the ActiveView attribute

References Base::BaseExceptionFreeCADError, Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and setActiveView().

staticCallback_setDocument()

int DocumentPy::staticCallback_setDocument ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the Document attribute

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

staticCallback_setEdit()

PyObject * DocumentPy::staticCallback_setEdit ( PyObject *  self, PyObject *  args  )

static

callback for the setEdit() method

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

staticCallback_setModified()

int DocumentPy::staticCallback_setModified ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the Modified attribute

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

staticCallback_setPos()

PyObject * DocumentPy::staticCallback_setPos ( PyObject *  self, PyObject *  args  )

static

callback for the setPos() method

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

staticCallback_show()

PyObject * DocumentPy::staticCallback_show ( PyObject *  self, PyObject *  args  )

static

callback for the show() method

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

staticCallback_toggleTreeItem()

PyObject * DocumentPy::staticCallback_toggleTreeItem ( PyObject *  self, PyObject *  args  )

static

callback for the toggleTreeItem() method

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

staticCallback_update()

PyObject * DocumentPy::staticCallback_update ( PyObject *  self, PyObject *  args  )

static

callback for the update() method

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

toggleTreeItem()

PyObject * DocumentPy::toggleTreeItem

(

PyObject *

args

)

implementer for the toggleTreeItem() method

References Gui::CollapseItem, Gui::ExpandItem, Gui::ExpandPath, getDocumentPtr(), App::DocumentObject::getSubObject(), Gui::Document::getViewProvider(), Gui::Document::signalExpandObject, Gui::ToggleItem, and App::DocumentObjectPy::Type.

Referenced by staticCallback_toggleTreeItem().

update()

PyObject * DocumentPy::update

(

PyObject *

args

)

implementer for the update() method

References getDocumentPtr(), and Gui::Document::onUpdate().

Referenced by ArchAxis.AxisSystemTaskPanel::addElement(), ArchSectionPlane.SectionPlaneTaskPanel::addElement(), ArchComponent.ComponentTaskPanel::addElement(), DraftGui.FacebinderTaskPanel::addElement(), femtaskpanels.task_result_mechanical._TaskPanel::calculate(), Spreadsheet_legacy.SpreadsheetView::changeCell(), draftguitools.gui_edit.Edit::endEditing(), draftguitools.gui_trackers.boxTracker::height(), ArchAxis.CommandArchGrid::IsActive(), draftguitools.gui_trackers.rectangleTracker::p3(), Plot.Plot::plot(), Spreadsheet_legacy.SpreadsheetView::recompute(), ArchAxis.AxisSystemTaskPanel::removeElement(), ArchSectionPlane.SectionPlaneTaskPanel::removeElement(), ArchComponent.ComponentTaskPanel::removeElement(), DraftGui.FacebinderTaskPanel::removeElement(), draftguitools.gui_trackers.gridTracker::reset(), ArchNesting.Nester::run(), staticCallback_update(), and draftguitools.gui_edit.Edit::update_object().

Member Data Documentation

GetterSetter

PyGetSetDef DocumentPy::GetterSetter

static

Initial value:

= {
    {"ActiveObject",
        (getter) staticCallback_getActiveObject,
        (setter) staticCallback_setActiveObject, 
        "The active object of the document",
        NULL
    },
    {"ActiveView",
        (getter) staticCallback_getActiveView,
        (setter) staticCallback_setActiveView, 
        "The active view of the document",
        NULL
    },
    {"Document",
        (getter) staticCallback_getDocument,
        (setter) staticCallback_setDocument, 
        "The related App document to this Gui document",
        NULL
    },
    {"Modified",
        (getter) staticCallback_getModified,
        (setter) staticCallback_setModified, 
        "Returns True if the document is marked as modified, and False otherwise",
        NULL
    },
    {NULL, NULL, NULL, NULL, NULL}              
}

Attribute structure of DocumentPy.

Methods

PyMethodDef DocumentPy::Methods

static

Methods structure of DocumentPy.

Type

PyTypeObject DocumentPy::Type

static

Type structure of DocumentPy.

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/DocumentPy.h
• src/Gui/DocumentPyImp.cpp
• build/webdoc/src/Gui/DocumentPy.cpp