Show: Delphi C++
Display Preferences

System.UITypes

From RAD Studio API Documentation
Jump to: navigation, search


Among other things, the UITypes unit defines Virtual Keys providing symbolic constants for scan codes of keyboard keys.

Package rtl240.bpl

Routines

IsAbortResultChecks whether the AModalResult parameter indicates that the user has selected Abort or Cancel.
IsAnAllResultChecks whether the AModalResult parameter indicates that the user has selected All, Yes to All, or No to All.
IsNegativeResultChecks whether the AModalResult parameter indicates that the user has selected No or No to All.
IsPositiveResultChecks whether the AModalResult parameter indicates that the user has selected Ok, Yes, Yes to All, or All.
StripAllFromResultConverts AModalResult from a value that refers to "all" to the corresponding simple value.

Types

PAlphaColorPAlphaColor is a pointer to TAlphaColor.
PAlphaColorF
PAlphaColorRecPAlphaColorRec is a pointer to TAlphaColorRec.
PColor
PColorRec
System_Uitypes
TAlphaColorTAlphaColor is used to specify alpha colors.
TAlphaColorFTAlphaColorF is a color type that treats each R, G, B, and A component as floats.
TAlphaColorRecTAlphaColorRec provides access to the color channels record.
TAlphaColors
TAnchorKindTAnchorKind specifies how a control is anchored to its parent.
TAnchors
TBorderIcon
TBorderIcons
TCalDayOfWeekDefines one of the days in a week.
TCloseAction
TColorTColor is used to specify the color of a control.
TColorRecTColorRec provides access to the color channels record.
TColorRef
TColors
TCursor
TDialogType
TDragKind
TDragMode
TDragState
TEditCharCaseEnumerates the character case for text.
TFontCharsetTFontCharset represents the character set of a font.
TFontDataName
TFontNameString that holds the typeface name of a font.
TFontPitchType of font pitch.
TFontQuality
TFontStyleTFontStyle and TFontStyles specify the style characteristics of a font.
TFontStylesTFontStyle and TFontStyles specify the style characteristics of a font.
TFontStylesBase
TImageIndexTImageIndex is an alias for the Integer type.
TModalResultDetermines whether and how a modal form is closed.
TMouseActivate
TMouseButton
TMsgDlgBtnRepresents a dialog box button.
TMsgDlgButtonsDelphi set of dialog box buttons.
TMsgDlgTypeType of dialog box, which usually affects its appearance.
TOpenOption
TOpenOptionExSets one extended open option, ofExNoPlacesBar, for a file open dialog box.
TOpenOptionsTOpenOption and TOpenOptions determine the behavior of a file selection dialog such as FMX.Dialogs.TOpenDialog.
TOpenOptionsEx
TPageMeasureUnits
TPageSetupDialogOptionSpecifies options for the FMX.Printer.TPageSetupDialog component.
TPageSetupDialogOptionsThe System.UITypes.TPageSetupDialogOptions type is a set of System.UITypes.TPageSetupDialogOption values.
TPageType
TPrintDialogOptionSpecifies options for the FMX.Printer.TPrintDialog component.
TPrintDialogOptionsThe System.UITypes.TPrintDialogOptions type is a set of System.UITypes.TPrintDialogOption values.
TPrinterCapabilities
TPrinterCapability
TPrinterKind
TPrinterOrientation
TPrinterState
TPrintRange
TScrollCode
TScrollStyle
TTabOrder
TTouchTrackingDefines the touch tracking directions.
TWindowStateTWindowState indicates whether a form is maximized, minimized, or normally sized.

Constants

cgiFirstcgiFirst: Integer = $FFFFFE00;
cgiLastcgiLast: Integer = $FFFFFFFF;
crAppStartcrAppStart: TCursor = $FFFFFFED;
crArrowcrArrow: TCursor = $FFFFFFFE;
crCrosscrCross: TCursor = $FFFFFFFD;
crDefaultcrDefault: TCursor = 0;
crDragcrDrag: TCursor = $FFFFFFF4;
crHandPointcrHandPoint: TCursor = $FFFFFFEB;
crHelpcrHelp: TCursor = $FFFFFFEC;
crHourGlasscrHourGlass: TCursor = $FFFFFFF5;
crHSplitcrHSplit: TCursor = $FFFFFFF2;
crIBeamcrIBeam: TCursor = $FFFFFFFC;
crMultiDragcrMultiDrag: TCursor = $FFFFFFF0;
crNocrNo: TCursor = $FFFFFFEE;
crNoDropcrNoDrop: TCursor = $FFFFFFF3;
crNonecrNone: TCursor = $FFFFFFFF;
crSizecrSize: TCursor = $FFFFFFEA;
crSizeAllcrSizeAll: TCursor = $FFFFFFEA;
crSizeNESWcrSizeNESW: TCursor = $FFFFFFFA;
crSizeNScrSizeNS: TCursor = $FFFFFFF9;
crSizeNWSEcrSizeNWSE: TCursor = $FFFFFFF8;
crSizeWEcrSizeWE: TCursor = $FFFFFFF7;
crSQLWaitcrSQLWait: TCursor = $FFFFFFEF;
crUpArrowcrUpArrow: TCursor = $FFFFFFF6;
crVSplitcrVSplit: TCursor = $FFFFFFF1;
idAbortidAbort: Integer = 3;
idCancelidCancel: Integer = 2;
idCloseidClose: Integer = 8;
idContinueidContinue: Integer = $B;
idHelpidHelp: Integer = 9;
idIgnoreidIgnore: Integer = 5;
idNoidNo: Integer = 7;
idOKidOK: Integer = 1;
idRetryidRetry: Integer = 4;
idTryAgainidTryAgain: Integer = $A;
idYesidYes: Integer = 6;
igiBeginigiBegin: Integer = $101;
igiDoubleTapigiDoubleTap: Integer = $109;
igiEndigiEnd: Integer = $102;
igiFirstigiFirst: Integer = $100;
igiLastigiLast: Integer = $1FF;
igiLongTapigiLongTap: Integer = $108;
igiPanigiPan: Integer = $104;
igiPressAndTapigiPressAndTap: Integer = $107;
igiRotateigiRotate: Integer = $105;
igiTwoFingerTapigiTwoFingerTap: Integer = $106;
igiZoomigiZoom: Integer = $103;
LF_FACESIZELF_FACESIZE: Integer = $20;
mrAbortmrAbort: Integer = 3;
mrAllmrAll: Integer = $C;
mrCancelmrCancel: Integer = 2;
mrClosemrClose: Integer = 8;
mrContinuemrContinue: Integer = $B;
mrHelpmrHelp: Integer = 9;
mrIgnoremrIgnore: Integer = 5;
mrNomrNo: Integer = 7;
mrNonemrNone: Integer = 0;
mrNoToAllmrNoToAll: Integer = $D;
mrOkmrOk: Integer = 1;
mrRetrymrRetry: Integer = 4;
mrTryAgainmrTryAgain: Integer = $A;
mrYesmrYes: Integer = 6;
mrYesToAllmrYesToAll: Integer = $E;
rgiFirstrgiFirst: Integer = $FFFFFC00;
rgiLastrgiLast: Integer = $FFFFFDFF;
sgiChecksgiCheck: Integer = $18;
sgiChevronDownsgiChevronDown: Integer = $20;
sgiChevronLeftsgiChevronLeft: Integer = $21;
sgiChevronRightsgiChevronRight: Integer = $22;
sgiChevronUpsgiChevronUp: Integer = $1F;
sgiCirclesgiCircle: Integer = $1B;
sgiCurlicuesgiCurlicue: Integer = $19;
sgiDoubleCirclesgiDoubleCircle: Integer = $1C;
sgiDoubleCurlicuesgiDoubleCurlicue: Integer = $1A;
sgiDownsgiDown: Integer = 4;
sgiDownLeftsgiDownLeft: Integer = 7;
sgiDownLeftLongsgiDownLeftLong: Integer = $13;
sgiDownRightsgiDownRight: Integer = 8;
sgiDownRightLongsgiDownRightLong: Integer = $14;
sgiDownUpsgiDownUp: Integer = $E;
sgiFirstsgiFirst: Integer = 1;
sgiLastsgiLast: Integer = $22;
sgiLeftsgiLeft: Integer = 1;
sgiLeftDownsgiLeftDown: Integer = $A;
sgiLeftRightsgiLeftRight: Integer = $F;
sgiLeftUpsgiLeftUp: Integer = 9;
sgiNoGesturesgiNoGesture: Integer = 0;
sgiRightsgiRight: Integer = 2;
sgiRightDownsgiRightDown: Integer = $C;
sgiRightLeftsgiRightLeft: Integer = $10;
sgiRightUpsgiRightUp: Integer = $B;
sgiScratchoutsgiScratchout: Integer = $15;
sgiSemiCircleLeftsgiSemiCircleLeft: Integer = $1D;
sgiSemiCircleRightsgiSemiCircleRight: Integer = $1E;
sgiSquaresgiSquare: Integer = $17;
sgiTrianglesgiTriangle: Integer = $16;
sgiUpsgiUp: Integer = 3;
sgiUpDownsgiUpDown: Integer = $D;
sgiUpLeftsgiUpLeft: Integer = 5;
sgiUpLeftLongsgiUpLeftLong: Integer = $11;
sgiUpRightsgiUpRight: Integer = 6;
sgiUpRightLongsgiUpRightLong: Integer = $12;
vk0vk0: Integer = $30;
vk1vk1: Integer = $31;
vk2vk2: Integer = $32;
vk3vk3: Integer = $33;
vk4vk4: Integer = $34;
vk5vk5: Integer = $35;
vk6vk6: Integer = $36;
vk7vk7: Integer = $37;
vk8vk8: Integer = $38;
vk9vk9: Integer = $39;
vkAvkA: Integer = $41;
vkAcceptvkAccept: Integer = $1E;
vkAddvkAdd: Integer = $6B;
vkAppsvkApps: Integer = $5D;
vkAttnvkAttn: Integer = $F6;
vkBvkB: Integer = $42;
vkBackvkBack: Integer = 8;
vkBackslashvkBackslash: Integer = $DC;
vkBrowserBackvkBrowserBack: Integer = $A6;
vkBrowserFavoritesvkBrowserFavorites: Integer = $AB;
vkBrowserForwardvkBrowserForward: Integer = $A7;
vkBrowserHomevkBrowserHome: Integer = $AC;
vkBrowserRefreshvkBrowserRefresh: Integer = $A8;
vkBrowserSearchvkBrowserSearch: Integer = $AA;
vkBrowserStopvkBrowserStop: Integer = $A9;
vkCvkC: Integer = $43;
vkCameravkCamera: Integer = $88;
vkCancelvkCancel: Integer = 3;
vkCapitalvkCapital: Integer = $14;
vkClearvkClear: Integer = $C;
vkCommavkComma: Integer = $BC;
vkControlvkControl: Integer = $11;
vkConvertvkConvert: Integer = $1C;
vkCrselvkCrsel: Integer = $F7;
vkDvkD: Integer = $44;
vkDecimalvkDecimal: Integer = $6E;
vkDeletevkDelete: Integer = $2E;
vkDividevkDivide: Integer = $6F;
vkDownvkDown: Integer = $28;
vkEvkE: Integer = $45;
vkEndvkEnd: Integer = $23;
vkEqualvkEqual: Integer = $BB;
vkErEofvkErEof: Integer = $F9;
vkEscapevkEscape: Integer = $1B;
vkExecutevkExecute: Integer = $2B;
vkExselvkExsel: Integer = $F8;
vkFvkF: Integer = $46;
vkF1vkF1: Integer = $70;
vkF10vkF10: Integer = $79;
vkF11vkF11: Integer = $7A;
vkF12vkF12: Integer = $7B;
vkF13vkF13: Integer = $7C;
vkF14vkF14: Integer = $7D;
vkF15vkF15: Integer = $7E;
vkF16vkF16: Integer = $7F;
vkF17vkF17: Integer = $80;
vkF18vkF18: Integer = $81;
vkF19vkF19: Integer = $82;
vkF2vkF2: Integer = $71;
vkF20vkF20: Integer = $83;
vkF21vkF21: Integer = $84;
vkF22vkF22: Integer = $85;
vkF23vkF23: Integer = $86;
vkF24vkF24: Integer = $87;
vkF3vkF3: Integer = $72;
vkF4vkF4: Integer = $73;
vkF5vkF5: Integer = $74;
vkF6vkF6: Integer = $75;
vkF7vkF7: Integer = $76;
vkF8vkF8: Integer = $77;
vkF9vkF9: Integer = $78;
vkFinalvkFinal: Integer = $18;
vkGvkG: Integer = $47;
vkHvkH: Integer = $48;
vkHangulvkHangul: Integer = $15;
vkHanjavkHanja: Integer = $19;
vkHardwareBackvkHardwareBack: Integer = $89;
vkHelpvkHelp: Integer = $2F;
vkHomevkHome: Integer = $24;
vkIvkI: Integer = $49;
vkIco00vkIco00: Integer = $E4;
vkIcoClearvkIcoClear: Integer = $E6;
vkIcoHelpvkIcoHelp: Integer = $E3;
vkInsertvkInsert: Integer = $2D;
vkJvkJ: Integer = $4A;
vkJunjavkJunja: Integer = $17;
vkKvkK: Integer = $4B;
vkKanavkKana: Integer = $15;
vkKanjivkKanji: Integer = $19;
vkLvkL: Integer = $4C;
vkLaunchApp1vkLaunchApp1: Integer = $B6;
vkLaunchApp2vkLaunchApp2: Integer = $B7;
vkLaunchMailvkLaunchMail: Integer = $B4;
vkLaunchMediaSelectvkLaunchMediaSelect: Integer = $B5;
vkLButtonvkLButton: Integer = 1;
vkLControlvkLControl: Integer = $A2;
vkLeftvkLeft: Integer = $25;
vkLeftBracketvkLeftBracket: Integer = $DB;
vkLineFeedvkLineFeed: Integer = $A;
vkLMenuvkLMenu: Integer = $A4;
vkLShiftvkLShift: Integer = $A0;
vkLWinvkLWin: Integer = $5B;
vkMvkM: Integer = $4D;
vkMButtonvkMButton: Integer = 4;
vkMediaNextTrackvkMediaNextTrack: Integer = $B0;
vkMediaPlayPausevkMediaPlayPause: Integer = $B3;
vkMediaPrevTrackvkMediaPrevTrack: Integer = $B1;
vkMediaStopvkMediaStop: Integer = $B2;
vkMenuvkMenu: Integer = $12;
vkMinusvkMinus: Integer = $BD;
vkModeChangevkModeChange: Integer = $1F;
vkMultiplyvkMultiply: Integer = $6A;
vkNvkN: Integer = $4E;
vkNextvkNext: Integer = $22;
vkNonamevkNoname: Integer = $FC;
vkNonConvertvkNonConvert: Integer = $1D;
vkNonevkNone: Integer = $FF;
vkNumLockvkNumLock: Integer = $90;
vkNumpad0vkNumpad0: Integer = $60;
vkNumpad1vkNumpad1: Integer = $61;
vkNumpad2vkNumpad2: Integer = $62;
vkNumpad3vkNumpad3: Integer = $63;
vkNumpad4vkNumpad4: Integer = $64;
vkNumpad5vkNumpad5: Integer = $65;
vkNumpad6vkNumpad6: Integer = $66;
vkNumpad7vkNumpad7: Integer = $67;
vkNumpad8vkNumpad8: Integer = $68;
vkNumpad9vkNumpad9: Integer = $69;
vkOvkO: Integer = $4F;
vkOem102vkOem102: Integer = $E2;
vkOemClearvkOemClear: Integer = $FE;
vkPvkP: Integer = $50;
vkPA1vkPA1: Integer = $FD;
vkPacketvkPacket: Integer = $E7;
vkParavkPara: Integer = $DF;
vkPausevkPause: Integer = $13;
vkPeriodvkPeriod: Integer = $BE;
vkPlayvkPlay: Integer = $FA;
vkPrintvkPrint: Integer = $2A;
vkPriorvkPrior: Integer = $21;
vkProcessKeyvkProcessKey: Integer = $E5;
vkQvkQ: Integer = $51;
vkQuotevkQuote: Integer = $DE;
vkRvkR: Integer = $52;
vkRButtonvkRButton: Integer = 2;
vkRControlvkRControl: Integer = $A3;
vkReturnvkReturn: Integer = $D;
vkRightvkRight: Integer = $27;
vkRightBracketvkRightBracket: Integer = $DD;
vkRMenuvkRMenu: Integer = $A5;
vkRShiftvkRShift: Integer = $A1;
vkRWinvkRWin: Integer = $5C;
vkSvkS: Integer = $53;
vkScrollvkScroll: Integer = $91;
vkSelectvkSelect: Integer = $29;
vkSemicolonvkSemicolon: Integer = $BA;
vkSeparatorvkSeparator: Integer = $6C;
vkShiftvkShift: Integer = $10;
vkSlashvkSlash: Integer = $BF;
vkSleepvkSleep: Integer = $5F;
vkSnapshotvkSnapshot: Integer = $2C;
vkSpacevkSpace: Integer = $20;
vkSubtractvkSubtract: Integer = $6D;
vkTvkT: Integer = $54;
vkTabvkTab: Integer = 9;
vkTildevkTilde: Integer = $C0;
vkUvkU: Integer = $55;
vkUpvkUp: Integer = $26;
vkVvkV: Integer = $56;
vkVolumeDownvkVolumeDown: Integer = $AE;
vkVolumeMutevkVolumeMute: Integer = $AD;
vkVolumeUpvkVolumeUp: Integer = $AF;
vkWvkW: Integer = $57;
vkXvkX: Integer = $58;
vkXButton1vkXButton1: Integer = 5;
vkXButton2vkXButton2: Integer = 6;
vkYvkY: Integer = $59;
vkZvkZ: Integer = $5A;
vkZoomvkZoom: Integer = $FB;


Virtual Keys

Virtual keys provide a symbolic representation of keyboard keys pressed by the user. Virtual keys are used in methods like FMX.Forms.TCommonCustomForm.KeyDown.

Virtual key constants define scan codes of keys on PC keyboards. Mac keyboards have different scan codes for some keys. FireMonkey converts Mac scan codes to be equal to the virtual key constants defined in this table.

Virtual Key Code Keyboard Key

vkLButton

Left mouse button

vkRButton

Right mouse button

vkCancel

CONTROL+BREAK processing

vkMButton

Middle mouse button (three-button mouse)

vkXButton1

Left lateral mouse button

vkXButton2

Right lateral mouse button

vkBack

BACKSPACE key

vkTab

TAB key

vkLineFeed

New line $0A

vkClear

CLEAR key

vkReturn

ENTER key. On Mac keyboard the numeric keypad's ENTER key has different scan code, but FireMonkey converts it to this vkReturn constant value.

vkShift

SHIFT key

vkControl

CTRL key

vkMenu

ALT key

vkPause

PAUSE key

vkCapital

CAPS LOCK key

vkKana

Input Method Editor (IME) Kana mode

vkHagul

IME Hangul mode

vkJunja

IME Junja mode

vkFinal

IME Final mode

vkHanja

IME Hanja mode

vkHardwareBack

On Android devices. BACK key--a button that will take the user back to the previous state.

vkKanji

IME Kanji mode

vkConvert

IME convert

vkNonConvert

IME nonconvert

vkAccept

IME accept

vkModeChange

Used with IME

vkEscape

ESC key

vkSpace

SPACEBAR key

vkPrior

PAGE UP key

vkNext

PAGE DOWN key

vkEnd

END key

vkHome

HOME key

vkLeft

LEFT ARROW key

vkUp

UP ARROW key

vkRight

RIGHT ARROW key

vkDown

DOWN ARROW key

vkSelect

SELECT key

vkPrint

PRINT key (keyboard-specific)

vkExecute

EXECUTE key

vkSnapshot

PRINT SCREEN key

vkInsert

INSERT key

vkDelete

DELETE key

vkHelp

HELP key

vk0

0 key

vk1

1 key

vk2

2 key

vk3

3 key

vk4

4 key

vk5

5 key

vk6

6 key

vk7

7 key

vk8

8 key

vk9

9 key

vkA

A key

vkB

B key

vkC

C key

vkD

D key

vkE

E key

vkF

F key

vkG

G key

vkH

H key

vkI

I key

vkJ

J key

vkK

K key

vkL

L key

vkM

M key

vkN

N key

vkO

O key

vkP

P key

vkR

R key

vkS

S key

vkT

T key

vkU

U key

vkV

V key

vkW

W key

vkX

X key

vkY

Y key

vkZ

Z key

vkLWin

Left Windows key (Microsoft keyboard)

vkRWin

Right Windows key (Microsoft keyboard)

vkApps

Applications key (Microsoft keyboard)

vkSleep

Computer Sleep key

vkNumpad0

0 key (numeric keypad)

vkNumpad1

1 key (numeric keypad)

vkNumpad2

2 key (numeric keypad)

vkNumpad3

3 key (numeric keypad)

vkNumpad4

4 key (numeric keypad)

vkNumpad5

5 key (numeric keypad)

vkNumpad6

6 key (numeric keypad)

vkNumpad7

7 key (numeric keypad)

vkNumpad8

8 key (numeric keypad)

vkNumpad9

9 key (numeric keypad)

vkMultiply

Multiply key (numeric keypad)

vkAdd

Add key (numeric keypad)

vkSeparator

Separator key (numeric keypad)

vkSubtract

Subtract key (numeric keypad)

vkDecimal

Decimal key (numeric keypad)

vkDivide

Divide key (numeric keypad)

vkF1

F1 key

vkF2

F2 key

vkF3

F3 key

vkF4

F4 key

vkF5

F5 key

vkF6

F6 key

vkF7

F7 key

vkF8

F8 key

vkF9

F9 key

vkF10

F10 key

vkF11

F11 key

vkF12

F12 key

vkF13

F13 key

vkF14

F14 key

vkF15

F15 key

vkF16

F16 key

vkF17

F17 key

vkF18

F18 key

vkF19

F19 key

vkF20

F20 key

vkF21

F21 key

vkF22

F22 key

vkF23

F23 key

vkF24

F24 key

vkNumLock

Num Lock key

vkScroll

Scroll Lock key

vkLShift

Left Shift key

vkRShift

Right Shift key

vkLControl

Left CONTROL key

vkRControl

Right CONTROL key

vkLMenu

Left ALT key

vkRMenu

Right Alt key

vkBrowserBack

Browser Back key

vkBrowserForward

Browser Forward key. On Mac keyboards this is the $ key

vkBrowserRefresh

Browser Refresh key

vkBrowserStop

Browser Stop key

vkBrowserSearch

Browser Search key

vkBrowserFavorites

Browser Favorites key

vkBrowserHome

Browser Start and Home key

vkVolumeMute

Volume Mute key

vkVolumeDown

Volume Down key

vkVolumeUp

Volume Up key

vkMediaNextTrack

Next Track key

vkMediaPrevTrack

Previous Track key

vkMediaStop

Stop Media key

vkMediaPlayPause

Play/Pause Media key

vkLaunchMail

Start Mail key

vkLaunchMediaSelect

Select Media key

vkLaunchApp1

Start Application1 key

vkLaunchApp2

Start Application2 key

vkSemicolon

Semicolon key (;)

vkEqual

Equal key =

vkComma

Comma key (,)

vkMinus

Minus key (-)

vlPeriod

Period key (.)

vkSlash

Slash key (/)

vkTilde

Tilde key (~)

vkLeftBracket

Left bracket key (()

vkBackSlash

Back slash key \ right-side positioned on keyboards.
Notice the difference from vkOem102, which implementation depends on a keyboard manufacturer. On Microsoft keyboards, vkOem102 corresponds to the back slash \ key left-side positioned on keyboards.

vkRightBracket

Right bracket key ())

vkQuote

Quote key (")

vkProcessKey

IME PROCESS key

vkPacket

Used to pass Unicode characters as if they were keystrokes. The vkPacket key is the low word of a 32-bit Virtual Key value used for non-keyboard input methods. (Windows 2000/XP)

vkAttn

Attn key

vkCrsel

CrSel key

vkExsel

ExSel key

vkErEof

Erase EOF key

vkPlay

Play key

vkZoom

Zoom key

vkNoname

Reserved for future use

vkPA1

PA1 key

vkOemClear

Clear key

vkOem102

Depends on a keyboard manufacturer.
On Japanese Mac keyboards, vkOem102 corresponds to the yen sign (¥) key.
On Microsoft keyboards, vkOem102 corresponds to the back slash \ key left-side positioned on the keyboard. Notice the difference from vkBackSlash that corresponds to the back slash \ key right-side positioned on the keyboard.

vkNone

Depends on a keyboard manufacturer.
On Japanese Mac keyboards, vkNone is the underscore key to the left of the right-side SHIFT key.
vkNone is not usually represented on other keyboards.

Personal tools
In Other Languages
Previous Versions
Assistance