MenuCard Class Reference

A playing card shaped graphical button that fires an action when released. More...

Inheritance diagram for MenuCard:

Signals
void	actionFired ()
	Emitted when the MenuCard is released. More...
Signals inherited from KeyNavFocusArea
void	pressed ()
	Emitted when this area receives a button press. More...
void	released ()
	Emitted when this area receives a button release. More...
void	escaped ()
	Emitted when a back navigation event occurs. More...

Properties
bool	locked
	Whether or not the MenuCard will fire an action when released. More...
bool	hideTitleWhenLocked
	Whether or not the title is displayed when the MenuCard is locked. More...
string	backgroundImagePath
	Path to the background graphic. More...
string	titleText
	Optional title to display on the top of the MenuCard. More...
Properties inherited from KeyNavFocusArea
Item	focusUp
	Item to transfer focus to upon an "up" press. More...
Item	focusDown
	Item to transfer focus to upon an "down" press. More...
Item	focusLeft
	Item to transfer focus to upon an "left" press. More...
Item	focusRight
	Item to transfer focus to upon an "right" press. More...
bool	captureBackNavigation
	Whether or not the back button event is handled. More...
int	backNavigationMode
	Mode that determines what keys behave as back buttons. More...

Detailed Description

A playing card shaped graphical button that fires an action when released.

Note

A sound effect will play when the action fires.

Member Function Documentation

void MenuCard::actionFired ( )

signal

Emitted when the MenuCard is released.

Property Documentation

string MenuCard::backgroundImagePath

Path to the background graphic.

bool MenuCard::hideTitleWhenLocked

Whether or not the title is displayed when the MenuCard is locked.

bool MenuCard::locked

Whether or not the MenuCard will fire an action when released.

The MenuCard will be rendered in grayscale and have a padlock overlaying it when true.

string MenuCard::titleText

Optional title to display on the top of the MenuCard.