Ginga Class Reference

Ginga handle. More...

#include <ginga.h>

Inheritance diagram for Ginga:

Public Member Functions
	Ginga (const GingaOptions *opts)
	Creates a new Ginga object. More...
virtual	~Ginga ()=0
	Destroys Ginga object.
virtual GingaState	getState ()=0
	Gets Ginga object state. More...
virtual bool	start (const std::string &path, std::string *errmsg)=0
	Starts the presentation of an NCL file. More...
virtual bool	stop ()=0
	Stops the presentation. More...
virtual void	resize (int width, int height)=0
	Resizes the presentation screen. More...
virtual void	redraw (cairo_t *cr)=0
	Draws the latest frame of the presentation on Cairo context. More...
virtual bool	sendKey (const std::string &key, bool press)=0
	Sends key event to presentation. More...
virtual bool	sendTick (uint64_t total, uint64_t diff, uint64_t frame)=0
	Sends tick event to presentation. More...
virtual const GingaOptions *	getOptions ()=0
	Gets current options. More...
virtual bool	getOptionBool (const std::string &name)=0
	Gets boolean option value. More...
virtual void	setOptionBool (const std::string &name, bool value)=0
	Sets boolean option. More...
virtual int	getOptionInt (const std::string &name)=0
	Gets integer option value. More...
virtual void	setOptionInt (const std::string &name, int value)=0
	Sets integer option. More...
virtual std::string	getOptionString (const std::string &name)=0
	Gets string option value. More...
virtual void	setOptionString (const std::string &name, std::string value)=0
	Sets string option. More...

Static Public Member Functions
static Ginga *	create (const GingaOptions *opts)
	Creates a new Ginga object. More...
static std::string	version ()
	Gets libginga version string. More...

Detailed Description

Ginga handle.

Opaque handle that represents an NCL formatter.

Constructor & Destructor Documentation

Ginga()

Ginga::Ginga

(

const GingaOptions *

opts

)

Creates a new Ginga object.

Parameters

opts	Options to initialize the object with.

Returns

New Ginga.

Member Function Documentation

create()

Ginga * Ginga::create ( const GingaOptions *  opts )

static

Creates a new Ginga object.

Parameters

opts	Options to initialize the object with.

Returns

New Ginga.

getOptionBool()

Ginga::getOptionBool ( const std::string &  name )

pure virtual

Gets boolean option value.

Parameters

name	Option name.

Returns

Option value.

Implemented in Formatter.

getOptionInt()

Ginga::getOptionInt ( const std::string &  name )

pure virtual

Gets integer option value.

Parameters

name	Option name.

Returns

Option value.

Implemented in Formatter.

getOptions()

Ginga::getOptions ( )

pure virtual

Gets current options.

Returns

Current options.

Implemented in Formatter.

getOptionString()

Ginga::getOptionString ( const std::string &  name )

pure virtual

Gets string option value.

Parameters

name	Option name.

Returns

Option value.

Implemented in Formatter.

getState()

Ginga::getState ( )

pure virtual

Gets Ginga object state.

Returns

Ginga object state.

Implemented in Formatter.

redraw()

Ginga::redraw ( cairo_t *  cr )

pure virtual

Draws the latest frame of the presentation on Cairo context.

Parameters

cr	Cairo context.

Implemented in Formatter.

resize()

Ginga::resize ( int  width, int  height  )

pure virtual

Resizes the presentation screen.

Parameters

width	Screen width (in pixels).
height	Screen height (in pixels).

Implemented in Formatter.

sendKey()

Ginga::sendKey ( const std::string &  key, bool  press  )

pure virtual

Sends key event to presentation.

Parameters

key	Key name.
press	Whether the key was pressed (or released).

Returns

true if successful, or false otherwise.

Implemented in Formatter.

sendTick()

Ginga::sendTick ( uint64_t  total, uint64_t  diff, uint64_t  frame  )

pure virtual

Sends tick event to presentation.

Parameters

total	Time since the presentation started.
diff	Time since last tick.
frame	Tick number.

Returns

true if successful, or false otherwise.

Implemented in Formatter.

setOptionBool()

Ginga::setOptionBool ( const std::string &  name, bool  value  )

pure virtual

Sets boolean option.

Parameters

name	Option name.
value	Option value.

Implemented in Formatter.

setOptionInt()

Ginga::setOptionInt ( const std::string &  name, int  value  )

pure virtual

Sets integer option.

Parameters

name	Option name.
value	Option value.

Implemented in Formatter.

setOptionString()

Ginga::setOptionString ( const std::string &  name, std::string  value  )

pure virtual

Sets string option.

Parameters

name	Option name.
value	Option value.

Implemented in Formatter.

start()

Ginga::start ( const std::string &  path, std::string *  errmsg  )

pure virtual

Starts the presentation of an NCL file.

Parameters

	path	Path to NCL file.
[out]	errmsg	Variable to store the error message (if any).

Returns

true if successful or false otherwise.

Implemented in Formatter.

stop()

Ginga::stop ( )

pure virtual

Stops the presentation.

Returns

true if successful or false otherwise.

Implemented in Formatter.

version()

string Ginga::version ( )

static

Gets libginga version string.

Returns

libginga version string.

---

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

• lib/ginga.h
• lib/Ginga.cpp