From 651303f114ab0aea090d649c57c41f5937025ece Mon Sep 17 00:00:00 2001 From: dsiders Date: Tue, 20 Dec 2022 04:30:16 +0000 Subject: [PATCH] Docs: LCL/graphics. Adds, updates topics with aliases to System.UITypes. Changes in 43d7f203. --- docs/xml/lcl/graphics.xml | 452 +++++++++++++++++++++++++++++++++----- 1 file changed, 401 insertions(+), 51 deletions(-) diff --git a/docs/xml/lcl/graphics.xml b/docs/xml/lcl/graphics.xml index 5d04e3a0da..561fc8d981 100644 --- a/docs/xml/lcl/graphics.xml +++ b/docs/xml/lcl/graphics.xml @@ -141,15 +141,30 @@ id="RGBToColor">RGBToColor. + + + -Represents pitches (or spacings) used in typefaces. + +Represents pitches (or spacings) used in typefaces. + -

Used to implement the Pitch member in TFontData and TFont. +

+Used to implement the Pitch member in TFontData and the Pitch property in +TFont.

+ +Modified in LCL 2.4 to be an alias to TFontPitch in System.UITypes for FPC +3.3.0 or higher. + + @@ -161,18 +176,35 @@ id="RGBToColor">RGBToColor. Font uses fixed pitch (or mono-spacing). + -Alias for the String type. + +Alias to the String type used to represent font names. +

TFontName is an alias for the String type. Not used in the current LCL implementation.

- + +Modified in LCL 2.4 to be an alias to TFontName in System.UITypes for FPC +3.3.0 or higher. + + + + + + + -Short String type used for typeface names. + +Short String type used for typeface names. +

TFontDataName is a Short String type used to represent @@ -185,24 +217,43 @@ Be aware that the definition can result in truncation of typeface names longer than 31 characters. + +Modified in LCL 2.4 to be an alias to TFontDataName in System.UITypes for FPC +3.3.0 or higher. + LF_FACESIZE + + -Represents font styles or variants. + +Represents styles or variants for a font. + -TFontStyle is an enumerated type with values used to represent a -style or variant for a typeface. Value(s) from TFontStyle are stored in the +TFontStyle is an enumerated type with values used to represent +styles or variants for a typeface. Value(s) from TFontStyle are stored in the TFontStyles and TFontStylesBase set types, and used to -implement the Style members in TFontData and -TFont. +implement the Style member in TFontData and the Style +property in TFont. + +Modified in LCL 2.4 to be an alias to TFontStyle in System.UITypes for FPC +3.3.0 or higher. + - + + @@ -211,27 +262,38 @@ implement the Style members in TFontData and Italic font style. - -Strike-out (or strike-through) font style. - Underline font style. + +Strike-out (or strike-through) font style. + + -Set type used to store TFontStyle value(s). + +Set type used to store TFontStyle value(s). +

TFontStyles is a set type used to store 0 (zero) or -more values from the -TFontStyle enumeration. +more values from the TFontStyle enumeration.

+ +Modified in LCL 2.4 to be an alias to TFontStyles in System.UITypes for FPC +3.3.0 or higher. + + + Set type used to store TFontStyle value(s). @@ -242,14 +304,25 @@ implement the Style member in TFontData and TFont.

+ +Modified in LCL 2.4 to be an alias to TFontStylesBase in System.UITypes for +FPC 3.3.0 or higher. + + + -Represents a font character set as a numeric value. + +Represents a font character set as a numeric value. +

TFontCharSet is a range type with values representing font @@ -263,11 +336,20 @@ used refer to constants defined in the widgetset interface. member in TFontData and TFont.

+ +Modified in LCL 2.4 to be an alias to TFontCharSet in System.UITypes for +FPC 3.3.0 or higher. + + + Font output quality, like anti-aliasing. @@ -291,9 +373,17 @@ bitmaps, like most East Asian fonts, do not use ClearType anti-aliasing. member in TFontData and TFont.

+ +Modified in LCL 2.4 to be an alias to TFontQuality in System.UITypes for FPC +3.3.0 or higher. + + @@ -301,28 +391,25 @@ member in TFontData and TFont. -Prefer other font features (size, style) against output quality. +Prefer other font features (size, style) against output quality. Appearance of +the font is less important than when fqProof is used. Generally offers lower +quality than fqProof or fqDefault. -Appearance of the font is less important than when fqProof is used. -Generally offers lower quality than fqProof or fqDefault. - -Prefer output quality against other font features (size, style). +Prefer output quality against other font features (size, style). Font quality +is more important exactly reproducing the size or style for the font. -Font quality is more important exactly reproducing the size or style -for the font. - Disable font anti-aliasing. -Use font anti-aliasing. -The font is always anti-aliased when supported, and the font size is -not too small or too large. - + +Use font anti-aliasing. The font is always anti-aliased when supported, and +the font size is not too small or too large. + Use ClearType font anti-aliasing when available. @@ -330,8 +417,10 @@ not too small or too large. Use Clear Type Natural font anti-aliasing when available. + -Contains information about a font used in an application. + +Contains information about a font used in an application.

@@ -350,19 +439,24 @@ in TFont. + The Operating System Handle for the Font. + The Height (in pixels) for the Font. + The Pitch (layout style) for the Font. + -The Style (or variant) for the Font. + +The Style (or variant) for the Font.

@@ -376,29 +470,32 @@ more information about the enumeration values and their meanings. + -The character set for a Font as an Integer value. + +The character set for a Font as an Integer value.

-CharSet is a -TFontCharSet member which stores an Integer identifier for a font -character set. Its value identifies the character set or encoding supported -in the font. +CharSet is a TFontCharSet member which stores an Integer +identifier for a font character set. Its value identifies the character set or +encoding supported in the font.

-

The actual value is specific to the Operating System and/or widgetset for -the application. For the Windows platform, it corresponds to the value in -TLogFont as retrieved from the Win32 GDI LogFont routine. Other -platforms and widgetsets rely on the mechanism native to the interface like: -X-Fonts, device contexts, or whatever API weirdness the Mac developers could -dream up. The native values are translated to to the value represented in the -member as an Integer. +

+The actual value is specific to the Operating System and/or widgetset for the +application. For the Windows platform, it corresponds to the value in TLogFont +as retrieved from the Win32 GDI LogFont routine. Other platforms +and widgetsets rely on the mechanism native to the interface like: X-Fonts, +device contexts, or whatever API weirdness the Mac developers could dream up. +The native values are translated to to the value represented in the member as +an Integer.

+ Output quality for the font. @@ -416,11 +513,182 @@ values and their meanings. + The Name (as a string) of the current Font. + + + + +Represents the fpDefault enumeration value in TFontPitch. + + + +Added in LCL 2.4 as an alias to the corresponding constant in System.UITypes +for FPC 3.3.0 or higher. + + + + + + +Represents the fpVariable enumeration value in TFontPitch. + + + +Added in LCL 2.4 as an alias to the corresponding constant in System.UITypes +for FPC 3.3.0 or higher. + + + + + + +Represents the fpFixed enumeration value in TFontPitch. + + + +Added in LCL 2.4 as an alias to the corresponding constant in System.UITypes +for FPC 3.3.0 or higher. + + + + + + +Represents the fsBold enumeration value in TFontStyle. + + + +Added in LCL 2.4 as an alias to the corresponding constant in System.UITypes +for FPC 3.3.0 or higher. + + + + + + +Represents the fsItalic enumeration value in TFontStyle. + + + +Added in LCL 2.4 as an alias to the corresponding constant in System.UITypes +for FPC 3.3.0 or higher. + + + + + + +Represents the fsUnderline enumeration value in TFontStyle. + + + +Added in LCL 2.4 as an alias to the corresponding constant in System.UITypes +for FPC 3.3.0 or higher. + + + + + + +Represents the fsStrikeout enumeration value in TFontStyle. + + + +Added in LCL 2.4 as an alias to the corresponding constant in System.UITypes +for FPC 3.3.0 or higher. + + + + + + +Represents the fqDefault enumeration value in TFontQuality. + + + +Added in LCL 2.4 as an alias to the corresponding constant in System.UITypes +for FPC 3.3.0 or higher. + + + + + + +Represents the fqDraft enumeration value in TFontQuality. + + + +Added in LCL 2.4 as an alias to the corresponding constant in System.UITypes +for FPC 3.3.0 or higher. + + + + + + +Represents the fqProof enumeration value in TFontQuality. + + + +Added in LCL 2.4 as an alias to the corresponding constant in System.UITypes +for FPC 3.3.0 or higher. + + + + + + +Represents the fqNonAntialiased enumeration value in TFontQuality. + + + +Added in LCL 2.4 as an alias to the corresponding constant in System.UITypes +for FPC 3.3.0 or higher. + + + + + + +Represents the fqAntialiased enumeration value in TFontQuality. + + + +Added in LCL 2.4 as an alias to the corresponding constant in System.UITypes +for FPC 3.3.0 or higher. + + + + + + +Represents the fqCleartype enumeration value in TFontQuality. + + + +Added in LCL 2.4 as an alias to the corresponding constant in System.UITypes +for FPC 3.3.0 or higher. + + + + + + +Represents the fqCleartypeNatural enumeration value in TFontQuality. + + + +Added in LCL 2.4 as an alias to the corresponding constant in System.UITypes +for FPC 3.3.0 or higher. + + + + Default font data used for new TFont instances. @@ -435,6 +703,7 @@ example, there can be a different default font for a button and a group box. + Represents the text layout used to render text in its rectangle. @@ -459,6 +728,7 @@ implement the Layout member in TTextStyle. Text is aligned to the bottom of the text rectangle. + The Style of the Text to be drawn in a rectangle. @@ -487,7 +757,7 @@ characters and do not result in line breaks.

- + @@ -556,6 +826,7 @@ is added to the end of the text value. Preference is given to + Represents the solid pen style. @@ -564,6 +835,7 @@ is added to the end of the text value. Preference is given to + Represents the dashed pen style. @@ -572,6 +844,7 @@ is added to the end of the text value. Preference is given to + Represents the dotted pen style. @@ -580,6 +853,7 @@ is added to the end of the text value. Preference is given to + Represents the dash-dot pattern pen style. @@ -588,6 +862,7 @@ is added to the end of the text value. Preference is given to + Represents the dash-dot-dot pattern pen style. @@ -596,6 +871,7 @@ is added to the end of the text value. Preference is given to + Represents the clear pen style. @@ -604,6 +880,7 @@ is added to the end of the text value. Preference is given to + Represents the pen style used for an inside frame. @@ -612,6 +889,7 @@ is added to the end of the text value. Preference is given to + Represents a pattern pen style. @@ -620,6 +898,7 @@ is added to the end of the text value. Preference is given to + Represents the Black pen mode. @@ -628,6 +907,7 @@ Pixels affected by the pen are always set to black.

+ Represents the White pen mode. @@ -636,6 +916,7 @@ Pixels affected by the pen are always set to white.

+ Represents the No OP pen mode. @@ -645,6 +926,7 @@ Pixels affected by the pen are unchanged.

+ Represents the NOT pen mode. @@ -653,6 +935,7 @@ Pixels affected by the pen are set to the inverse for the current color.

+ Represents the Copy pen mode. @@ -661,6 +944,7 @@ Pixels affected by the pen are set to the pen color.

+ Represents the Not Copy pen mode. @@ -669,6 +953,7 @@ Pixels affected by the pen are set to the inverse of the pen color.

+ Represents the Merge Pen Not pen mode. @@ -678,6 +963,7 @@ inverse of the pixel color.

+ Represents the Mask Pen Not pen mode. @@ -687,6 +973,7 @@ inverse of the pixel color.

+ Represents the Merge Not Pen pen mode. @@ -696,6 +983,7 @@ inverse of the pixel color.

+ Represents the Mask Not Pen pen mode. @@ -705,6 +993,7 @@ the inverse of the pen color and the current pixel color.

+ Represents the Merge pen mode. @@ -714,6 +1003,7 @@ current pixel color.

+ Represents the Not Merge pen mode. @@ -723,6 +1013,7 @@ pmMerge pen mode.

+ Represents the Mask pen mode. @@ -732,6 +1023,7 @@ pen color and the current pixel color.

+ Represents the Not Mask pen mode. @@ -741,6 +1033,7 @@ mode.

+ Represents the XOR pen mode. @@ -750,6 +1043,7 @@ current pixel color, but not both.

+ Represents the Not XOR pen mode. @@ -759,6 +1053,7 @@ pen mode.

+ Represents the Solid brush style. @@ -770,6 +1065,7 @@ Fills a shape using the color for the brush. + Represents the Clear brush style. @@ -781,6 +1077,7 @@ Fills a shape with transparency (using the existing color as the fill color). + Represents the Horizontal brush style. @@ -792,6 +1089,7 @@ Fills a shape with a pattern consisting of equidistant horizontal lines. + Represents the Vertical brush style. @@ -803,6 +1101,7 @@ Fills a shape with a pattern consisting of equidistant vertical lines. + Represents the FDiagonal brush style. @@ -815,6 +1114,7 @@ Fills a shape with a pattern consisting of equidistant lines drawn with a + Represents the BDiagonal brush style. @@ -827,6 +1127,7 @@ Fills a shape with a pattern consisting of equidistant lines drawn with a + Represents the Cross brush style. @@ -839,6 +1140,7 @@ horizontal and vertical cross-hatch. + Represents the DiagCross brush style. @@ -851,36 +1153,43 @@ degree cross-hatch. + Represents the Round pen end cap. Added in LCL version 2.6.3. + Represents the Square pen end cap. Added in LCL version 2.6.3. + Represents the Flat pen end cap. Added in LCL version 2.6.3. + Represents the Round pen join style. Added in LCL version 2.6.3. + Represents the Bevel pen join style. Added in LCL version 2.6.3. + Represents the Miter pen join style. Added in LCL version 2.6.3. + Alias for the TGraphicsFillStyle enumeration type in LazUtils. @@ -890,6 +1199,7 @@ degree cross-hatch. TGraphicsFillStyle + Represents Fill Mode values. @@ -905,6 +1215,7 @@ with the LazRegionFillMode type in lazregions.pas. + Type used to represent canvas copy modes. @@ -999,6 +1310,7 @@ Copy mode constants are omitted for the CAPTUREBLT and + Represents states values for TCanvas. @@ -1028,11 +1340,13 @@ Context (DC). + Set type used to store TCanvasStates values. + Represents orientations for a canvas. Not used in the current LCL implementation. @@ -1048,6 +1362,7 @@ Context (DC). + Alias for the TFPImgProgressStage type in the FCL. @@ -1055,6 +1370,7 @@ Alias for the TFPImgProgressStage type in the FCL. + TProgressEvent - for monitoring the progress of a drawing process. @@ -1063,6 +1379,7 @@ TProgressEvent - for monitoring the progress of a drawing process. + Represents storage formats for pixels in image data. @@ -1111,6 +1428,7 @@ TIconImage, TCustomIcon, et. al. Uses a pixel format other than the defined values. + Constant with the number of bits per pixel for TPixelFormat enumeration @@ -1129,6 +1447,7 @@ for the associated pixel format. + Represents transparency modes used in raster images. @@ -1221,10 +1540,12 @@ Transparency is determined by examining a designated pixel in the image data. + One of the special colors. + The default color of a given control. @@ -1241,6 +1562,7 @@ TControl.GetRGBColorResolvingParent. TControl.GetRGBColorResolvingParent + One of the System colors. @@ -1687,11 +2009,13 @@ other places for raised areas such as a panel. + Deprecated CLX color range. Do not use. + Deprecated CLX color enumeration. Do not use. @@ -1706,6 +2030,7 @@ other places for raised areas such as a panel. + Deprecated CLX color enumeration. Do not use. @@ -1779,11 +2104,13 @@ other places for raised areas such as a panel. + Class reference used to create new instances of TCustomBitmap. + Primitive ancestor class, mainly for Delphi compatibility. @@ -1799,6 +2126,7 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. + Changing - software emulation of @@ -1807,6 +2135,7 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. + Changed - software emulation of @@ -1815,6 +2144,7 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor. + Lock - method for locking the object, making it unavailable for @@ -1823,6 +2153,7 @@ changes. + UnLock - method for releasing locked object. @@ -1837,6 +2168,7 @@ changes. + OnChange - event handler for changed object. @@ -1844,6 +2176,7 @@ changes. + TFontHandleCacheDescriptor - descriptor for items in Font Handle @@ -1852,12 +2185,14 @@ Cache. + Contains the logical font information for the cache descriptor. + LongFontName - the long name for the Font. @@ -1865,6 +2200,7 @@ Cache. + TFontHandleCache - a resource cache for font handles. @@ -1872,6 +2208,7 @@ Cache. + Removes the specified resource item from the cache. @@ -1882,6 +2219,7 @@ Cache. Item removed from the resource cache. + Constructor for the class instance. @@ -1895,6 +2233,7 @@ to create new cache entries. + Compares the specified logical font names and font details. @@ -1914,6 +2253,7 @@ to create new cache entries. + FindFont - returns the Font specified by its handle as a cache @@ -1928,6 +2268,7 @@ item from the FontHandleCache. + FindFontDesc - returns the descriptor for the FontHandle using its @@ -1946,6 +2287,7 @@ item from the FontHandleCache. + Add the Font specified by its handle, @@ -1967,8 +2309,11 @@ item from the FontHandleCache. + -Represents a font used to draw text in an application. + +Represents a font used to draw text in an application. +

TFont is a TFPCustomFont descendant, and provides @@ -1988,6 +2333,8 @@ widgetset implementation.

+ + @@ -2002,6 +2349,7 @@ widgetset implementation. + Frees the widgetset font reference in the class instance. @@ -2028,6 +2376,7 @@ when the class instance is freed. + Gets the value for the Handle property. @@ -2038,6 +2387,7 @@ when the class instance is freed. Value for the property. + Gets the value for the FontData property. @@ -5339,7 +5689,7 @@ BitMap, PixMap, PNG, JPEG, GIF, TIFF or Icon image formats. LoadFromFile and SaveToFile are polymorphic. For example, if the TPicture is holding an Icon, you can LoadFromFile a bitmap file, whereas if the class is -TIcon you could only read .ICO files. +TIcon you could only read .ICO files.

  • @@ -7834,7 +8184,7 @@ Draws an arc over a specified angle along the circumference of a circle. along the circumference of a circle with given radius and center point.

    -X and Y contain the coordinates for the center of the +X and Y contain the coordinates for the center of the circle along which the arc is drawn.

    @@ -10382,7 +10732,7 @@ The MaskHandle is not created when: BitmapHandleNeeded calls CreateCompatibleBitmaps to get the handles for the bitmap and mask using a pointer to the raw image data, and creates a default handle if CreateCompatibleBitmaps is unsuccessful. UpdateHandles is called to -assign the new handles to BitmapHandle and MaskHandle (when used). +assign the new handles to BitmapHandle and MaskHandle (when used).

    BitmapHandleNeeded is called from the Draw method prior to performing @@ -10787,7 +11137,7 @@ valid stream could not be created for the image data.

    WriteData is an overridden method with support for writing a header with the size for the raw image data. WriteData re-implements the method, and does not -call the inherited method - but does call SaveToStream to +call the inherited method - but does call SaveToStream to complete the operation (just like the ancestor).

    @@ -16622,7 +16972,7 @@ Implements support for the TIFF (Tag Image File Format) graphic format.

    TTiffImage is a TFPImageBitmap descendant which implements support for the -TIFF (Tag Image File Format) image format. +TIFF (Tag Image File Format) image format.

    It is a raster graphics image format. TIFF is widely supported by scanning,