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

#include <charschool.h>

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

Public Member Functions

 CharSchool (CharGenChoices &choices, ::Engines::Console *console=0)
 
 ~CharSchool ()
 
void reset ()
 
void hide ()
 Hide the GUI. More...
 
- Public Member Functions inherited from Engines::NWN::CharGenBase
 CharGenBase (::Engines::Console *console=0)
 
 ~CharGenBase ()
 
- 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 show ()
 Show 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
 

Private Member Functions

void callbackActive (Widget &widget)
 Callback that's triggered when a widget was activated. More...
 

Private Attributes

Common::ScopedPtr< ButtonsGroup_buttons
 

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 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...
 
- Protected Attributes inherited from Engines::NWN::CharGenBase
CharGenChoices_choices
 
- 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

Definition at line 38 of file charschool.h.

Constructor & Destructor Documentation

◆ CharSchool()

Engines::NWN::CharSchool::CharSchool ( CharGenChoices choices,
::Engines::Console console = 0 
)

◆ ~CharSchool()

Engines::NWN::CharSchool::~CharSchool ( )

Definition at line 59 of file charschool.cpp.

Member Function Documentation

◆ callbackActive()

void Engines::NWN::CharSchool::callbackActive ( Widget widget)
privatevirtual

Callback that's triggered when a widget was activated.

Reimplemented from Engines::GUI.

Definition at line 81 of file charschool.cpp.

References _buttons, Engines::NWN::CharGenBase::_choices, Engines::GUI::_returnCode, Engines::Widget::getTag(), and Engines::NWN::CharGenChoices::setSpellSchool().

Here is the call graph for this function:

◆ hide()

void Engines::NWN::CharSchool::hide ( )
virtual

Hide the GUI.

Reimplemented from Engines::GUI.

Definition at line 71 of file charschool.cpp.

References _buttons, Engines::NWN::CharGenBase::_choices, Engines::GUI::_returnCode, Engines::NWN::CharGenChoices::getSpellSchool(), Engines::GUI::hide(), and UINT8_MAX.

Here is the call graph for this function:

◆ reset()

void Engines::NWN::CharSchool::reset ( )
virtual

Member Data Documentation

◆ _buttons

Common::ScopedPtr<ButtonsGroup> Engines::NWN::CharSchool::_buttons
private

Definition at line 49 of file charschool.h.

Referenced by callbackActive(), CharSchool(), hide(), and reset().


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