Reference for unit 'LCLIntf': Procedures and functions

`AddEventHandler`
`AddPipeEventHandler`
`AddProcessEventHandler`
`AdjustWindowRectEx`
`AllocateHWnd`
`AngleChord`		Draws a filled Chord described by two angles.
`Arc`		Draws an elliptical curve.
`AskUser`
`BeginPaint`		Start painting in a window.
`BitBlt`		Copies a section of a Canvas to another one, performing a raster operation (ROP).
`CallDefaultWndHandler`
`CallNextHookEx`		Calls the next procedure in the hook chain.
`CallWindowProc`		Calls another Window procedure, to handle a message.
`CharLower`
`CharLowerBuff`
`CharUpper`
`CharUpperBuff`
`ClientToScreen`		Converts (relative) Client coordinates into absolute Screen coordinates.
`ClipboardFormatNeedsNullByte`
`ClipboardFormatToMimeType`
`ClipboardGetData`
`ClipboardGetFormats`
`ClipboardGetOwnerShip`
`ClipboardRegisterFormat`
`CombineRgn`		Combines two regions.
`CopyRect`
`CreateBitmap`		Creates a bitmap object.
`CreateBrushIndirect`		Creates a brush object (bitmap).
`CreateBrushWithRadialGradient`
`CreateCaret`		Creates the Caret (text cursor) for the specified windowed control.
`CreateCompatibleBitmap`		Creates a bitmap that is compatible with the given DC.
`CreateCompatibleDC`		Creates an memory Device Context, compatible with the device of the given DC.
`CreateDIBitmap`		Creates a Device Dependent Bitmap (DDB) from a Device Independent Bitmap (DIB).
`CreateDIBSection`		Creates a bitmap into which the application can write.
`CreateEllipticRgn`		Creates an elliptic region.
`CreateEllipticRgnIndirect`
`CreateEmptyRegion`
`CreateFont`
`CreateFontIndirect`		Creates a logical font, selectable into any DC.
`CreateFontIndirectEx`		Creates a logical font, selectable into any DC. Allows for a long font name.
`CreateIconIndirect`		Creates an icon or cursor.
`CreatePalette`		Creates a logical palette, selectable into any DC.
`CreatePatternBrush`		Creates a logical brush, selectable into any DC.
`CreatePen`
`CreatePenIndirect`		Creates a logical Pen, selectable into any DC.
`CreatePixmapIndirect`
`CreatePolygonRgn`		Creates a polygonal region.
`CreateRectRgn`		Creates a rectangular region.
`CreateRectRgnIndirect`
`CreateRegionCopy`
`CreateRoundRectRgn`		Creates a rectangular region with rounded corners.
`CreateRubberBand`
`CreateSolidBrush`
`CreateStandardCursor`
`DCClipRegionValid`
`DeallocateHWnd`
`DeleteCriticalSection`		Deletes an un-owned critical section.
`DeleteDC`		Deletes a device context created by CreateDC.
`DeleteObject`		Frees a GDI object.
`DestroyCaret`		Destroys the caret but does not free the bitmap.
`DestroyCursor`		Destroys a mouse cursor.
`DestroyIcon`		Destroys an icon.
`DestroyRubberBand`
`DPtoLP`		Converts an array of Device Points (coordinates) into Logical Points.
`DrawDefaultDockImage`
`DrawEdge`		Draws one or more edges for a rectangle.
`DrawFocusRect`		Draws a focus rectangle on the specified device context.
`DrawFrameControl`		Draws a window frame for a control of the specified type in a given state.
`DrawGrid`		Draws the grid separator lines between columns and rows with the specified width and height.
`DrawText`		Draws formatted text on the specified device context.
`Ellipse`		Draws a filled circle or ellipse, bounded by a rectangle.
`EnableScrollBar`		Enables or disables the arrows of a scroll bar control, or of the scroll bars of a window.
`EnableWindow`		Enables or disables mouse and keyboard input to the specified window or control.
`EndPaint`		Ends painting a window, started with BeginPaint.
`EnterCriticalSection`		Enters a critical section.
`EnumDisplayMonitors`		Invokes a callback function for every available display monitor.
`EnumFontFamilies`		Invokes a callback function for every font available on a specified device.
`EnumFontFamiliesEx`		Invokes a callback function for every available font that matches certain criteria.
`EqualRect`		Returns True when the rectangles are identical.
`EqualRgn`
`ExcludeClipRect`		Excludes a rectangle from the clipping region, i.e. allows one to paint within the rectangle.
`ExcludeClipRgn`
`ExtCreatePen`		Creates a logical pen, selectable into any DC.
`ExtSelectClipRGN`		Combines the passed Region with the current clipping region.
`ExtTextOut`		Draws an string without formatting (single line).
`ExtUTF8Out`
`FillRect`		Fills a rectangle by using the specified brush.
`FillRgn`		Fills a region using the specified brush.
`FindDefaultBrowser`		Gets the path to the default browser and its parameters.
`FloodFill`		Fills an area of the display surface with the current brush.
`FontIsMonoSpace`		Indicates whether the specified font handle represents a fixed-pitch typeface.
`Frame3d`
`FrameRect`		Draws a border around a rectangle.
`GetAcceleratorString`
`GetActiveWindow`		Returns the Handle of the active window of the calling thread.
`GetAvailableNativeCanvasTypes`
`GetAvailableNativeHandleTypes`
`GetBitmapBits`		Fills an buffer with the bitmap bits.
`GetBkColor`		Returns the background color of an device context.
`GetBValue`		Extracts the blue color value from a COLORREF.
`GetCapture`		Returns the window that captures mouse messages.
`GetCaretPos`		Returns the caret position, in client coordinates.
`GetCaretRespondToFocus`
`GetCharABCWidths`		Returns the ABC widths of an range of character codes.
`GetClientBounds`
`GetClientRect`		Returns the client rectangle of a control. Left and Top are always 0.
`GetClipBox`		Returns the smallest rectangle which includes the entire clipping region of an device context.
`GetClipRGN`		Returns the clipping region of an device context.
`GetCmdLineParamDescForInterface`
`GetCompositorExtendedBorder`		Gets extended border information added by the compositor for the Desktop Window Manager.
`GetControlConstraints`
`GetCurrentObject`		Returns an currently selected object in an device context.
`GetCursorPos`
`GetDC`		Returns the handle of an Device Context (DC) for the client area of a window.
`GetDCOriginRelativeToWindow`
`GetDesignerDC`
`GetDeviceCaps`		Returns various device specific information.
`GetDeviceSize`
`GetDIBits`		Fill an buffer with the bitmap bits.
`GetDoubleClickTime`		Returns the double-click time, in milliseconds.
`GetDpiForMonitor`
`GetFocus`		Returns the handle of the window that has the focus in the current thread.
`GetFontLanguageInfo`		Returns language information about the currently selected font.
`GetForegroundWindow`		Returns the window that the user is currently working with, session wide.
`GetGValue`		Extracts the green color value from a COLORREF.
`GetIconInfo`		Returns information about an Icon or Cursor.
`GetKeyState`		The status of a virtual key.
`GetLCLOwnerObject`
`GetMapMode`		Returns the mapping mode of an device context.
`GetMonitorInfo`		Returns information about an display monitor.
`GetNativeCanvas`
`GetNativeHandle`
`GetObject`		Returns information about a graphics object.
`GetPaletteEntries`		Retrieves an range of color entries from a logical palette.
`GetParent`		Returns the parent window of a window.
`GetProp`		Retrieves an property value for a window.
`GetRGBIntValues`		Extracts the red, green and blue color values from a COLORREF.
`GetRGBValues`		Extracts the red, green and blue color values from a COLORREF.
`GetRgnBox`		Returns the bounding rectangle of a region, containing the entire region.
`GetROP2`		The current Foreground Mixing Mode in an device context.
`GetRValue`		Extracts the red color value from a COLORREF.
`GetScrollBarSize`
`GetScrollbarVisible`
`GetScrollInfo`		Returns all or selected information about a Scroll Bar.
`GetScrollPos`		Returns the scroll bar position.
`GetScrollRange`		Returns the minimum and maximum Position values of a Scroll Bar.
`GetStockObject`		Retrieves a handle to one of the predefined graphic objects.
`GetSysColor`		Retrieves the system color for standard display elements.
`GetSysColorBrush`		Retrieves a system brush for standard display elements.
`GetSystemMetrics`		Retrieves various system metrics.
`GetSystemPaletteEntries`		Retrieves an range of color entries from the system palette for a device.
`GetTextColor`		The current text color in an device context.
`GetTextExtentExPoint`		Calculates the number of characters, that fit into some horizontal space.
`GetTextExtentPoint`		Computes the display width and height of an string.
`GetTextExtentPoint32`		Computes the display width and height of an string.
`GetTextMetrics`		Retrieves the metrics for the currently selected font.
`GetTickCount`		Number of ticks (milliseconds) elapsed since the computer was started.
`GetTickCount64`		Number of ticks (milliseconds) elapsed since the computer was started.
`GetViewPortExtEx`		Returns the size of the viewport of an device context.
`GetViewPortOrgEx`		Returns the origin of the viewport of an device context.
`GetWindowExtEx`		Returns the extent of a window, in logical units.
`GetWindowLong`		Returns attributes for the specified window handle.
`GetWindowOrgEx`		Retrieves the window origin of an device context, in logical units.
`GetWindowRect`		Retrieves the bounding rectangle for a window, including the window decoration in screen coordinates.
`GetWindowRelativePosition`
`GetWindowSize`		Returns the Width and Height of a window, including the window decoration.
`GradientFill`		Fills rectangle or triangle areas with gradient colors.
`HideCaret`		Removes the caret from the screen.
`IndexToOverlayMask`		Converts an imagelist index into an overlay index.
`InflateRect`		Inflates the rectangle in all directions.
`InitializeCriticalSection`		Initializes a Critical Section object.
`IntersectClipRect`		Shrinks the clipping region of an Device Context to a rectangular boundary, e.g. a text area.
`IntersectRect`		Intersects SrcRect1 and SrcRect2 into DestRect.
`InvalidateFrame`
`InvalidateRect`		Marks a display area for repaint.
`InvalidateRgn`		Marks a display area for repaint.
`IsCDIntfControl`
`IsCharAlphaNumeric`		Checks for ASCII letter or digit characters.
`IsDBCSLeadByte`
`IsDesignerDC`
`IsIconic`		True when the window is minimized.
`IsMobilePlatform`
`IsRectEmpty`		Returns True if the rectangle is empty.
`IsWindow`		Checks whether a handle refers to a window.
`IsWindowEnabled`		Determines whether a window can receive mouse and keyboard input.
`IsWindowVisible`		The definite Visible state of a window.
`IsZoomed`		True when the window is maximized.
`KillTimer`		Removes an timer.
`LeaveCriticalSection`		Releases a critical section, for use by other threads.
`LineTo`		Draws a line from the current position up to, but not including, the specified point.
`LoadBitmap`
`LoadCursor`
`LoadIcon`
`LPtoDP`		Converts logical coordinates into device coordinates.
`MakeLong`		Copies two words into a double word.
`MakeLParam`		Copies two words into a double word, usable as a message lParam.
`MakeLResult`		Copies two words into a double word, usable as a message Result.
`MakeROP4`
`MakeWord`		Copies two bytes into a word.
`MakeWParam`		Copies two words into a double word, usable as a message wParam.
`MaskBlt`		Copies part of an source DC into an destination DC, using the specified foreground and background raster operations.
`MessageBox`		Displays a modal dialog with the given text, caption, icon and buttons.
`MonitorFromPoint`		Finds an monitor from screen coordinates.
`MonitorFromRect`
`MonitorFromWindow`		Finds the monitor which contains most of the specified window.
`MoveToEx`		Moves the current position to the specified point.
`MoveWindowOrgEx`
`MsgKeyDataToShiftState`
`NotifyUser`
`NotifyUserAtXY`
`OffsetRect`		Deprecated. Use the OffsetRect routine in the RTL types.pp unit instead.
`OffsetRgn`		Moves a region by the specified relative offset.
`OpenDocument`		Opens the specified document using the default application for the platform or widgetset.
`OpenURL`		Open a given URL with the default browser.
`PaintRgn`
`PeekMessage`
`Pie`		Draws a filled pie-shaped wedge, from an ellipse and two radials.
`PointToSmallPoint`
`PointToSmallPointNoChecks`
`PolyBezier`		Draws Bézier curves.
`Polygon`		Draws a Polygon.
`Polyline`		Draws a sequence of lines.
`PostMessage`		Sends a message to a window.
`PredefinedClipboardFormat`
`PromptUser`
`PromptUserAtXY`
`PtInRect`		Checks whether a Point is within a Rect.
`PtInRegion`		Determines whether the specified coordinates are within the given region handle.
`RadialArc`
`RadialChord`
`RadialPie`
`RawImage_CreateBitmaps`
`RawImage_DescriptionFromBitmap`
`RawImage_DescriptionFromDevice`
`RawImage_FromBitmap`
`RawImage_FromDevice`
`RawImage_QueryDescription`
`RealizePalette`
`Rectangle`
`RectInRegion`
`RectVisible`		Indicates whether the specified rectangle in visible in the clipping region for the device context.
`RedrawWindow`		Redraws (part of) a window.
`RegroupMenuItem`
`ReleaseCapture`		Restores normal mouse input processing, after SetCapture.
`ReleaseDC`		Releases an Device Context obtained by GetDC.
`ReleaseDesignerDC`
`RemoveEventHandler`
`RemovePipeEventHandler`
`RemoveProcessEventHandler`
`RemoveProp`		Removes a named property from a window.
`RequestInput`
`RestoreDC`		Restores a Device Context (DC) to an previously saved state.
`RGB`		Combines Red, Green and Blue values into an TColorRef value.
`RoundRect`		Draws a rectangle with rounded corners to the specified device context.
`SaveDC`		Saves the state of a Device Context in the context stack.
`ScreenToClient`		Converts absolute Screen coordinates into Client relative coordinates.
`ScrollWindow`		Scrolls the content of a window, by a number of pixels.
`ScrollWindowEx`
`SelectClipRGN`		Sets the ClipRegion of an DeviceContext.
`SelectObject`		Selects an object into an device context.
`SelectPalette`
`SendCachedLCLMessages`
`SendMessage`		Sends a message directed to a specific window to the message pool for the application.
`SetActiveWindow`		Sets focus to the specified window, if the application is on top.
`SetBkColor`		Sets the current background color of an device context.
`SetBkMode`		Sets the background mix mode (transparency) of an device context.
`SetCapture`		Sets the mouse capture to the specified window.
`SetCaretPos`		Moves the Caret to the specified coordinates.
`SetCaretPosEx`		Moves the Caret into a window.
`SetCaretRespondToFocus`
`SetComboMinDropDownSize`
`SetCursor`		Changes the shape of the mouse cursor.
`SetCursorPos`		Changes the position of the mouse cursor.
`SetEventHandlerFlags`
`SetFocus`		Sets the keyboard input focus to the specified window handle.
`SetForegroundWindow`		Moves a window in front of all other windows, and activates it.
`SetMapMode`		Sets the mapping mode of an device context.
`SetMenu`		Assigns a menu to a window.
`SetParent`		Changes the parent of a window.
`SetProp`		Adds a property to a window.
`SetRect`		Copies coordinates into a rectangle.
`SetRectEmpty`		Clears the rectangle to all zero coordinates.
`SetRectRgn`
`SetROP2`		Sets the Foreground Mixing Mode in an device context.
`SetRubberBandRect`
`SetScrollInfo`
`SetScrollPos`		Changes the Position of an Scroll Bar slider.
`SetScrollRange`		Sets the minimum and maximum position values for a scroll bar.
`SetStretchBltMode`		Sets the StrechBlt mode for an device context.
`SetSysColors`		Sets the colors for one or more display elements of window borders and desktop.
`SetTextCharacterExtra`		Sets extra inter-character spacing in text output.
`SetTextColor`		Sets the text color on a device context.
`SetTimer`		Creates or resets an timer for the given time interval.
`SetViewPortExtEx`		Sets the extent of the viewport for a device context.
`SetViewPortOrgEx`		Sets the device origin corresponding to the window origin (0,0) in an device context.
`SetWindowExtEx`		Sets the extent of the window for an device context.
`SetWindowLong`		Sets an attribute of a window.
`SetWindowOrgEx`		Specifies which window point maps to the viewport origin (0,0).
`SetWindowPos`		Changes the size, position, and Z order of a window.
`SetWindowRgn`		Defines the visible region of a window or control.
`ShowCaret`		Shows the Caret (text cursor).
`ShowScrollBar`		Shows or hides a Scroll Bar.
`ShowSelectItemDialog`
`ShowWindow`		Shows a window in an specific state.
`SmallPointToPoint`		Converts a TSmallPoint value to a TPoint value.
`StretchBlt`		Copies a rectangular region into an device context, shrinking or stretching it as required.
`StretchDIBits`		Copies a rectangular region from a DIB into an device context, shrinking or stretching it as required.
`StretchMaskBlt`
`SubtractRect`		Computes the bounding box with the geometric difference between two rectangles.
`SystemParametersInfo`		Retrieves or sets one of the system-wide parameters.
`TextOut`		Draws an string without formatting (single line).
`TextUTF8Out`
`UnionRect`		Computes the bounding box of the union of two rectangles.
`UpdateWindow`		Forces an immediate repaint of a window, if required.
`WindowFromPoint`		Finds the window containing the specified point.

Version 3.2

Generated 2024-02-25

Home