From 748c5b4c127301300f484d99b9fc5f3624279df6 Mon Sep 17 00:00:00 2001 From: dsiders Date: Sat, 19 Jun 2021 02:36:11 +0000 Subject: [PATCH] Docs: LCL. Minor updates to TPen, LCL version constants. git-svn-id: trunk@65279 - --- docs/xml/lcl/graphics.xml | 46 ++++++++++++++++++++++--------------- docs/xml/lcl/lclversion.xml | 16 ++++++------- 2 files changed, 35 insertions(+), 27 deletions(-) diff --git a/docs/xml/lcl/graphics.xml b/docs/xml/lcl/graphics.xml index 3ad316bb61..110690592d 100644 --- a/docs/xml/lcl/graphics.xml +++ b/docs/xml/lcl/graphics.xml @@ -3137,9 +3137,10 @@ - + Contains the line drawing style for the pen. -

Style can contain one of the following values: +

+ Style is a TPenStyle property with the style used to draw lines with the Pen, and can contain one of the following values:

  • psSolid
    • @@ -3151,7 +3152,17 @@
  • psPattern
  • psClear
-

The default value is psSolid. +

+ psDash, psDot, psDashDot, and psDashDotDot are drawn using the corresponding TPenPattern for the Style. On the Windows platform, these styles are not available if the Width is any value other than 1. +

+

+ psInsideFrame uses a solid drawing style, and a Color dithered to one of the values in the color table for the device. The content drawn with the pen is reduced in size so that it appears inside of a bounding rectangle including the Width for the pen. +

+

+ psClear, in general, tells the implementing class or routine that the drawing operation is not needed. +

+

+ The default value for the property is psSolid. Setting a new value for the property cause the Changed method to be called to signal the OnChange event handler (when assigned).

@@ -3159,12 +3170,13 @@ Width for the Pen.

- Width is an - Integer property which contains the width for the pen. + Width is an Integer property which contains the width for the pen.

-

Setting a new value for the property causes the pen Reference to be re-created. The Changed method is called to signal the OnChange event handler (when assigned). The default value for the property is 1. +

+ Setting a new value for the property causes the pen Reference to be re-created. The Changed method is called to signal the OnChange event handler (when assigned). The default value for the property is 1.

-

Width is related to the Cosmetic property. A cosmetic pen has a width of 1. Setting Width to a value larger than 1 prevents using it as a cosmetic pen. +

+ Width is related to the Cosmetic property. A cosmetic pen has a width of 1. Setting Width to a value larger than 1 prevents using it as a cosmetic pen.

@@ -3460,10 +3472,10 @@ Contains a Reference to the handle allocated for the Brush.

- Reference is a read-only - TWSBrushReference property which contains a reference to the widgetset class used for the brush instance. It provides access to the Handle allocated for the brush resource, and is used in methods that need access to an existing brush handle. + Reference is a read-only TWSBrushReference property which contains a reference to the widgetset class used for the brush instance. It provides access to the Handle allocated for the brush resource, and is used in methods that need access to an existing brush handle.

-

Resources for the property are allocated (when needed) and initialized by calling the ReferenceNeeded method. The resources are freed in the FreeReference method. +

+ Resources for the property are allocated (when needed) and initialized by calling the ReferenceNeeded method. The resources are freed in the FreeReference method.

@@ -3475,17 +3487,13 @@

- Color is a - TColor property with the color used to draw the brush pattern indicated in the - Style property. It is the background or fill color when Style contains - bsSolid. Color is not used when Style is set to - bsClear; in fact, the brush style in - TFPCustomBrush ancestor is actually set to - bsSolid. + Color is a TColor property with the color used to draw the brush pattern indicated in the Style property. It is the background or fill color when Style contains bsSolid. Color is not used when Style is set to bsClear; in fact, the brush style in TFPCustomBrush ancestor is actually set to bsSolid.

-

Setting a new value for the property causes an existing brush handle in Reference to be freed, and the pattern image in Bitmap is discarded. +

+ Setting a new value for the property causes an existing brush handle in Reference to be freed, and the pattern image in Bitmap is discarded.

-

The default value for the property is clWhite. The default property value is restored when a new value is assigned to the Bitmap property. +

+ The default value for the property is clWhite. The default property value is restored when a new value is assigned to the Bitmap property.

diff --git a/docs/xml/lcl/lclversion.xml b/docs/xml/lcl/lclversion.xml index 6b6e6807d2..7396db3033 100644 --- a/docs/xml/lcl/lclversion.xml +++ b/docs/xml/lcl/lclversion.xml @@ -41,7 +41,7 @@ digits and concatenated (leading zeros are omitted). LCL major version.

-Given a complete version string like 2.0.12, the lcl_major constant +Given a complete version string like 2.2.0, the lcl_major constant contains the first number (2).

@@ -52,8 +52,8 @@ contains the first number (2). LCL minor version.

-Given a version string like 2.0.12, the lcl_minor constant -contains the second number (0). +Given a version string like 2.2.0, the lcl_minor constant +contains the second number (2).

lcl_version @@ -63,8 +63,8 @@ contains the second number (0). LCL release number.

-Given a version string like 2.0.12, the lcl_release constant -contains the third number (12). +Given a version string like 2.2.0, the lcl_release constant +contains the third number (0).

lcl_version @@ -74,9 +74,9 @@ contains the third number (12). LCL patch version.

-Given a complete version string like 2.0.12.1, the lcl_patch constant +Given a complete version string like 2.2.0.1, the lcl_patch constant contains the last number (1). If there is no fourth number, for example when the -version string is 2.0.12, then lcl_patch is 0. +version string is 2.2.0, then lcl_patch is 0.

lcl_version @@ -84,7 +84,7 @@ version string is 2.0.12, then lcl_patch is 0. LCL version string. -Contains the LCL version string, e.g. 2.0.12. +Contains the LCL version string, e.g. 2.2.0.