FMX.Forms.TCommonCustomForm.IsDialogKey

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure IsDialogKey(const Key: Word; const KeyChar: WideChar; const Shift: TShiftState;
var IsDialog: Boolean); virtual;

C++

virtual void __fastcall IsDialogKey(const System::Word Key, const System::WideChar KeyChar, const System::Classes::TShiftState Shift, bool &IsDialog);

Properties

Type Visibility Source Unit Parent
procedure
function
protected
FMX.Forms.pas
FMX.Forms.hpp
FMX.Forms TCommonCustomForm

Description

Determines whether the pressed key should be processed only by the control having the focus or by all children controls and menus of the form.

IsDialogKey is used internally in the KeyDown method.

IsDialog returns True, if KeyChar < ' ' or Shift identifies any of the CTRL, ALT, or CMD keys. That is, if the KeyChar and Shift combination identifies some control combination -- not a printable character. IsDialog returns False, if the Key and KeyChar combination identifies some printable character. The ' ' character has the $20 ASCII value. ASCII values less than $20 identify control combinations.

IsDialogKey has the following parameters:

  • Key is the scan code of the pressed keyboard key. This parameter is ignored.
  • KeyChar is the character code of the pressed key.
  • Shift indicates which shift keys--SHIFT, CTRL, ALT, and CMD (only for Mac)--were down when you press the key.
  • IsDialog is the return boolean parameter.

See also