#include <gui.h>

Inheritance diagram for Engines::KotOR::GUI:

[legend]

Collaboration diagram for Engines::KotOR::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 Kotor' 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 Kotor'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 KotOR GUI.

Definition at line 57 of file gui.h.

Member Enumeration Documentation

◆ WidgetType

enum Engines::KotOR::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::KotOR::GUI::GUI ( ::Engines::Console * console = 0 )

Definition at line 63 of file gui.cpp.

◆ ~GUI()

Engines::KotOR::GUI::~GUI ( )

virtual

Reimplemented from Engines::GUI.

Definition at line 66 of file gui.cpp.

Member Function Documentation

◆ addBackground()

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

protected

Definition at line 300 of file gui.cpp.

References _background.

Here is the caller graph for this function:

◆ convertToGUI()

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

Converts Xoreos' coordinates with a coordinate origin in the center to Kotor'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::KotOR::GUI::convertToXoreos	(	float &	x,
		float &	y,
		const float	widgetHeight
	)		const

Converts Kotor' 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:

◆ createWidget()

void Engines::KotOR::GUI::createWidget ( WidgetContext & ctx )

private

Definition at line 158 of file gui.cpp.

References Common::UString::c_str(), Common::exceptionDispatcherWarning(), initWidget(), kWidgetTypeButton, kWidgetTypeCheckBox, kWidgetTypeLabel, kWidgetTypeListBox, kWidgetTypePanel, kWidgetTypeProgressbar, kWidgetTypeProtoItem, kWidgetTypeScrollbar, kWidgetTypeSlider, Engines::KotORJadeWidget::load(), Engines::KotOR::GUI::WidgetContext::strct, Engines::KotOR::GUI::WidgetContext::tag, Engines::KotOR::GUI::WidgetContext::type, and Engines::KotOR::GUI::WidgetContext::widget.

Referenced by loadWidget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getButton()

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

protected

Definition at line 228 of file gui.cpp.

References Common::UString::c_str(), and Engines::GUI::getWidget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCheckBox()

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

protected

Definition at line 240 of file gui.cpp.

References Common::UString::c_str(), and Engines::GUI::getWidget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCheckBoxState()

bool Engines::KotOR::GUI::getCheckBoxState ( const Common::UString & tag )

protected

Definition at line 312 of file gui.cpp.

References getCheckBox(), and Engines::WidgetCheckBox::getState().

Referenced by Engines::KotOR::OptionsAutoPauseMenu::callbackActive(), Engines::KotOR::OptionsGraphicsAdvancedMenu::callbackActive(), Engines::KotOR::OptionsMouseSettingsMenu::callbackActive(), Engines::KotOR::OptionsSoundAdvancedMenu::callbackActive(), Engines::KotOR::OptionsGameplayMenu::callbackActive(), and Engines::KotOR::OptionsGraphicsMenu::callbackActive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLabel()

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

protected

Definition at line 204 of file gui.cpp.

References Common::UString::c_str(), and Engines::GUI::getWidget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getListBox()

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

protected

Definition at line 288 of file gui.cpp.

References Common::UString::c_str(), and Engines::GUI::getWidget().

Referenced by Engines::KotOR::MenuEquipment::callbackActive(), Engines::KotOR::DialogGUIBase::callbackActive(), Engines::KotOR::SaveLoadMenu::callbackActive(), Engines::KotOR::ContainerMenu::callbackKeyInput(), Engines::KotOR::MenuEquipment::callbackKeyInput(), Engines::KotOR::DialogGUIBase::callbackKeyInput(), Engines::KotOR::SaveLoadMenu::callbackKeyInput(), Engines::KotOR::ConfirmDialog::ConfirmDialog(), Engines::KotOR::ContainerMenu::ContainerMenu(), Engines::KotOR::MenuEquipment::fillEquipableItemsList(), Engines::KotOR::ContainerMenu::fillFromInventory(), Engines::KotOR::MenuEquipment::fixateOnSlot(), Engines::KotOR::MainMenu::MainMenu(), Engines::KotOR::MenuEquipment::MenuEquipment(), Engines::KotOR::DialogGUIBase::refresh(), Engines::KotOR::SaveLoadMenu::SaveLoadMenu(), Engines::KotOR::ConfirmDialog::setText(), and Engines::KotOR::DialogGUIBase::update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getName()

Common::UString Engines::KotOR::GUI::getName ( ) const

virtual

Reimplemented from Engines::GUI.

Definition at line 91 of file gui.cpp.

References _name.

◆ getPanel()

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

protected

Definition at line 192 of file gui.cpp.

References Common::UString::c_str(), and Engines::GUI::getWidget().

Referenced by Engines::KotOR::ConfirmDialog::ConfirmDialog(), Engines::KotOR::ContainerMenu::ContainerMenu(), and Engines::KotOR::LoadScreen::LoadScreen().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProgressbar()

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

protected

Definition at line 276 of file gui.cpp.

References Common::UString::c_str(), and Engines::GUI::getWidget().

Referenced by Engines::KotOR::LoadScreen::LoadScreen().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProtoItem()

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

protected

Definition at line 216 of file gui.cpp.

References Common::UString::c_str(), and Engines::GUI::getWidget().

Referenced by Engines::KotOR::Menu::Menu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getScrollbar()

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

protected

Definition at line 264 of file gui.cpp.

References Common::UString::c_str(), and Engines::GUI::getWidget().

Here is the call graph for this function:

◆ getSlider()

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

protected

Definition at line 252 of file gui.cpp.

References Common::UString::c_str(), and Engines::GUI::getWidget().

Here is the call graph for this function:

◆ hide()

void Engines::KotOR::GUI::hide ( )

virtual

Hide the GUI.

Reimplemented from Engines::GUI.

Reimplemented in Engines::KotOR::DialogGUIBase, and Engines::KotOR::MenuEquipment.

Definition at line 75 of file gui.cpp.

References _background, and Engines::GUI::hide().

Referenced by Engines::KotOR::MainMenu::createClassSelection(), Engines::KotOR::MenuEquipment::hide(), Engines::KotOR::DialogGUIBase::hide(), Engines::KotOR::Module::loadModule(), Engines::KotOR2::Game::mainMenu(), Engines::KotOR::Game::mainMenu(), Engines::KotOR::CharacterGenerationMenu::start(), and Engines::KotOR::SaveLoadMenu::tryLoadGame().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initWidget()

void Engines::KotOR::GUI::initWidget ( Widget & widget )

protectedvirtual

Reimplemented in Engines::KotOR::HUD, Engines::KotOR::MainMenu, Engines::KotOR2::MainMenu, Engines::KotOR2::GUI, and Engines::KotOR2::HUD.

Definition at line 189 of file gui.cpp.

Referenced by createWidget().

Here is the caller graph for this function:

◆ load()

void Engines::KotOR::GUI::load ( const Common::UString & resref )

protected

Definition at line 103 of file gui.cpp.

References _gff, _guiHeight, _guiWidth, _name, Common::StackException::add(), Common::UString::c_str(), Engines::GUI::clearWidgets(), Engines::GUI::empty(), Aurora::kFileTypeGUI, loadWidget(), MKTAG, Common::ScopedPtrBase< T, Deallocator >::reset(), and ResMan.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadWidget()

void Engines::KotOR::GUI::loadWidget	(	const Aurora::GFF3Struct &	strct,
		Widget *	parent
	)

private

Definition at line 126 of file gui.cpp.

References _guiHeight, _guiWidth, _widgetZ, Engines::GUI::addWidget(), convertToXoreos(), createWidget(), Engines::KotORJadeWidget::getHeight(), Aurora::GFF3Struct::getList(), Engines::Widget::getPosition(), Engines::KotORJadeWidget::getWidth(), Aurora::GFF3Struct::hasField(), Engines::KotORJadeWidget::setPosition(), Engines::KotOR::GUI::WidgetContext::strct, and Engines::KotOR::GUI::WidgetContext::widget.

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mouseDown()

void Engines::KotOR::GUI::mouseDown ( )

protectedvirtual

Reimplemented from Engines::GUI.

Definition at line 95 of file gui.cpp.

References CursorMan.

◆ mouseUp()

void Engines::KotOR::GUI::mouseUp ( )

protectedvirtual

The mouse state has changed.

Reimplemented from Engines::GUI.

Definition at line 99 of file gui.cpp.

References CursorMan.

◆ setCheckBoxState()

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

protected

Definition at line 307 of file gui.cpp.

References getCheckBox(), and Engines::WidgetCheckBox::setState().

Referenced by Engines::KotOR::OptionsMouseSettingsMenu::displayConfig(), Engines::KotOR::OptionsSoundAdvancedMenu::displayConfig(), Engines::KotOR::OptionsAutoPauseMenu::displayConfig(), Engines::KotOR::OptionsGraphicsAdvancedMenu::displayConfig(), Engines::KotOR::OptionsGraphicsMenu::displayConfig(), and Engines::KotOR::OptionsGameplayMenu::displayConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ show()

void Engines::KotOR::GUI::show ( )

virtual

Show the GUI.

Reimplemented from Engines::GUI.

Reimplemented in Engines::KotOR::DialogGUIBase, Engines::KotOR::MenuEquipment, Engines::KotOR::OptionsGameplayMenu, Engines::KotOR::OptionsGraphicsMenu, Engines::KotOR::OptionsAutoPauseMenu, Engines::KotOR::OptionsGraphicsAdvancedMenu, Engines::KotOR::OptionsMouseSettingsMenu, and Engines::KotOR::OptionsSoundAdvancedMenu.

Definition at line 69 of file gui.cpp.

References _background, and Engines::GUI::show().

Referenced by Engines::KotOR::MainMenu::createClassSelection(), Engines::KotOR::Module::loadModule(), Engines::KotOR2::Game::mainMenu(), Engines::KotOR::Game::mainMenu(), Engines::KotOR::OptionsSoundAdvancedMenu::show(), Engines::KotOR::OptionsAutoPauseMenu::show(), Engines::KotOR::OptionsGraphicsAdvancedMenu::show(), Engines::KotOR::OptionsMouseSettingsMenu::show(), Engines::KotOR::OptionsGraphicsMenu::show(), Engines::KotOR::OptionsGameplayMenu::show(), Engines::KotOR::MenuEquipment::show(), Engines::KotOR::DialogGUIBase::show(), and Engines::KotOR::CharacterGenerationMenu::start().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ _background

Common::ScopedPtr<GUIBackground> Engines::KotOR::GUI::_background

private

Definition at line 135 of file gui.h.

Referenced by addBackground(), hide(), and show().

◆ _gff

Common::ScopedPtr<Aurora::GFF3File> Engines::KotOR::GUI::_gff

private

Definition at line 137 of file gui.h.

Referenced by load().

◆ _guiHeight

float Engines::KotOR::GUI::_guiHeight

private

Definition at line 132 of file gui.h.

Referenced by convertToGUI(), convertToXoreos(), load(), and loadWidget().

◆ _guiWidth

float Engines::KotOR::GUI::_guiWidth

private

Definition at line 133 of file gui.h.

Referenced by convertToGUI(), convertToXoreos(), load(), and loadWidget().

◆ _name

Common::UString Engines::KotOR::GUI::_name

private

Definition at line 139 of file gui.h.

Referenced by getName(), and load().

◆ _widgetZ

float Engines::KotOR::GUI::_widgetZ

private

Definition at line 130 of file gui.h.

Referenced by loadWidget().

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

src/engines/kotor/gui/gui.h
src/engines/kotor/gui/gui.cpp

Classes

Public Member Functions

Protected Types

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ WidgetType

Constructor & Destructor Documentation

◆ GUI()

◆ ~GUI()

Member Function Documentation

◆ addBackground()

◆ convertToGUI()

◆ convertToXoreos()

◆ createWidget()

◆ getButton()

◆ getCheckBox()

◆ getCheckBoxState()

◆ getLabel()

◆ getListBox()

◆ getName()

◆ getPanel()

◆ getProgressbar()

◆ getProtoItem()

◆ getScrollbar()

◆ getSlider()

◆ hide()

◆ initWidget()

◆ load()

◆ loadWidget()

◆ mouseDown()

◆ mouseUp()

◆ setCheckBoxState()

◆ show()

Member Data Documentation

◆ _background

◆ _gff

◆ _guiHeight

◆ _guiWidth

◆ _name

◆ _widgetZ