xoreos  0.0.5
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
Engines::Jade::OptionsMenu Class Reference

#include <options.h>

Inheritance diagram for Engines::Jade::OptionsMenu:
Inheritance graph
[legend]
Collaboration diagram for Engines::Jade::OptionsMenu:
Collaboration graph
[legend]

Public Member Functions

 OptionsMenu (::Engines::Console *console=0)
 
- Public Member Functions inherited from Engines::Jade::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 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 Member Functions

void callbackActive (Widget &widget)
 Callback that's triggered when a widget was activated. More...
 
void callbackRun ()
 Callback that's triggered periodically in the run() method. More...
 
- Protected Member Functions inherited from Engines::Jade::GUI
virtual void mouseUp ()
 The mouse state has changed. More...
 
virtual void mouseDown ()
 
void load (const Common::UString &resref)
 
virtual void initWidget (Widget &widget)
 
WidgetPanelgetPanel (const Common::UString &tag, bool vital=false)
 
WidgetLabelgetLabel (const Common::UString &tag, bool vital=false)
 
WidgetProtoItemgetProtoItem (const Common::UString &tag, bool vital=false)
 
WidgetButtongetButton (const Common::UString &tag, bool vital=false)
 
WidgetCheckBoxgetCheckBox (const Common::UString &tag, bool vital=false)
 
WidgetSlidergetSlider (const Common::UString &tag, bool vital=false)
 
WidgetScrollbargetScrollbar (const Common::UString &tag, bool vital=false)
 
WidgetProgressbargetProgressbar (const Common::UString &tag, bool vital=false)
 
WidgetListBoxgetListBox (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...
 
WidgetgetWidget (const Common::UString &tag, bool vital=false)
 Return a widget in the GUI. More...
 
const WidgetgetWidget (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...
 

Private Member Functions

void createAudioOptions ()
 
void createVideoOptions ()
 
void createDifficultyOptions ()
 
void createGameInfoOptions ()
 
void createControlOptions ()
 

Private Attributes

Common::ScopedPtr< GUI_audioOptions
 
Common::ScopedPtr< GUI_videoOptions
 
Common::ScopedPtr< GUI_difficultyOptions
 
Common::ScopedPtr< GUI_gameInfoOptions
 
Common::ScopedPtr< GUI_controlOptions
 
Engines::WidgetProtoItem_audioOptionsButton
 
Engines::WidgetProtoItem_videoOptionsButton
 
Engines::WidgetProtoItem_difficultyOptionsButton
 
Engines::WidgetProtoItem_gameInfoOptionsButton
 
Engines::WidgetProtoItem_controlOptionsButton
 
Engines::WidgetProtoItem_creditsButton
 
Engines::WidgetButton_backButton
 
Engines::KotORJadeWidget_currentButton
 
Engines::WidgetLabel_optionsDescription
 
Common::UString _audioOptionsDescription
 
Common::UString _videoOptionsDescription
 
Common::UString _difficultyOptionsDescription
 
Common::UString _gameInfoOptionsDescription
 
Common::UString _controlOptionsDescription
 
Common::UString _creditsDescription
 
Common::UString _backButtonDescription
 

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::Jade::GUI
enum  WidgetType {
  kWidgetTypeInvalid = - 1, kWidgetTypePanel = 2, kWidgetTypeLabel = 4, kWidgetTypeProtoItem = 5,
  kWidgetTypeButton = 6, kWidgetTypeCheckBox = 7, kWidgetTypeSlider = 8, kWidgetTypeScrollbar = 9,
  kWidgetTypeProgressbar = 10, kWidgetTypeListBox = 11
}
 
- 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 41 of file options.h.

Constructor & Destructor Documentation

◆ OptionsMenu()

Engines::Jade::OptionsMenu::OptionsMenu ( ::Engines::Console console = 0)

Member Function Documentation

◆ callbackActive()

void Engines::Jade::OptionsMenu::callbackActive ( Widget widget)
protectedvirtual

Callback that's triggered when a widget was activated.

Reimplemented from Engines::GUI.

Definition at line 135 of file options.cpp.

References Engines::GUI::_returnCode, Engines::Widget::getTag(), Engines::GUI::kReturnCodeAbort, Engines::playVideo(), and Engines::GUI::sub().

Here is the call graph for this function:

◆ callbackRun()

void Engines::Jade::OptionsMenu::callbackRun ( )
protectedvirtual

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

Reimplemented from Engines::GUI.

Definition at line 109 of file options.cpp.

◆ createAudioOptions()

void Engines::Jade::OptionsMenu::createAudioOptions ( )
private

Definition at line 89 of file options.cpp.

References Engines::GUI::_console.

◆ createControlOptions()

void Engines::Jade::OptionsMenu::createControlOptions ( )
private

Definition at line 105 of file options.cpp.

References Engines::GUI::_console.

◆ createDifficultyOptions()

void Engines::Jade::OptionsMenu::createDifficultyOptions ( )
private

Definition at line 97 of file options.cpp.

References Engines::GUI::_console.

◆ createGameInfoOptions()

void Engines::Jade::OptionsMenu::createGameInfoOptions ( )
private

Definition at line 101 of file options.cpp.

References Engines::GUI::_console.

◆ createVideoOptions()

void Engines::Jade::OptionsMenu::createVideoOptions ( )
private

Definition at line 93 of file options.cpp.

References Engines::GUI::_console.

Member Data Documentation

◆ _audioOptions

Common::ScopedPtr<GUI> Engines::Jade::OptionsMenu::_audioOptions
private

Definition at line 52 of file options.h.

◆ _audioOptionsButton

Engines::WidgetProtoItem* Engines::Jade::OptionsMenu::_audioOptionsButton
private

Definition at line 58 of file options.h.

◆ _audioOptionsDescription

Common::UString Engines::Jade::OptionsMenu::_audioOptionsDescription
private

Definition at line 70 of file options.h.

◆ _backButton

Engines::WidgetButton* Engines::Jade::OptionsMenu::_backButton
private

Definition at line 65 of file options.h.

◆ _backButtonDescription

Common::UString Engines::Jade::OptionsMenu::_backButtonDescription
private

Definition at line 76 of file options.h.

◆ _controlOptions

Common::ScopedPtr<GUI> Engines::Jade::OptionsMenu::_controlOptions
private

Definition at line 56 of file options.h.

◆ _controlOptionsButton

Engines::WidgetProtoItem* Engines::Jade::OptionsMenu::_controlOptionsButton
private

Definition at line 62 of file options.h.

◆ _controlOptionsDescription

Common::UString Engines::Jade::OptionsMenu::_controlOptionsDescription
private

Definition at line 74 of file options.h.

◆ _creditsButton

Engines::WidgetProtoItem* Engines::Jade::OptionsMenu::_creditsButton
private

Definition at line 63 of file options.h.

◆ _creditsDescription

Common::UString Engines::Jade::OptionsMenu::_creditsDescription
private

Definition at line 75 of file options.h.

◆ _currentButton

Engines::KotORJadeWidget* Engines::Jade::OptionsMenu::_currentButton
private

Definition at line 66 of file options.h.

◆ _difficultyOptions

Common::ScopedPtr<GUI> Engines::Jade::OptionsMenu::_difficultyOptions
private

Definition at line 54 of file options.h.

◆ _difficultyOptionsButton

Engines::WidgetProtoItem* Engines::Jade::OptionsMenu::_difficultyOptionsButton
private

Definition at line 60 of file options.h.

◆ _difficultyOptionsDescription

Common::UString Engines::Jade::OptionsMenu::_difficultyOptionsDescription
private

Definition at line 72 of file options.h.

◆ _gameInfoOptions

Common::ScopedPtr<GUI> Engines::Jade::OptionsMenu::_gameInfoOptions
private

Definition at line 55 of file options.h.

◆ _gameInfoOptionsButton

Engines::WidgetProtoItem* Engines::Jade::OptionsMenu::_gameInfoOptionsButton
private

Definition at line 61 of file options.h.

◆ _gameInfoOptionsDescription

Common::UString Engines::Jade::OptionsMenu::_gameInfoOptionsDescription
private

Definition at line 73 of file options.h.

◆ _optionsDescription

Engines::WidgetLabel* Engines::Jade::OptionsMenu::_optionsDescription
private

Definition at line 68 of file options.h.

◆ _videoOptions

Common::ScopedPtr<GUI> Engines::Jade::OptionsMenu::_videoOptions
private

Definition at line 53 of file options.h.

◆ _videoOptionsButton

Engines::WidgetProtoItem* Engines::Jade::OptionsMenu::_videoOptionsButton
private

Definition at line 59 of file options.h.

◆ _videoOptionsDescription

Common::UString Engines::Jade::OptionsMenu::_videoOptionsDescription
private

Definition at line 71 of file options.h.


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