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

The NWN main menu. More...

#include <main.h>

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

Public Member Functions

 MainMenu (Module &module, ::Engines::Console *console=0)
 
 ~MainMenu ()
 
void show ()
 Show the GUI. More...
 
void abort ()
 Abort the currently running 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...
 
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 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)
 
virtual void initWidget (Widget &widget)
 
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 createNew ()
 
void createMovies ()
 
void createOptions ()
 

Private Attributes

Module_module
 
bool _hasXP
 
Common::ScopedPtr< GUI_charType
 
Common::ScopedPtr< GUI_new
 
Common::ScopedPtr< GUI_movies
 
Common::ScopedPtr< GUI_options
 

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 main menu.

Definition at line 39 of file main.h.

Constructor & Destructor Documentation

◆ MainMenu()

Engines::NWN::MainMenu::MainMenu ( Module module,
::Engines::Console console = 0 
)

◆ ~MainMenu()

Engines::NWN::MainMenu::~MainMenu ( )

Definition at line 74 of file main.cpp.

Member Function Documentation

◆ abort()

void Engines::NWN::MainMenu::abort ( )
virtual

Abort the currently running GUI.

Reimplemented from Engines::GUI.

Definition at line 114 of file main.cpp.

References Engines::GUI::abort(), and EventMan.

Here is the call graph for this function:

◆ callbackActive()

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

Callback that's triggered when a widget was activated.

Reimplemented from Engines::GUI.

Definition at line 121 of file main.cpp.

References _movies, _new, _options, Engines::GUI::_returnCode, ConfigMan, createMovies(), createNew(), createOptions(), EventMan, Engines::Widget::getTag(), Engines::NWN::NewGameFogs::show(), show(), and Engines::GUI::sub().

Here is the call graph for this function:

◆ createMovies()

void Engines::NWN::MainMenu::createMovies ( )
private

Definition at line 89 of file main.cpp.

References Engines::GUI::_console, _hasXP, and _movies.

Referenced by callbackActive().

Here is the caller graph for this function:

◆ createNew()

void Engines::NWN::MainMenu::createNew ( )
private

Definition at line 77 of file main.cpp.

References _charType, Engines::GUI::_console, _hasXP, _module, and _new.

Referenced by callbackActive().

Here is the caller graph for this function:

◆ createOptions()

void Engines::NWN::MainMenu::createOptions ( )
private

Definition at line 101 of file main.cpp.

References Engines::GUI::_console, _module, _options, and Engines::NWN::Module::getGameVersion().

Referenced by callbackActive().

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

◆ show()

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

Show the GUI.

Reimplemented from Engines::GUI.

Definition at line 108 of file main.cpp.

References Engines::GUI::getWidget(), Engines::GUI::show(), and Engines::Widget::show().

Referenced by callbackActive(), and Engines::NWN::Game::mainMenu().

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

Member Data Documentation

◆ _charType

Common::ScopedPtr<GUI> Engines::NWN::MainMenu::_charType
private

Definition at line 56 of file main.h.

Referenced by createNew(), and MainMenu().

◆ _hasXP

bool Engines::NWN::MainMenu::_hasXP
private

Definition at line 54 of file main.h.

Referenced by createMovies(), createNew(), and MainMenu().

◆ _module

Module* Engines::NWN::MainMenu::_module
private

Definition at line 52 of file main.h.

Referenced by createNew(), createOptions(), and MainMenu().

◆ _movies

Common::ScopedPtr<GUI> Engines::NWN::MainMenu::_movies
private

Definition at line 59 of file main.h.

Referenced by callbackActive(), and createMovies().

◆ _new

Common::ScopedPtr<GUI> Engines::NWN::MainMenu::_new
private

Definition at line 58 of file main.h.

Referenced by callbackActive(), and createNew().

◆ _options

Common::ScopedPtr<GUI> Engines::NWN::MainMenu::_options
private

Definition at line 60 of file main.h.

Referenced by callbackActive(), and createOptions().


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