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

The NWN character creator. More...

#include <charpremade.h>

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

Classes

struct  Character
 

Public Member Functions

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

const Common::UStringgetSelectedCharacter ()
 
void initCharacterList ()
 
void playCharacter ()
 

Private Attributes

Module_module
 
Common::ScopedPtr< GUI_charGen
 
std::vector< Character_characters
 

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 character creator.

Definition at line 66 of file charpremade.h.

Constructor & Destructor Documentation

◆ CharPremadeMenu()

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

Definition at line 110 of file charpremade.cpp.

References _charGen, Engines::GUI::_console, _module, Engines::GUI::getWidget(), Engines::NWN::GUI::load(), and Engines::Widget::setDisabled().

Here is the call graph for this function:

◆ ~CharPremadeMenu()

Engines::NWN::CharPremadeMenu::~CharPremadeMenu ( )

Definition at line 131 of file charpremade.cpp.

Member Function Documentation

◆ callbackActive()

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

Callback that's triggered when a widget was activated.

Reimplemented from Engines::GUI.

Definition at line 148 of file charpremade.cpp.

References _charGen, Engines::GUI::_returnCode, Engines::Widget::getTag(), playCharacter(), and Engines::GUI::sub().

Here is the call graph for this function:

◆ fixWidgetType()

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

Reimplemented from Engines::NWN::GUI.

Definition at line 143 of file charpremade.cpp.

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

◆ getSelectedCharacter()

const Common::UString & Engines::NWN::CharPremadeMenu::getSelectedCharacter ( )
private

Definition at line 230 of file charpremade.cpp.

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

Referenced by playCharacter().

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

◆ initCharacterList()

void Engines::NWN::CharPremadeMenu::initCharacterList ( )
private

◆ playCharacter()

void Engines::NWN::CharPremadeMenu::playCharacter ( )
private

Definition at line 238 of file charpremade.cpp.

References _module, Engines::GUI::_returnCode, Common::exceptionDispatcherWarning(), getSelectedCharacter(), and Engines::NWN::Module::usePC().

Referenced by callbackActive().

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

◆ show()

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

Show the GUI.

Reimplemented from Engines::GUI.

Definition at line 134 of file charpremade.cpp.

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

Here is the call graph for this function:

Member Data Documentation

◆ _characters

std::vector<Character> Engines::NWN::CharPremadeMenu::_characters
private

Definition at line 97 of file charpremade.h.

Referenced by getSelectedCharacter(), initCharacterList(), and show().

◆ _charGen

Common::ScopedPtr<GUI> Engines::NWN::CharPremadeMenu::_charGen
private

Definition at line 95 of file charpremade.h.

Referenced by callbackActive(), and CharPremadeMenu().

◆ _module

Module* Engines::NWN::CharPremadeMenu::_module
private

Definition at line 93 of file charpremade.h.

Referenced by CharPremadeMenu(), and playCharacter().


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