KeyNavFocusArea Class Reference

Item that handles focus navigation. More...

Inheritance diagram for KeyNavFocusArea:

Signals
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
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

Item that handles focus navigation.

This base class is used to deploy UI elements that are navigated by directional pad interfaces. It defines what Items gain focus when the user presses in a cardinal direction.

Member Function Documentation

void KeyNavFocusArea::escaped ( )

signal

Emitted when a back navigation event occurs.

void KeyNavFocusArea::pressed ( )

signal

Emitted when this area receives a button press.

void KeyNavFocusArea::released ( )

signal

Emitted when this area receives a button release.

Property Documentation

int KeyNavFocusArea::backNavigationMode

Mode that determines what keys behave as back buttons.

bool KeyNavFocusArea::captureBackNavigation

Whether or not the back button event is handled.

Item KeyNavFocusArea::focusDown

Item to transfer focus to upon an "down" press.

Item KeyNavFocusArea::focusLeft

Item to transfer focus to upon an "left" press.

Item KeyNavFocusArea::focusRight

Item to transfer focus to upon an "right" press.

Item KeyNavFocusArea::focusUp

Item to transfer focus to upon an "up" press.