TPDFlibFormInputEvent

Forms, interaction, data types

Description

Describes pointer, wheel, keyboard and composed-text input without depending on VCL, FMX, LCL, Win32 messages or another host toolkit Only fields relevant to

Kind are read by DispatchInputEvent

Declaration

type
  TPDFlibFormInputEventKind = (fiekPointerMove,
    fiekPointerDown, fiekPointerUp, fiekPointerDoubleClick,
    fiekPointerLeave, fiekPointerCancel, fiekWheel,
    fiekKeyDown, fiekKeyUp, fiekTextInput);

  TPDFlibFormInputModifier = (fimShift, fimControl,
    fimAlt, fimMeta);
  TPDFlibFormInputModifiers = set of TPDFlibFormInputModifier;

  TPDFlibFormInputButton = (fibNone, fibPrimary,
    fibSecondary, fibMiddle, fibX1, fibX2);

  TPDFlibFormInputKey = (fikNone, fikBackspace, fikTab,
    fikEnter, fikEscape, fikSpace, fikPageUp, fikPageDown,
    fikEnd, fikHome, fikLeft, fikUp, fikRight, fikDown,
    fikInsert, fikDelete, fikA, fikY, fikZ);

  TPDFlibFormInputEvent = record
    Kind: TPDFlibFormInputEventKind;
    Modifiers: TPDFlibFormInputModifiers;
    Button: TPDFlibFormInputButton;
    Key: TPDFlibFormInputKey;
    Page: Integer;
    X: Double;
    Y: Double;
    WheelDeltaX: Double;
    WheelDeltaY: Double;
    Text: WideString;
  end;

Fields

KindSelects the event and determines which remaining fields are consumed
ModifiersActive Shift, Control, Alt and platform Meta modifiers
ButtonPointer button for down and up events; PDF Widget activation uses fibPrimary
KeyNamed, platform-neutral key for key-down and key-up events
PageOne-based PDF page containing the pointer position
X, YFinite pointer position in rotated visual CropBox coordinates
WheelDeltaX, WheelDeltaYNormalised logical wheel steps, independent of a platform's native wheel constant
TextComposed UTF-16 text supplied by fiekTextInput

See also

DispatchInputEvent, TPDFlibFormInputResult, TPDFlibFormSession