VoltAir
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Groups Pages
Properties | List of all members
Toast Class Reference

Simple popup that fades in and out after a set duration. More...

Inheritance diagram for Toast:
UiComponent KeyNavFocusArea

Properties

Text textElement
 Reference to the Text element that is used by this Toast. More...
 
int duration
 How long, in seconds, the Toast is shown. More...
 
- Properties inherited from UiComponent
string showState
 State transitioned to when show() is called. More...
 
string hideState
 State transitioned to when hide() is called. More...
 
int showDuration
 Time, in milliseconds, that the UiComponent takes to show. More...
 
int hideDuration
 Time, in milliseconds, that the UiComponent takes to hide. More...
 
bool showing
 Whether or not the UiComponent is shown or is transitioning to the showState. More...
 
bool shouldGainFocus
 Whether or not the UiComponent should gain focus when shown. More...
 
Item returnFocusTo
 Item that the component returns focus to if this UiComponent gained focus previously. 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...
 

Additional Inherited Members

- Signals inherited from UiComponent
void showCompleted ()
 Emitted when the UiComponent has completely shown. More...
 
void hideCompleted ()
 Emitted when the UiComponent has completely hidden. 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...
 
- Public Member Functions inherited from UiComponent
void show (int time)
 Shows the UiComponent over time milliseconds. More...
 
void hide (int time)
 Hides the UiComponent over time milliseconds. More...
 

Detailed Description

Simple popup that fades in and out after a set duration.

Property Documentation

int Toast::duration

How long, in seconds, the Toast is shown.

Text Toast::textElement

Reference to the Text element that is used by this Toast.