Sign in Join
FPDoc Onlineexperiment

TScrollingWinControl.ClientToScreen function

Member of TScrollingWinControlpublicIn unit Forms

Converts the specified client coordinates to absolute screen coordinates.

Declaration

pascal
function ClientToScreen(const APoint: TPoint): TPoint; override

Arguments

APoint

TPoint instance with the client-relative coordinates converted in the method.

Function result

TPoint instance with the screen coordinates for the specified value.

Description

ClientToScreen is an overridden method in TScrollingWinControl.

ClientToScreen calls the inherited method to get the TPoint instance with the screen coordinates for the client coordinates in APoint. The X and Y members in the return value are updated to reflect the current scroll offsets for the control. This gives the screen coordinates where the origin for the logical display area is located on the control.

ClientToScreen is used, along with ScreenToClient, in inherited methods which respond to changes in the mouse pointer position for a control. This includes context menu display and drag-and-dock operations.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.