paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-17 15:39:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL/forms. Updates topics for TLCLHandle changes in 211d95da.

Browse Source
This commit is contained in:
dsiders 2023-07-09 05:10:05 +01:00
parent 450eba28e3
commit 3b39b2ef36
1 changed files with 44 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
docs/xml/lcl/forms.xml
View File

@ -12591,37 +12591,56 @@ Finds the monitor containing the form with the given window handle.
</short> </short>
<descr> <descr>
<p> <p>
MonitorFromWindow is a TMonitor function used to locate monitor where the MonitorFromWindow is a TMonitor function used to locate the monitor where the
form represented by the specified window Handle is displayed. form represented by the specified window Handle is displayed.
</p> </p>
<p> <p>
<var>MonitorDefault</var> is a <var>TMonitorDefaultTo</var> enumeration value <var>MonitorDefault</var> is a <var>TMonitorDefaultTo</var> enumeration value
which indicates the monitor used when the display area for the form is not which indicates the monitor used when the display area for the form is not
found on a monitor. See TMonitorDefaultTo for more information about the found on a monitor.
values in the enumeration and their meanings. See <link href="TMonitorDefaultTo">TMonitorDefaultTo</link> for more
information about the values in the enumeration and their meanings.
</p> </p>
<p> <p>
MonitorFromWindow calls MonitorFromWindow in the widgetset class to get a MonitorFromWindow calls the MonitorFromWindow routine in the LCL interface to
monitor handle used to locate the monitor in the Monitors property. The get the HMONITOR handle to locate in the Monitors property. The
UpdatedMonitor method is called to ensure that Monitors contains up-to-date UpdatedMonitors method is called to ensure that Monitors contains up-to-date
values for the available monitors. values for the available monitors.
</p> </p>
<p> <p>
If a monitor with the Handle is not found, GetWindowRect is called to get the If the handle is found in Monitors, the TMonitor instance with the handle is
display areas for the monitor Handle. MonitorFromRect is called to locate the used as the return value.
monitor which contains the rectangle. </p>
<p>
If a monitor is not found, GetWindowRect is called to get the display area for
the TLCLHandle specified in the Handle argument. MonitorFromRect is called to
locate the monitor which contains the rectangle. The TMonitor instance is used
as the return value.
</p>
<p>
MonitorFromWindow is called from methods like TCustomForm.GetMonitor.
</p> </p>
</descr> </descr>
<seealso/> <version>
Modified in LCL version 4.0 to use the TLCLHandle type instead of the
deprecated THandle type in the Handle parameter.
</version>
<seealso>
<link id="TCustomForm.GetMonitor"/>
<link id="TMonitor.Handle"/>
<link id="TMonitorDefaultTo"/>
<link id="#lcl.lcltype.TLCLHandle">TLCLHandle</link>
<link id="#lcl.lcltype.HMONITOR">HMONITOR</link>
</seealso>
</element> </element>
<element name="TScreen.MonitorFromWindow.Result"> <element name="TScreen.MonitorFromWindow.Result">
<short>The monitor found.</short> <short>The TMonitor instance found for the specified handle.</short>
</element> </element>
<element name="TScreen.MonitorFromWindow.Handle"> <element name="TScreen.MonitorFromWindow.Handle">
<short>The window handle to use.</short> <short>The TLCLHandle instance on the monitor located in the method.</short>
</element> </element>
<element name="TScreen.MonitorFromWindow.MonitorDefault"> <element name="TScreen.MonitorFromWindow.MonitorDefault">
<short>What to return when no monitor was found.</short> <short>What to return if a monitor was found.</short>
</element> </element>
<element name="TScreen.BeginTempCursor"> <element name="TScreen.BeginTempCursor">
@ -18084,23 +18103,28 @@ Values are added to and removed from Flags in methods like:
<element name="TApplication.Handle"> <element name="TApplication.Handle">
<short> <short>
Provides access to the widgetset handle for the application instance. Provides access to the handle for the application instance.
</short> </short>
<descr> <descr>
<p> <p>
<var>Handle</var> is a <var>THandle</var> property which provides access to <var>Handle</var> is a <var>TLCLHandle</var> property which provides access to
the widgetset handle used for the application instance. Reading the value for the handle used for the application instance. Reading the value for the
the property is redirected to the AppHandle allocated in the widgetset class. property is redirected to the AppHandle allocated in the widgetset class.
Setting the value for the property causes the AppHandle in the widgetset Setting the value for the property causes the AppHandle in the widgetset class
class to be updated with the new value. to be updated with the new value.
</p> </p>
<p> <p>
Handle is used to send and receive window messages and state change Handle is used to send and receive window messages and state change
notifications for the application instance using the <b>LCL</b> interface. notifications for the application instance using the <b>LCL</b> interface.
</p> </p>
</descr> </descr>
<version>
Modified in LCL version 4.0 to use the TLCLHandle type instead of the
deprecated THandle type.
</version>
<seealso> <seealso>
<link id="TWidgetSet.AppHandle"/> <link id="#lcl.lcltype.TLCLHandle">TLCLHandle</link>
<link id="#lcl.interfacebase.TWidgetSet.AppHandle">TWidgetSet.AppHandle</link>
</seealso> </seealso>
</element> </element>