Gui::ActiveObjectList Class Reference

List of active or special objects This class holds a list of objects with a special name. More...

#include <ActiveObjectList.h>

Public Member Functions
	ActiveObjectList (Document *doc)
template<typename _T >
_T	getObject (const char *name, App::DocumentObject **parent=nullptr, std::string *subname=nullptr) const
bool	hasObject (App::DocumentObject *obj, const char *, const char *subname=nullptr) const
bool	hasObject (const char *) const
void	objectDeleted (const ViewProviderDocumentObject &viewProviderIn)
void	setObject (App::DocumentObject *, const char *, const char *subname=nullptr, const Gui::HighlightMode &m=HighlightMode::UserDefined)

Detailed Description

List of active or special objects This class holds a list of objects with a special name.

Its mainly used to points to something like the active Body or Part in a edit session. The class is used the viewer (editor) of a document.

See also

Gui::MDIViewer

Author

Jürgen Riegel

Constructor & Destructor Documentation

ActiveObjectList()

Gui::ActiveObjectList::ActiveObjectList

(

Document *

doc

)

Member Function Documentation

getObject()

template<typename _T >

_T Gui::ActiveObjectList::getObject	(	const char *	name,
		App::DocumentObject **	parent = nullptr,
		std::string *	subname = nullptr
	)		const

hasObject() [1/2]

bool Gui::ActiveObjectList::hasObject	(	App::DocumentObject *	obj,
		const char *	name,
		const char *	subname = nullptr
	)		const

hasObject() [2/2]

bool Gui::ActiveObjectList::hasObject

(

const char *

name

)

const

objectDeleted()

void ActiveObjectList::objectDeleted

(

const ViewProviderDocumentObject &

viewProviderIn

)

References Gui::ViewProviderDocumentObject::getObject().

setObject()

void Gui::ActiveObjectList::setObject	(	App::DocumentObject *	obj,
		const char *	name,
		const char *	subname = nullptr,
		const Gui::HighlightMode &	m = HighlightMode::UserDefined
	)

---

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

• FreeCAD/src/Gui/ActiveObjectList.h
• FreeCAD/src/Gui/ActiveObjectList.cpp