Document Class Reference

#include <Document.h>

Collaboration diagram for Document:

Public Member Functions
	Document ()
virtual	~Document ()
const set< Object * > *	getObjects ()
Object *	getObjectById (const string &)
Object *	getObjectByIdOrAlias (const string &)
void	addObject (Object *)
Context *	getRoot ()
MediaSettings *	getSettings ()
const set< Media * > *	getMedias ()
const set< Context * > *	getContexts ()
const set< Switch * > *	getSwitches ()
int	evalAction (Event *, Event::Transition, const string &value="")
int	evalAction (Action)
bool	evalPredicate (Predicate *)
bool	evalPropertyRef (const string &, string *)
bool	getData (const string &, void **)
bool	setData (const string &, void *, UserDataCleanFunc fn=nullptr)

Private Attributes
set< Object * >	_objects
Context *	_root
MediaSettings *	_settings
set< Media * >	_medias
set< Context * >	_contexts
set< Switch * >	_switches
UserData	_udata

Constructor & Destructor Documentation

GINGA_NAMESPACE_BEGIN Document::Document

(

)

References _root, _settings, Composition::addChild(), and addObject().

Document::~Document ( )

virtual

References _objects.

Member Function Documentation

void Document::addObject

(

Object *

obj

)

References _contexts, _medias, _objects, _settings, _switches, cast, g_assert(), g_assert_nonnull(), Object::getId(), getObjectByIdOrAlias(), Object::initDocument(), instanceof, and unlikely.

Referenced by Composition::addChild(), and Document().

int Document::evalAction	(	Event *	event,
		Event::Transition	transition,
		const string &	value = ""
	)

References Action::event, g_assert_nonnull(), Action::predicate, Action::transition, and Action::value.

Referenced by Switch::endTransition(), Media::endTransition(), Context::endTransition(), Media::sendKeyEvent(), Media::sendTickEvent(), Object::sendTickEvent(), and MediaSettings::updateCurrentFocus().

int Document::evalAction

(

Action

init

)

References Event::ATTRIBUTION, cast, evalPredicate(), Action::event, g_assert_nonnull(), Context::getLinks(), Context::getLinksStatus(), Event::getObject(), Object::getParent(), Event::getType(), instanceof, Object::isOccurring(), n, Event::setParameter(), Event::transition(), Action::transition, and Action::value.

bool Document::evalPredicate

(

Predicate *

pred

)

References Predicate::ATOM, Predicate::CONJUNCTION, Predicate::DISJUNCTION, Predicate::EQ, evalPropertyRef(), Predicate::FALSUM, Predicate::GE, Predicate::getChildren(), Predicate::getTest(), Predicate::getType(), Predicate::GT, Predicate::LE, Predicate::LT, Predicate::NE, Predicate::NEGATION, strbool, TRACE, and Predicate::VERUM.

Referenced by evalAction(), and Switch::startTransition().

bool Document::evalPropertyRef	(	const string &	ref,
		string *	result
	)

References getObjectByIdOrAlias(), Object::getProperty(), and tryset.

Referenced by Media::endTransition(), and evalPredicate().

const set< Context * > * Document::getContexts

(

)

References _contexts.

bool Document::getData	(	const string &	key,
		void **	value
	)

References _udata, and UserData::getData().

Referenced by Media::startTransition().

const set< Media * > * Document::getMedias

(

)

References _medias.

Referenced by MediaSettings::updateCurrentFocus().

Object * Document::getObjectById

(

const string &

id

)

References _objects.

Referenced by getObjectByIdOrAlias().

Object * Document::getObjectByIdOrAlias

(

const string &

id

)

References _objects, getObjectById(), and Object::hasAlias().

Referenced by addObject(), evalPropertyRef(), and ParserState::popNcl().

const set< Object * > * Document::getObjects

(

)

References _objects.

Context * Document::getRoot

(

)

References _root, and g_assert_nonnull().

Referenced by ParserState::pushNcl().

MediaSettings * Document::getSettings

(

)

References _settings, and g_assert_nonnull().

Referenced by ParserState::pushMedia(), and Media::sendKeyEvent().

const set< Switch * > * Document::getSwitches

(

)

References _switches.

bool Document::setData	(	const string &	key,
		void *	value,
		UserDataCleanFunc	fn = nullptr
	)

References _udata, GINGA_NAMESPACE_END, and UserData::setData().

Member Data Documentation

set<Context *> Document::_contexts

private

Referenced by addObject(), and getContexts().

set<Media *> Document::_medias

private

Referenced by addObject(), and getMedias().

set<Object *> Document::_objects

private

Referenced by addObject(), getObjectById(), getObjectByIdOrAlias(), getObjects(), and ~Document().

Context* Document::_root

private

Referenced by Document(), and getRoot().

MediaSettings* Document::_settings

private

Referenced by addObject(), Document(), and getSettings().

set<Switch *> Document::_switches

private

Referenced by addObject(), and getSwitches().

UserData Document::_udata

private

Referenced by getData(), and setData().

---

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

• Document.h
• Document.cpp