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

#include <newmodule.h>

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

Public Member Functions

 WidgetListItemModule (::Engines::GUI &gui, const Common::UString &font, const Common::UString &text, float spacing=0.0f)
 
 ~WidgetListItemModule ()
 
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::WidgetListItem
 WidgetListItem (::Engines::GUI &gui)
 
 ~WidgetListItem ()
 
bool operator< (const WidgetListItem &item) const
 
void mouseUp (uint8 state, float x, float y)
 A mouse button was released on the widget. More...
 
void mouseWheel (uint8 state, int x, int y)
 A mouse wheel was used on the widget. More...
 
void mouseDblClick (uint8 state, float x, float y)
 A mouse button was double-clicked on the widget. More...
 
void select ()
 
size_t getItemNumber () const
 
- 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 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...
 

Protected Member Functions

bool activate ()
 
bool deactivate ()
 
- Protected Member Functions inherited from Engines::NWN::WidgetListItem
bool getState ()
 
void signalGroupMemberActive ()
 A fellow group member signaled that it is now active. More...
 
- Protected Member Functions inherited from Engines::Widget
void setActive (bool active)
 The widget's active state. More...
 
void raiseCallbackActive (Widget &widget)
 

Private Attributes

Common::ScopedPtr< Graphics::Aurora::Model_button
 
Common::ScopedPtr< Graphics::Aurora::Text_text
 
float _spacing
 

Additional Inherited Members

- 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

Definition at line 45 of file newmodule.h.

Constructor & Destructor Documentation

◆ WidgetListItemModule()

Engines::NWN::WidgetListItemModule::WidgetListItemModule ( ::Engines::GUI gui,
const Common::UString font,
const Common::UString text,
float  spacing = 0.0f 
)

◆ ~WidgetListItemModule()

Engines::NWN::WidgetListItemModule::~WidgetListItemModule ( )

Definition at line 64 of file newmodule.cpp.

Member Function Documentation

◆ activate()

bool Engines::NWN::WidgetListItemModule::activate ( )
protectedvirtual

Reimplemented from Engines::NWN::WidgetListItem.

Definition at line 103 of file newmodule.cpp.

References _button, and Engines::NWN::WidgetListItem::activate().

Here is the call graph for this function:

◆ deactivate()

bool Engines::NWN::WidgetListItemModule::deactivate ( )
protectedvirtual

Reimplemented from Engines::NWN::WidgetListItem.

Definition at line 112 of file newmodule.cpp.

References _button, and Engines::NWN::WidgetListItem::deactivate().

Here is the call graph for this function:

◆ getHeight()

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

Get the widget's height.

Reimplemented from Engines::Widget.

Definition at line 93 of file newmodule.cpp.

References _button, and _spacing.

◆ getWidth()

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

Get the widget's width.

Reimplemented from Engines::Widget.

Definition at line 89 of file newmodule.cpp.

References _button.

◆ hide()

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

Hide the widget.

Reimplemented from Engines::Widget.

Definition at line 72 of file newmodule.cpp.

References _button, and _text.

◆ setPosition()

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

Set the widget's position.

Reimplemented from Engines::Widget.

Definition at line 77 of file newmodule.cpp.

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

Here is the call graph for this function:

◆ setTag()

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

Set the widget's tag.

Reimplemented from Engines::Widget.

Definition at line 97 of file newmodule.cpp.

References _button, and Engines::Widget::setTag().

Here is the call graph for this function:

◆ show()

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

Show the widget.

Reimplemented from Engines::Widget.

Definition at line 67 of file newmodule.cpp.

References _button, and _text.

Member Data Documentation

◆ _button

Common::ScopedPtr<Graphics::Aurora::Model> Engines::NWN::WidgetListItemModule::_button
private

◆ _spacing

float Engines::NWN::WidgetListItemModule::_spacing
private

Definition at line 69 of file newmodule.h.

Referenced by getHeight().

◆ _text

Common::ScopedPtr<Graphics::Aurora::Text> Engines::NWN::WidgetListItemModule::_text
private

Definition at line 67 of file newmodule.h.

Referenced by hide(), setPosition(), show(), and WidgetListItemModule().


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