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

#include <checkbox.h>

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

Public Member Functions

 WidgetCheckBox (GUI &gui, const Common::UString &tag)
 
 ~WidgetCheckBox ()
 
void load (const Aurora::GFF3Struct &gff)
 
void setState (bool state)
 
bool getState () const
 
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...
 
void setSelected (const Common::UString &selected)
 
void setUnselected (const Common::UString &unselected)
 
void setSelectedHighlighted (const Common::UString &selectedHighlighted)
 
void setUnselectedHighlighted (const Common::UString &unselectedHighlighted)
 
- 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 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 Member Functions

void setTextHighlighting (Graphics::Aurora::Highlightable *highlightable)
 
void setQuadHighlighting (Graphics::Aurora::Highlightable *highlightable)
 

Private Attributes

Common::UString _selected
 
Common::UString _unselected
 
Common::UString _selectedHighlighted
 
Common::UString _unselectedHighlighted
 
bool _state
 
Sound::ChannelHandle _sound
 
float _unselectedR
 
float _unselectedG
 
float _unselectedB
 
float _unselectedA
 

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 34 of file checkbox.h.

Constructor & Destructor Documentation

◆ WidgetCheckBox()

Engines::WidgetCheckBox::WidgetCheckBox ( GUI gui,
const Common::UString tag 
)

Definition at line 45 of file checkbox.cpp.

◆ ~WidgetCheckBox()

Engines::WidgetCheckBox::~WidgetCheckBox ( )

Definition at line 54 of file checkbox.cpp.

Member Function Documentation

◆ enter()

void Engines::WidgetCheckBox::enter ( )
virtual

◆ getState()

bool Engines::WidgetCheckBox::getState ( ) const

Definition at line 124 of file checkbox.cpp.

References _state.

Referenced by Engines::Jade::GUI::getCheckBoxState(), and Engines::KotOR::GUI::getCheckBoxState().

Here is the caller graph for this function:

◆ leave()

void Engines::WidgetCheckBox::leave ( )
virtual

◆ load()

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

◆ mouseUp()

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

A mouse button was released on the widget.

Reimplemented from Engines::Widget.

Definition at line 166 of file checkbox.cpp.

References _state, Engines::Widget::isDisabled(), Sound::kSoundTypeSFX, Engines::playSound(), Engines::Widget::setActive(), and setState().

Here is the call graph for this function:

◆ setQuadHighlighting()

void Engines::WidgetCheckBox::setQuadHighlighting ( Graphics::Aurora::Highlightable highlightable)
private

Definition at line 198 of file checkbox.cpp.

References Graphics::Aurora::Highlightable::setHighlightable(), and Graphics::Aurora::Highlightable::setHighlightLowerBound().

Referenced by load().

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

◆ setSelected()

void Engines::WidgetCheckBox::setSelected ( const Common::UString selected)

Definition at line 175 of file checkbox.cpp.

References _selected.

Referenced by Engines::KotOR::PartySelectionGUI::setSlotTexture().

Here is the caller graph for this function:

◆ setSelectedHighlighted()

void Engines::WidgetCheckBox::setSelectedHighlighted ( const Common::UString selectedHighlighted)

Definition at line 183 of file checkbox.cpp.

References _selectedHighlighted.

Referenced by Engines::KotOR::PartySelectionGUI::setSlotTexture().

Here is the caller graph for this function:

◆ setState()

void Engines::WidgetCheckBox::setState ( bool  state)

◆ setTextHighlighting()

void Engines::WidgetCheckBox::setTextHighlighting ( Graphics::Aurora::Highlightable highlightable)
private

◆ setUnselected()

void Engines::WidgetCheckBox::setUnselected ( const Common::UString unselected)

Definition at line 179 of file checkbox.cpp.

References _unselected.

Referenced by Engines::KotOR::PartySelectionGUI::setSlotTexture().

Here is the caller graph for this function:

◆ setUnselectedHighlighted()

void Engines::WidgetCheckBox::setUnselectedHighlighted ( const Common::UString unselectedHighlighted)

Definition at line 187 of file checkbox.cpp.

References _unselectedHighlighted.

Referenced by Engines::KotOR::PartySelectionGUI::setSlotTexture().

Here is the caller graph for this function:

Member Data Documentation

◆ _selected

Common::UString Engines::WidgetCheckBox::_selected
private

Definition at line 55 of file checkbox.h.

Referenced by load(), setSelected(), and setState().

◆ _selectedHighlighted

Common::UString Engines::WidgetCheckBox::_selectedHighlighted
private

Definition at line 56 of file checkbox.h.

Referenced by load(), setSelectedHighlighted(), and setState().

◆ _sound

Sound::ChannelHandle Engines::WidgetCheckBox::_sound
private

Definition at line 59 of file checkbox.h.

Referenced by enter(), and leave().

◆ _state

bool Engines::WidgetCheckBox::_state
private

Definition at line 57 of file checkbox.h.

Referenced by getState(), mouseUp(), and setState().

◆ _unselected

Common::UString Engines::WidgetCheckBox::_unselected
private

Definition at line 55 of file checkbox.h.

Referenced by load(), setState(), and setUnselected().

◆ _unselectedA

float Engines::WidgetCheckBox::_unselectedA
private

Definition at line 60 of file checkbox.h.

Referenced by enter(), and leave().

◆ _unselectedB

float Engines::WidgetCheckBox::_unselectedB
private

Definition at line 60 of file checkbox.h.

Referenced by enter(), and leave().

◆ _unselectedG

float Engines::WidgetCheckBox::_unselectedG
private

Definition at line 60 of file checkbox.h.

Referenced by enter(), and leave().

◆ _unselectedHighlighted

Common::UString Engines::WidgetCheckBox::_unselectedHighlighted
private

Definition at line 56 of file checkbox.h.

Referenced by load(), setState(), and setUnselectedHighlighted().

◆ _unselectedR

float Engines::WidgetCheckBox::_unselectedR
private

Definition at line 60 of file checkbox.h.

Referenced by enter(), and leave().


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