App::DocumentT Class Reference

The DocumentT class is a helper class to store the name of a document. More...

#include <DocumentObserver.h>

Public Member Functions
	DocumentT ()
	DocumentT (const DocumentT &)
	DocumentT (const std::string &)
	DocumentT (Document *)
Document *	getDocument () const
const std::string &	getDocumentName () const
std::string	getDocumentPython () const
bool	operator< (const DocumentT &other) const
void	operator= (const Document *)
void	operator= (const DocumentT &)
void	operator= (const std::string &)
bool	operator== (const DocumentT &other) const
	~DocumentT ()

Detailed Description

The DocumentT class is a helper class to store the name of a document.

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

Author

Werner Mayer

Constructor & Destructor Documentation

DocumentT() [1/4]

DocumentT::DocumentT

(

)

Constructor

DocumentT() [2/4]

DocumentT::DocumentT

(

Document *

doc

)

Constructor

DocumentT() [3/4]

DocumentT::DocumentT

(

const std::string &

name

)

Constructor

DocumentT() [4/4]

DocumentT::DocumentT

(

const DocumentT &

doc

)

Constructor

~DocumentT()

DocumentT::~DocumentT

(

)

Destructor

Member Function Documentation

getDocument()

Document * DocumentT::getDocument

(

void

)

const

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

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

getDocumentName()

const std::string & DocumentT::getDocumentName

(

)

const

Get the name of the document.

getDocumentPython()

std::string DocumentT::getDocumentPython

(

)

const

Get the document as Python command.

operator<()

bool App::DocumentT::operator<

(

const DocumentT &

other

)

const

operator=() [1/3]

void DocumentT::operator=

(

const Document *

doc

)

Assignment operator

operator=() [2/3]

void DocumentT::operator=

(

const DocumentT &

doc

)

Assignment operator

operator=() [3/3]

void DocumentT::operator=

(

const std::string &

name

)

Assignment operator

operator==()

bool App::DocumentT::operator==

(

const DocumentT &

other

)

const

---

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

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