#include <gtksup.h>

Inheritance diagram for gnash::GtkGui:

Public Member Functions
	GtkGui (unsigned long xid, float scale, bool loop, RunResources &r)

virtual	~GtkGui ()

virtual bool	init (int argc, char **argv[])
	GUI interface implementation. More...

virtual bool	createWindow (int width, int height)

virtual bool	createWindow (const char *title, int width, int height, int xPosition=0, int yPosition=0)
	Create and display our window. More...

virtual void	resizeWindow (int width, int height)

virtual bool	run ()
	Start main rendering loop. More...

virtual void	quitUI ()
	End main rendering loop calling GUI-specific exit functions. More...

virtual bool	createMenu ()

virtual bool	createMenuAlt ()

virtual bool	setupEvents ()
	Set up callbacks for key, mouse and other GTK events. More...

virtual void	beforeRendering ()

virtual void	renderBuffer ()

virtual void	setInterval (unsigned int interval)
	Set main loop delay in milliseconds. More...

virtual void	setTimeout (unsigned int timeout)
	Set the time in milliseconds after which the programme should exit. More...

virtual void	setFullscreen ()

virtual void	unsetFullscreen ()

virtual void	hideMenu ()

virtual bool	yesno (const std::string &question)
	Prompt user with a question she can answer with yes/no. More...

virtual double	getPixelAspectRatio () const
	For System.capabilities information. More...

virtual std::pair< int, int >	screenResolution () const

virtual double	getScreenDPI () const

virtual void	setClipboard (const std::string &copy)

void	grabFocus ()
	Grab focus so to receive all key events. More...

bool	createMenuBar ()
	Create a menu bar for the application, attach to our window. More...

void	createFileMenu (GtkWidget *obj)

void	createEditMenu (GtkWidget *obj)

void	createViewMenu (GtkWidget *obj)

void	createQualityMenu (GtkWidget *obj)

void	createHelpMenu (GtkWidget *obj)

void	createControlMenu (GtkWidget *obj)

void	showPropertiesDialog ()

void	showPreferencesDialog ()

void	showAboutDialog ()

void	expose (const GdkRegion *region)

void	setInvalidatedRegions (const InvalidatedRanges &ranges)

bool	want_multiple_regions ()

virtual void	setCursor (gnash_cursor_type newcursor)
	Sets the current mouse cursor for the Gui window. More...

virtual bool	showMouse (bool show)
	Sets whether the gui should show the system mouse pointer. More...

virtual void	showMenu (bool show)
	Sets whether the menus should be shown (for fscommand) More...

virtual void	error (const std::string &msg)
	Handle error message from the core. More...

bool	checkX11Extension (const std::string &ext)

virtual bool	visible ()
	Determines whether the Gui is visible (not obscured). More...

void	setVisible (bool visible)

Public Member Functions inherited from gnash::Gui
virtual	~Gui ()

virtual VirtualClock &	getClock ()
	Return the clock provided by this Gui. More...

void	setScreenShotter (std::unique_ptr< ScreenShotter > ss)

void	quit ()
	Always called on exit. More...

virtual void	setInvalidatedRegion (const SWFRect &bounds)
	Gives the GUI a hint which region of the stage should be redrawn. More...

virtual bool	want_redraw ()
	Asks the GUI handler if the next frame should be redrawn completely. More...

virtual std::string	getScreenColor () const
	Get the screen color type. More...

bool	loops () const

bool	isFullscreen () const

void	notifyMouseMove (int x, int y)
	Mouse notification callback to be called when the mouse is moved. More...

void	notifyMouseClick (bool mouse_pressed)
	Mouse notification callback to be called when the mouse is clicked. More...

void	notifyMouseWheel (int delta)
	Send a mouse wheel event to the stage. More...

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. More...

void	resize_view (int width, int height)
	Resize the client area view and the window accordingly. More...

void	updateStageMatrix ()

bool	advanceMovie (bool doDisplay=true)
	Give movie an heart-beat. More...

void	refreshView ()

virtual void	allowScale (bool allow)
	Sets whether scaling should be allowed (for fscommand) More...

void	toggleFullscreen ()

void	stop ()
	Put the application in "stop" mode. More...

void	play ()
	Put the application in "play" mode. More...

void	pause ()
	Toggle between "stop" and "play" mode. More...

void	start ()
	Start the movie. More...

bool	isStopped () const
	See stop(), play() and pause() More...

bool	isPlugin () const
	Whether gnash is is running as a plugin. More...

void	takeScreenShot ()
	Take a screenshot now! More...

void	setMaxAdvances (unsigned long ul)
	Set the maximum number of frame advances before Gnash exits. More...

void	showUpdatedRegions (bool x)

bool	showUpdatedRegions () const

void	restart ()

void	setQuality (Quality q)
	Set rendering quality, if not locked by RC file.. More...

Quality	getQuality () const
	Get current rendering quality. More...

void	toggleSound ()

void	addFlashVars (VariableMap &vars)
	Add variables to set into instances of the top-level movie definition. More...

void	setMovieDefinition (movie_definition *md)
	Set the definition of top-level movie. More...

void	setStage (movie_root *stage)
	Set the stage to advance/display. More...

void	setAudioDump (const std::string &fname)
	Set the name of a file to dump audio to. More...

movie_root *	getStage ()
	The root movie, or "Stage". More...

float	getXScale () const
	Width of a window pixel, in stage pseudopixel units. More...

float	getYScale () const
	Height of a window pixel, in stage pseudopixel units. More...

float	getFPS () const
	Height of a window pixel, in stage pseudopixel units. More...

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. More...

Protected Member Functions inherited from gnash::Gui
	Gui (RunResources &r)
	Default constructor. Initialises members to safe defaults. More...

	Gui (unsigned long xid, float scale, bool loop, RunResources &r)
	Expanded constructor for more control over member values. More...

virtual bool	watchFD (int)
	Watch a file descriptor. More...

Protected Attributes inherited from gnash::Gui
bool	_loop
	Determines if playback should restart after the movie ends. More...

unsigned long	_xid
	The X Window ID to attach to. If zero, we create a new window. More...

geometry::Range2d< int >	_validbounds

int	_width
	Desired window width. More...

int	_height
	Desired window height. More...

RunResources &	_runResources
	Per-run resources. More...

unsigned int	_interval
	Main loop interval: the time between successive advance_movie calls. More...

std::shared_ptr< Renderer >	_renderer
	The handler which is called to update the client area of our window. More...

bool	_redraw_flag

bool	_fullscreen

bool	_mouseShown

unsigned long	_maxAdvances

unsigned long	_advances
	Counter to keep track of frame advances. More...

std::string	_audioDump
	Name of a file to dump audio to. More...

Constructor & Destructor Documentation

§ GtkGui()

gnash::GtkGui::GtkGui	(	unsigned long	xid,
		float	scale,
		bool	loop,
		RunResources &	r
	)

§ ~GtkGui()

gnash::GtkGui::~GtkGui ( )

virtual

Member Function Documentation

§ beforeRendering()

void gnash::GtkGui::beforeRendering ( )

virtual

Reimplemented from gnash::Gui.

References gnash::Gui::getStage(), GNASH_CANVAS, and gnash_canvas_before_rendering().

§ checkX11Extension()

bool gnash::GtkGui::checkX11Extension ( const std::string & ext )

References gnash::key::i, and gnash::key::n.

Referenced by init(), and want_multiple_regions().

§ createControlMenu()

void gnash::GtkGui::createControlMenu ( GtkWidget * obj )

References _, gnash::Gui::pause(), gnash::Gui::play(), gnash::Gui::restart(), and gnash::Gui::stop().

Referenced by createMenu(), and createMenuBar().

§ createEditMenu()

void gnash::GtkGui::createEditMenu ( GtkWidget * obj )

References _.

Referenced by createMenu(), createMenuAlt(), and createMenuBar().

§ createFileMenu()

void gnash::GtkGui::createFileMenu ( GtkWidget * obj )

/// Menus /// ///

References _, and gnash::Gui::quit().

Referenced by createMenu(), and createMenuBar().

§ createHelpMenu()

void gnash::GtkGui::createHelpMenu ( GtkWidget * obj )

References _.

Referenced by createMenu(), createMenuAlt(), and createMenuBar().

§ createMenu()

bool gnash::GtkGui::createMenu ( )

virtual

The sound handler is initialized after the Gui is created, and may be disabled or enabled dynamically.

References _, createControlMenu(), createEditMenu(), createFileMenu(), createHelpMenu(), createViewMenu(), and gnash::Gui::quit().

Referenced by init().

§ createMenuAlt()

bool gnash::GtkGui::createMenuAlt ( )

virtual

References createEditMenu(), createHelpMenu(), and gnash::Gui::quit().

Referenced by init().

§ createMenuBar()

bool gnash::GtkGui::createMenuBar ( )

Create a menu bar for the application, attach to our window.

/// Widget functions /// ///

References createControlMenu(), createEditMenu(), createFileMenu(), createHelpMenu(), and createViewMenu().

Referenced by init().

§ createQualityMenu()

void gnash::GtkGui::createQualityMenu ( GtkWidget * obj )

References _.

Referenced by createViewMenu().

§ createViewMenu()

void gnash::GtkGui::createViewMenu ( GtkWidget * obj )

References _, createQualityMenu(), and gnash::Gui::showUpdatedRegions().

Referenced by createMenu(), and createMenuBar().

§ createWindow() [1/2]

bool gnash::GtkGui::createWindow	(	int	width,
		int	height
	)

virtual

/// Rendering stuff /// ///

References gnash::Gui::_height, gnash::Gui::_validbounds, gnash::Gui::_width, height, gnash::geometry::Range2d< T >::setTo(), and width.

Referenced by createWindow().

§ createWindow() [2/2]

bool gnash::GtkGui::createWindow	(	const char *	title,
		int	width,
		int	height,
		int	xPosition = `0`,
		int	yPosition = `0`
	)

virtual

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.

References gnash::Gui::_xid, createWindow(), gnash::key::e, gnash::key::i, gnash::key::p, x, and y.

§ error()

void gnash::GtkGui::error ( const std::string & )

virtual

Handle error message from the core.

Parameters

msg	The error message recieved

Reimplemented from gnash::Gui.

References gnash::RcInitFile::getDefaultInstance(), and gnash::RcInitFile::popupMessages().

Referenced by want_multiple_regions(), and yesno().

§ expose()

void gnash::GtkGui::expose ( const GdkRegion * region )

§ getPixelAspectRatio()

double gnash::GtkGui::getPixelAspectRatio ( ) const

virtual

For System.capabilities information.

Reimplemented from gnash::Gui.

References screenResolution().

§ getScreenDPI()

double gnash::GtkGui::getScreenDPI ( ) const

virtual

Reimplemented from gnash::Gui.

§ grabFocus()

void gnash::GtkGui::grabFocus ( )

Grab focus so to receive all key events.

Might become a virtual in the base class

§ hideMenu()

void gnash::GtkGui::hideMenu ( )

virtual

Hide the menu bar when using standalone player

Reimplemented from gnash::Gui.

References gnash::Gui::_fullscreen, gnash::Gui::_xid, and showMenu().

§ init()

bool gnash::GtkGui::init	(	int	argc,
		char **	argv[]
	)

virtual

GUI interface implementation.

Implements gnash::Gui.

References _, gnash::Gui::_renderer, gnash::Gui::_runResources, gnash::Gui::_xid, checkX11Extension(), createMenu(), createMenuAlt(), createMenuBar(), gnash::RunResources::getHWAccelBackend(), gnash::RunResources::getRenderBackend(), GNASH_CANVAS, gnash_canvas_get_renderer(), gnash_canvas_new(), gnash_canvas_setup(), gnash::log_debug(), gnash::log_error(), gnash::RunResources::setRenderer(), and setupEvents().

§ quitUI()

void gnash::GtkGui::quitUI ( )

virtual

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.

References _, gnash::Gui::_interval, gnash::Gui::advance_movie(), and gnash::log_debug().

§ renderBuffer()

void gnash::GtkGui::renderBuffer ( )

virtual

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

Implements gnash::Gui.

§ resizeWindow()

void gnash::GtkGui::resizeWindow	(	int	width,
		int	height
	)

virtual

Reimplemented from gnash::Gui.

References gnash::Gui::_xid.

§ run()

bool gnash::GtkGui::run ( )

virtual

Start main rendering loop.

Implements gnash::Gui.

References gnash::Gui::advance_movie().

§ screenResolution()

std::pair< int, int > gnash::GtkGui::screenResolution ( ) const

virtual

Reimplemented from gnash::Gui.

Referenced by getPixelAspectRatio().

§ setClipboard()

void gnash::GtkGui::setClipboard ( const std::string & copy )

virtual

Reimplemented from gnash::Gui.

§ setCursor()

void gnash::GtkGui::setCursor ( gnash_cursor_type newcursor )

virtual

Sets the current mouse cursor for the Gui window.

Reimplemented from gnash::Gui.

References gnash::Gui::_mouseShown, gnash::CURSOR_HAND, and gnash::CURSOR_INPUT.

Referenced by want_multiple_regions().

§ setFullscreen()

void gnash::GtkGui::setFullscreen ( )

virtual

Attempt to run in a fullscreen window both for plugin and standalone player. Use isFullscreen() to see if gnash thinks it's running in fullscreen or not. The switch to fullscreen may fail if, for instance, the window manager refuses to allow it, but the flag will be set anyway.

Reimplemented from gnash::Gui.

References gnash::Gui::_fullscreen, gnash::Gui::_xid, and showMenu().

§ setInterval()

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

virtual

Set main loop delay in milliseconds.

Reimplemented from gnash::Gui.

References gnash::Gui::_interval, and gnash::Gui::isStopped().

§ setInvalidatedRegions()

void gnash::GtkGui::setInvalidatedRegions ( const InvalidatedRanges & ranges )

virtual

Reimplemented from gnash::Gui.

References gnash::Gui::_renderer, gnash::Gui::_validbounds, gnash::geometry::Range2d< T >::getMinX(), gnash::geometry::Range2d< T >::getMinY(), gnash::geometry::SnappingRanges2d< T >::getRange(), gnash::geometry::Range2d< T >::height(), gnash::geometry::Intersection(), gnash::geometry::Range2d< T >::isFinite(), gnash::geometry::Range2d< T >::isNull(), gnash::geometry::SnappingRanges2d< T >::size(), and gnash::geometry::Range2d< T >::width().

§ setTimeout()

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

virtual

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

Implements gnash::Gui.

§ setupEvents()

bool gnash::GtkGui::setupEvents ( )

virtual

Set up callbacks for key, mouse and other GTK events.

Must be called after the drawing area has been added to a top level window, as it calls setupWindowEvents() to add key event callbacks to the top level window.

Referenced by init().

§ setVisible()

void gnash::GtkGui::setVisible ( bool visible )

inline

References visible().

§ showAboutDialog()

void gnash::GtkGui::showAboutDialog ( void )

References _, gnash::Gui::_renderer, gnash::Gui::_runResources, BRANCH_NICK, BRANCH_REVNO, COMMIT_ID, gnash::media::MediaHandler::description(), gnash::key::m, gnash::RunResources::mediaHandler(), and VERSION.

§ showMenu()

void gnash::GtkGui::showMenu ( bool show )

virtual

Sets whether the menus should be shown (for fscommand)

Parameters

show	true if the menu bar should be shown.

Reimplemented from gnash::Gui.

References gnash::RcInitFile::getDefaultInstance(), and gnash::RcInitFile::ignoreShowMenu().

Referenced by hideMenu(), setFullscreen(), unsetFullscreen(), and want_multiple_regions().

§ showMouse()

bool gnash::GtkGui::showMouse ( bool show )

virtual

Sets whether the gui should show the system mouse pointer.

Parameters

show	true if the mouse should be shown.

Returns: true if the state changed.

Reimplemented from gnash::Gui.

References gnash::Gui::_mouseShown, color, gnash::RcInitFile::getDefaultInstance(), and gnash::RcInitFile::showMouse().

Referenced by want_multiple_regions().

§ showPreferencesDialog()

void gnash::GtkGui::showPreferencesDialog ( )

§ showPropertiesDialog()

void gnash::GtkGui::showPropertiesDialog ( )

References _.

§ unsetFullscreen()

void gnash::GtkGui::unsetFullscreen ( )

virtual

Return from fullscreen to normal mode.

Reimplemented from gnash::Gui.

References gnash::Gui::_fullscreen, gnash::Gui::_xid, and showMenu().

§ visible()

virtual bool gnash::GtkGui::visible ( )

inlinevirtual

Determines whether the Gui is visible (not obscured).

Reimplemented from gnash::Gui.

Referenced by setVisible().

§ want_multiple_regions()

bool gnash::GtkGui::want_multiple_regions ( )

inlinevirtual

Reimplemented from gnash::Gui.

References checkX11Extension(), error(), setCursor(), showMenu(), and showMouse().

§ yesno()

bool gnash::GtkGui::yesno ( const std::string & question )

virtual

Prompt user with a question she can answer with yes/no.

Parameters

question The question to ask user

Returns: true for YES, false for NO

The default implementation always returns true.

Reimplemented from gnash::Gui.

References _, error(), and gnash::log_error().

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

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

§ GtkGui()

§ ~GtkGui()

Member Function Documentation

§ beforeRendering()

§ checkX11Extension()

§ createControlMenu()

§ createEditMenu()

§ createFileMenu()

§ createHelpMenu()

§ createMenu()

§ createMenuAlt()

§ createMenuBar()

§ createQualityMenu()

§ createViewMenu()

§ createWindow() [1/2]

§ createWindow() [2/2]

§ error()

§ expose()

§ getPixelAspectRatio()

§ getScreenDPI()

§ grabFocus()

§ hideMenu()

§ init()

§ quitUI()

§ renderBuffer()

§ resizeWindow()

§ run()

§ screenResolution()

§ setClipboard()

§ setCursor()

§ setFullscreen()

§ setInterval()

§ setInvalidatedRegions()

§ setTimeout()

§ setupEvents()

§ setVisible()

§ showAboutDialog()

§ showMenu()

§ showMouse()

§ showPreferencesDialog()

§ showPropertiesDialog()

§ unsetFullscreen()

§ visible()

§ want_multiple_regions()

§ yesno()