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

A button within the NWN quickbar. More...

#include <quickbar.h>

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

Public Member Functions

 QuickbarButton (::Engines::GUI &gui, size_t n)
 
 ~QuickbarButton ()
 
void show ()
 Show the widget. More...
 
void hide ()
 Hide the widget. More...
 
void setPosition (float x, float y, float z)
 Set the widget's position. More...
 
float getWidth () const
 Get the widget's width. More...
 
float getHeight () const
 Get the widget's height. More...
 
void setTag (const Common::UString &tag)
 Set the widget's tag. More...
 
- Public Member Functions inherited from Engines::NWN::NWNWidget
 NWNWidget (::Engines::GUI &gui, const Common::UString &tag)
 
 ~NWNWidget ()
 
void hide ()
 Hide the widget. More...
 
void enter ()
 The mouse entered the widget. More...
 
void leave ()
 The mouse left the widget. More...
 
void setPosition (float x, float y, float z)
 Set the widget's position. More...
 
void setTooltip (const Common::UString &text)
 
void setTooltipPosition (float x, float y, float z)
 
- Public Member Functions inherited from Engines::Widget
 Widget (GUI &gui, const Common::UString &tag)
 
virtual ~Widget ()
 
const Common::UStringgetTag () const
 Get the widget's tag. More...
 
bool isActive () const
 Was the widget activated? More...
 
bool isVisible () const
 Is the widget visible? More...
 
bool isDisabled () const
 Is the widget disabled? More...
 
bool isInvisible () const
 Is the widget invisible (never visible)? More...
 
WidgetgetParent ()
 
const WidgetgetParent () const
 
WidgetgetChild (const Common::UString &childTag)
 Get the widget's child by tag. More...
 
virtual void movePosition (float x, float y, float z)
 Move the widget, relative to its current position. More...
 
virtual void getPosition (float &x, float &y, float &z) const
 Get the widget's position. More...
 
virtual void setDisabled (bool disabled)
 Disable/Enable the widget. More...
 
virtual void setInvisible (bool invisible)
 Make the widget invisible. More...
 
virtual void mouseMove (uint8 state, float x, float y)
 The mouse was moved over the widget. More...
 
virtual void mouseDown (uint8 state, float x, float y)
 A mouse button was pressed on the widget. More...
 
virtual void mouseUp (uint8 state, float x, float y)
 A mouse button was released on the widget. More...
 
virtual void mouseWheel (uint8 state, int x, int y)
 A mouse wheel was used on the widget. More...
 
virtual void mouseDblClick (uint8 state, float x, float y)
 A mouse button was double-clicked on the widget. More...
 
virtual void subActive (Widget &widget)
 A sub-widget was activated. More...
 
void remove ()
 Remove the widget from the GUI. More...
 
virtual void addSub (Widget &widget)
 Add a sub-widget to the widget. More...
 
virtual void addChild (Widget &widget)
 Add a child to the widget. More...
 
virtual void addGroupMember (Widget &widget)
 Add a fellow group member to the widget. More...
 
virtual void removeSub (Widget &widget)
 Remove a sub-widget from the widget. More...
 
virtual void removeChild (Widget &widget)
 Remove a child from the widget. More...
 
virtual void removeGroupMember (Widget &widget)
 Remove fellow group member from the widget. More...
 

Private Attributes

Common::ScopedPtr< Graphics::Aurora::Model_model
 
size_t _buttonNumber
 

Additional Inherited Members

- Protected Member Functions inherited from Engines::Widget
virtual void signalGroupMemberActive ()
 A fellow group member signaled that it is now active. More...
 
void setActive (bool active)
 The widget's active state. More...
 
void raiseCallbackActive (Widget &widget)
 
- Protected Attributes inherited from Engines::Widget
GUI_gui
 The GUI the widget belongs to. More...
 
Common::UString _tag
 The widget's tag. More...
 
Widget_parent
 The widget's parent, if any. More...
 
Widget_owner
 The widget's owner, if any. More...
 
std::list< Widget * > _subWidgets
 The widget's sub-widgets. More...
 
std::list< Widget * > _children
 The widget's children. More...
 
std::list< Widget * > _groupMembers
 The widget's fellow group members. More...
 

Detailed Description

A button within the NWN quickbar.

Definition at line 44 of file quickbar.h.

Constructor & Destructor Documentation

◆ QuickbarButton()

Engines::NWN::QuickbarButton::QuickbarButton ( ::Engines::GUI gui,
size_t  n 
)

◆ ~QuickbarButton()

Engines::NWN::QuickbarButton::~QuickbarButton ( )

Definition at line 72 of file quickbar.cpp.

Member Function Documentation

◆ getHeight()

float Engines::NWN::QuickbarButton::getHeight ( ) const
virtual

Get the widget's height.

Reimplemented from Engines::Widget.

Definition at line 94 of file quickbar.cpp.

References _model.

◆ getWidth()

float Engines::NWN::QuickbarButton::getWidth ( ) const
virtual

Get the widget's width.

Reimplemented from Engines::Widget.

Definition at line 90 of file quickbar.cpp.

References _model.

◆ hide()

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

Hide the widget.

Reimplemented from Engines::Widget.

Definition at line 79 of file quickbar.cpp.

References _model.

◆ setPosition()

void Engines::NWN::QuickbarButton::setPosition ( float  x,
float  y,
float  z 
)
virtual

Set the widget's position.

Reimplemented from Engines::Widget.

Definition at line 83 of file quickbar.cpp.

References _model, Engines::Widget::getPosition(), and Engines::NWN::NWNWidget::setPosition().

Referenced by Engines::NWN::Quickbar::Quickbar().

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

◆ setTag()

void Engines::NWN::QuickbarButton::setTag ( const Common::UString tag)
virtual

Set the widget's tag.

Reimplemented from Engines::Widget.

Definition at line 98 of file quickbar.cpp.

◆ show()

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

Show the widget.

Reimplemented from Engines::Widget.

Definition at line 75 of file quickbar.cpp.

References _model.

Member Data Documentation

◆ _buttonNumber

size_t Engines::NWN::QuickbarButton::_buttonNumber
private

Definition at line 62 of file quickbar.h.

Referenced by QuickbarButton().

◆ _model

Common::ScopedPtr<Graphics::Aurora::Model> Engines::NWN::QuickbarButton::_model
private

Definition at line 60 of file quickbar.h.

Referenced by getHeight(), getWidth(), hide(), QuickbarButton(), setPosition(), and show().


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