Object Class Reference

#include <Object.h>

Inheritance diagram for Object:

Collaboration diagram for Object:

Public Member Functions
	Object (const string &)
virtual	~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
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 Object::Object

(

const string &

id

)

References _doc, _id, _lambda, _parent, _time, addPresentationEvent(), g_assert_nonnull(), getPresentationEvent(), and GINGA_TIME_NONE.

Object::~Object ( )

virtual

References _events, and doStop().

Member Function Documentation

void Object::addAlias

(

const string &

alias

)

References _aliases, and tryinsert.

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

void Object::addAttributionEvent

(

const string &

propName

)

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

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

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

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

Referenced by Media::endTransition().

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

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

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

void Object::addSelectionEvent

(

const string &

key

)

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

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

void Object::doStart ( )

protectedvirtual

References _time.

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

void Object::doStop ( )

protectedvirtual

Reimplemented in Media.

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

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

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

pure virtual

Implemented in Context, Media, and Switch.

Referenced by Event::transition().

const list< string > * Object::getAliases

(

)

References _aliases.

Event * Object::getAttributionEvent

(

const string &

propName

)

References Event::ATTRIBUTION, and getEvent().

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

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

References _udata, and UserData::getData().

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

(

)

References _delayed.

Document * Object::getDocument

(

)

References _doc.

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

References _events.

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

const set< Event * > * Object::getEvents

(

)

References _events.

string Object::getId

(

)

References _id.

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

Event * Object::getLambda

(

)

References _lambda, and g_assert_nonnull().

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

virtual string Object::getObjectTypeAsString ( )

pure virtual

Implemented in Context, Media, Switch, and MediaSettings.

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

Composition * Object::getParent

(

)

References _parent.

Referenced by Document::evalAction().

Event * Object::getPresentationEvent

(

const string &

id

)

References getEvent(), and Event::PRESENTATION.

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

string Object::getProperty ( const string &  name )

virtual

Reimplemented in Context.

References _properties.

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

Event * Object::getSelectionEvent

(

const string &

key

)

References getEvent(), and Event::SELECTION.

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

bool Object::hasAlias

(

const string &

alias

)

References _aliases.

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

void Object::initDocument

(

Document *

doc

)

References _doc, and g_assert_nonnull().

Referenced by Document::addObject().

void Object::initParent

(

Composition *

parent

)

References _parent, and g_assert_nonnull().

Referenced by Composition::addChild().

bool Object::isOccurring

(

)

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

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

bool Object::isPaused

(

)

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

bool Object::isSleeping

(

)

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

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

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

virtual

Reimplemented in Context, and Media.

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

virtual

Reimplemented in Context, Media, and MediaSettings.

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

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

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

References _udata, and UserData::setData().

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

virtual

Reimplemented in Context, Media, and MediaSettings.

References _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 virtual

Implemented in Context, Media, and Switch.

Referenced by Event::transition().

string Object::toString ( )

virtual

Reimplemented in Context, and Media.

References _aliases, _events, _id, _parent, _properties, _time, Event::ATTRIBUTION, c_str, getId(), 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

protected

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

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

protected

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

Document* Object::_doc

protected

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

set<Event *> Object::_events

protected

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

string Object::_id

protected

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

Event* Object::_lambda

protected

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

Composition* Object::_parent

protected

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

map<string, string> Object::_properties

protected

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

Time Object::_time

protected

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

UserData Object::_udata

protected

Referenced by getData(), and setData().

---

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

• Object.h
• Object.cpp