ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Stark::Button Class Reference

#include <button.h>

Collaboration diagram for Stark::Button:

List of all members.

Public Types

enum  HintAlign { kAlignLeft, kAlignRight }

Public Member Functions

 Button (const Common::String &text, StaticProvider::UIElement stockElement, const Common::Point &pos, HintAlign align, const Common::Point &hintPos)
 ~Button ()
void setPosition (const Common::Point &pos)
void setUIElement (const StaticProvider::UIElement &stockElement)
void showButtonHint ()
 Set hint to render for one frame.
void render ()
bool containsPoint (const Common::Point &point)
void resetHintVisual ()
 Reset the hint text visual so it is rebuilt with the appropriate texture size.
void goToAnimStatement (int animScriptItemIndex)
 Move execution of the button's icon anim script to the specified item.
void startImageExplosion (VisualImageXMG *image)
 Start overlaying an explosion animation of an image on top of the button.
void stopImageExplosion ()
 Remove the currently playing exploding image animation, if any.
void startImageFlashing (VisualImageXMG *image)
 Start a flash animation of an image button.
void stopImageFlashing ()
 Remove the currently playing flash image animation, if any.

Private Attributes

StaticProvider::UIElement _stockElement
Common::Point _position
Common::Point _hintPosition
Common::String _text
VisualText_mouseText
VisualExplodingImage_explodingImageAnimation
VisualFlashingImage_flashingImageAnimation
const HintAlign _align
bool _renderHint

Detailed Description

Definition at line 43 of file button.h.


Member Enumeration Documentation

Enumerator:
kAlignLeft 
kAlignRight 

Definition at line 45 of file button.h.


Constructor & Destructor Documentation

Stark::Button::Button ( const Common::String text,
StaticProvider::UIElement  stockElement,
const Common::Point pos,
HintAlign  align,
const Common::Point hintPos 
)

Definition at line 36 of file button.cpp.

Stark::Button::~Button (  ) 

Definition at line 48 of file button.cpp.


Member Function Documentation

bool Stark::Button::containsPoint ( const Common::Point point  ) 

Definition at line 76 of file button.cpp.

void Stark::Button::goToAnimStatement ( int  animScriptItemIndex  ) 

Move execution of the button's icon anim script to the specified item.

Definition at line 103 of file button.cpp.

void Stark::Button::render (  ) 

Definition at line 54 of file button.cpp.

void Stark::Button::resetHintVisual (  ) 

Reset the hint text visual so it is rebuilt with the appropriate texture size.

Definition at line 98 of file button.cpp.

void Stark::Button::setPosition ( const Common::Point pos  )  [inline]

Definition at line 50 of file button.h.

void Stark::Button::setUIElement ( const StaticProvider::UIElement stockElement  )  [inline]

Definition at line 51 of file button.h.

void Stark::Button::showButtonHint (  ) 

Set hint to render for one frame.

Definition at line 87 of file button.cpp.

void Stark::Button::startImageExplosion ( VisualImageXMG image  ) 

Start overlaying an explosion animation of an image on top of the button.

Definition at line 107 of file button.cpp.

void Stark::Button::startImageFlashing ( VisualImageXMG image  ) 

Start a flash animation of an image button.

Definition at line 120 of file button.cpp.

void Stark::Button::stopImageExplosion (  ) 

Remove the currently playing exploding image animation, if any.

Definition at line 115 of file button.cpp.

void Stark::Button::stopImageFlashing (  ) 

Remove the currently playing flash image animation, if any.

Definition at line 128 of file button.cpp.


Member Data Documentation

Definition at line 84 of file button.h.

Definition at line 79 of file button.h.

Definition at line 81 of file button.h.

Definition at line 78 of file button.h.

Definition at line 85 of file button.h.

Definition at line 77 of file button.h.

Definition at line 80 of file button.h.


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


Generated on Sat Jan 12 2019 05:05:12 for ResidualVM by doxygen 1.7.1
curved edge   curved edge