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

The NWN game options menu. More...

#include <game.h>

Inheritance diagram for Engines::NWN::OptionsGameMenu:
Inheritance graph
[legend]
Collaboration diagram for Engines::NWN::OptionsGameMenu:
Collaboration graph
[legend]

Public Member Functions

 OptionsGameMenu (bool isMain=false, ::Engines::Console *console=0)
 
 ~OptionsGameMenu ()
 
void show ()
 Show the GUI. More...
 
- Public Member Functions inherited from Engines::NWN::GUI
 GUI (::Engines::Console *console=0)
 
 ~GUI ()
 
- Public Member Functions inherited from Engines::GUI
 GUI (Console *console=0)
 
virtual void hide ()
 Hide the GUI. More...
 
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...
 
virtual Common::UString getName () const
 

Protected Member Functions

void fixWidgetType (const Common::UString &tag, WidgetType &type)
 
void initWidget (Widget &widget)
 
void callbackActive (Widget &widget)
 Callback that's triggered when a widget was activated. More...
 
- Protected Member Functions inherited from Engines::NWN::GUI
void load (const Common::UString &resref)
 
WidgetFramegetFrame (const Common::UString &tag, bool vital=false)
 
WidgetClosegetClose (const Common::UString &tag, bool vital=false)
 
WidgetCheckBoxgetCheckBox (const Common::UString &tag, bool vital=false)
 
WidgetPanelgetPanel (const Common::UString &tag, bool vital=false)
 
WidgetLabelgetLabel (const Common::UString &tag, bool vital=false)
 
WidgetSlidergetSlider (const Common::UString &tag, bool vital=false)
 
WidgetEditBoxgetEditBox (const Common::UString &tag, bool vital=false)
 
WidgetButtongetButton (const Common::UString &tag, bool vital=false)
 
WidgetListBoxgetListBox (const Common::UString &tag, bool vital=false)
 
WidgetScrollbargetScrollbar (const Common::UString &tag, bool vital=false)
 
- 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...
 
virtual void mouseUp ()
 The mouse state has changed. More...
 
virtual void mouseDown ()
 
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 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 updateDifficulty (int difficulty)
 
void adoptChanges ()
 
void revertChanges ()
 

Private Attributes

int _difficulty
 
Common::ScopedPtr< GUI_gorepass
 
Common::ScopedPtr< GUI_feedback
 

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::NWN::GUI
enum  WidgetType {
  kWidgetTypeInvalid = - 1, kWidgetTypeFrame = 0, kWidgetTypeCloseButton = 1, kWidgetTypeCheckBox = 2,
  kWidgetTypePanel = 3, kWidgetTypeLabel = 5, kWidgetTypeSlider = 6, kWidgetTypeEditBox = 8,
  kWidgetTypeButton = 9, kWidgetTypeListBox = 100, kWidgetTypeScrollbar = 101
}
 
- 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

The NWN game options menu.

Definition at line 37 of file game.h.

Constructor & Destructor Documentation

◆ OptionsGameMenu()

Engines::NWN::OptionsGameMenu::OptionsGameMenu ( bool  isMain = false,
::Engines::Console console = 0 
)

◆ ~OptionsGameMenu()

Engines::NWN::OptionsGameMenu::~OptionsGameMenu ( )

Definition at line 70 of file game.cpp.

Member Function Documentation

◆ adoptChanges()

void Engines::NWN::OptionsGameMenu::adoptChanges ( )
private

Definition at line 149 of file game.cpp.

References ConfigMan, and Engines::NWN::GUI::getSlider().

Referenced by callbackActive().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ callbackActive()

void Engines::NWN::OptionsGameMenu::callbackActive ( Widget widget)
protectedvirtual

Callback that's triggered when a widget was activated.

Reimplemented from Engines::GUI.

Definition at line 100 of file game.cpp.

References _feedback, _gorepass, Engines::GUI::_returnCode, adoptChanges(), Engines::Widget::getTag(), revertChanges(), Engines::GUI::sub(), and updateDifficulty().

Here is the call graph for this function:

◆ fixWidgetType()

void Engines::NWN::OptionsGameMenu::fixWidgetType ( const Common::UString tag,
WidgetType type 
)
protectedvirtual

Reimplemented from Engines::NWN::GUI.

Definition at line 83 of file game.cpp.

References Engines::NWN::GUI::kWidgetTypeListBox.

◆ initWidget()

void Engines::NWN::OptionsGameMenu::initWidget ( Widget widget)
protectedvirtual

Reimplemented from Engines::NWN::GUI.

Definition at line 88 of file game.cpp.

References Engines::Widget::getTag(), and Engines::NWN::WidgetListBox::kModeStatic.

Here is the call graph for this function:

◆ revertChanges()

void Engines::NWN::OptionsGameMenu::revertChanges ( )
private

Definition at line 153 of file game.cpp.

Referenced by callbackActive().

Here is the caller graph for this function:

◆ show()

void Engines::NWN::OptionsGameMenu::show ( )
virtual

Show the GUI.

Reimplemented from Engines::GUI.

Definition at line 73 of file game.cpp.

References _difficulty, CLIP(), ConfigMan, Engines::NWN::GUI::getSlider(), Engines::NWN::WidgetSlider::setState(), Engines::GUI::show(), and updateDifficulty().

Here is the call graph for this function:

◆ updateDifficulty()

void Engines::NWN::OptionsGameMenu::updateDifficulty ( int  difficulty)
private

Definition at line 132 of file game.cpp.

References Engines::NWN::GUI::getLabel(), Engines::NWN::GUI::getListBox(), Engines::NWN::WidgetLabel::setText(), Engines::NWN::WidgetListBox::setText(), and TalkMan.

Referenced by callbackActive(), and show().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ _difficulty

int Engines::NWN::OptionsGameMenu::_difficulty
private

Definition at line 51 of file game.h.

Referenced by show().

◆ _feedback

Common::ScopedPtr<GUI> Engines::NWN::OptionsGameMenu::_feedback
private

Definition at line 54 of file game.h.

Referenced by callbackActive(), and OptionsGameMenu().

◆ _gorepass

Common::ScopedPtr<GUI> Engines::NWN::OptionsGameMenu::_gorepass
private

Definition at line 53 of file game.h.

Referenced by callbackActive(), and OptionsGameMenu().


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