#include <gui.h>

Inheritance diagram for Engines::Jade::GUI:

[legend]

Collaboration diagram for Engines::Jade::GUI:

[legend]

Classes
struct	WidgetContext

Public Member Functions
	GUI (::Engines::Console *console=0)

	~GUI ()

virtual void	show ()
	Show the GUI. More...

virtual void	hide ()
	Hide the GUI. More...

void	convertToXoreos (float &x, float &y, const float widgetHeight) const
	Converts Jade Empire' GUI coordinates with a coordinate origin in the upper left corner to the Xoreos coordinate system with the coordinate origin in the center. More...

void	convertToGUI (float &x, float &y, const float widgetHeight) const
	Converts Xoreos' coordinates with a coordinate origin in the center to Jade Empire's GUI coordinates with the coordinate origin in the the upper left corner. More...

Common::UString	getName () const

Public Member Functions inherited from Engines::GUI
	GUI (Console *console=0)

uint32	run (uint32 startCode=kStartCodeNone)
	Run the GUI. More...

virtual void	abort ()
	Abort the currently running GUI. More...

void	addEvent (const Events::Event &event)
	Add a single event for consideration into the GUI event queue. More...

uint32	processEventQueue ()
	Process the current event queue. More...

Protected Types
enum	WidgetType { kWidgetTypeInvalid = - 1, kWidgetTypePanel = 2, kWidgetTypeLabel = 4, kWidgetTypeProtoItem = 5, kWidgetTypeButton = 6, kWidgetTypeCheckBox = 7, kWidgetTypeSlider = 8, kWidgetTypeScrollbar = 9, kWidgetTypeProgressbar = 10, kWidgetTypeListBox = 11 }

Protected Member Functions
virtual void	mouseUp ()
	The mouse state has changed. More...

virtual void	mouseDown ()

void	load (const Common::UString &resref)

virtual void	initWidget (Widget &widget)

WidgetPanel *	getPanel (const Common::UString &tag, bool vital=false)

WidgetLabel *	getLabel (const Common::UString &tag, bool vital=false)

WidgetProtoItem *	getProtoItem (const Common::UString &tag, bool vital=false)

WidgetButton *	getButton (const Common::UString &tag, bool vital=false)

WidgetCheckBox *	getCheckBox (const Common::UString &tag, bool vital=false)

WidgetSlider *	getSlider (const Common::UString &tag, bool vital=false)

WidgetScrollbar *	getScrollbar (const Common::UString &tag, bool vital=false)

WidgetProgressbar *	getProgressbar (const Common::UString &tag, bool vital=false)

WidgetListBox *	getListBox (const Common::UString &tag, bool vital=false)

void	addBackground (const Common::UString &background, bool front=false)

void	setCheckBoxState (const Common::UString &tag, bool state)

bool	getCheckBoxState (const Common::UString &tag)

Protected Member Functions inherited from Engines::GUI
void	addWidget (Widget *widget)
	Add a widget. More...

void	removeWidget (Widget *widget)
	Remove a widget. More...

void	clearWidgets ()
	Clear all widgets. More...

bool	empty ()
	Check if the gui is currently empty. More...

bool	hasWidget (const Common::UString &tag) const
	Does this specific widget exist within the GUI? More...

Widget *	getWidget (const Common::UString &tag, bool vital=false)
	Return a widget in the GUI. More...

const Widget *	getWidget (const Common::UString &tag, bool vital=false) const
	Return a widget in the GUI. More...

void	declareGroup (const std::list< Widget *> &group)
	Put these widgets together into a group. More...

void	removeFocus ()
	Forcefully remove the focus from the current widget. More...

void	updateMouse ()
	Force an update of the mouse position. More...

uint32	sub (GUI &gui, uint32 startCode=kStartCodeNone, bool showSelf=true, bool hideSelf=true)
	Open up a sub GUI. More...

void	setPosition (float x, float y, float z)
	Set the GUI's position. More...

void	getPosition (float &x, float &y, float &z) const
	Get the GUI's position. More...

virtual void	callbackRun ()
	Callback that's triggered periodically in the run() method. More...

virtual void	callbackActive (Widget &widget)
	Callback that's triggered when a widget was activated. More...

virtual void	callbackTextInput (const Common::UString &text)
	Callback that's triggered when a text input is received. More...

virtual void	callbackKeyInput (const Events::Key &key, const Events::EventType &type)
	Callback that's triggered when a key is pressed or released. More...

void	addChild (GUI *gui)
	Add a child GUI object to this GUI. More...

void	removeChild (GUI *gui)
	Remove a child GUI object from this GUI. More...

Private Member Functions
void	loadWidget (const Aurora::GFF3Struct &strct, Widget *parent)

void	createWidget (WidgetContext &ctx)

Private Attributes
float	_widgetZ

float	_guiHeight

float	_guiWidth

Common::ScopedPtr< GUIBackground >	_background

Common::ScopedPtr< Aurora::GFF3File >	_gff

Common::UString	_name

Additional Inherited Members
Static Public Attributes inherited from Engines::GUI
static const uint32	kStartCodeNone = 0

static const uint32	kReturnCodeNone = 0

static const uint32	kReturnCodeAbort = 0xFFFFFFFF

Protected Attributes inherited from Engines::GUI
Console *	_console

Widget *	_currentWidget
	The widget the mouse is currently on. More...

uint32	_startCode
	The GUI's start code. More...

uint32	_returnCode
	The GUI's return code. More...

GUI *	_sub
	The currently running sub GUI. More...

Detailed Description

A Jade Empire GUI.

Definition at line 57 of file gui.h.

Member Enumeration Documentation

◆ WidgetType

enum Engines::Jade::GUI::WidgetType

protected

Enumerator
kWidgetTypeInvalid
kWidgetTypePanel
kWidgetTypeLabel
kWidgetTypeProtoItem
kWidgetTypeButton
kWidgetTypeCheckBox
kWidgetTypeSlider
kWidgetTypeScrollbar
kWidgetTypeProgressbar
kWidgetTypeListBox

Definition at line 81 of file gui.h.

Constructor & Destructor Documentation

◆ GUI()

Engines::Jade::GUI::GUI ( ::Engines::Console * console = 0 )

Definition at line 63 of file gui.cpp.

◆ ~GUI()

Engines::Jade::GUI::~GUI ( )

virtual

Reimplemented from Engines::GUI.

Definition at line 66 of file gui.cpp.

Member Function Documentation

◆ addBackground()

void Engines::Jade::GUI::addBackground	(	const Common::UString &	background,
		bool	front = `false`
	)

protected

Definition at line 290 of file gui.cpp.

References _background.

◆ convertToGUI()

void Engines::Jade::GUI::convertToGUI	(	float &	x,
		float &	y,
		const float	widgetHeight
	)		const

Converts Xoreos' coordinates with a coordinate origin in the center to Jade Empire's GUI coordinates with the coordinate origin in the the upper left corner.

Definition at line 86 of file gui.cpp.

References _guiHeight, and _guiWidth.

◆ convertToXoreos()

void Engines::Jade::GUI::convertToXoreos	(	float &	x,
		float &	y,
		const float	widgetHeight
	)		const

Converts Jade Empire' GUI coordinates with a coordinate origin in the upper left corner to the Xoreos coordinate system with the coordinate origin in the center.

Definition at line 81 of file gui.cpp.

References _guiHeight, and _guiWidth.

Referenced by loadWidget().

Here is the caller graph for this function: