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

#include <charpackage.h>

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

Public Member Functions

 CharPackage (CharGenChoices &choices, ::Engines::Console *console)
 
 ~CharPackage ()
 
void reset ()
 
void show ()
 Show 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 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 callbackActive (Widget &widget)
 Callback that's triggered when a widget was activated. More...
 
void createPackageList ()
 
- 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 Attributes

WidgetListBox_packageListBox
 
Common::PtrVector< CharGenBase_subGUIs
 
std::vector< Common::UString_packageNames
 
std::vector< uint8_packageID
 
std::vector< Common::UString_helpTexts
 

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::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 40 of file charpackage.h.

Constructor & Destructor Documentation

◆ CharPackage()

Engines::NWN::CharPackage::CharPackage ( CharGenChoices choices,
::Engines::Console console 
)

Definition at line 46 of file charpackage.cpp.

References Engines::NWN::CharGenBase::_choices, _packageListBox, Engines::NWN::GUI::getListBox(), and Engines::NWN::GUI::load().

Here is the call graph for this function:

◆ ~CharPackage()

Engines::NWN::CharPackage::~CharPackage ( )

Definition at line 53 of file charpackage.cpp.

Member Function Documentation

◆ callbackActive()

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

◆ createPackageList()

void Engines::NWN::CharPackage::createPackageList ( )
protected

◆ reset()

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

Implements Engines::NWN::CharGenBase.

Definition at line 56 of file charpackage.cpp.

References Engines::NWN::CharGenBase::_choices, _subGUIs, Engines::NWN::GUI::getEditBox(), Engines::NWN::CharGenChoices::resetPackage(), Engines::NWN::WidgetListBox::setText(), Engines::NWN::WidgetEditBox::setTitle(), and TalkMan.

Referenced by callbackActive().

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

◆ show()

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

Show the GUI.

Reimplemented from Engines::GUI.

Definition at line 65 of file charpackage.cpp.

References createPackageList(), and Engines::GUI::show().

Here is the call graph for this function:

Member Data Documentation

◆ _helpTexts

std::vector<Common::UString> Engines::NWN::CharPackage::_helpTexts
private

Definition at line 60 of file charpackage.h.

Referenced by callbackActive(), and createPackageList().

◆ _packageID

std::vector<uint8> Engines::NWN::CharPackage::_packageID
private

Definition at line 59 of file charpackage.h.

Referenced by callbackActive(), and createPackageList().

◆ _packageListBox

WidgetListBox* Engines::NWN::CharPackage::_packageListBox
private

Definition at line 54 of file charpackage.h.

Referenced by callbackActive(), CharPackage(), and createPackageList().

◆ _packageNames

std::vector<Common::UString> Engines::NWN::CharPackage::_packageNames
private

Definition at line 58 of file charpackage.h.

Referenced by callbackActive(), and createPackageList().

◆ _subGUIs

Common::PtrVector<CharGenBase> Engines::NWN::CharPackage::_subGUIs
private

Definition at line 56 of file charpackage.h.

Referenced by callbackActive(), and reset().


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