diff --git a/docs/xml/lcl/lazregions.xml b/docs/xml/lcl/lazregions.xml index 8d194c15e3..e875c83156 100644 --- a/docs/xml/lcl/lazregions.xml +++ b/docs/xml/lcl/lazregions.xml @@ -78,7 +78,7 @@ Gets the rectangle with the Bounds for an area in a region.

- GetBoundingRect is a TRect function used to get the rectangle with the Bounds for a rectangular area in a region. In TLazRegionPart, the return value contains an empty rectangle (with zero assigned to its Left, Top, Right, Bottom, Width, and Height members). + GetBoundingRect is a TRect function used to get the rectangle with the Bounds for a rectangular area in a region. In TLazRegionPart, the return value contains an empty rectangle (with zero assigned to its Left, Top, Right, Bottom, Width, and Height members).

@@ -99,7 +99,7 @@ - True when the coordinates are located in the bounds for the rectangular area. + True when the coordinates are located in the bounds for the rectangular area. @@ -149,7 +149,7 @@ - True when the coordinates are located in the bounds rectangle for the region. + True when the coordinates are located in the bounds rectangle for the region. @@ -213,7 +213,9 @@ - True when the point occurs inside the vertices for the polygonal region. + + True when the point occurs inside the vertices for the polygonal region. + Horizontal coordinate for the point. @@ -276,7 +278,9 @@ - True when the specified point is located inside the area for the ellipse. + + True when the specified point is located inside the area for the ellipse. + Horizontal coordinate for the point. @@ -290,7 +294,7 @@ - Defined for FPC version 2.6 or older. Defined in fpcanvas.pp in the FCL for later FPC versions. + Defined for FPC version 2.6 or older. Defined in fpcanvas.pp in the FCL for later FPC versions. @@ -299,38 +303,38 @@ - Defined for FPC version 2.6. Defined in fpcanvas.pp for later FPC versions. + Defined for FPC version 2.6. Defined in fpcanvas.pp for later FPC versions. - Defined for FPC version 2.6. Defined in fpcanvas.pp for later FPC versions. + Defined for FPC version 2.6. Defined in fpcanvas.pp for later FPC versions. - Defined for FPC version 2.6. Defined in fpcanvas.pp for later FPC versions. + Defined for FPC version 2.6. Defined in fpcanvas.pp for later FPC versions. - Defined for FPC version 2.6. Defined in fpcanvas.pp for later FPC versions. + Defined for FPC version 2.6. Defined in fpcanvas.pp for later FPC versions. - Defined for FPC version 2.6. Defined in fpcanvas.pp for later FPC versions. + Defined for FPC version 2.6. Defined in fpcanvas.pp for later FPC versions. - Defined for FPC version 2.6. Defined in fpcanvas.pp for later FPC versions. + Defined for FPC version 2.6. Defined in fpcanvas.pp for later FPC versions. @@ -466,11 +470,11 @@
COMPLEXREGION (3)
- The region has more than one rectangle, polygon, or ellipse. Used when IsSimpleRectRegion is False. + The region has more than one rectangle, polygon, or ellipse. Used when IsSimpleRectRegion is False.
SIMPLEREGION (2)
- The region is a simple rectangle defined using the Rect member. Used when IsSimpleRectRegion is True, and Rect is not an empty rectangle (Left, Top, Bottom, and Right all contain zero). + The region is a simple rectangle defined using the Rect member. Used when IsSimpleRectRegion is True, and Rect is not an empty rectangle (Left, Top, Bottom, and Right all contain zero).
NULLREGION (1)
@@ -495,7 +499,7 @@ - True when the dimensions for the rectangle are invalid. + True when the dimensions for the rectangle are invalid. @@ -503,7 +507,7 @@ Adds the specified part as a subregion in the Parts member.

- AddPart is a procedure used to add the specified TLazRegionPart in APart to the Parts member in the class instance. AddPart calls the TFPList.Add method to store the value in APart in the list. AddPart calls DoChangeToComplexRegion to update IsSimpleRectRegion to reflect the current composition for the region. + AddPart is a procedure used to add the specified TLazRegionPart in APart to the Parts member in the class instance. AddPart calls the TFPList.Add method to store the value in APart in the list. AddPart calls DoChangeToComplexRegion to update IsSimpleRectRegion to reflect the current composition for the region.

AddPart is used in the implementation of the AddRectangle, AddPolygon, and AddEllipse methods. @@ -587,7 +591,7 @@ Horizontal coordinate for the endpoint of the major axis. - Vertical coordinate for the endpoint of the major axis. + Vertical coordinate for the endpoint of the major axis. Horizontal coordinate for the endpoint of the minor axis. @@ -632,11 +636,11 @@ - Adds the value in Rect to the Parts member, and resets the value in IsSimpleRectRegion. + Adds the value in Rect to the Parts member, and resets the value in IsSimpleRectRegion.

- DoChangeToComplexRegion is a procedure used to change the region from a simple rectangle to a complex region as defined in the Parts member. DoChangeToComplexRegion uses the values from IsSimpleRectRegion and IsSimpleRectEmpty to determine if any actions are required in the method. No actions are performed when IsSimpleRectRegion is False, or when IsSimpleRectEmpty returns True. + DoChangeToComplexRegion is a procedure used to change the region from a simple rectangle to a complex region as defined in the Parts member. DoChangeToComplexRegion uses the values from IsSimpleRectRegion and IsSimpleRectEmpty to determine if any actions are required in the method. No actions are performed when IsSimpleRectRegion is False, or when IsSimpleRectEmpty returns True.

DoChangeToComplexRegion changes the value in IsSimpleRectRegion to False, and calls AddRectangle to store the value in Rect in the Parts member. @@ -674,7 +678,7 @@ - True when the point is located inside the rectangle or one of the subregions that define the bounds for the region. + True when the point is located inside the rectangle or one of the subregions that define the bounds for the region. @@ -763,7 +767,7 @@ - True when the point is within the bounds for one of the child areas in the region. + True when the point is within the bounds for one of the child areas in the region. @@ -780,7 +784,7 @@

- The function will return True if the point at AX, AY is inside the specified polygon. Returns False if it is not. + The function will return True if the point at AX, AY is inside the specified polygon. Returns False if it is not.

Original C code: @@ -798,7 +802,7 @@ - True when the specified point is located within the polygon using the specified vertices. + True when the specified point is located within the polygon using the specified vertices.