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

User interface widget bound to a Location RenderEntry. More...

#include <locationscreen.h>

Inheritance diagram for Stark::StaticLocationWidget:
Collaboration diagram for Stark::StaticLocationWidget:

List of all members.

Public Member Functions

 StaticLocationWidget (const char *renderEntryName, WidgetOnClickCallback *onClickCallback, WidgetOnMouseMoveCallback *onMouseMoveCallback)
virtual ~StaticLocationWidget ()
virtual void render ()
 Draw the widget.
virtual bool isMouseInside (const Common::Point &mousePos) const
 Is the specified point inside the widget?
virtual void onClick ()
 Called when the widget is clicked.
virtual void onMouseMove (const Common::Point &mousePos)
 Called when the mouse hovers the widget.
virtual void onMouseUp ()
 Called when the mouse's left button just gets up.
virtual void onScreenChanged ()
 Called when the screen's resolution is changed.
void setupSounds (int16 enterSound, int16 clickSound)
 Lookup sounds in the static location for use when hovering / clicking the widget.
void setTextColor (const Color &textColor)
 Override the text color.
bool isVisible () const
 Widgets must be visible to be rendered and interactive.
void setVisible (bool visible)
void onGameLoop ()
 Per frame widget state update callback.
void onMouseEnter ()
 Called when the mouse enters the widget.
void onMouseLeave ()
 Called when the mouse leaves the widget.

Protected Member Functions

Common::Point getPosition () const

Protected Attributes

Gfx::RenderEntry_renderEntry

Private Attributes

Resources::ItemVisual_item
bool _visible
Resources::Sound_soundMouseEnter
Resources::Sound_soundMouseClick
WidgetOnClickCallback_onClick
WidgetOnMouseMoveCallback_onMouseMove

Detailed Description

User interface widget bound to a Location RenderEntry.

Also used without bounding the RenderEntry, as a base class

Definition at line 93 of file locationscreen.h.


Constructor & Destructor Documentation

Stark::StaticLocationWidget::StaticLocationWidget ( const char *  renderEntryName,
WidgetOnClickCallback onClickCallback,
WidgetOnMouseMoveCallback onMouseMoveCallback 
)

Definition at line 147 of file locationscreen.cpp.

Stark::StaticLocationWidget::~StaticLocationWidget (  )  [virtual]

Definition at line 264 of file locationscreen.cpp.


Member Function Documentation

Common::Point Stark::StaticLocationWidget::getPosition (  )  const [protected]

Definition at line 256 of file locationscreen.cpp.

bool Stark::StaticLocationWidget::isMouseInside ( const Common::Point mousePos  )  const [virtual]

Is the specified point inside the widget?

Reimplemented in Stark::DialogTitleWidget, Stark::SaveDataWidget, Stark::CheckboxWidget, and Stark::VolumeWidget.

Definition at line 184 of file locationscreen.cpp.

bool Stark::StaticLocationWidget::isVisible (  )  const

Widgets must be visible to be rendered and interactive.

Definition at line 176 of file locationscreen.cpp.

void Stark::StaticLocationWidget::onClick (  )  [virtual]

Called when the widget is clicked.

Reimplemented in Stark::DialogTitleWidget, Stark::SaveDataWidget, Stark::CheckboxWidget, and Stark::VolumeWidget.

Definition at line 191 of file locationscreen.cpp.

void Stark::StaticLocationWidget::onGameLoop (  ) 

Per frame widget state update callback.

Definition at line 204 of file locationscreen.cpp.

void Stark::StaticLocationWidget::onMouseEnter (  ) 

Called when the mouse enters the widget.

Definition at line 210 of file locationscreen.cpp.

void Stark::StaticLocationWidget::onMouseLeave (  ) 

Called when the mouse leaves the widget.

Definition at line 216 of file locationscreen.cpp.

void Stark::StaticLocationWidget::onMouseMove ( const Common::Point mousePos  )  [virtual]

Called when the mouse hovers the widget.

Reimplemented in Stark::DialogTitleWidget, Stark::SaveDataWidget, and Stark::VolumeWidget.

Definition at line 250 of file locationscreen.cpp.

virtual void Stark::StaticLocationWidget::onMouseUp (  )  [inline, virtual]

Called when the mouse's left button just gets up.

Reimplemented in Stark::VolumeWidget.

Definition at line 112 of file locationscreen.h.

void Stark::StaticLocationWidget::onScreenChanged (  )  [virtual]

Called when the screen's resolution is changed.

Reimplemented in Stark::DialogTitleWidget, and Stark::SaveDataWidget.

Definition at line 241 of file locationscreen.cpp.

void Stark::StaticLocationWidget::render (  )  [virtual]

Draw the widget.

Reimplemented in Stark::DialogTitleWidget, Stark::SaveDataWidget, Stark::CheckboxWidget, and Stark::VolumeWidget.

Definition at line 170 of file locationscreen.cpp.

void Stark::StaticLocationWidget::setTextColor ( const Color textColor  ) 

Override the text color.

Only applies for widget referring to a RenderEntry for a text visual

Definition at line 232 of file locationscreen.cpp.

void Stark::StaticLocationWidget::setupSounds ( int16  enterSound,
int16  clickSound 
)

Lookup sounds in the static location for use when hovering / clicking the widget.

Definition at line 222 of file locationscreen.cpp.

void Stark::StaticLocationWidget::setVisible ( bool  visible  ) 

Definition at line 180 of file locationscreen.cpp.


Member Data Documentation

Definition at line 146 of file locationscreen.h.


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


Generated on Sat Mar 16 2019 05:06:56 for ResidualVM by doxygen 1.7.1
curved edge   curved edge