FocusNext

Forms, interaction, input

Description

Moves focus of a TPDFlibFormSession to the next or previous entry of the computed tab sequence

The sequence comes from GetTabSequence; when the focused Widget is not part of it, the step starts at the first entry, or at the last entry when moving backwards

Stepping past either end wraps around to the opposite end when WrapAround is set, otherwise the call returns 0 without changing focus

The resulting transition runs through FocusField and therefore follows the normal commit, /Bl and /Fo rules

Declaration

function FocusNext(Backwards: Boolean = False;
  WrapAround: Boolean = True; CommitCurrent: Boolean = True): Integer;

Parameters

BackwardsTrue moves toward the previous entry, False toward the next
WrapAroundTrue wraps at both sequence ends, False stops there
CommitCurrentTrue commits the active edit before the transition, False cancels it

Return value

Returns 1 when another entry received focus, otherwise 0 when the sequence is empty, wraparound is disabled at an end or the focus transition was rejected

See also

GetTabSequence, FocusField, FocusAt, Blur, DispatchInputEvent, TPDFlibFormSession