#include <menu.h>

Inheritance diagram for Engines::KotOR::Menu:

Collaboration diagram for Engines::KotOR::Menu:

[legend]

Classes
struct	SubMenu

Public Member Functions
	Menu (Module &module, ::Engines::Console *console=0)

void	setReturnStrref (uint32)
	Set the return string ref. More...

void	setReturnQueryStrref (uint32)
	Set the return query string ref. More...

void	setReturnEnabled (bool)
	Set the return button enabled/disabled. More...

void	showMenu (const Common::UString &tag)

Public Member Functions inherited from Engines::KotOR::GUI
	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...

Private Types
enum	MenuType { kMenuTypeEquipment, kMenuTypeInventory, kMenuTypeCharacter, kMenuTypeAbilities, kMenuTypeMessages, kMenuTypeJournal, kMenuTypeMap, kMenuTypeOptions, kMenuTypeMAX }

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

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

void	showMenu (MenuType type)

Private Attributes
Module &	_module

SubMenu	_menu [kMenuTypeMAX]

SubMenu *	_currentMenu

Common::ScopedPtr< SaveLoadMenu >	_menuLoad

Common::ScopedPtr< SaveLoadMenu >	_menuSave

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 Types inherited from Engines::KotOR::GUI
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 inherited from Engines::KotOR::GUI
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	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...

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

Definition at line 47 of file menu.h.

Member Enumeration Documentation

◆ MenuType

enum Engines::KotOR::Menu::MenuType

private

Enumerator
kMenuTypeEquipment
kMenuTypeInventory
kMenuTypeCharacter
kMenuTypeAbilities
kMenuTypeMessages
kMenuTypeJournal
kMenuTypeMap
kMenuTypeOptions
kMenuTypeMAX

Definition at line 61 of file menu.h.

Constructor & Destructor Documentation

◆ Menu()

Engines::KotOR::Menu::Menu	(	Module &	module,
		::Engines::Console *	console = `0`
	)

Member Function Documentation

◆ callbackActive()

void Engines::KotOR::Menu::callbackActive ( Widget & widget )

privatevirtual

Callback that's triggered when a widget was activated.

Reimplemented from Engines::GUI.

Definition at line 144 of file menu.cpp.

References Engines::Widget::getTag(), and showMenu().

Here is the call graph for this function:

◆ callbackRun()

void Engines::KotOR::Menu::callbackRun ( )

privatevirtual

Callback that's triggered periodically in the run() method.

Reimplemented from Engines::GUI.

Definition at line 112 of file menu.cpp.

References _currentMenu, _menu, _menuLoad, _menuSave, _module, Engines::GUI::_returnCode, GfxMan, kMenuTypeOptions, Engines::KotOR::kOptionsItemExitGame, Engines::KotOR::kOptionsItemLoadGame, Engines::KotOR::kOptionsItemSaveGame, Engines::KotOR::Module::leave(), Engines::KotOR::Menu::SubMenu::menu, and Engines::GUI::sub().

Here is the call graph for this function:

◆ setReturnEnabled()

void Engines::KotOR::Menu::setReturnEnabled ( bool enabled )

Set the return button enabled/disabled.

Definition at line 90 of file menu.cpp.

References _menu, kMenuTypeMap, and Engines::KotOR::Menu::SubMenu::menu.

◆ setReturnQueryStrref()

void Engines::KotOR::Menu::setReturnQueryStrref ( uint32 id )

Set the return query string ref.

Definition at line 86 of file menu.cpp.

References _menu, kMenuTypeMap, and Engines::KotOR::Menu::SubMenu::menu.

◆ setReturnStrref()

void Engines::KotOR::Menu::setReturnStrref ( uint32 id )

Set the return string ref.

Definition at line 82 of file menu.cpp.

References _menu, kMenuTypeMap, and Engines::KotOR::Menu::SubMenu::menu.

◆ showMenu() [1/2]

void Engines::KotOR::Menu::showMenu ( const Common::UString & tag )

Definition at line 135 of file menu.cpp.

References _menu, and kMenuTypeMAX.

Referenced by callbackActive().

Here is the caller graph for this function:

◆ showMenu() [2/2]

void Engines::KotOR::Menu::showMenu ( MenuType type )

private

Definition at line 94 of file menu.cpp.

References _currentMenu, _menu, _module, Engines::GUI::addChild(), Engines::KotOR::Module::getPC(), kMenuTypeEquipment, kMenuTypeMAX, Engines::KotOR::Menu::SubMenu::menu, Engines::KotOR::Menu::SubMenu::protoItem, Engines::GUI::removeChild(), and Engines::KotORJadeWidget::setHighlight().

Here is the call graph for this function:

Member Data Documentation

◆ _currentMenu

SubMenu* Engines::KotOR::Menu::_currentMenu

private

Definition at line 89 of file menu.h.

Referenced by callbackRun(), and showMenu().

◆ _menu

SubMenu Engines::KotOR::Menu::_menu[kMenuTypeMAX]

private

Definition at line 88 of file menu.h.

Referenced by callbackRun(), Menu(), setReturnEnabled(), setReturnQueryStrref(), setReturnStrref(), and showMenu().

◆ _menuLoad

Common::ScopedPtr<SaveLoadMenu> Engines::KotOR::Menu::_menuLoad

private

Definition at line 91 of file menu.h.

Referenced by callbackRun(), and Menu().

◆ _menuSave

Common::ScopedPtr<SaveLoadMenu> Engines::KotOR::Menu::_menuSave

private

Definition at line 92 of file menu.h.

Referenced by callbackRun(), and Menu().

◆ _module

Module& Engines::KotOR::Menu::_module

private

Definition at line 86 of file menu.h.

Referenced by callbackRun(), and showMenu().

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

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

Classes

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ MenuType

Constructor & Destructor Documentation

◆ Menu()

Member Function Documentation

◆ callbackActive()

◆ callbackRun()

◆ setReturnEnabled()

◆ setReturnQueryStrref()

◆ setReturnStrref()

◆ showMenu() [1/2]

◆ showMenu() [2/2]

Member Data Documentation

◆ _currentMenu

◆ _menu

◆ _menuLoad

◆ _menuSave

◆ _module