Stark::StaticLocationWidget Class Reference

#include <locationscreen.h>

Inheritance diagram for Stark::StaticLocationWidget:

Public Member Functions
	StaticLocationWidget (const char *renderEntryName, WidgetOnClickCallback *onClickCallback, WidgetOnMouseMoveCallback *onMouseMoveCallback)
virtual void	render ()
virtual bool	isMouseInside (const Common::Point &mousePos) const
virtual void	onClick ()
virtual void	onMouseMove (const Common::Point &mousePos)
virtual void	onMouseUp ()
virtual void	onScreenChanged ()
void	setupSounds (int16 enterSound, int16 clickSound)
void	setTextColor (const Gfx::Color &textColor)
bool	isVisible () const
void	setVisible (bool visible)
void	onGameLoop ()
void	onMouseEnter ()
void	onMouseLeave ()

Protected Member Functions
Common::Point	getPosition () const

Protected Attributes
Gfx::RenderEntry *	_renderEntry

Detailed Description

User interface widget bound to a Location RenderEntry

Also used without bounding the RenderEntry, as a base class

Member Function Documentation

render()

virtual void Stark::StaticLocationWidget::render ( )

virtual

Draw the widget

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

isMouseInside()

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

virtual

Is the specified point inside the widget?

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

onClick()

virtual void Stark::StaticLocationWidget::onClick ( )

virtual

Called when the widget is clicked

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

onMouseMove()

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

virtual

Called when the mouse hovers the widget

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

onMouseUp()

virtual void Stark::StaticLocationWidget::onMouseUp ( )

inlinevirtual

Called when the mouse's left button just gets up

Reimplemented in Stark::VolumeWidget.

onScreenChanged()

virtual void Stark::StaticLocationWidget::onScreenChanged ( )

virtual

Called when the screen's resolution is changed

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

setupSounds()

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

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

setTextColor()

void Stark::StaticLocationWidget::setTextColor

(

const Gfx::Color &

textColor

)

Override the text color

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

isVisible()

bool Stark::StaticLocationWidget::isVisible

(

)

const

Widgets must be visible to be rendered and interactive

onGameLoop()

void Stark::StaticLocationWidget::onGameLoop

(

)

Per frame widget state update callback

onMouseEnter()

void Stark::StaticLocationWidget::onMouseEnter

(

)

Called when the mouse enters the widget

onMouseLeave()

void Stark::StaticLocationWidget::onMouseLeave

(

)

Called when the mouse leaves the widget

---

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

• engines/stark/ui/menu/locationscreen.h