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

#include <menu_equ.h>

Inheritance diagram for Engines::KotOR::MenuEquipment:
Inheritance graph
[legend]
Collaboration diagram for Engines::KotOR::MenuEquipment:
Collaboration graph
[legend]

Public Member Functions

 MenuEquipment (::Engines::Console *console=0)
 
void setPC (Creature *pc)
 
void show ()
 Show the GUI. More...
 
void hide ()
 Hide the GUI. More...
 
- Public Member Functions inherited from Engines::KotOR::GUI
 GUI (::Engines::Console *console=0)
 
 ~GUI ()
 
void convertToXoreos (float &x, float &y, const float widgetHeight) const
 Converts Kotor' GUI coordinates with a coordinate origin in the upper left corner to the Xoreos coordinate system with the coordinate origin in the center. More...
 
void convertToGUI (float &x, float &y, const float widgetHeight) const
 Converts Xoreos' coordinates with a coordinate origin in the center to Kotor's GUI coordinates with the coordinate origin in the the upper left corner. More...
 
Common::UString getName () const
 
- Public Member Functions inherited from Engines::GUI
 GUI (Console *console=0)
 
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...
 

Protected Member Functions

void callbackRun ()
 Callback that's triggered periodically in the run() method. More...
 
void callbackActive (Widget &widget)
 Callback that's triggered when a widget was activated. More...
 
void callbackKeyInput (const Events::Key &key, const Events::EventType &type)
 Callback that's triggered when a key is pressed or released. More...
 
- Protected Member Functions inherited from Engines::KotOR::GUI
virtual void mouseUp ()
 The mouse state has changed. More...
 
virtual void mouseDown ()
 
void load (const Common::UString &resref)
 
virtual void initWidget (Widget &widget)
 
WidgetPanelgetPanel (const Common::UString &tag, bool vital=false)
 
WidgetLabelgetLabel (const Common::UString &tag, bool vital=false)
 
WidgetProtoItemgetProtoItem (const Common::UString &tag, bool vital=false)
 
WidgetButtongetButton (const Common::UString &tag, bool vital=false)
 
WidgetCheckBoxgetCheckBox (const Common::UString &tag, bool vital=false)
 
WidgetSlidergetSlider (const Common::UString &tag, bool vital=false)
 
WidgetScrollbargetScrollbar (const Common::UString &tag, bool vital=false)
 
WidgetProgressbargetProgressbar (const Common::UString &tag, bool vital=false)
 
WidgetListBoxgetListBox (const Common::UString &tag, bool vital=false)
 
void addBackground (const Common::UString &background, bool front=false)
 
void setCheckBoxState (const Common::UString &tag, bool state)
 
bool getCheckBoxState (const Common::UString &tag)
 
- 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...
 
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 callbackTextInput (const Common::UString &text)
 Callback that's triggered when a text input is received. 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 fillEquipedItems ()
 
Common::UString getEquipedItemIcon (EquipmentSlot slot) const
 
void fillEquipableItemsList ()
 
EquipmentSlot getSlotByWidgetTag (const Common::UString &tag) const
 
WidgetButtongetSlotButton (EquipmentSlot slot)
 
Common::UString getSlotName (EquipmentSlot slot) const
 
void fixateOnSlot (bool fixate)
 

Private Attributes

Creature_pc
 
EquipmentSlot _selectedSlot
 
bool _slotFixated
 
std::vector< Common::UString_visibleItems
 

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::KotOR::GUI
enum  WidgetType {
  kWidgetTypeInvalid = - 1, kWidgetTypePanel = 2, kWidgetTypeLabel = 4, kWidgetTypeProtoItem = 5,
  kWidgetTypeButton = 6, kWidgetTypeCheckBox = 7, kWidgetTypeSlider = 8, kWidgetTypeScrollbar = 9,
  kWidgetTypeProgressbar = 10, kWidgetTypeListBox = 11
}
 
- 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 39 of file menu_equ.h.

Constructor & Destructor Documentation

◆ MenuEquipment()

Engines::KotOR::MenuEquipment::MenuEquipment ( ::Engines::Console console = 0)

Member Function Documentation

◆ callbackActive()

void Engines::KotOR::MenuEquipment::callbackActive ( Widget widget)
protectedvirtual

◆ callbackKeyInput()

void Engines::KotOR::MenuEquipment::callbackKeyInput ( const Events::Key key,
const Events::EventType type 
)
protectedvirtual

Callback that's triggered when a key is pressed or released.

Reimplemented from Engines::GUI.

Definition at line 160 of file menu_equ.cpp.

References Engines::KotOR::GUI::getListBox(), Events::kEventKeyDown, Events::kKeyDown, Events::kKeyUp, Engines::WidgetListBox::selectNextItem(), and Engines::WidgetListBox::selectPreviousItem().

Here is the call graph for this function:

◆ callbackRun()

void Engines::KotOR::MenuEquipment::callbackRun ( )
protectedvirtual

◆ fillEquipableItemsList()

void Engines::KotOR::MenuEquipment::fillEquipableItemsList ( )
private

◆ fillEquipedItems()

void Engines::KotOR::MenuEquipment::fillEquipedItems ( )
private

◆ fixateOnSlot()

void Engines::KotOR::MenuEquipment::fixateOnSlot ( bool  fixate)
private

◆ getEquipedItemIcon()

Common::UString Engines::KotOR::MenuEquipment::getEquipedItemIcon ( EquipmentSlot  slot) const
private

Definition at line 197 of file menu_equ.cpp.

References _pc, Engines::KotOR::Creature::getEquipedItem(), and Engines::KotOR::Item::getIcon().

Referenced by fillEquipedItems().

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

◆ getSlotButton()

WidgetButton * Engines::KotOR::MenuEquipment::getSlotButton ( EquipmentSlot  slot)
private

◆ getSlotByWidgetTag()

EquipmentSlot Engines::KotOR::MenuEquipment::getSlotByWidgetTag ( const Common::UString tag) const
private

◆ getSlotName()

Common::UString Engines::KotOR::MenuEquipment::getSlotName ( EquipmentSlot  slot) const
private

◆ hide()

void Engines::KotOR::MenuEquipment::hide ( )
virtual

Hide the GUI.

Reimplemented from Engines::KotOR::GUI.

Definition at line 88 of file menu_equ.cpp.

References _selectedSlot, getSlotButton(), Engines::KotOR::GUI::hide(), Engines::KotOR::kEquipmentSlotNone, and Engines::KotORJadeWidget::setHighlight().

Here is the call graph for this function:

◆ setPC()

void Engines::KotOR::MenuEquipment::setPC ( Creature pc)

Definition at line 74 of file menu_equ.cpp.

References _pc, fillEquipableItemsList(), and fillEquipedItems().

Here is the call graph for this function:

◆ show()

void Engines::KotOR::MenuEquipment::show ( )
virtual

Show the GUI.

Reimplemented from Engines::KotOR::GUI.

Definition at line 81 of file menu_equ.cpp.

References _selectedSlot, getSlotButton(), Engines::KotOR::kEquipmentSlotNone, Engines::KotORJadeWidget::setHighlight(), and Engines::KotOR::GUI::show().

Here is the call graph for this function:

Member Data Documentation

◆ _pc

Creature* Engines::KotOR::MenuEquipment::_pc
private

Definition at line 54 of file menu_equ.h.

Referenced by callbackActive(), fillEquipableItemsList(), getEquipedItemIcon(), and setPC().

◆ _selectedSlot

EquipmentSlot Engines::KotOR::MenuEquipment::_selectedSlot
private

Definition at line 55 of file menu_equ.h.

Referenced by callbackActive(), callbackRun(), fillEquipableItemsList(), fixateOnSlot(), hide(), and show().

◆ _slotFixated

bool Engines::KotOR::MenuEquipment::_slotFixated
private

Definition at line 56 of file menu_equ.h.

Referenced by callbackActive(), and fixateOnSlot().

◆ _visibleItems

std::vector<Common::UString> Engines::KotOR::MenuEquipment::_visibleItems
private

Definition at line 57 of file menu_equ.h.

Referenced by callbackActive(), and fillEquipableItemsList().


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