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

#include <protoitem.h>

Inheritance diagram for Engines::WidgetProtoItem:
Inheritance graph
[legend]
Collaboration diagram for Engines::WidgetProtoItem:
Collaboration graph
[legend]

Public Member Functions

 WidgetProtoItem (GUI &gui, const Common::UString &tag, WidgetListBox *parentList=0)
 
 ~WidgetProtoItem ()
 
virtual void setContents (const Common::UString &contents)
 Set item contents. More...
 
bool isHovered () const
 
virtual void load (const Aurora::GFF3Struct &gff)
 
void enter ()
 The mouse entered the widget. More...
 
void leave ()
 The mouse left the widget. More...
 
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...
 
void setDisableHighlight (bool disableHighlight)
 
void setSoundHover (const Common::UString &resRef)
 
void setSoundClick (const Common::UString &resRef)
 
- Public Member Functions inherited from Engines::KotORJadeWidget
 KotORJadeWidget (GUI &gui, const Common::UString &tag)
 
 ~KotORJadeWidget ()
 
void setClickable (bool clickable)
 Set the widget clickable, or not clickable. More...
 
void setScissor (int x, int y, int width, int height)
 Create a scissor test over this widget. More...
 
void setFill (const Common::UString &fill)
 
void setColor (float r, float g, float b, float a)
 
void setBorderColor (float r, float g, float b, float a)
 
void setWrapped (bool wrapped)
 
void setSubScene (Graphics::Aurora::SubSceneQuad *subscene)
 
float getBorderDimension () const
 
void setHighlight (const Common::UString &hilight)
 
void setHighlight (bool highlight)
 Set if the widget should be highlighted. More...
 
bool isHighlight ()
 If the widget is highlighted. More...
 
void createText (const Common::UString &font, const Common::UString &str)
 Initialize the text within this widget. More...
 
void setFont (const Common::UString &fnt)
 Change the font for this widget. More...
 
void setText (const Common::UString &text)
 
void setTextColor (float r, float g, float b, float a)
 
void setHorizontalTextAlign (float halign)
 
void setVerticalTextAlign (float valign)
 
float getTextHeight (const Common::UString &text) const
 
void setTag (const Common::UString &tag)
 Set the widget's tag. More...
 
virtual void show ()
 Show the widget. More...
 
virtual void hide ()
 Hide the widget. More...
 
virtual void setPosition (float x, float y, float z)
 Set the widget's position. More...
 
virtual void setRotation (float angle)
 Set the rotation of the widget in degrees. More...
 
virtual void setWidth (float width)
 Set the width of the widget. More...
 
virtual void setHeight (float height)
 Set the height of the widget. More...
 
float getWidth () const
 Get the widget's width. More...
 
float getHeight () const
 Get the widget's height. More...
 
virtual void setInvisible (bool invisible)
 Make the widget invisible. More...
 
- 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 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 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 Member Functions

void setDefaultHighlighting (Graphics::Aurora::Highlightable *highlightable)
 

Private Attributes

bool _disableHighlight
 
bool _hovered
 
WidgetListBox_parentList
 
Common::UString _soundHover
 
Common::UString _soundClick
 

Additional Inherited Members

- Protected Member Functions inherited from Engines::KotORJadeWidget
Graphics::Aurora::HighlightablegetTextHighlightableComponent () const
 
Graphics::Aurora::HighlightablegetQuadHighlightableComponent () const
 
Extend createExtend (const Aurora::GFF3Struct &gff)
 
Border createBorder (const Aurora::GFF3Struct &gff)
 
Text createText (const Aurora::GFF3Struct &gff)
 
Hilight createHilight (const Aurora::GFF3Struct &gff)
 
- 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::KotORJadeWidget
float _width
 
float _height
 
uint32 _borderDimension
 
float _r
 
float _g
 
float _b
 
float _a
 
float _unselectedR
 
float _unselectedG
 
float _unselectedB
 
float _unselectedA
 
bool _wrapped
 
Common::ScopedPtr< Graphics::Aurora::GUIQuad_quad
 
Common::ScopedPtr< Graphics::Aurora::GUIQuad_highlight
 
Common::ScopedPtr< Graphics::Aurora::HighlightableText_text
 
Common::ScopedPtr< Graphics::Aurora::BorderQuad_border
 
Graphics::Aurora::SubSceneQuad_subScene
 
bool _highlighted
 
- 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 33 of file protoitem.h.

Constructor & Destructor Documentation

◆ WidgetProtoItem()

Engines::WidgetProtoItem::WidgetProtoItem ( GUI gui,
const Common::UString tag,
WidgetListBox parentList = 0 
)

Definition at line 34 of file protoitem.cpp.

◆ ~WidgetProtoItem()

Engines::WidgetProtoItem::~WidgetProtoItem ( )

Definition at line 41 of file protoitem.cpp.

Member Function Documentation

◆ enter()

void Engines::WidgetProtoItem::enter ( )
virtual

The mouse entered the widget.

Reimplemented from Engines::Widget.

Definition at line 65 of file protoitem.cpp.

References _disableHighlight, _hovered, _soundHover, Common::UString::empty(), Sound::kSoundTypeSFX, Engines::playSound(), and Engines::KotORJadeWidget::setHighlight().

Here is the call graph for this function:

◆ isHovered()

bool Engines::WidgetProtoItem::isHovered ( ) const

Definition at line 49 of file protoitem.cpp.

References _hovered.

◆ leave()

void Engines::WidgetProtoItem::leave ( )
virtual

The mouse left the widget.

Reimplemented from Engines::Widget.

Definition at line 75 of file protoitem.cpp.

References _disableHighlight, _hovered, and Engines::KotORJadeWidget::setHighlight().

Here is the call graph for this function:

◆ load()

void Engines::WidgetProtoItem::load ( const Aurora::GFF3Struct gff)
virtual

Reimplemented from Engines::KotORJadeWidget.

Reimplemented in Engines::KotORInventoryItem.

Definition at line 53 of file protoitem.cpp.

References Engines::KotORJadeWidget::getQuadHighlightableComponent(), Engines::KotORJadeWidget::getTextHighlightableComponent(), Engines::KotORJadeWidget::load(), and setDefaultHighlighting().

Referenced by Engines::KotORInventoryItem::load().

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

◆ mouseUp()

void Engines::WidgetProtoItem::mouseUp ( uint8  state,
float  x,
float  y 
)
virtual

A mouse button was released on the widget.

Reimplemented from Engines::Widget.

Definition at line 82 of file protoitem.cpp.

References _soundClick, Common::UString::empty(), Sound::kSoundTypeSFX, Engines::playSound(), and Engines::Widget::setActive().

Here is the call graph for this function:

◆ mouseWheel()

void Engines::WidgetProtoItem::mouseWheel ( uint8  state,
int  x,
int  y 
)
virtual

A mouse wheel was used on the widget.

Reimplemented from Engines::Widget.

Definition at line 108 of file protoitem.cpp.

References _parentList, and Engines::WidgetListBox::mouseWheel().

Here is the call graph for this function:

◆ setContents()

void Engines::WidgetProtoItem::setContents ( const Common::UString contents)
virtual

Set item contents.

If not overriden this method will only change text.

Reimplemented in Engines::KotORInventoryItem.

Definition at line 44 of file protoitem.cpp.

References Engines::KotORJadeWidget::_text.

Referenced by Engines::WidgetListBox::refreshItemWidgets().

Here is the caller graph for this function:

◆ setDefaultHighlighting()

void Engines::WidgetProtoItem::setDefaultHighlighting ( Graphics::Aurora::Highlightable highlightable)
private

◆ setDisableHighlight()

void Engines::WidgetProtoItem::setDisableHighlight ( bool  disableHighlight)

Definition at line 89 of file protoitem.cpp.

References _disableHighlight.

Referenced by Engines::KotORInventoryItem::KotORInventoryItem().

Here is the caller graph for this function:

◆ setSoundClick()

void Engines::WidgetProtoItem::setSoundClick ( const Common::UString resRef)

Definition at line 97 of file protoitem.cpp.

References _soundClick.

◆ setSoundHover()

void Engines::WidgetProtoItem::setSoundHover ( const Common::UString resRef)

Definition at line 93 of file protoitem.cpp.

References _soundHover.

Member Data Documentation

◆ _disableHighlight

bool Engines::WidgetProtoItem::_disableHighlight
private

Definition at line 60 of file protoitem.h.

Referenced by enter(), leave(), and setDisableHighlight().

◆ _hovered

bool Engines::WidgetProtoItem::_hovered
private

Definition at line 61 of file protoitem.h.

Referenced by enter(), isHovered(), and leave().

◆ _parentList

WidgetListBox* Engines::WidgetProtoItem::_parentList
private

Definition at line 63 of file protoitem.h.

Referenced by mouseWheel().

◆ _soundClick

Common::UString Engines::WidgetProtoItem::_soundClick
private

Definition at line 66 of file protoitem.h.

Referenced by mouseUp(), and setSoundClick().

◆ _soundHover

Common::UString Engines::WidgetProtoItem::_soundHover
private

Definition at line 65 of file protoitem.h.

Referenced by enter(), and setSoundHover().


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