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

Docs: LCL/extctrls. Updates TShape topics for HitTest to PtInShape changes in e13451a5.

Browse Source 
(cherry picked from commit ace343ea93)
This commit is contained in:
dsiders 2023-09-12 02:50:01 +01:00
parent 704b47f33b
commit d0b7d52ff4
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/xml/lcl/extctrls.xml
View File

@ -1638,14 +1638,14 @@ Canvas and other resources allocated in ancestor classes.
</seealso> </seealso>
</element> </element>
<element name="TShape.HitTest"> <element name="TShape.PtInShape">
<short> <short>
Determines whether the coordinates for the specified Point are within the area Determines whether the coordinates for the specified Point are within the area
for the shaped control. for the shaped control.
</short> </short>
<descr> <descr>
<p> <p>
<var>HitTest</var> uses a temporary TBitmap instance to determine whether the <var>PtInShape</var> uses a temporary TBitmap instance to determine whether the
coordinates in P are within the interior of the shaped control. The Bitmap coordinates in P are within the interior of the shaped control. The Bitmap
contains a monochrome variant of the filled shape where the pixels inside the contains a monochrome variant of the filled shape where the pixels inside the
shape have the color clBlack. Pixels outside of the filled interior area have shape have the color clBlack. Pixels outside of the filled interior area have
@ -1658,7 +1658,7 @@ in <var>P</var> has the color clBlack. False indicates that the parent control
mouse position. mouse position.
</p> </p>
<p> <p>
HitTest is used in the Click method to determine whether an assigned PtInShape is used in the Click method to determine whether an assigned
OnShapeClick event handler is signalled for the mouse position on the control. OnShapeClick event handler is signalled for the mouse position on the control.
It is also called when CMShapeHitTest handles a TCMHittest message received for It is also called when CMShapeHitTest handles a TCMHittest message received for
the control design surface. the control design surface.
@ -1675,13 +1675,13 @@ Added in LCL version 4.0.
<link id="#rtl.classes.TPoint">TPoint</link> <link id="#rtl.classes.TPoint">TPoint</link>
</seealso> </seealso>
</element> </element>
<element name="TShape.HitTest.Result"> <element name="TShape.PtInShape.Result">
<short> <short>
Returns <b>True</b> if the specified coordinates are within the interior of the Returns <b>True</b> if the specified coordinates are within the interior of the
shape. shape.
</short> </short>
</element> </element>
<element name="TShape.HitTest.P"> <element name="TShape.PtInShape.P">
<short> <short>
TPoint instance with the horizontal (X) and vertical (Y) coordinates tested in TPoint instance with the horizontal (X) and vertical (Y) coordinates tested in
the method. the method.
@ -1796,7 +1796,7 @@ handler signalled if a mouse click occurs on the shaped control.
OnShapeClick is signalled (when assigned) from the Click method, and occurs OnShapeClick is signalled (when assigned) from the Click method, and occurs
after the OnClick handler has been signalled and an optional Action assigned to after the OnClick handler has been signalled and an optional Action assigned to
the control has been executed. The event handler is <b>not</b> signalled if the control has been executed. The event handler is <b>not</b> signalled if
HitTest indicates that the mouse click did not occur within the interior PtInShape indicates that the mouse click did not occur within the interior
of the shape on the control. of the shape on the control.
</p> </p>
<p> <p>
@ -1809,7 +1809,7 @@ Added in LCL version 4.0.
</version> </version>
<seealso> <seealso>
<link id="TShape.Click"/> <link id="TShape.Click"/>
<link id="TShape.HitTest"/> <link id="TShape.PtInShape"/>
<link id="#lcl.controls.TControl.OnClick">TControl.OnClick</link> <link id="#lcl.controls.TControl.OnClick">TControl.OnClick</link>
<link id="#lcl.controls.TControl.Action">TControl.Action</link> <link id="#lcl.controls.TControl.Action">TControl.Action</link>
<link id="#rtl.classes.TNotifyEvent">TNotifyEvent</link> <link id="#rtl.classes.TNotifyEvent">TNotifyEvent</link>