App::DocumentObjectT Class Reference

The DocumentObjectT class is a helper class to store the names of a document object and its document. More...

#include <DocumentObserver.h>

Public Member Functions
	DocumentObjectT ()
	DocumentObjectT (const char *docName, const char *objName)
	DocumentObjectT (const DocumentObject *)
	DocumentObjectT (const DocumentObjectT &)
	DocumentObjectT (const Property *)
	DocumentObjectT (DocumentObjectT &&)
Document *	getDocument () const
const std::string &	getDocumentName () const
std::string	getDocumentPython () const
DocumentObject *	getObject () const
template<typename T >
T *	getObjectAs () const
const std::string &	getObjectLabel () const
const std::string &	getObjectName () const
std::string	getObjectPython () const
Property *	getProperty () const
template<typename T >
T *	getPropertyAs () const
const std::string &	getPropertyName () const
std::string	getPropertyPython () const
void	operator= (const DocumentObject *)
DocumentObjectT &	operator= (const DocumentObjectT &)
void	operator= (const Property *)
DocumentObjectT &	operator= (DocumentObjectT &&)
bool	operator== (const DocumentObjectT &) const
	~DocumentObjectT ()

Detailed Description

The DocumentObjectT class is a helper class to store the names of a document object and its document.

This can be useful when you cannot rely on that the document or the object still exists when you have to access it.

Author

Werner Mayer

Constructor & Destructor Documentation

DocumentObjectT() [1/6]

DocumentObjectT::DocumentObjectT

(

)

Constructor

DocumentObjectT() [2/6]

DocumentObjectT::DocumentObjectT

(

const DocumentObjectT &

other

)

Constructor

DocumentObjectT() [3/6]

DocumentObjectT::DocumentObjectT

(

DocumentObjectT &&

other

)

Constructor

DocumentObjectT() [4/6]

DocumentObjectT::DocumentObjectT

(

const DocumentObject *

obj

)

Constructor

DocumentObjectT() [5/6]

DocumentObjectT::DocumentObjectT	(	const char *	docName,
		const char *	objName
	)

Constructor

DocumentObjectT() [6/6]

DocumentObjectT::DocumentObjectT

(

const Property *

prop

)

Constructor

~DocumentObjectT()

DocumentObjectT::~DocumentObjectT

(

)

Destructor

Member Function Documentation

getDocument()

Document * DocumentObjectT::getDocument

(

)

const

Get a pointer to the document or 0 if it doesn't exist any more.

References App::GetApplication(), and App::Application::getDocument().

Referenced by getObject(), and Gui::PropertyEditor::PropertyLinkItem::toString().

getDocumentName()

const std::string & DocumentObjectT::getDocumentName

(

)

const

Get the name of the document.

Referenced by App::SubObjectT::operator<(), and Gui::PropertyEditor::LinkSelection::select().

getDocumentPython()

std::string DocumentObjectT::getDocumentPython

(

)

const

Get the document as Python command.

Referenced by ReenGui::FitBSplineSurfaceWidget::accept(), and ReenGui::PoissonWidget::accept().

getObject()

DocumentObject * DocumentObjectT::getObject

(

)

const

Get a pointer to the document object or 0 if it doesn't exist any more.

References getDocument().

Referenced by Gui::TaskCSysDragger::accept(), Gui::Dialog::DlgPropertyLink::formatObject(), App::SubObjectT::getNewElementName(), App::SubObjectT::getOldElementName(), getProperty(), App::SubObjectT::getSubObject(), App::SubObjectT::getSubObjectList(), Gui::Dialog::DlgPropertyLink::init(), Gui::PropertyEditor::LinkLabel::updatePropertyLink(), and MeshPartGui::Mesh2ShapeGmsh::writeProject().

getObjectAs()

template<typename T >

T* App::DocumentObjectT::getObjectAs

(

)

const

Get a pointer to the document or 0 if it doesn't exist any more or the type doesn't match.

getObjectLabel()

const std::string & DocumentObjectT::getObjectLabel

(

)

const

Get the label of the document object.

getObjectName()

const std::string & DocumentObjectT::getObjectName

(

)

const

Get the name of the document object.

Referenced by Gui::SelectionSingleton::hasPreselection(), App::SubObjectT::operator<(), Gui::PropertyEditor::LinkSelection::select(), and Gui::SelectionSingleton::setPreselectCoord().

getObjectPython()

std::string DocumentObjectT::getObjectPython

(

)

const

Get the document object as Python command.

Referenced by ReenGui::FitBSplineSurfaceWidget::accept(), ReenGui::PoissonWidget::accept(), and App::SubObjectT::getSubObjectPython().

getProperty()

Property * DocumentObjectT::getProperty

(

)

const

Get a pointer to the property or 0 if it doesn't exist any more.

References getObject().

Referenced by Gui::Dialog::DlgPropertyLink::init(), and Gui::PropertyEditor::LinkLabel::updatePropertyLink().

getPropertyAs()

template<typename T >

T* App::DocumentObjectT::getPropertyAs

(

)

const

getPropertyName()

const std::string & DocumentObjectT::getPropertyName

(

)

const

Get the name of the property.

Referenced by App::SubObjectT::operator<().

getPropertyPython()

std::string DocumentObjectT::getPropertyPython

(

)

const

Get the property as Python command.

operator=() [1/4]

void DocumentObjectT::operator=

(

const DocumentObject *

obj

)

Assignment operator

operator=() [2/4]

DocumentObjectT & DocumentObjectT::operator=

(

const DocumentObjectT &

obj

)

Assignment operator

operator=() [3/4]

void DocumentObjectT::operator=

(

const Property *

prop

)

Assignment operator

References Base::Persistence::getClassTypeId(), App::Property::getContainer(), App::Property::getName(), App::DocumentObject::getNameInDocument(), and Base::BaseClass::isDerivedFrom().

operator=() [4/4]

DocumentObjectT & DocumentObjectT::operator=

(

DocumentObjectT &&

obj

)

Assignment operator

operator==()

bool DocumentObjectT::operator==

(

const DocumentObjectT &

other

)

const

Equality operator

---

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

• src/App/DocumentObserver.h
• src/App/DocumentObserver.cpp