Null GUI, used when rendering is disabled. More...

#include <NullGui.h>

Inheritance diagram for gnash::NullGui:

Public Member Functions
	NullGui (bool do_loop, RunResources &r)
	~NullGui ()
void	setInterval (unsigned int interval)
	Set main loop delay in milliseconds.
void	setTimeout (unsigned int to)
	Set the time in milliseconds after which the programme should exit.
bool	init (int, char ***)
bool	createWindow (const char *, int, int, int, int)
	Create and display our window.
bool	run ()
	Start main rendering loop.
bool	createMenu ()
bool	setupEvents ()
void	renderBuffer ()
void	quitUI ()
	End main rendering loop calling GUI-specific exit functions.
Public Member Functions inherited from gnash::Gui
virtual	~Gui ()
virtual bool	init (int argc, char **argv[])=0
	/ Initialise the gui and the associated renderer.
virtual VirtualClock &	getClock ()
	Return the clock provided by this Gui.
void	setScreenShotter (std::auto_ptr< ScreenShotter > ss)
virtual void	resizeWindow (int width, int height)
void	quit ()
	Always called on exit.
virtual void	setInvalidatedRegion (const SWFRect &bounds)
	Gives the GUI a hint which region of the stage should be redrawn.
virtual void	setInvalidatedRegions (const InvalidatedRanges &ranges)
virtual void	beforeRendering ()
virtual bool	want_multiple_regions ()
virtual bool	want_redraw ()
	Asks the GUI handler if the next frame should be redrawn completely.
virtual void	setCursor (gnash_cursor_type newcursor)
	Sets the current mouse cursor for the Gui window.
virtual void	setClipboard (const std::string &copy)
virtual double	getPixelAspectRatio () const
virtual std::pair< int, int >	screenResolution () const
virtual double	getScreenDPI () const
virtual std::string	getScreenColor () const
	Get the screen color type.
bool	loops () const
bool	isFullscreen () const
void	notifyMouseMove (int x, int y)
	Mouse notification callback to be called when the mouse is moved.
void	notifyMouseClick (bool mouse_pressed)
	Mouse notification callback to be called when the mouse is clicked.
void	notifyMouseWheel (int delta)
	Send a mouse wheel event to the stage.
void	notify_key_event (gnash::key::code k, int modifier, bool pressed)
	Key event notification to be called when a key is pressed or depressed.
void	resize_view (int width, int height)
	Resize the client area view and the window accordingly.
void	updateStageMatrix ()
bool	advanceMovie (bool doDisplay=true)
	Give movie an heart-beat.
void	refreshView ()
virtual void	setFullscreen ()
virtual void	unsetFullscreen ()
virtual void	hideMenu ()
virtual bool	showMouse (bool show)
	Sets whether the gui should show the system mouse pointer.
virtual void	showMenu (bool show)
	Sets whether the menus should be shown (for fscommand)
virtual void	allowScale (bool allow)
	Sets whether scaling should be allowed (for fscommand)
void	toggleFullscreen ()
void	stop ()
	Put the application in "stop" mode.
void	play ()
	Put the application in "play" mode.
void	pause ()
	Toggle between "stop" and "play" mode.
void	start ()
	Start the movie.
bool	isStopped () const
	See stop(), play() and pause()
bool	isPlugin () const
	Whether gnash is is running as a plugin.
void	takeScreenShot ()
	Take a screenshot now!
void	setMaxAdvances (unsigned long ul)
	Set the maximum number of frame advances before Gnash exits.
void	showUpdatedRegions (bool x)
bool	showUpdatedRegions () const
void	restart ()
void	setQuality (Quality q)
	Set rendering quality, if not locked by RC file..
Quality	getQuality () const
	Get current rendering quality.
void	toggleSound ()
void	addFlashVars (VariableMap &vars)
	Add variables to set into instances of the top-level movie definition.
void	setMovieDefinition (movie_definition *md)
	Set the definition of top-level movie.
void	setStage (movie_root *stage)
	Set the stage to advance/display.
void	setAudioDump (const std::string &fname)
	Set the name of a file to dump audio to.
movie_root *	getStage ()
	The root movie, or "Stage".
virtual void	error (const std::string &)
	Handle error message from the core.
virtual bool	yesno (const std::string &question)
	Prompt user with a question she can answer with yes/no.
float	getXScale () const
	Width of a window pixel, in stage pseudopixel units.
float	getYScale () const
	Height of a window pixel, in stage pseudopixel units.
float	getFPS () const
	Height of a window pixel, in stage pseudopixel units.

Additional Inherited Members
Public Types inherited from gnash::Gui
typedef std::map< std::string, std::string >	VariableMap
Static Public Member Functions inherited from gnash::Gui
static bool	advance_movie (Gui *gui)
	Convenience static wrapper around advanceMovie for callbacks happiness.
Protected Member Functions inherited from gnash::Gui
	Gui (RunResources &r)
	Default constructor. Initialises members to safe defaults.
	Gui (unsigned long xid, float scale, bool loop, RunResources &r)
	Expanded constructor for more control over member values.
virtual bool	watchFD (int)
	Watch a file descriptor.
virtual void	stopHook ()
virtual void	playHook ()
	Called by Gui::play().
virtual bool	visible ()
	Determines whether the Gui is visible (not obscured).
Protected Attributes inherited from gnash::Gui
bool	_loop
	Determines if playback should restart after the movie ends.
unsigned long	_xid
	The X Window ID to attach to. If zero, we create a new window.
geometry::Range2d< int >	_validbounds
int	_width
	Desired window width.
int	_height
	Desired window height.
RunResources &	_runResources
	Per-run resources.
unsigned int	_interval
	Main loop interval: the time between successive advance_movie calls.
boost::shared_ptr< Renderer >	_renderer
	The handler which is called to update the client area of our window.
bool	_redraw_flag
bool	_fullscreen
bool	_mouseShown
unsigned long	_maxAdvances
unsigned long	_advances
	Counter to keep track of frame advances.
std::string	_audioDump
	Name of a file to dump audio to.

Detailed Description

Null GUI, used when rendering is disabled.

Constructor & Destructor Documentation

gnash::NullGui::NullGui	(	bool	do_loop,
		RunResources &	r
	)

inline

gnash::NullGui::~NullGui ( )

inline

Member Function Documentation

bool gnash::NullGui::createMenu ( )

inline

bool gnash::NullGui::createWindow	(	const char *	title,
		int	width,
		int	height,
		int	xPosition,
		int	yPosition
	)

inlinevirtual

Create and display our window.

Parameters

title	The window title.
width	The desired window width in pixels.
height	The desired window height in pixels.
xPosition	The desired window X position from the top left corner.
yPosition	The desired window Y position from the top left corner.

Implements gnash::Gui.

bool gnash::NullGui::init	(	int	,
		char ***
	)

inline

void gnash::NullGui::quitUI ( )

inlinevirtual

End main rendering loop calling GUI-specific exit functions.

Do not call this directly. Call quit() instead. The default implementation calls exit(EXIT_SUCCESS), which isn't nice. Please implement the proper main loop quitter in the subclasses.

Reimplemented from gnash::Gui.

void gnash::NullGui::renderBuffer ( )

inlinevirtual

Render the current buffer. For OpenGL, this means that the front and back buffers are swapped.

Implements gnash::Gui.

bool gnash::NullGui::run ( )

virtual

Start main rendering loop.

Implements gnash::Gui.

References gnash::Gui::_interval, gnash::Gui::advanceMovie(), gnash::SystemClock::elapsed(), and gnash::gnashSleep().

void gnash::NullGui::setInterval ( unsigned int interval )

inlinevirtual

Set main loop delay in milliseconds.

Reimplemented from gnash::Gui.

References gnash::Gui::_interval.

void gnash::NullGui::setTimeout ( unsigned int timeout )

inlinevirtual

Set the time in milliseconds after which the programme should exit.

Implements gnash::Gui.

bool gnash::NullGui::setupEvents ( )

inline

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation