Home > Language Reference > Classes > UIComponent

FiveWayNavigator Event

Event raised when the user presses one of the 5-way navigator keys.

Syntax

Public Event FiveWayNavigator(ByVal eButton As HbRocker, ByRef bForward As Boolean)

ParameterDescription
eButtonValue indicating which button is pressed.
bForwardIndicates whether the system should continue to process the event or not.

Remarks

The FiveWayNavigator event is raised when the user presses or helds down one of the 5-way navigator keys. If the device has no 5-way navigator, this event can also be raised when the user presses or helds down the page up and page down buttons. On some devices, the jog dial can also raise this event.

The eButton parameter specify which button was pressed, and can take one of the following values:

ConstantValueButton
hbRockerTop1Up (or page up on older devices)
hbRockerRight2Right
hbRockerBottom3Bottom (or page down on older devices)
hbRockerLeft4Left
hbRockerCenter5Center

The bForward parameter indicates whether the system should continue to process the event or not. By default, it is set to True. If you want to prevent the system from carrying out the default action, such as moving the blue focus ring, set this parameter to False before returning from your event handler.

If the device supports the blue ring feature and the NavState property is set to hbNavStateObject or hbNavStateInteraction, this event is raised by the control that is currently focused (or not raised at all if no control is focused). In all other cases, this event is raised by the form. This allows to write code that behaves properly on all devices.

For more information about supporting the 5-way navigator and the blue focus ring feature in your applications, please refer to the One handed navigation section in the Programmer's Guide.

System requirements

SystemMinimal versionRemarks
Palm OSPalm OS 3.0N/A