diff --git a/docs/xml/lcl/lclproc.xml b/docs/xml/lcl/lclproc.xml index 75552aa0a5..07ae051b1c 100644 --- a/docs/xml/lcl/lclproc.xml +++ b/docs/xml/lcl/lclproc.xml @@ -415,22 +415,71 @@ key code. -Returns the textual representation for a shortcut value. - - + +Returns the localized textual representation for a shortcut value. + + +

+ShortCutToText is the counterpart to the TextToShortCut routine, and +converts the numeric TShortCut value in ShortCut its textual representation. +

+

+ShortCut is the Word value with the modifier keys and the +key code OR'd together. The high-order byte contains the Shift/Ctrl/Alt/Meta +modifier(s) for the shortcut. The low-order-byte contains the virtual key code +for the shortcut. +

+

+The return value contains localized versions of text for the modifiers and +the key cap used in the shortcut. For example: +

+ +Ctrl+V +Ctrl+Alt+Del +^V +Shift+F9 +Alt+G +Meta+Q + +

+Use ShortCutToTextRaw to get the text for a shortcut without localization. +

+
+ + + +TShortCut +
-Localized text value for the specified shortcut. + +Localized text value for the specified shortcut. + - + +TShortCut instance with the numeric shift modifier and key code handled in the +routine. + Converts a shortcut value to its text representation without localization. - + +

+ShortCutToTextRaw is similar to ShortCutToText, but does not use +localization for the modifiers or key caps found in the shortcut. +

+

+See ShortCutToText for more information. +

+

+Use TextToShortCutRaw to create a shortcut for text which does not +use localization. +

+
@@ -442,35 +491,145 @@ Converts a shortcut value to its text representation without localization. -Converts the textual representation for a shortcut into a shortcut value. +Converts the textual representation for a shortcut to its TShortCut value. - - + +

+TextToShortCut is a TShortcut function used to convert +the string representation for a shortcut (or accelerator) to a TShortCut +instance. +

+

+ShortCutText contains the text which represents a key or a key +combination used as a shortcut in an application. It can contain optional key +modifier(s) as well as a key caption. For example: +

+ +Ctrl+V +Ctrl+Alt+Del +^V +Shift+F9 +Alt+G +Meta+Q + +

+Recognized key modifiers include: +

+ +Alt +Ctrl or ^ +Meta +Shift + +

+Recognized key captions include the standard key caps for your keyboard and the +localized versions of the following: +

+
+
BkSp
+
VK_BACK
+
Del
+
VK_DELETE
+
Down
+
VK_DOWN
+
End
+
VK_END
+
Enter
+
VK_RETURN
+
Esc
+
VK_ESCAPE
+
Help
+
VK_HELP
+
Home
+
VK_HOME
+
Ins
+
VK_INSERT
+
Left
+
VK_LEFT
+
PgDn
+
VK_NEXT
+
PgUp
+
VK_PRIOR
+
Right
+
VK_RIGHT
+
Space
+
VK_SPACE
+
Tab
+
VK_TAB
+
Up
+
VK_UP
+
+

+The return value is a TShortCut instance with the numeric value used to +represent both the Shift/Ctrl/Alt modifier and the key code for the shortcut. +It consists of the Shift and Key values OR'd together. +

+

+Use TextToShortCutRaw to convert a non-localized string to it TShortCut +equivalent. +

+

+Use ShortCutToText to reverse the process. +

+
+ + + + +TShortCut +
-TShortcut value for the specified text. + +TShortcut value for the specified text. + -Text converted to a shortcut value in the method. + +Text converted to a shortcut value in the routine. + -Converts the non-localized textual representation for a shortcut into a -shortcut value. +Converts the non-localized textual representation for a shortcut to a TShortCut +value. - - + +

+TextToShortCutRaw is similar to TextToShortCut, but does +not handle or use localized versions of modifiers or key caps in +ShortCutText. +

+

+See TextToShortCut for more information. +

+

+Use ShortCutToTextRaw to reverse the process. +

+
+ + + + +TShortCut +
- + +TShortcut value for the specified text. + - + +Text converted to a shortcut value in the routine. + -Finds a string in a list, given its first few characters. + +Finds a string in a list, given its first few characters. +