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

The NWN new premium module menu. More...

#include <newpremium.h>

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

Public Member Functions

 NewPremiumMenu (Module &module, GUI &charType, ::Engines::Console *console=0)
 
 ~NewPremiumMenu ()
 
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

Common::UString getSelectedModule ()
 
void initModuleList ()
 
void selectedModule ()
 
void loadModule ()
 

Private Attributes

Module_module
 
std::vector< Common::UString_modules
 
GUI_charType
 

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 new premium module menu.

Definition at line 73 of file newpremium.h.

Constructor & Destructor Documentation

◆ NewPremiumMenu()

Engines::NWN::NewPremiumMenu::NewPremiumMenu ( Module module,
GUI charType,
::Engines::Console console = 0 
)

Definition at line 124 of file newpremium.cpp.

References Engines::NWN::GUI::load().

Here is the call graph for this function:

◆ ~NewPremiumMenu()

Engines::NWN::NewPremiumMenu::~NewPremiumMenu ( )

Definition at line 130 of file newpremium.cpp.

Member Function Documentation

◆ callbackActive()

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

Callback that's triggered when a widget was activated.

Reimplemented from Engines::GUI.

Definition at line 176 of file newpremium.cpp.

References Engines::GUI::_returnCode, Engines::Widget::getTag(), loadModule(), and selectedModule().

Here is the call graph for this function:

◆ fixWidgetType()

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

Reimplemented from Engines::NWN::GUI.

Definition at line 140 of file newpremium.cpp.

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

◆ getSelectedModule()

Common::UString Engines::NWN::NewPremiumMenu::getSelectedModule ( )
private

Definition at line 197 of file newpremium.cpp.

References _modules, Engines::NWN::GUI::getListBox(), and Engines::NWN::WidgetListBox::getSelected().

Referenced by loadModule(), and selectedModule().

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

◆ initModuleList()

void Engines::NWN::NewPremiumMenu::initModuleList ( )
private

◆ initWidget()

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

Reimplemented from Engines::NWN::GUI.

Definition at line 147 of file newpremium.cpp.

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

Here is the call graph for this function:

◆ loadModule()

void Engines::NWN::NewPremiumMenu::loadModule ( )
private

Definition at line 213 of file newpremium.cpp.

References _charType, _module, Engines::GUI::_returnCode, Common::exceptionDispatcherWarning(), getSelectedModule(), Engines::NWN::Module::load(), show(), and Engines::GUI::sub().

Referenced by callbackActive().

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

◆ selectedModule()

void Engines::NWN::NewPremiumMenu::selectedModule ( )
private

Definition at line 205 of file newpremium.cpp.

References Common::UString::empty(), Engines::NWN::Object::getDescription(), Engines::NWN::GUI::getListBox(), getSelectedModule(), Engines::NWN::WidgetListBox::setText(), and TalkMan.

Referenced by callbackActive(), and initModuleList().

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

◆ show()

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

Show the GUI.

Reimplemented from Engines::GUI.

Definition at line 133 of file newpremium.cpp.

References _modules, initModuleList(), and Engines::GUI::show().

Referenced by loadModule().

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

Member Data Documentation

◆ _charType

GUI* Engines::NWN::NewPremiumMenu::_charType
private

Definition at line 91 of file newpremium.h.

Referenced by loadModule().

◆ _module

Module* Engines::NWN::NewPremiumMenu::_module
private

Definition at line 87 of file newpremium.h.

Referenced by loadModule().

◆ _modules

std::vector<Common::UString> Engines::NWN::NewPremiumMenu::_modules
private

Definition at line 89 of file newpremium.h.

Referenced by getSelectedModule(), initModuleList(), and show().


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