diff --git a/docs/xml/lcl/lcltype.xml b/docs/xml/lcl/lcltype.xml index 2bad837441..7381e70392 100644 --- a/docs/xml/lcl/lcltype.xml +++ b/docs/xml/lcl/lcltype.xml @@ -10,7 +10,7 @@ Provides compatibility with the Delphi Windows unit.

- lcltype.pas is being created specifically for compatibility with Delphi. It should only be used for constants and type definitions that are included in the Delphi Windows unit. This is only done for compatibility. + lcltype.pp was created specifically for compatibility with Delphi. It should only be used for constants and type definitions that are included in the Delphi Windows unit. This is done only for compatibility.

@@ -38,19 +38,30 @@ - - - + Alias for the String type. + +

+ TTranslateString is the type used to represent string values that can be translated using the localization facilities found in the LCL and the Lazarus IDE. Properties, constants, variables, and parameter values defined using this type can be localized using translation classes found in the lcltranslator unit. +

+ + + TUpdateTranslator + TDefaultTranslator + - - + Alias for the PtrUInt type. + +

+ TCriticalSection is the type used to protect access to resources in a multi-threaded application. Please note that the type is different than the TRTLCriticalSection type and the class by the same name implemented in the syncobjs unit in the FPC RTL (Run-Time Library). +

+ - + - + Actions occurring while dragging an image. @@ -214,13 +225,13 @@ - A LongBool, distinct from the Boolean type. + A LongBool type, distinct from the Boolean type. - + A SmallInt type. @@ -250,21 +261,25 @@ - + Alias for the PtrUInt type. - - + Alias for the THandle type. + +

+ TLCLIntfHandle is the type returned from the CreateHandle method in widgetset classes. +

+ - Value representing an invalid (unassigned...) Handle. + Value representing an invalid (unassigned) Handle. @@ -577,16 +592,21 @@ - + + Class style constant used to redraw the entire window when the height for the client area has been changed. + - + - + + Class style constant used to redraw the entire window when the width for the client area has been changed. + + @@ -950,7 +970,7 @@ DrawFrameControl menubar control style: - submenu arrow. + sub-menu arrow. @@ -1099,12 +1119,13 @@ - + - + Hit test error (like HTNOWHERE) which produces a system beep. + Hit test: transparent area. @@ -1129,48 +1150,63 @@ - + - + + Indicates an input event occurred in a dialog. + - + - + + Indicates an input event occurred in a message box. + + - + + Indicates an input event occurred in a menu. + + + ??? - + + ??? - + - + + Indicates an input event occurred in a scroll bar. + - + - + + Indicates an ALT+TAB input event occurred to activate the next window. + + @@ -1209,103 +1245,133 @@ - + Menu flag to draw a horizontal separator. - + + Menu flag to enable a menu item for selection. + - + + Menu flag to disable a menu item and prevent its selection. + - + + Menu flag to disable a menu item and prevent its selection, but it does not gray the menu item. + - + + Menu to flag to draw the item without a check mark, even when a bitmap is supplied for the menu item. + - + + Menu flag to draw a check mark for the menu item. + - + + Menu flag to enable check mark bitmaps for menu items. + - + + Menu flag which specifies a menu item as a text value. + - + + Menu flag which specifies a menu item as a bitmap image. + - + + Menu flag which specified the menu item is owner-drawn. Indicates that WM_MEASUREITEM and WM_DRAWITEM messages are used when the menu item is updated. + - + + Menu flag which specifies the menu item is a a pop-up, drop-down, or sub-menu. + - + + Menu flag, like MF_MENUBREAK, but used for a menu bar. Causes a menu, sub-menu, or short cut to be displayed in a new column with a vertical separator. + - + + Menu flag, like MF_MENUBARBREAK, but used for a menu item. Causes the new menu item to appear on a separate line (menu bar) or column (menu, sub-menu, or short cut) without a separator line. + - + Menu flag used to remove highlighting from a menu item. - + + Menu flag used to add highlighting to a menu item. When omitted, the MF_UNHILITE menu flag is assumed. + - + + Menu flag used to indicate that an item is the default selection for a menu. + - + + Menu flag which indicates if the menu item appears on the Window menu. + @@ -1314,112 +1380,123 @@ + ??? - + Menu flag which indicates the menu item caption is right aligned. - + Menu flag which indicates the item has been selected using the mouse. - + Mask used to filter menu flag values. - + Focus and activation key flag used to test for extended key values. - + Focus and activation key flag which indicates if a dialog is active. - + Focus and activation key flag which indicates if a menu is active. - + Focus and activation key flag which indicates if the Alt key is pressed. - + + Focus and activation key flag used to manipulate the previous key state flag. + - + + Focus and activation key flag used to manipulate a key state transition flag. + - + Represents the Meta key in a short cut value. - + Virtual key code for an unknown key (defined by the LCL). - + Virtual key code (Windows API compatible). - + Virtual key code (Windows API compatible). - + Virtual key code (Windows API compatible). - + Virtual key code for the middle mouse button (Windows API compatible). - + + Virtual key code for the first extra mouse button (Windows API compatible). + - + + Virtual key code for the second extra mouse button (Windows API compatible). + - + + Virtual key code for the Backspace key. Not to be confused with the Android BACK navigation key which is mapped to VK_ESCAPE. + @@ -2419,141 +2496,228 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ Not equivalent to anything less than $FF. Will only be sent by a primary "@" key but not for a @ key as secondary action of a "2" key, for example. +

+ + + - + Represents a 3-D border style with a raised outer border. - + Represents a 3-D border style with a sunken outer border. - + Represents a 3-D border style with a raised inner border. - + Represents a 3-D border style with a sunken inner border. - + + Indicates whether an outer border (raised or sunken) is in use for a control. + - + + Indicates whether an inner border (raised or sunken) is in use for a control. + - + + Indicates whether a raised border (inner or outer) is in use for a control. + - + + Indicates whether a sunken border (inner or outer) is in use for a control. + - + Combination of BDR_RAISEDOUTER and BDR_SUNKENINNER. - + Combination of BDR_SUNKENOUTER and BDR_RAISEDINNER. - + Combination of BDR_RAISEDOUTER and BDR_RAISEDINNER. - + Combination of BDR_SUNKENOUTER and BDR_SUNKENINNER. - + Border flag representing the left side of a border rectangle. - + Border flag representing the top edge of a border rectangle. - + Border flag representing the right side of a border rectangle. - + Border flag representing the bottom edge of a border rectangle. - + Border flag representing the top and left sides of a border rectangle. - + Border flag representing the top and right sides of a border rectangle. - + Border flag representing the bottom and left sides of a border rectangle. - + + Border flag representing the bottom and right sides of a border rectangle. + - + + Border flag representing all sides of a border rectangle. + - + + Border flag representing a diagonal border. + - + + Border flag representing a diagonal border where the origin is the bottom-left corner and the terminus is the top-right corner of the rectangle. + @@ -2829,55 +2993,78 @@ - + Indicates a message box includes an Ok button. - + Indicates a message box includes Ok and Cancel buttons. - + Indicates a message box includes Abort, Retry, and Ignore buttons. - + Indicates a message box includes Yes, No, and Cancel buttons. - + Indicates a message box includes Yes and No buttons. - + Indicates a message box includes Retry and Cancel buttons. + + + Indicates a message box includes Cancel, Retry, and Continue buttons. + +

+ Not yet supported by MessageDlg. +

+ + + + + + Indicates a message box includes a Help button. + +

+ Not yet supported by MessageDlg. +

+ + + + - + + Indicates that a message box displays a Stop Sign icon. + - + Indicates that a message box displays a Question Mark icon. - + Indicates that a message box displays an Exclamation Point icon. @@ -4134,7 +4321,11 @@ - + +

+ Defined for the LCL. +

+ @@ -4574,6 +4765,7 @@ + TODO: Move this to StdCtrls. @@ -6748,79 +6940,79 @@ - + Cardinal color value used for no color. - + Mask used to check for the default color value. - + Same as CLR_NONE - + Offset into the system color map for the scroll bar color. - + Offset into the system color map for the background color. - + Offset into the system color map for the active caption color. - + Offset into the system color map for the inactive caption color. - + Offset into the system color map for the menu color. - + Offset into the system color map for the window color. - + Offset into the system color map for the window frame or border color. - + Offset into the system color map for the menu text color. - + Offset into the system color map for the window text color. - + Offset into the system color map for the caption text color. @@ -6832,49 +7024,49 @@ - + Offset into the system color map for the inactive border color. - + Offset into the system color map for the workspace color. - + Offset into the system color map for the highlight color. - + Offset into the system color map for the highlighted text color. - + Offset into the system color map for the button face color. - + Offset into the system color map for the button shadow color. - + Offset into the system color map for the grayed or inactive text color. - + Offset into the system color map for the button text color. @@ -7318,8 +7510,12 @@ - - + Maximum number of system colors. + +

+ Same as COLOR_ENDCOLORS. +

+ @@ -7330,133 +7526,133 @@ - + Represents the stock object for a white brush. - + Represents the stock object for a light gray brush. - + Represents the stock object for a gray brush. - + Represents the stock object for a dark gray brush. - + Represents the stock object for a black brush. - + Represents the stock object for an undefined brush. - + Same as NULL_BRUSH. - + Represents the stock object for a white pen. - + Represents the stock object for a black pen. - + Represents an undefined pen. - + Represents the stock object for an OEM fixed-pitch font. - + Represents the stock object for an ANSI fixed-pitch font. - + Represents the stock object for an ANSI variable-pitch font. - + Represents the stock object for the system font. - + Represents the stock object for a default device font. - + Represents the stock object for the default system color palette. - + Represents the stock object for the fixed-pitch system font. - + Represents the stock object for the default GUI font. - + Represents the stock object with a device context for a brush. - + Represents the stock object with a device context for a pen. - + Upper limit for stock object index definitions. - + Lower limit for the stock pixmap type indexes. @@ -7582,61 +7778,61 @@ - + Represents the pixmap containing the shield image used on dialogs. - + Device context object type for a pen. - + Device context object type for a brush. - + Device context object type for a device handle. - + Device context object type for a device handle with metadata. - + Device context object type for a palette. - + Device context object type for a font. - + Device context object type for a bitmap image. - + Device context object type for a region. - + Device context object type for a metafile (.wmf). @@ -7672,55 +7868,69 @@ - + + System metric index used to get the width in pixels of the screen for the primary display monitor. + - + + System metric index used to get the height in pixels of the screen for the primary display monitor. + - + + System metric index used to get the width of a vertical scroll bar in pixels. + - + + System metric index used to get the height of a horizontal scroll bar in pixels. + - + + System metric index used to get the height of the caption area in pixels. + - + + System metric index used to get the width of the window border in pixels. Same as SM_CXEDGE when the windows uses 3-D borders. + - + + System metric index used to get the height of the window border in pixels. Same as SM_CYEDGE when the windows uses 3-D borders. + - + Same as SM_CXFIXEDFRAME. - + Same as SM_CYFIXEDFRAME. @@ -8180,21 +8390,47 @@ + + + Defined to get accurate maximized window width under X11. + + + + + Defined to get accurate maximized height under X11. + + + + + Indicates if a form uses Alpha channel transparency. + + + + + + System metric index used to determine if the calling process is a terminal services client session (non-zero return value) or a console session (zero return value). A console session does not have to be the physical console. + + + + + - + Gets the state for warning beeps from system parameter information. - + Sets warning beeps on or off using system parameter information. - + + Gets mouse threshold and acceleration values from system parameter information. + @@ -9196,13 +9432,17 @@ - + + Gets the color orientation for font smoothing from system parameter information. + - + + Sets the color orientation for font smoothing using system parameter information. + @@ -9242,11 +9482,11 @@ - Horizontal width in pixels. + Horizontal width in pixels for a device context. - Vertical height in pixels. + Vertical height in pixels for a device context. @@ -11487,155 +11727,151 @@ - + - - - + Alias for the PtrUInt type. + +

+ TClipboardFormat is the type passed as an argument to TClipboardRequestEvent event handlers, and to routines in the graphics and clipbrd units. +

+ + + + + PredefinedClipboardFormat + - + - + Pointer to a TClipboardFormat type. - + - - - + + Specifies an event handler signalled to get a stream instance with the data for a given clipboard format. + + +

+ TClipboardRequestEvent is the type used to represent an event handler procedure for clipboard requests in widgetset classes. It is the type used to implement the OnRequest event handler in TClipboard. +

+ + + TClipboard.OnRequest + - - - + - - + Represents the sources or dispositions for clipboard data. + +

+ Used for platforms / window managers / desktop environments that support more than on clipboard. It appears to be inherently tied to the ICCCM protocol developed by freedesktop.org. Values in the enumeration are used in widgetset classes as an index to access the different clipboard storages. +

+ - - + + The clipboard is the one designated as PRIMARY for the desktop. Implies that it is used for commands that accept a single argument. Historically, it is used for mouse selections, pasting using the middle mouse button, and explicit cut/copy/paste operations initiated from a menu item. + - - + + The clipboard is the one designated as SECONDARY for the desktop. Implies that it is used to exchange values for primary and secondary selections. + - - + + This is the clipboard type when the desktop does not support multiple clipboards, or when copy/cut and paste operations are performed between different clients. + - + - + + Contains the names associated with the clipboard types accessed using the enumeration values. + - + - - - + Represents predefined clipboard formats used in the LCL. + +

+ Values in the enumeration indicates the type of content stored on the clipboard. Values from the enumeration are passed as an argument to routines in the LCL interface, and used in the implementation of widgetset classes. +

+ + + + - - + Clipboard contains plain text. - - + Clipboard contains an image using the .BMP or Bitmap format. - - + Clipboard contains an image using the PixMap format. - - + Clipboard contains an image using the .ico or Icon format. - - + Clipboard contains an image using the TPicture format. - - + Clipboard contains an object (TObject) instance. - - + Clipboard contains a component (TComponent) instance. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + Clipboard contains data stored using an application-specific custom format. + - + + Contains MIME types for the values in the TPredefinedClipboardFormat enumeration. + + - - - + + Specifies an event handler signalled when a value in a TListWithEvent instance is modified. + + +

+ TListChangeEvent is the type used for the OnChange event handler property in TListWithEvent. +

+ + + + + TListNotification + - - + An untyped Pointer to the modified list item for the event. - - + + Indicates the action performed for the list item that caused the notification event. + - + Implements a list with an event signalled when values are added or removed. @@ -12095,7 +12331,8 @@ ShiftStateToKeys - + + @@ -12337,13 +12574,13 @@ - + List View notification message code for a pending change to an item. - + List View notification message code for a completed change to an item. @@ -12463,13 +12700,13 @@ - + Pointer to the TNMListView type. - + Record type used for List View change notification messages. @@ -12523,190 +12760,231 @@ - + Alias for the TNMListView type. - + Alias for the TNMListView type. - + Alias for the TNMListView type. - + - - + Represents stock font types used in InitStockFont. + +

+ Values in the enumeration are passed as an argument to the InitStockFont routine in the LCL interface, and used when a widgetset class calls its InitStockFont method. +

+ - - + Represents the stock system font. - - + Represents the stock hint font. - - + Represents the stock icon font. - - + Represents the stock menu font. - + - - - + + Converts a component style identifier to a component style name. + + +

+ The following values are not supported in the CompStyle argument, and cause 'Unknown component style' to be returned from the routine: +

+
    +
  • csAlignment
    • +
  • csBox
    • +
  • csGTKTable
    • +
  • csMainForm
    • +
  • csTable
    • +
  • csVScrollBar
    • +
  • csFrame
    • +
  • csButtonBox
    • +
  • csCanvas
    • +
  • csFont
    • +
  • csPen
    • +
  • csBrush
    • +
  • csTimer
    • +
  • csImage
    • +
  • csToolbar
    • +
  • csToolButton
    • +
  • csSpeedButton
    • +
+

+ Not used in the current LCL implementation. +

+ - - + + String representing the component style, or 'Unknown component style' for unsupported values. + - - + + Integer component style identifier converted to its representation as a String. + - + - + Gets the largest value for the specified Integer as a Word type. - - + + + Hi + - - + Largest Word value for the specified Integer. - - + Integer value examined in the routine. - + - + Gets the smallest value for the specified Integer as a Word type. - - + + + Lo + - - + Smallest Word value for the specified Integer. - - + Integer value examined in the routine. - + - - - + Gets the virtual key code for the specified character value. + +

+ The return value is 0 (zero) if the character in C is not an alphanumeric character in the ranges '0'..'9', 'a'..'z', or 'A'..'Z'. +

+ - - + Virtual key code for the specified value. - - + Character value examined in the routine. - - - + + + Gets the character value for the specified virtual key code. - - - - + + Character value for the specified virtual key code. - - - + + Virtual key code converted to a character in the routine. - - - - - - - - - + - + Rounds the specified Real value to an Int64 value. - - - + Int64 type with the rounded value. - - + Real type with the value rounded in the routine. - + + + + Multiples the numerator by the specified Integer value, and divides the result by the denominator value. + + +

+ Values passed in the arguments to the routine are Integer types. Values in nNumber and nNumerator are cast to Int64 values for the multiplication operation. MathRound is called to ensure that the result for the division operation is rounded for the Int64 type, and is cast to the Integer type used in the return value. +

+

+ When nNumerator and nDenominator have the same value, the return value is set to nNumber. The return value is -1 if the value in nDenominator is 0 (zero). +

+ + + + + Integer result for the multiply and divide operations. + + + Multiplicand for the operation. + + + Numerator multiplied by the specified value. + + + Denominator used for the division operation. + + - - - + Gets the short cut value for the specified key code and shift modifiers. + +

+ The return value is determined by combining the value in Key with the Shift, Ctrl, Alt, or Meta modifiers in Shift. The return value is 0 if any of the high-order bits in Key are already set. +

+ - - + TShortCut value for the specified key code and shift modifier. - - + Key code for the short cut value. - - + Shift, Ctrl, Alt, or Meta modifier for the short cut value. - + - + Gets a String with the name for the specified character set identifier. - - + Character set name for the specified identifier. - - + Character set identifier converted to a name in the routine. - + - + Gets the character set identifier for the specified character set name. - - + + Constant with the character set identifier for the specified character set name. + - - + Character set name converted to its identifier constant.