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

A NWN label widget. More...

#include <label.h>

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

Public Member Functions

 WidgetLabel (::Engines::GUI &gui, const Common::UString &tag)
 
 ~WidgetLabel ()
 
void initCaption (const Common::UString &font, const Common::UString &text, float r=1.0f, float g=1.0f, float b=1.0f, float a=1.0f, float halign=Graphics::Aurora::kHAlignLeft, float valign=Graphics::Aurora::kVAlignTop)
 
void setText (const Common::UString &text)
 
float getWidth () const
 Get the widget's width. More...
 
float getHeight () const
 Get the widget's height. More...
 
void setSize (float width, float height)
 
- Public Member Functions inherited from Engines::NWN::NWNWidgetWithCaption
 NWNWidgetWithCaption (::Engines::GUI &gui, const Common::UString &tag)
 
 ~NWNWidgetWithCaption ()
 
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...
 
void setColor (float r, float g, float b, float a)
 
void setText (const Common::UString &text)
 
const Common::UString getText () const
 
float getWidth () const
 Get the widget's width. More...
 
float getHeight () const
 Get the widget's height. More...
 
float getHorizontalAlign () const
 
float getVerticalAlign () const
 
void setDisabled (bool disabled)
 Disable/Enable the widget. More...
 
- Public Member Functions inherited from Engines::NWN::NWNWidget
 NWNWidget (::Engines::GUI &gui, const Common::UString &tag)
 
 ~NWNWidget ()
 
void enter ()
 The mouse entered the widget. More...
 
void leave ()
 The mouse left the widget. 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...
 
virtual void setTag (const Common::UString &tag)
 Set 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 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

float _width
 
float _height
 

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::NWN::NWNWidgetWithCaption
Common::ScopedPtr< Graphics::Aurora::Text_caption
 
float _r
 
float _g
 
float _b
 
float _a
 
- 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 NWN label widget.

Definition at line 41 of file label.h.

Constructor & Destructor Documentation

◆ WidgetLabel()

Engines::NWN::WidgetLabel::WidgetLabel ( ::Engines::GUI gui,
const Common::UString tag 
)

Definition at line 35 of file label.cpp.

◆ ~WidgetLabel()

Engines::NWN::WidgetLabel::~WidgetLabel ( )

Definition at line 40 of file label.cpp.

Member Function Documentation

◆ getHeight()

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

Get the widget's height.

Reimplemented from Engines::Widget.

Definition at line 88 of file label.cpp.

References _height.

Referenced by Engines::NWN::OKCancelDialog::show(), and Engines::NWN::YesNoCancelDialog::show().

Here is the caller graph for this function:

◆ getWidth()

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

Get the widget's width.

Reimplemented from Engines::Widget.

Definition at line 84 of file label.cpp.

References _width.

Referenced by Engines::NWN::CharSkills::CharSkills(), Engines::NWN::YesNoCancelDialog::show(), and Engines::NWN::OKCancelDialog::show().

Here is the caller graph for this function:

◆ initCaption()

void Engines::NWN::WidgetLabel::initCaption ( const Common::UString font,
const Common::UString text,
float  r = 1.0f,
float  g = 1.0f,
float  b = 1.0f,
float  a = 1.0f,
float  halign = Graphics::Aurora::kHAlignLeft,
float  valign = Graphics::Aurora::kVAlignTop 
)
virtual

◆ setSize()

void Engines::NWN::WidgetLabel::setSize ( float  width,
float  height 
)

Definition at line 92 of file label.cpp.

References Engines::NWN::NWNWidgetWithCaption::_caption, _height, and _width.

Referenced by Engines::NWN::GUI::initWidget(), and setText().

Here is the caller graph for this function:

◆ setText()

void Engines::NWN::WidgetLabel::setText ( const Common::UString text)

Member Data Documentation

◆ _height

float Engines::NWN::WidgetLabel::_height
private

Definition at line 58 of file label.h.

Referenced by getHeight(), initCaption(), setSize(), and setText().

◆ _width

float Engines::NWN::WidgetLabel::_width
private

Definition at line 57 of file label.h.

Referenced by getWidth(), initCaption(), setSize(), and setText().


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