FMX.ActnList.TCustomAction.IsDialogKey

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function IsDialogKey(const Key: Word; const Shift: TShiftState): Boolean;

C++

bool __fastcall IsDialogKey(const System::Word Key, const System::Classes::TShiftState Shift);

Properties

Type Visibility Source Unit Parent
function public
FMX.ActnList.pas
FMX.ActnList.hpp
FMX.ActnList TCustomAction

Description

Checks whether the specified keyboard key corresponds to one of the action's shortcuts.

IsDialogKey returns True if the keyboard key specified by the combination of Key and Shift corresponds to one of the action's shortcuts. Here:

  • Key is a keyboard scan code. You can find constants for keyboard scan codes in the Constants section of the System.UITypes unit. These are vkXXXX constants (vkEscape, vkReturn, vkF1, and others).
  • Shift specifies the combination of the ALT, CTRL, SHIFT, and CMD (only Mac) keys.
  • The action's shortcuts are listed in the ShortCut and SecondaryShortCuts properties.

See Also