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

The NWN ingame quickbar. More...

#include <quickbar.h>

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

Public Member Functions

 Quickbar ()
 
 ~Quickbar ()
 
float getWidth () const
 
float getHeight () const
 
- 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...
 
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
 
- Public Member Functions inherited from Events::Notifyable
 Notifyable ()
 
virtual ~Notifyable ()
 

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 getSlotSize ()
 
void notifyResized (int oldWidth, int oldHeight, int newWidth, int newHeight)
 

Private Attributes

float _slotWidth
 
float _slotHeight
 
float _edgeHeight
 

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 ingame quickbar.

Definition at line 66 of file quickbar.h.

Constructor & Destructor Documentation

◆ Quickbar()

Engines::NWN::Quickbar::Quickbar ( )

◆ ~Quickbar()

Engines::NWN::Quickbar::~Quickbar ( )

Definition at line 124 of file quickbar.cpp.

Member Function Documentation

◆ callbackActive()

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

Callback that's triggered when a widget was activated.

Reimplemented from Engines::GUI.

Definition at line 135 of file quickbar.cpp.

◆ getHeight()

float Engines::NWN::Quickbar::getHeight ( ) const

Definition at line 131 of file quickbar.cpp.

References _edgeHeight, and _slotHeight.

◆ getSlotSize()

void Engines::NWN::Quickbar::getSlotSize ( )
private

Definition at line 138 of file quickbar.cpp.

References _slotHeight, _slotWidth, and Engines::loadModelGUI().

Referenced by Quickbar().

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

◆ getWidth()

float Engines::NWN::Quickbar::getWidth ( ) const

Definition at line 127 of file quickbar.cpp.

References _slotWidth.

◆ notifyResized()

void Engines::NWN::Quickbar::notifyResized ( int  oldWidth,
int  oldHeight,
int  newWidth,
int  newHeight 
)
privatevirtual

Reimplemented from Events::Notifyable.

Definition at line 145 of file quickbar.cpp.

References _slotWidth, and Engines::GUI::setPosition().

Referenced by Quickbar().

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

Member Data Documentation

◆ _edgeHeight

float Engines::NWN::Quickbar::_edgeHeight
private

Definition at line 81 of file quickbar.h.

Referenced by getHeight(), and Quickbar().

◆ _slotHeight

float Engines::NWN::Quickbar::_slotHeight
private

Definition at line 79 of file quickbar.h.

Referenced by getHeight(), getSlotSize(), and Quickbar().

◆ _slotWidth

float Engines::NWN::Quickbar::_slotWidth
private

Definition at line 78 of file quickbar.h.

Referenced by getSlotSize(), getWidth(), notifyResized(), and Quickbar().


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