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

The NWN sound options menu. More...

#include <sound.h>

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

Public Member Functions

 OptionsSoundMenu (bool isMain=false, ::Engines::Console *console=0)
 
 ~OptionsSoundMenu ()
 
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 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)
 
virtual void fixWidgetType (const Common::UString &tag, WidgetType &type)
 
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 updateVolume (double volume, Sound::SoundType type, const Common::UString &label)
 
void adoptChanges ()
 
void revertChanges ()
 

Private Attributes

Common::ScopedPtr< GUI_advanced
 
double _volMusic
 
double _volSFX
 
double _volVoice
 
double _volVideo
 

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 sound options menu.

Definition at line 39 of file sound.h.

Constructor & Destructor Documentation

◆ OptionsSoundMenu()

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

◆ ~OptionsSoundMenu()

Engines::NWN::OptionsSoundMenu::~OptionsSoundMenu ( )

Definition at line 104 of file sound.cpp.

Member Function Documentation

◆ adoptChanges()

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

Definition at line 174 of file sound.cpp.

References _volMusic, _volSFX, _volVideo, _volVoice, and ConfigMan.

Referenced by callbackActive().

Here is the caller graph for this function:

◆ callbackActive()

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

Callback that's triggered when a widget was activated.

Reimplemented from Engines::GUI.

Definition at line 124 of file sound.cpp.

References _advanced, Engines::GUI::_returnCode, _volMusic, _volSFX, _volVideo, _volVoice, adoptChanges(), Engines::Widget::getTag(), Sound::kSoundTypeMusic, Sound::kSoundTypeSFX, Sound::kSoundTypeVideo, Sound::kSoundTypeVoice, revertChanges(), Engines::GUI::sub(), and updateVolume().

Here is the call graph for this function:

◆ initWidget()

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

Reimplemented from Engines::NWN::GUI.

Definition at line 107 of file sound.cpp.

References Engines::Widget::getTag().

Here is the call graph for this function:

◆ revertChanges()

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

Definition at line 181 of file sound.cpp.

References ConfigMan, Sound::kSoundTypeMusic, Sound::kSoundTypeSFX, Sound::kSoundTypeVideo, Sound::kSoundTypeVoice, and SoundMan.

Referenced by callbackActive().

Here is the caller graph for this function:

◆ show()

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

◆ updateVolume()

void Engines::NWN::OptionsSoundMenu::updateVolume ( double  volume,
Sound::SoundType  type,
const Common::UString label 
)
private

Definition at line 165 of file sound.cpp.

References Common::UString::empty(), Common::UString::format(), Engines::NWN::GUI::getLabel(), Engines::NWN::WidgetLabel::setText(), and SoundMan.

Referenced by callbackActive(), and show().

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

Member Data Documentation

◆ _advanced

Common::ScopedPtr<GUI> Engines::NWN::OptionsSoundMenu::_advanced
private

Definition at line 51 of file sound.h.

Referenced by callbackActive(), and OptionsSoundMenu().

◆ _volMusic

double Engines::NWN::OptionsSoundMenu::_volMusic
private

Definition at line 53 of file sound.h.

Referenced by adoptChanges(), callbackActive(), and show().

◆ _volSFX

double Engines::NWN::OptionsSoundMenu::_volSFX
private

Definition at line 54 of file sound.h.

Referenced by adoptChanges(), callbackActive(), and show().

◆ _volVideo

double Engines::NWN::OptionsSoundMenu::_volVideo
private

Definition at line 56 of file sound.h.

Referenced by adoptChanges(), callbackActive(), and show().

◆ _volVoice

double Engines::NWN::OptionsSoundMenu::_volVoice
private

Definition at line 55 of file sound.h.

Referenced by adoptChanges(), callbackActive(), and show().


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