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

#include <gridbox.h>

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

Public Member Functions

 WidgetGridBox (::Engines::GUI &gui, const Common::UString &tag, const Common::UString &model, float innerHSpace=0.0f, float InnerVSpace=0.0f)
 
 ~WidgetGridBox ()
 
void mouseDown (uint8 state, float x, float y)
 A mouse button was pressed on the widget. More...
 
void unlock ()
 
void subActive (Widget &widget)
 A sub-widget was activated. More...
 
- Public Member Functions inherited from Engines::NWN::WidgetListBox
 WidgetListBox (::Engines::GUI &gui, const Common::UString &tag, const Common::UString &model)
 
 ~WidgetListBox ()
 
Mode getMode () const
 
void setMode (Mode mode)
 
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 getContentWidth () const
 
float getContentHeight () const
 
void lock ()
 
void clear ()
 
void reserve (size_t n)
 
void add (WidgetListItem *item, bool noTag=false)
 
void remove (WidgetListItem *item)
 
void unlock ()
 
void sortByTag ()
 
void setText (const Common::UString &font, const Common::UString &text, float spacing=0.0f)
 
void select (size_t item)
 
size_t getSelected () const
 
WidgetListItemgetSelectedItem () const
 
void deselect ()
 
void setStartItem (size_t firstItem)
 Set the first item to show in the list. More...
 
size_t getStartItem () const
 Get the first item shown in the list. More...
 
std::vector< WidgetListItem * >::iterator begin ()
 Get begin iterator from all the items in WidgetListBox. More...
 
std::vector< WidgetListItem * >::iterator end ()
 Get end iterator from all the items in WidgetListBox. More...
 
bool wasDblClicked ()
 
void mouseDown (uint8 state, float x, float y)
 A mouse button was pressed on the widget. More...
 
void mouseWheel (uint8 state, int x, int y)
 A mouse wheel was used on the widget. More...
 
void subActive (Widget &widget)
 A sub-widget was activated. More...
 
- Public Member Functions inherited from Engines::NWN::ModelWidget
 ModelWidget (::Engines::GUI &gui, const Common::UString &tag, const Common::UString &model)
 
 ~ModelWidget ()
 
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...
 
Graphics::Aurora::ModelNodegetNode (const Common::UString &nodeName) const
 
- 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...
 
virtual 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 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...
 
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 mouseUp (uint8 state, float x, float y)
 A mouse button was released on the widget. More...
 
virtual void mouseDblClick (uint8 state, float x, float y)
 A mouse button was double-clicked on the widget. 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

void updateScrollbarLength ()
 
void updateVisible ()
 
void scrollUp (size_t n)
 
void scrollDown (size_t n)
 
- Protected Member Functions inherited from Engines::NWN::WidgetListBox
virtual void updateScrollbarPosition ()
 
- 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

size_t _itemsByRow
 
float _innerHSpace
 
float _innerVSpace
 
- Protected Attributes inherited from Engines::NWN::WidgetListBox
float _contentX
 
float _contentY
 
float _contentZ
 
float _contentWidth
 
float _contentHeight
 
std::vector< WidgetListItem * > _items
 
std::vector< WidgetListItem * > _visibleItems
 
size_t _startItem
 
size_t _selectedItem
 
WidgetButton_up
 
WidgetButton_down
 
WidgetScrollbar_scrollbar
 
bool _locked
 
- Protected Attributes inherited from Engines::NWN::ModelWidget
Graphics::Aurora::Model_model
 
- 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...
 

Additional Inherited Members

- Public Types inherited from Engines::NWN::WidgetListBox
enum  Mode { kModeStatic = 0, kModeSelectable }
 

Detailed Description

Definition at line 40 of file gridbox.h.

Constructor & Destructor Documentation

◆ WidgetGridBox()

Engines::NWN::WidgetGridBox::WidgetGridBox ( ::Engines::GUI gui,
const Common::UString tag,
const Common::UString model,
float  innerHSpace = 0.0f,
float  InnerVSpace = 0.0f 
)

Definition at line 40 of file gridbox.cpp.

◆ ~WidgetGridBox()

Engines::NWN::WidgetGridBox::~WidgetGridBox ( )

Definition at line 46 of file gridbox.cpp.

Member Function Documentation

◆ mouseDown()

void Engines::NWN::WidgetGridBox::mouseDown ( uint8  state,
float  x,
float  y 
)
virtual

◆ scrollDown()

void Engines::NWN::WidgetGridBox::scrollDown ( size_t  n)
protectedvirtual

Reimplemented from Engines::NWN::WidgetListBox.

Definition at line 234 of file gridbox.cpp.

References Engines::NWN::WidgetListBox::_items, _itemsByRow, Engines::NWN::WidgetListBox::_startItem, Engines::NWN::WidgetListBox::_visibleItems, Engines::NWN::WidgetListBox::updateScrollbarPosition(), and updateVisible().

Referenced by mouseDown(), and subActive().

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

◆ scrollUp()

void Engines::NWN::WidgetGridBox::scrollUp ( size_t  n)
protectedvirtual

Reimplemented from Engines::NWN::WidgetListBox.

Definition at line 221 of file gridbox.cpp.

References _itemsByRow, Engines::NWN::WidgetListBox::_startItem, Engines::NWN::WidgetListBox::_visibleItems, Engines::NWN::WidgetListBox::updateScrollbarPosition(), and updateVisible().

Referenced by mouseDown(), and subActive().

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

◆ subActive()

void Engines::NWN::WidgetGridBox::subActive ( Widget widget)
virtual

◆ unlock()

void Engines::NWN::WidgetGridBox::unlock ( )

◆ updateScrollbarLength()

void Engines::NWN::WidgetGridBox::updateScrollbarLength ( )
protectedvirtual

Reimplemented from Engines::NWN::WidgetListBox.

Definition at line 171 of file gridbox.cpp.

References Engines::NWN::WidgetListBox::_items, _itemsByRow, Engines::NWN::WidgetListBox::_scrollbar, Engines::NWN::WidgetListBox::_visibleItems, and Engines::NWN::WidgetScrollbar::setLength().

Referenced by unlock().

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

◆ updateVisible()

void Engines::NWN::WidgetGridBox::updateVisible ( )
protectedvirtual

Member Data Documentation

◆ _innerHSpace

float Engines::NWN::WidgetGridBox::_innerHSpace
protected

Definition at line 59 of file gridbox.h.

Referenced by unlock(), and updateVisible().

◆ _innerVSpace

float Engines::NWN::WidgetGridBox::_innerVSpace
protected

Definition at line 60 of file gridbox.h.

Referenced by unlock(), and updateVisible().

◆ _itemsByRow

size_t Engines::NWN::WidgetGridBox::_itemsByRow
protected

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