#include <Composition.h>

Inheritance diagram for Composition:

Collaboration diagram for Composition:

[legend]

Public Member Functions
	Composition (const string &)

virtual	~Composition ()=0

const set< Object * > *	getChildren ()

Object *	getChildById (const string &)

Object *	getChildByIdOrAlias (const string &)

void	addChild (Object *)

string	getId ()

Document *	getDocument ()

void	initDocument (Document *)

Composition *	getParent ()

void	initParent (Composition *)

virtual string	getObjectTypeAsString ()=0

virtual string	toString ()

const list< string > *	getAliases ()

bool	hasAlias (const string &)

void	addAlias (const string &)

const set< Event * > *	getEvents ()

Event *	getEvent (Event::Type, const string &)

Event *	getAttributionEvent (const string &)

void	addAttributionEvent (const string &)

Event *	getPresentationEvent (const string &)

void	addPresentationEvent (const string &, Time, Time)

Event *	getSelectionEvent (const string &)

void	addSelectionEvent (const string &)

Event *	getLambda ()

bool	isOccurring ()

bool	isPaused ()

bool	isSleeping ()

virtual string	getProperty (const string &)

virtual void	setProperty (const string &, const string &, Time dur=0)

list< pair< Action, Time > > *	getDelayedActions ()

void	addDelayedAction (Event *, Event::Transition, const string &value="", Time delay=0)

virtual void	sendKeyEvent (const string &, bool)

virtual void	sendTickEvent (Time, Time, Time)

virtual bool	startTransition (Event *, Event::Transition)=0

virtual void	endTransition (Event *, Event::Transition)=0

bool	getData (const string &, void **)

bool	setData (const string &, void *, UserDataCleanFunc fn=nullptr)

Protected Member Functions
virtual void	doStart ()

virtual void	doStop ()

Protected Attributes
set< Object * >	_children

string	_id

Document *	_doc

Composition *	_parent

list< string >	_aliases

Time	_time

map< string, string >	_properties

Event *	_lambda

set< Event * >	_events

list< pair< Action, Time > >	_delayed

UserData	_udata

Constructor & Destructor Documentation

GINGA_NAMESPACE_BEGIN Composition::Composition ( const string & id )

Composition::~Composition ( )

pure virtual

Member Function Documentation

void Object::addAlias ( const string & alias )

inherited

References Object::_aliases, and tryinsert.

Referenced by ParserState::pushContext(), ParserState::pushMedia(), ParserState::pushNcl(), and Formatter::start().

void Object::addAttributionEvent ( const string & propName )

inherited

References Object::_events, Event::ATTRIBUTION, and Object::getAttributionEvent().

Referenced by MediaSettings::MediaSettings(), Formatter::obtainEvent(), and ParserState::pushProperty().

void Composition::addChild ( Object * child )

References _children, Object::_doc, Document::addObject(), g_assert_nonnull(), GINGA_NAMESPACE_END, Object::initParent(), and tryinsert.

Referenced by Document::Document(), Formatter::obtainExecutionObject(), ParserState::pushContext(), and ParserState::pushMedia().

void Object::addDelayedAction	(	Event *	event,
		Event::Transition	transition,
		const string &	value = `""`,
		Time	delay = `0`
	)

inherited

References Object::_delayed, Object::_time, Action::event, Action::transition, and Action::value.

Referenced by Media::endTransition().

void Object::addPresentationEvent	(	const string &	id,
		Time	begin,
		Time	end
	)

inherited

References Object::_events, Object::getPresentationEvent(), Event::PRESENTATION, and Event::setInterval().

Referenced by Object::Object(), Formatter::obtainEvent(), and ParserState::pushArea().

void Object::addSelectionEvent ( const string & key )

inherited

References Object::_events, Object::getSelectionEvent(), and Event::SELECTION.

Referenced by Formatter::obtainEvent(), and ParserState::popNcl().

void Object::doStart ( )

protectedvirtualinherited

References Object::_time.

Referenced by Switch::endTransition(), Media::endTransition(), and Context::endTransition().

void Object::doStop ( )

protectedvirtualinherited

Reimplemented in Media.

References Object::_delayed, Object::_events, Object::_time, GINGA_NAMESPACE_END, and GINGA_TIME_NONE.

Referenced by Media::doStop(), Switch::endTransition(), Context::endTransition(), and Object::~Object().

virtual void Object::endTransition	(	Event *	,
		Event::Transition
	)

pure virtualinherited

Implemented in Context, Media, and Switch.

Referenced by Event::transition().

const list< string > * Object::getAliases ( )

inherited

References Object::_aliases.

Event * Object::getAttributionEvent ( const string & propName )

inherited

References Event::ATTRIBUTION, and Object::getEvent().

Referenced by Object::addAttributionEvent(), Formatter::obtainEvent(), ParserState::resolveInterfaceRef(), and MediaSettings::updateCurrentFocus().

Object * Composition::getChildById ( const string & id )

References _children.

Referenced by getChildByIdOrAlias().

Object * Composition::getChildByIdOrAlias ( const string & id )

References _children, getChildById(), and Object::hasAlias().

Referenced by ParserState::resolveComponentRef().

const set< Object * > * Composition::getChildren ( )

References _children.

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

inherited

References Object::_udata, and UserData::getData().

list< pair< Action, Time > > * Object::getDelayedActions ( )

inherited

References Object::_delayed.

Document * Object::getDocument ( )

inherited

References Object::_doc.

Event * Object::getEvent	(	Event::Type	type,
		const string &	id
	)

inherited

References Object::_events.

Referenced by Object::getAttributionEvent(), Object::getPresentationEvent(), Object::getSelectionEvent(), and Formatter::obtainEvent().

const set< Event * > * Object::getEvents ( )

inherited

References Object::_events.

string Object::getId ( )

inherited

References Object::_id.

Referenced by Document::addObject(), Event::getFullId(), ParserState::resolveComponentRef(), ParserState::resolveGhostBindRef(), ParserState::resolveInterfaceRef(), Object::toString(), and Event::toString().

Event * Object::getLambda ( )

inherited

References Object::_lambda, and g_assert_nonnull().

Referenced by Formatter::obtainFormatterEventFromBind(), ParserState::resolveInterfaceRef(), Media::sendTickEvent(), Formatter::start(), and Switch::startTransition().

virtual string Object::getObjectTypeAsString ( )

pure virtualinherited

Implemented in Context, Media, Switch, and MediaSettings.

Referenced by Object::toString(), and Event::toString().

Composition * Object::getParent ( )

inherited

References Object::_parent.

Referenced by Document::evalAction().

Event * Object::getPresentationEvent ( const string & id )

inherited

References Object::getEvent(), and Event::PRESENTATION.

Referenced by Object::addPresentationEvent(), Object::Object(), Formatter::obtainEvent(), and ParserState::resolveInterfaceRef().

string Object::getProperty ( const string & name )

virtualinherited

Reimplemented in Context.

References Object::_properties.

Referenced by Document::evalPropertyRef(), Context::getProperty(), and Media::setProperty().

Event * Object::getSelectionEvent ( const string & key )

inherited

References Object::getEvent(), and Event::SELECTION.

Referenced by Object::addSelectionEvent(), Formatter::obtainEvent(), and ParserState::popNcl().

bool Object::hasAlias ( const string & alias )

inherited

References Object::_aliases.

Referenced by getChildByIdOrAlias(), Document::getObjectByIdOrAlias(), and ParserState::resolveComponentRef().

void Object::initDocument ( Document * doc )

inherited

References Object::_doc, and g_assert_nonnull().

Referenced by Document::addObject().

void Object::initParent ( Composition * parent )

inherited

References Object::_parent, and g_assert_nonnull().

Referenced by addChild().

bool Object::isOccurring ( )

inherited

References Object::_lambda, g_assert_nonnull(), Event::getState(), and Event::OCCURRING.

Referenced by Media::endTransition(), Document::evalAction(), Media::isFocused(), Object::sendTickEvent(), and Media::startTransition().

bool Object::isPaused ( )

inherited

References Object::_lambda, g_assert_nonnull(), Event::getState(), and Event::PAUSED.

bool Object::isSleeping ( )

inherited

References Object::_lambda, g_assert_nonnull(), Event::getState(), and Event::SLEEPING.

Referenced by Media::getZ(), and Media::redraw().

void Object::sendKeyEvent	(	const string &	,
		bool
	)

virtualinherited

Reimplemented in Context, and Media.

void Object::sendTickEvent	(	Time	,
		Time	,
		Time
	)

virtualinherited

Reimplemented in Context, Media, and MediaSettings.

References Object::_delayed, Object::_doc, Object::_time, Document::evalAction(), g_assert(), GINGA_TIME_IS_VALID, GINGA_TIME_NONE, and Object::isOccurring().

Referenced by Media::sendTickEvent(), and Context::sendTickEvent().

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

inherited

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

void Object::setProperty	(	const string &	name,
		const string &	value,
		Time	dur = `0`
	)

virtualinherited

Reimplemented in Context, Media, and MediaSettings.

References Object::_properties, g_assert(), and GINGA_TIME_IS_VALID.

Referenced by ParserState::pushProperty(), Media::setProperty(), and Context::setProperty().

virtual bool Object::startTransition	(	Event *	,
		Event::Transition
	)

pure virtualinherited

Implemented in Context, Media, and Switch.

Referenced by Event::transition().

string Object::toString ( )

virtualinherited

Reimplemented in Context, and Media.

References Object::_aliases, Object::_events, Object::_id, Object::_parent, Object::_properties, Object::_time, Event::ATTRIBUTION, c_str, Object::getId(), Object::getObjectTypeAsString(), GINGA_TIME_ARGS, GINGA_TIME_FORMAT, GINGA_TIME_IS_VALID, Event::PRESENTATION, Event::SELECTION, and xstrbuild().

Referenced by Context::toString(), and Media::toString().

Member Data Documentation

list<string> Object::_aliases

protectedinherited

Referenced by Object::addAlias(), Object::getAliases(), Object::hasAlias(), and Object::toString().

set<Object *> Composition::_children

protected

Referenced by addChild(), getChildById(), getChildByIdOrAlias(), getChildren(), and Context::startTransition().

list<pair<Action, Time> > Object::_delayed

protectedinherited

Referenced by Object::addDelayedAction(), Object::doStop(), Object::getDelayedActions(), and Object::sendTickEvent().

Document* Object::_doc

protectedinherited

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

set<Event *> Object::_events

protectedinherited

Referenced by Object::addAttributionEvent(), Object::addPresentationEvent(), Object::addSelectionEvent(), Object::doStop(), Media::endTransition(), Object::getEvent(), Object::getEvents(), Media::sendKeyEvent(), Object::toString(), and Object::~Object().

string Object::_id

protectedinherited

Referenced by Object::getId(), Object::Object(), Media::startTransition(), and Object::toString().

Event* Object::_lambda

protectedinherited

Referenced by Object::getLambda(), Object::isOccurring(), Object::isPaused(), Object::isSleeping(), and Object::Object().

Composition* Object::_parent

protectedinherited

Referenced by Object::getParent(), Object::initParent(), Object::Object(), and Object::toString().

map<string, string> Object::_properties

protectedinherited

Referenced by Object::getProperty(), Object::setProperty(), Media::startTransition(), and Object::toString().

Time Object::_time

protectedinherited

Referenced by Object::addDelayedAction(), Object::doStart(), Object::doStop(), Media::endTransition(), Object::Object(), Media::sendTickEvent(), Object::sendTickEvent(), and Object::toString().

UserData Object::_udata

protectedinherited

Referenced by Object::getData(), and Object::setData().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation