From f377516bef72660bfa39a187407a540f4aef4009 Mon Sep 17 00:00:00 2001 From: dsiders Date: Sat, 20 May 2023 20:53:55 +0100 Subject: [PATCH] Docs: LCL/graphics. Various updates and corrections. * Fixes invalid version admonitions (uses Lazarus version instead of FPC version). * Fixes grammar, questionable wording in various topics. * Updates content for Progress topics in TGraphic, TPicture. * Updates TProgressEvent topic, and removes stand-alone Progress topic. * Restores TODOs in commented See Also links. * Restores whitespace between topics to improve readability. --- docs/xml/lcl/graphics.xml | 1629 +++++++++++++++++++++++++++++-------- 1 file changed, 1294 insertions(+), 335 deletions(-) diff --git a/docs/xml/lcl/graphics.xml b/docs/xml/lcl/graphics.xml index de2af7c54b..58705f0583 100644 --- a/docs/xml/lcl/graphics.xml +++ b/docs/xml/lcl/graphics.xml @@ -142,7 +142,6 @@ id="RGBToColor">RGBToColor. - Represents pitches (or spacings) used in typefaces. @@ -161,7 +160,7 @@ Modified in LCL 2.4 to be an alias to TFontPitch in System.UITypes for FPC @@ -194,7 +193,7 @@ Modified in LCL 2.4 to be an alias to TFontName in System.UITypes for FPC @@ -224,7 +223,7 @@ Modified in LCL 2.4 to be an alias to TFontDataName in System.UITypes for FPC LF_FACESIZE @@ -250,7 +249,7 @@ Modified in LCL 2.4 to be an alias to TFontStyle in System.UITypes for FPC @@ -287,7 +286,7 @@ Modified in LCL 2.4 to be an alias to TFontStyles in System.UITypes for FPC @@ -312,7 +311,7 @@ FPC 3.3.0 or higher. @@ -343,7 +342,7 @@ FPC 3.3.0 or higher. @@ -359,7 +358,7 @@ font attributes are applied to output using a font.

There are situations where an enumeration value may not produce the desired -result. ClearType and ClearType Natural anti-aliasing algorithms are oriented +result. ClearType and ClearTypeNatural anti-aliasing algorithms are oriented to display usage. They cannot be applied to printed output in general. They are ignored for fonts that are not TrueType or OpenType fonts with TrueType outlines. Postscript Type 1 fonts, and Postscript OpenType fonts without @@ -380,7 +379,7 @@ Modified in LCL 2.4 to be an alias to TFontQuality in System.UITypes for FPC @@ -429,8 +428,9 @@ well as attributes for the font. Values in the record are read from the font file when its handle is assigned, or when the default font from the widgetset interface is assigned.

-

TFontData is the type used to implement the FontData property -in TFont. +

+TFontData is the type used to implement the FontData property in +TFont.

@@ -485,9 +485,9 @@ 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. +device contexts, or whatever API mechanism the MacOS developers currently have +in place. The native values are translated to to the value represented in the +member as an Integer.

@@ -499,13 +499,14 @@ an Integer. Output quality for the font.

-Quality is a -TFontQuality member which contains an enumeration value which -indicates the output quality for the font. The output quality determines how -carefully font attributes are applied to output using the font. +Quality is a TFontQuality member which contains an +enumeration value which indicates the output quality for the font. The output +quality determines how carefully font attributes are applied to output using +the font.

-

See TFontQuality for more information about the enumeration -values and their meanings. +

+See TFontQuality for more information about the enumeration values +and their meanings.

@@ -779,7 +780,8 @@ value is 8. Draws a single Ampersand characters as an accelerator key decoration. -

When set to True, the first Ampersand (&) +

+When set to True, the first Ampersand (&) character on a line is drawn as the decoration used for an accelerator key. The character after the Ampersand contains the key for the accelerator. When True, double Ampersand (&&) characters are required to @@ -791,7 +793,8 @@ draw an Ampersand character in the text. Causes a long line of text to be word-wrapped. -

When set to True, a line of text that is larger than the available +

+When set to True, a line of text that is larger than the available width in the rectangle is word-wrapped into multiple lines at word boundaries.

@@ -817,7 +820,8 @@ width in the rectangle is word-wrapped into multiple lines at word boundaries. Indicates if text is "ellipsified" when too long for its rectangle. -

If a line of text is too long to fit between left and right boundaries for +

+If a line of text is too long to fit between left and right boundaries for the text rectangle, the text is shortened and an Ellipsis (...) is added to the end of the text value. Preference is given to WordBreak when set. @@ -1143,9 +1147,10 @@ horizontal and vertical cross-hatch. Represents the DiagCross brush style. -

Alias for the TFPBrushStyle.bsDiagCross enumeration value in the FCL. -Fills a shape with a pattern consisting of equidistant lines drawn as a 45 -degree cross-hatch. +

+Alias for the TFPBrushStyle.bsDiagCross enumeration value in the FCL. Fills a +shape with a pattern consisting of equidistant lines drawn as a 45 degree +cross-hatch.

@@ -1192,37 +1197,37 @@ Added in LCL version 2.4.0. Represents the Round pen end cap. -Added in LCL version 2.6.3. +Added in LCL version 1.2.0. Represents the Square pen end cap. -Added in LCL version 2.6.3. +Added in LCL version 1.2.0. Represents the Flat pen end cap. -Added in LCL version 2.6.3. +Added in LCL version 1.2.0. Represents the Round pen join style. -Added in LCL version 2.6.3. +Added in LCL version 1.2.0. Represents the Bevel pen join style. -Added in LCL version 2.6.3. +Added in LCL version 1.2.0. Represents the Miter pen join style. -Added in LCL version 2.6.3. +Added in LCL version 1.2.0. @@ -1238,8 +1243,9 @@ Added in LCL version 2.4.0. Represents Fill Mode values. -

Not used in the current LCL implementation. Appears to have been replaced -with the LazRegionFillMode type in lazregions.pas. +

+Not used in the current LCL implementation. Replaced with the +LazRegionFillMode type in lazregions.pas.

@@ -1255,8 +1261,8 @@ with the LazRegionFillMode type in lazregions.pas. Type used to represent canvas copy modes.

-TCopyMode is an alias for the LongInt type. TCopyMode -is the type used to implement the CopyMode property in +TCopyMode is an alias for the LongInt type. TCopyMode is +the type used to implement the CopyMode property in TCanvas. Normally contains a value defined in the copy mode constants:

@@ -1409,11 +1415,96 @@ Alias for the TFPImgProgressStage type in the FCL. -TProgressEvent - for monitoring the progress of a drawing process. +Specifies an event handler for monitoring the progress of a drawing process. -Alias for the TFPImgProgressEvent type in the FCL. + +

+TProgressEvent is a alias for the TFPImgProgressEvent type in the +FCL. It specifies an event handler used to perform progress notifications for +computationally intensive (slow) operations such as loading, storing, or +transforming graphic image data. +

+

+The object procedure type (defined in fpimage.pp) includes the following +parameters: +

+ +
+
Sender
+
+Object instance for the notification. +
+ +
Stage
+
+Indicates whether the notification is to prepare for, process, or clean up +after a graphic operation. The first call for a graphic operation will be with +Stage = psStarting, to allow the event handler to allocate whatever +resources it needs to process subsequent progress notifications. After +Stage = psStarting, you are guaranteed that OnProgress +will be called again with Stage = psEnding to allow you to free +those resources, even if the graphic operation is aborted by an exception. +Zero or more calls to OnProgress with Stage = psRunning +may occur between the psStarting and psEnding calls. +
+ +
PercentDone
+
+The ratio of work done to work remaining, on a scale of 0 to 100. Values may +repeat or even regress (get smaller) in successive calls. +PercentDone is usually a guess, and the guess may be dramatically +altered as new information is discovered in decoding the image. The value of +this property could usefully be passed to a ProgressBar to show the user the +progress for the operation. Please note that the Byte type used for the +argument allows a value which can exceed 100. +
+ +
RedrawNow
+
+Indicates whether the graphic can or should be redrawn immediately. Useful +for showing successive approximations of an image as data is available +instead of waiting for all the data to arrive before drawing anything. Since +there is no message loop activity during graphic operations, you should call +Update to force a control to be redrawn immediately in the +OnProgress event handler. Redrawing a graphic when +RedrawNow = False could corrupt the image or cause +exceptions. +
+ +
R
+
+TRect instance with the area on an image that has been changed and needs to be +redrawn. +
+ +
Msg
+
+Optional text describing in one or two words what the graphic class is +currently working on. For example: "Loading", "Storing", "Reducing colors", +etc. The Msg string can also be empty. Msg strings +should be resourced for translation, should not contain trailing periods, and +should be used only for display purposes. (Do not use the construct: if Msg = +'Loading' then...). +
+ +
Continue
+
+Variable Boolean argument which indicates if the current operation can be +continued. Set Continue to False to notifiy the calling procedure that +the operation should be aborted. +
+
+ +

+TProgressEvent is the type used to implement the OnProgress property in +TGraphic and TPicture. +

 - + + + + + @@ -1618,7 +1709,7 @@ TControl.GetRGBColorResolvingParent. Background color for an edit control.

-The color of the background of a widget, for example a TEdit. This is usually +The color of the background for a widget, for example a TEdit. This is usually white. Don't confuse this with the background of a window, or form, which is given by clForm.

@@ -2157,6 +2248,7 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor.

+ @@ -2632,6 +2724,7 @@ from the EndUpdate method when the internal update count reaches + DoAllocateResources - calls inherited method then calls @@ -2640,6 +2733,7 @@ from the EndUpdate method when the internal update count reaches + DoCopyProps - calls inherited method; if From argument @@ -2659,6 +2753,7 @@ method. + Sets the value for the CharSet property. @@ -2669,6 +2764,7 @@ method. New value for the property. + Sets the value for the Color property. @@ -2689,6 +2785,7 @@ the TFPColor values used in ancestor class. New property value as a TFPColor type. + Gets the value for the Color property. @@ -2699,6 +2796,7 @@ the TFPColor values used in ancestor class. Value for the property. + Sets the value for an indexed style flag. @@ -2715,7 +2813,8 @@ helper for the class. Boolean value that indicates whether the TFontStyle value is included in or excluded from the style flags.

-

SetFlags is called when a new value is assigned to the Style +

+SetFlags is called when a new value is assigned to the Style property differs from the existing value.

@@ -2731,6 +2830,7 @@ property differs from the existing value. New value for the style flag at the specified position. + Sets the font Color to the specified TFPColor value. @@ -2751,6 +2851,7 @@ property differs from the existing value. TFPColor value applied to the Color property. + Sets the value for the Height property. @@ -2765,6 +2866,7 @@ property differs from the existing value. New value for the property. + Sets the value for the Name property. @@ -2775,20 +2877,24 @@ property differs from the existing value. New value for the property. + Sets the value for the Orientation property. + New value for the property. + Sets the value for the Pitch property. + @@ -2822,6 +2928,7 @@ method, performs the appropriate rounding and sets the New value for the property. + SetQuality - specify the quality. @@ -2833,6 +2940,7 @@ method, performs the appropriate rounding and sets the New value for the property. + Constructor for the class instance. @@ -2884,6 +2992,7 @@ The DelayAllocate property from the TFPCanvasHelper ancestor is set to TObject.Create + Destructor for the class instance. @@ -2898,6 +3007,7 @@ inherited destructor is called prior to exiting from the method. TPersistent.Destroy + Copies values from Source to the current class instance. @@ -2919,11 +3029,13 @@ is cast to TFont) or a TLogFont record instance. Logical font resource with values stored in the method. + Starts an update process for the class instance. + Finishes an update process for the class instance. @@ -2934,6 +3046,7 @@ is cast to TFont) or a TLogFont record instance. + HandleAllocated - returns True if a handle has been @@ -2945,10 +3058,12 @@ allocated. + Operating system Handle for the Font. -

Operating system Handle for the Font. +

+Operating system Handle for the Font.

@@ -2963,6 +3078,7 @@ allocated. + IsEqual - returns True if this Font is the same as the @@ -2979,15 +3095,16 @@ specified Font. Font instance to compare to the current class instance. + Indicates if the font uses fixed-width characters (monospace).

-IsMonoSpace is a read-only -Boolean property which indicates if the font is a monospaced font -with a fixed character width. The FontIsMonoSpace routine from the -LCL interface is called to get the property value, and uses the font handle -in Reference to retrieve the font data. +IsMonoSpace is a read-only Boolean property which +indicates if the font is a monospaced font with a fixed character width. The +FontIsMonoSpace routine from the LCL interface is called to get the +property value, and uses the font handle in Reference to retrieve +the font data.

@@ -2995,15 +3112,15 @@ in Reference to retrieve the font data. FontIsMonoSpace + Sets font properties to their default values.

-SetDefault is a procedure used to set properties in the font to -the values used in the -DefFontData variable. SetDefault calls -BeginUpdate to start an update process, and sets the values for -the following properties: +SetDefault is a procedure used to set properties in the font to the +values used in the DefFontData variable. SetDefault calls +BeginUpdate to start an update process, and sets the values for the +following properties:

  • Name
    • @@ -3014,9 +3131,10 @@ the following properties:
  • Style
  • Color
-

Color is set to clDefault when the UseCLDefault compiler -directive is defined. Otherwise, the value clWindowText is used in -the property. +

+Color is set to clDefault when the UseCLDefault compiler directive +is defined. Otherwise, the value clWindowText is used in the +property.

EndUpdate is called to finish the update process prior to exiting @@ -3029,6 +3147,7 @@ from the method. + Display density for the font. @@ -3054,6 +3173,7 @@ handler (when assigned). + Reference - References made to this Font. @@ -3073,6 +3193,7 @@ FreeReference method. + Indicates the character set used in the font. @@ -3095,6 +3216,7 @@ when Assign is called to copy values from another font instance. + Color used to render text using the font. @@ -3172,6 +3294,7 @@ the Name member in DefFontData. + Rotation for the current font in 1/10ths of a degree. @@ -3210,6 +3333,7 @@ The default value for the property is 0 (zero).

+ Pitch type of the Font. @@ -3229,6 +3353,7 @@ be re-created, and the Changed method is called to signal the + Output quality for the Font, such as anti-aliasing. @@ -3322,14 +3447,17 @@ re-created. The Change method is called to signal the OnChange event handler + Represents line drawing styles used when rendering to a canvas. -

TPenStyle is an alias for the TFPPenStyle type in the FCL. +

+TPenStyle is an alias for the TFPPenStyle type in the FCL.

+ Represents pen modes used when rendering to a canvas. @@ -3338,17 +3466,20 @@ re-created. The Change method is called to signal the OnChange event handler + Represents end cap styles used for a pen. -

TPenEndCap is an enumerated typed with values representing geometric -shapes used as end caps for a pen. End caps are applied to the starting and -ending points in a line segment. +

+TPenEndCap is an enumerated typed with values representing geometric shapes +used as end caps for a pen. End caps are applied to the starting and ending +points in a line segment.

-

TPenEndCap is the type used to implement the EndCap property in TPen. +

+TPenEndCap is the type used to implement the EndCap property in TPen.

-Added in LCL version 2.6.3. +Added in LCL version 1.2.0. @@ -3362,10 +3493,11 @@ ending points in a line segment. Flat (or blunt) end cap which does not extend beyond the point. + Represents join styles used between line segments. -Added in LCL version 2.6.3. +Added in LCL version 1.2.0. @@ -3377,12 +3509,13 @@ ending points in a line segment. Mitered angular shape used at join points. + Represents a pattern brush for a pen.

-TPenPattern is an array type used to store the sequence of -LongWord values that make up the pattern. TPenPattern is +TPenPattern is an array type used to store the sequence of +LongWord values that make up the pen pattern. TPenPattern is essentially a user-defined pen style.

TPenPattern is the type used to implement the Pattern property @@ -3393,6 +3526,7 @@ in TPen. + Cache descriptor for Pen Handles. @@ -3404,6 +3538,7 @@ in TPen. The Pattern for this pen. + TPenHandleCache - Resource Cache for Pen Handles. @@ -3479,6 +3614,7 @@ been added to the cache. + Represents a pen used to draw on a canvas. @@ -3500,6 +3636,8 @@ TPen is the type used to implement the Pen property in TCanvas. + + @@ -3507,6 +3645,7 @@ TPen is the type used to implement the Pen property in TCanvas. + Frees the Pen class reference and optionally removes it from the Pen resource @@ -3515,6 +3654,7 @@ cache. + Gets the value for the Handle property. @@ -3523,6 +3663,7 @@ cache. Value for the property. + Gets the value for the Reference property. @@ -3531,11 +3672,13 @@ cache. Value for the property. + Ensures that the Reference class is allocated and initialized. + Sets the value for the Cosmetic property. @@ -3546,6 +3689,7 @@ cache. New value for the property. + Sets the value for the Handle property. @@ -3557,6 +3701,7 @@ cache. New value for the property. + Performs actions needed to allocate resources for the class instance. @@ -3565,26 +3710,29 @@ Performs actions needed to allocate resources for the class instance.

DoAllocateResources is an overridden method used to allocate resources for the class instance. DoAllocateResources calls the inherited -method , and calls GetReference to initialize the -Reference property used in the class instance. +method , and calls GetReference to initialize the Reference +property used in the class instance.

+ Performs actions to free resources allocated for the class instance. -

Overridden. +

+Overridden. Calls FreeReference. -Calls the inherited method. +Calls the inherited method prior to exiting from the method.

+ Copies properties from the specified source to the class instance. @@ -3600,6 +3748,7 @@ Calls the inherited method. Canvas helper descendant with properties copied in the method. + Sets the value for the Color property. @@ -3610,6 +3759,7 @@ Calls the inherited method. New value for the property. + Sets the pen Color to the specified TFPColor value. @@ -3626,13 +3776,14 @@ applied to the Color property. + -SetEndCap - specified the type of end cap to be used for the pen, -if it is a geometric pen. +Specifies the type of end cap used for the pen if it is a geometric pen. -

Defined for FCL versions where the EndCap property is implemented. +

+Defined for FCL versions where the EndCap property is implemented.

@@ -3640,12 +3791,13 @@ if it is a geometric pen. New value for the property. + Sets the value for the JoinStyle property.

-SetJoinStyle - specifies the style to be used by the geometric pen -when lines join (at corners etc). +SetJoinStyle specifies the style used on a geometric pen when lines +join (at corners etc).

@@ -3653,6 +3805,7 @@ when lines join (at corners etc). New value for the property. + Sets the value for the Mode property. Overridden write access specifier. @@ -3664,10 +3817,12 @@ when lines join (at corners etc). New value for the property. + Sets the value for the Style property. -

Overridden write access specifier. +

+Overridden write access specifier for the Style property.

@@ -3677,10 +3832,12 @@ when lines join (at corners etc). New value for the property. + Sets the value for the Width property. -

Overridden write access specifier. +

+Overridden write access specifier for the Width property.

@@ -3690,14 +3847,13 @@ when lines join (at corners etc). New value for the property. + Constructor for the class instance.

Create is the overridden constructor for TPen. It calls the -inherited -Create method, and sets the default values for properties -including: +inherited Create method, and sets the default values for properties including:

  • DelayAllocate
    • @@ -3714,26 +3870,26 @@ including: TObject.Create + Destructor for the class instance.

    -Destroy is the destructor for -TPen. It frees resource in Reference and calls the inherited -Destroy method. +Destroy is the destructor for TPen. It frees resources +in Reference and calls the inherited Destroy method.

    TPersistent.Destroy     + Copies property values from the specified persistent object.

    Assign is an overridden method used to copy property values from -the persistent object in -Source to the current class instance. +the persistent object in Source to the current class instance.

    Source is the TPersistent class instance with the property values copied in the method. If Source is a TPen instance, the @@ -3748,56 +3904,58 @@ Otherwise, the inherited method is called. Persistent object with values copied in the method. + The Operating System Handle for the current Pen.

    -Handle is a -HPEN property with the handle allocated for the pen by the -operating system or widgetset. 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). +Handle is a HPEN property with the handle allocated for +the pen by the operating system or widgetset. 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 Handle property has been marked as deprecated. Use the Reference -property to access the Handle for the pen. + +The Handle property has been marked as deprecated. Use the Reference property +to access the Handle for the pen.     + A Reference made to this Pen.

    -Reference is a read-only -TWSPenReference property which provides a reference to the class -allocated for the pen by a widgetset class. Use -Reference to access the handle allocated for the pen resource. +Reference is a read-only TWSPenReference property which +provides a reference to the class allocated for the pen by a widgetset class. +Use Reference to access the handle allocated for the pen resource.

    + Gets the Pattern used in the Pen.

    -GetPattern is a -TPenPattern function used to get Pattern for the pen. Use -SetPattern to assign the Pattern used for the pen. +GetPattern is a TPenPattern function used to get Pattern +for the pen. Use SetPattern to assign the Pattern used for the pen.

    -Please note that the Pattern property in the TFPCustomPen ancestor -class uses a different type (LongWord instead of TPenPattern). + +Please note that the Pattern property in the TFPCustomPen ancestor class uses +a different type (LongWord instead of TPenPattern).     + SetPattern - specifies the pattern for the pen. @@ -3809,27 +3967,30 @@ type. The property in the ancestor class uses the LongWord type. + The Color of the current Pen.

    -Color is a -TColor property which contains the color used by the pen to draw -on a canvas. The default value for the property is +Color is a TColor property which contains the color used +by the pen to draw on a canvas. The default value for the property is clBlack.

    + -Whether the Pen is Cosmetic, or non-geometric. + +Indicates whether the Pen is Cosmetic (non-geometric). +

    Cosmetic is a Boolean property which indicates whether -the pen is a Cosmetic one. When set to False, it is a Geometric Pen. +the pen is a Cosmetic one. When set to False, it is a Geometric pen.

    -A Pen can be either Cosmetic or Geometric. A cosmetic pen is always 1 pixel +A pen can be either Cosmetic or Geometric. A cosmetic pen is always 1 pixel wide, while a geometric pen can have any width. The width of a geometric pen is defined in world units and thus depends on transforms (scaling, rotation, shear, reflection) applied to a canvas. Operations using a cosmetic pen are @@ -3845,38 +4006,45 @@ be re-created. The Changed method is called to signal the

    + The sort of EndCap used on the Pen. -

    The end cap can be Round, Square or Flat. When end caps are round, the -last points are drawn round. When end caps are square, the last points are -drawn square. When end caps are flat, the last points are not drawn at all. +

    +The end cap can be Round, Square or Flat. When end caps are round, the last +points are drawn with a rounded shape. When end caps are square, the last +points are drawn with a square aspect. When end caps are flat, the last points +are not drawn at all.

    -Added in LCL version 2.6.3. +Added in LCL version 1.2.0.     + JoinStyle - the style of joint where two lines meet or cross. -

    The join style can be: Round, Bevel or Miter. When style is Round, then -line joins are round. When style is Bevel, then line joins are beveled. When -style is Miter, then line joins are mitered. +

    +The join style can be: Round, Bevel or Miter. When style is Round, then +line joins use a rounded shape. When style is Bevel, then line joins are +beveled at their intersection. When style is Miter, then line joins are +mitered at their intersection.

    -Added in LCL version 2.6.3. +Added in LCL version 1.2.0.     + Pen mode for the class instance.

    -Mode is a TFPPenMode property which contains the pen mode used in the class -instance. A pen mode indicates the raster operation performed to combine the -pen color with existing pixels in the destination bitmap. Mode can contain -any of the values: +Mode is a TFPPenMode property which contains the pen +mode used in the class instance. A pen mode indicates the raster operation +performed to combine the pen color with existing pixels in the destination +bitmap. Mode can contain any of the values:

    pmBlack
    @@ -3886,8 +4054,9 @@ any of the values:
    pmNop
    Pixels affected by the pen are unchanged.
    pmNot
    -
    Pixels affected by the pen are set to the inverse for the current -color.
    +
    +Pixels affected by the pen are set to the inverse for the current color. +
    pmCopy
    Pixels affected by the pen are set to the pen color.
    pmNotCopy
    @@ -3950,12 +4119,13 @@ The default value for the property is pmCopy. + Contains the line drawing style for the pen.

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

    • psSolid
      • @@ -3963,14 +4133,14 @@ and can contain one of the following values:
    • psDot
    • psDashDot
    • psDashDotDot
      • -
    • psinsideFrame
      • +
    • psInsideFrame
    • psPattern
    • psClear

    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. +available if Width has any value other than 1.

    psInsideFrame uses a solid drawing style, and a Color dithered to one of the @@ -3984,13 +4154,19 @@ 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). +for the property causes the handle in Reference to be freed. The Changed +method is called to signal the OnChange event handler (when assigned).

    + + + + +     + -Width for the Pen. +Width for lines drawn using the Pen.

    Width is an Integer property which contains the width @@ -4010,31 +4186,85 @@ using it as a cosmetic pen. + Represents the pattern for a Brush. -

    TBrushStyle is an alias for TFPBrushStyle from the FCL. Brush style -constants are defined in the LCL, and includes: +

    +TBrushStyle is an alias for the TFPBrushStyle type from the FCL. Brush style +constants defined in the LCL include: +

    +
    +
    bsSolid
    +
    +Fills a shape with the color for the brush. +
    + +
    bsClear
    +
    +Fills a shape with transparency (using the existing color as the fill color). +
    + +
    bsHorizontal
    +
    +Fills a shape with a pattern consisting of equidistant horizontal lines. +
    + +
    bsVertical
    +
    +Fills a shape with a pattern consisting of equidistant vertical lines. +
    + +
    bsFDiagonal
    +
    +Fills a shape with a pattern consisting of equidistant lines drawn with a +45-degree downward, left-to-right hatch. +
    + +
    bsBDiagonal
    +
    +Fills a shape with a pattern consisting of equidistant lines drawn with a +45-degree upward, left-to-right hatch. +
    + +
    bsCross
    +
    +Fills a shape with a pattern consisting of equidistant lines drawn as a +horizontal and vertical cross-hatch. +
    + +
    bsDiagCross
    +
    +Fills a shape with a pattern consisting of equidistant lines drawn as a 45 +degree cross-hatch. +
    + +
    bsImage
    +
    +Fills a shape with a user-specified image (bitmap). +
    + +
    bsPattern
    +
    +Fills a shape with a user-specified pattern (bitmap). +
    +
    +

    +The constant values are assigned to the Style property in TBrush.

    -
      -
    • bsSolid
      • -
    • bsClear
      • -
    • bsHorizontal
      • -
    • bsVertical
      • -
    • bsFDiagonal
      • -
    • bsBDiagonal
      • -
    • bsCross
      • -
    • bsDiagCross
      • -
     - + + +     + TBrushHandleCache - resource cache for Brush Handles. + Deletes the widgetset object with the handle in Item and removes it from the resource cache. @@ -4054,6 +4284,7 @@ from the resource cache. TObject.Create + The Brush to be used to Paint on the current Canvas. @@ -4074,6 +4305,7 @@ A Brush is typically used to fill an enclosed area on the Frees the widgetset reference for the Brush. + Gets the value for the Handle property. @@ -4082,6 +4314,7 @@ A Brush is typically used to fill an enclosed area on the + Gets the value for the Reference property. @@ -4090,6 +4323,7 @@ A Brush is typically used to fill an enclosed area on the + Gets the value for the Color property. @@ -4098,6 +4332,7 @@ A Brush is typically used to fill an enclosed area on the + Ensures that resources are allocated for the Reference property. @@ -4105,6 +4340,7 @@ Ensures that resources are allocated for the Reference property. + Sets the value for the Handle property. @@ -4113,6 +4349,7 @@ Ensures that resources are allocated for the Reference property. New value for the property. + Performs action needed when the Brush is changed. @@ -4121,48 +4358,69 @@ Ensures that resources are allocated for the Reference property. + -DoAllocateResources - calls inherited method then calls -GetReference. +Performs actions needed to allocate (or reallocate) resources for the brush +instance. - + + + + + -DoDeAllocateResources - frees reference then calls inherited -method. +Performs actions to free resources allocated for the brush instance. + -DoCopyProps - if the -From argument is another -Brush, frees reference before calling inherited method, then sets -the -Changed property. +Copies properties from the specified FCL brush into the current class instance. - + +

    +DoCopyProps is an overridden method in TBrush used to +copy properties from the brush instance in From to the current +brush instance. If From is derived from TBrush, it ensures that the Handle in +Reference is freed prior to copying values and calls the Changed method when +the operation has been completed. +

    +

    +DoCopyProps calls the inherited method to copy values for the Style, Image, +and Color properties. +

    +

    +DoCopyProps is called from the CopyBrush method in the ancestor class. +

    +         - + +TFPCanvasHelper instance with the properties copied in the method. + + Sets the value for the Color property. -

    An overloaded variant provides both TColor and -TFPColor values. It is used to set the color by calling the -SetFPColor method in the ancestor class. No actions are performed -in the method when the values in Color and FPColor have -not been changed and the brush Style contains bsClear. +

    +An overloaded variant provides both TColor and TFPColor +values. It is used to set the color by calling the SetFPColor +method in the ancestor class. No actions are performed in the method when the +values in Color and FPColor have not been changed and +the brush Style contains bsClear.

    -

    Frees the brush handle in the References property, and sets the +

    +Frees the brush handle in the References property, and sets the value in Bitmap to Nil. Calls the inherited -SetStyle method when Style is bsClear. Calls Changed to +SetStyle method when Style is bsClear. Calls Changed to signal the OnChange event handler (when assigned).

    @@ -4182,16 +4440,14 @@ signal the OnChange event handler (when assigned). TFPColor value applied to the brush Color. + Sets the Brush color to the specified TFPColor value.

    -SetFPColor is an overridden method used to set the color using the -TFPColor value in -AValue. Calls -FPColorToTColor to convert AValue to a -TColor value, and applies it to the -Color property. +SetFPColor is an overridden method used to set the color using the +TFPColor value in AValue. Calls FPColorToTColor to +convert AValue to a TColor value, and applies it to the Color property.

    @@ -4203,6 +4459,7 @@ signal the OnChange event handler (when assigned). Color value applied to the Color property. + Sets the value for the Bitmap property. @@ -4213,6 +4470,7 @@ signal the OnChange event handler (when assigned). New value for the property. + Sets the value for the Style property. @@ -4223,8 +4481,10 @@ signal the OnChange event handler (when assigned). New value for the property. + -Copies values from Source to the current brush instance. + +Copies values from Source to the current brush instance.

    @@ -4239,6 +4499,7 @@ signal the OnChange event handler (when assigned). Brush instance with values copied in the method. + Constructor for the class instance. @@ -4258,7 +4519,8 @@ new value. to apply the value in ancestor classes.

    -

    Create sets the value in DelayAllocate to True to defer +

    +Create sets the value in DelayAllocate to True to defer resource allocation until the brush is used. The internal counter used to track updates is reset.

    @@ -4267,20 +4529,21 @@ track updates is reset. TObject.Create     + Destructor for the class instance.

    Destroy is the overridden destructor for the class instance. -Destroy frees the handle for the brush in the -Reference property, and calls the inherited destructor prior to -exiting from the method. +Destroy frees the handle for the brush in the Reference property, +and calls the inherited destructor prior to exiting from the method.

    TPersistent.Destroy     + Compares the specified Brush to the current class instance. @@ -4288,20 +4551,21 @@ exiting from the method. -True when the brush properties match the values in the current class -instance. +True when the properties from the specified brush match the values in +the current class instance. Brush instance compared to the current class. + Bitmap with the pattern for the Brush.

    -Bitmap is a -TCustomBitmap property which contains the pattern used to draw the -brush, and is generally used to fill shapes or rectangular areas. +Bitmap is a TCustomBitmap property which contains the +pattern used to draw the brush, and is generally used to fill shapes or +rectangular areas.

    When assigned, the Bitmap image is used to draw the brush pattern instead of @@ -4312,26 +4576,33 @@ Handle for the brush is freed, and the Changed method is called to signal the OnChange event handler (when assigned).

    -The image in Bitmap will be discarded when a new value is assigned to the -Style property. +The image in Bitmap is discarded when a new value is assigned to the Style +property.

    + + + +     + Operating System handle for the brush.

    -Handle is a -HBRUSH property which contains the handle allocated for the brush. +Handle is a HBRUSH property which contains the handle +allocated for the brush.

    -Handle has been marked as deprecated. Use the Reference property to -access the handle for the brush. + +Handle has been marked as deprecated. Use the Reference property to access the +handle for the brush.     + Contains a Reference to the handle allocated for the Brush. @@ -4351,8 +4622,10 @@ FreeReference method. + -The Color of the current Brush. + +The Color of the current Brush.

    @@ -4380,14 +4653,14 @@ property. + -Indicates the pattern drawn for the brush. +Indicates the pattern drawn using the brush.

    -Style is a -TFPBrushStyle property which indicates the pattern drawn using the -brush. Style contains one of the enumeration values defined in the FCL. The -enumeration values are introduced as constants in the LCL, and includes: +Style is a TFPBrushStyle property which indicates the +pattern drawn using the brush. Style contains one of the enumeration values +defined in the FCL. The enumeration values are introduced as constants in the LCL, and include:

    • bsSolid
      • @@ -4398,15 +4671,19 @@ enumeration values are introduced as constants in the LCL, and includes:
    • bsBDiagonal
    • bsCross
    • bsDiagCross
      • +
    • bsImage
      • +
    • bsPattern
    -

    Setting a new value in Style causes the brush Handle in Reference to be -freed. The image in Bitmap is also discarded by setting the member to -Nil. The Changed method is called to signal the -OnChange event handler (when assigned). +

    +Setting a new value in Style causes the brush Handle in Reference to be freed. +The image in Bitmap is also discarded by setting the member to Nil. The +Changed method is called to signal the OnChange event +handler (when assigned).

    -

    The default value for the property is bsSolid. The value in -Style is automatically set to bsSolid when a value is assigned to -the Bitmap property. +

    +The default value for the property is bsSolid. The value in Style +is automatically set to bsSolid when a value is assigned to the +Bitmap property.

    @@ -4420,8 +4697,11 @@ the Bitmap property. + +     + Represents combination methods used for regions. @@ -4509,24 +4789,26 @@ output.

    -TRegion is a -TGraphicsObject descendant which represents shaped areas that can -be drawn, filled, or examined on a screen or canvas. The shaped areas can be -one or more rectangles, and can overlap. +TRegion is a TGraphicsObject descendant which represents +shaped areas that can be drawn, filled, or examined on a screen or canvas. The +shaped areas can be one or more rectangles, and can overlap.

    -

    Use AddRectangle to create and combine a new rectangular area -with the existing areas in the region. Each region has a Handle -which identifies the construct. It is modified when a new rectangular area is -added to the region. +

    +Use AddRectangle to create and combine a new rectangular area with +the existing areas in the region. Each region has a Handle which +identifies the construct. It is modified when a new rectangular area is added +to the region.

    -

    TRegion is the type used to implement the Region propriety in +

    +TRegion is the type used to implement the Region propriety in TCanvas, and passed as an argument to the SetShape method in TWinControl.

    -Some operating systems and widgetsets allow regions to be defined -with ellipses, rounded rectangles, and polygons as the sub-regions. TRegion -is limited to the rectangle with the area that is the bounding box for a -shape. See TLazRegion in LazRegions.pas and + +Some operating systems and widgetsets allow regions to be defined with +ellipses, rounded rectangles, and polygons as the sub-regions. TRegion is +limited to the rectangle with the area that is the bounding box for a shape. +See TLazRegion in LazRegions.pas and TLazCanvas in LazCanvas.pas for alternate implementations that provide these capabilities. @@ -4534,21 +4816,30 @@ implementations that provide these capabilities.     + Adds the specified operation to the region. -AddOperation is an empty implementation in the current LCL version. + +

    +AddOperation is an empty implementation in the current LCL version. +

         + Clears sub-regions defined for the region. -ClearSubRegions is an empty implementation in the current LCL version. + +

    +ClearSubRegions is an empty implementation in the current LCL version. +

         + Adds a sub-region with the specified handle to the region . @@ -4562,11 +4853,13 @@ implementations that provide these capabilities. + Frees the Region Reference in the class instance. + Gets the value for the Reference property. @@ -4577,6 +4870,7 @@ implementations that provide these capabilities. Value for the property. + Gets the value for the Handle property. @@ -4587,6 +4881,7 @@ implementations that provide these capabilities. Value for the property. + Ensures that resources are allocated in Reference for the region. @@ -4594,6 +4889,7 @@ Ensures that resources are allocated in Reference for the region. + Sets the value for the Handle property. @@ -4604,6 +4900,7 @@ Ensures that resources are allocated in Reference for the region. New value for the property. + Sets the value for the ClipRect property. @@ -4614,6 +4911,7 @@ Ensures that resources are allocated in Reference for the region. New value for the property. + Gets the value for the ClipRect property. @@ -4624,6 +4922,7 @@ Ensures that resources are allocated in Reference for the region. Value for the property. + Constructor for the class instance. @@ -4631,6 +4930,7 @@ Ensures that resources are allocated in Reference for the region. TObject.Create + Destructor for the class instance. @@ -4644,6 +4944,7 @@ the inherited destructor prior to exit. TPersistent.Destroy + Assign - if @@ -4658,17 +4959,21 @@ the inherited destructor prior to exit. Persistent object with properties copied in the method. + Convenience routine to add a rectangle to the region. -

    Gets a handle for the rectangular defined by the opposing corners with the -X1, Y1, X2, and Y2 coordinates. The new region handle is OR-ed with the -existing handle for the region. +

    +Gets a handle for the rectangular defined by the opposing corners with the X1, +Y1, X2, and Y2 coordinates. The new region handle is OR-ed with the existing +handle for the region.

    -

    Calls ReferenceNeeded to ensure that the handle for the region has been +

    +Calls ReferenceNeeded to ensure that the handle for the region has been allocated.

    -

    Discards the new region handle by calling DeleteObject. +

    +Discards the new region handle by calling DeleteObject.

    @@ -4689,11 +4994,13 @@ Horizontal coordinate for the opposing corner of the rectangular area. Vertical coordinate for the opposing corner of the rectangular area.     + The clipping rectangle for the region. + Operating System Handle for the region. @@ -4702,11 +5009,13 @@ Vertical coordinate for the opposing corner of the rectangular area. THandle + A Reference to the current Region. + Abstract base class used for images in supported image formats. @@ -4783,11 +5092,14 @@ passed as an argument to methods in TCanvas. + + + Performs action needed when the image data has changed. @@ -4810,6 +5122,7 @@ Changed is called when the value in Modified is changed from False to Object for the change notification. + Determines if the specified class instance is the same as the current class @@ -4829,6 +5142,7 @@ instance. TObject instance compared in the method. + DefineProperties finds out whether the object really is a binary @@ -4849,10 +5163,11 @@ TFiler instance used to read and write property values during component streaming. + -Method to Draw the Graphic on the specified Canvas, in the -specified Rectangle. +Method used to draw the Graphic on the specified Canvas, in the specified +Rectangle.

    @@ -4878,8 +5193,10 @@ graphic is drawn on the Canvas. Canvas coordinates where the graphic is drawn. + -Gets the value for the Empty property. + +Gets the value for the Empty property.

    @@ -4899,6 +5216,7 @@ specific image format. True when no data exists in the graphic. + Gets the value for the Height property. @@ -4909,6 +5227,7 @@ specific image format. Value for the property. + Gets the value for the MimeType property. @@ -4919,6 +5238,7 @@ specific image format. + Gets the value for the Palette property. @@ -4932,6 +5252,7 @@ specific image format. Value for the property. + Gets the value for the Transparent property. @@ -4942,6 +5263,7 @@ specific image format. Value for the property. + Gets the value for the Width property. @@ -4952,6 +5274,7 @@ specific image format. Value for the property. + Monitor the Progress of the drawing. @@ -4977,7 +5300,8 @@ as a Byte type, and will accept a value that exceeds 100. - + + @@ -5001,6 +5325,7 @@ as a Byte type, and will accept a value that exceeds 100. Indicates if the caller should continue the current operation. + ReadData - reads data for the Graphic from a stream. @@ -5023,6 +5348,7 @@ ReadData calls LoadFromStream to complete the operation. TStream instance where data for the graphic is stored. + Sets the value for the Height Property. @@ -5038,6 +5364,7 @@ in a descendent class. New value for the property. + Sets the value for the Palette property. @@ -5052,6 +5379,7 @@ SetPalette is an empty implementation in TGraphic. New value for the property. + Sets the value for the Transparent property. @@ -5067,6 +5395,7 @@ implemented in a descendent class. New value for the property. + Sets the value for the Width property. @@ -5082,6 +5411,7 @@ implemented in a descendent class. New value for the property. + Sets the value for the Modified property. @@ -5092,50 +5422,70 @@ implemented in a descendent class. Value for the property. + -WriteData - writes Graphic data to a stream. +Writes the data for the Graphic to a stream. - + +

    +Used by the TFiler instance for the class during LCL component streaming. +

    +         - + +TStream instance where the data for the class instance is written. + + -Checks if there really is a source to assign (if not, calls -Clear), then calls inherited method. +Implements object persistence for the TGraphic type. - + +

    +Assign is an overridden method in TGraphic. It ensures +that the inherited Assign method is not called if the object instance in +ASource has not been assigned. If ASource contains Nil, the +Clear method is called. If ASource has an assigned value, the inherited Assign +method is called to copy property values from ASource into the current class +instance. +

    +     + TPersistent.Assign     -Persistent object with values copied in the method. +Persistent object with property values copied in the method. + -Clear the resources used by the Graphic, leaving a blank -Graphic. +Clear has an empty implementation in TGraphic. +         + -Create - constructor for TGraphic: calls inherited -Create. +Constructor for the class instance. -This is a Virtual method; it is recommended that a constructor be -supplied to -override this method in descendent classes. +

    +Create is a virtual method in TGraphic; it is recommended that a +constructor be supplied to override this method in descendent classes. +

     -TObject.Create +TObject.Create     + Determines if the specified resource type is valid for the image format. @@ -5167,6 +5517,7 @@ Returns True when ResourceType is supported in the image format. The resource type examined in the method. + Reads data for the graphic from a file. @@ -5183,7 +5534,8 @@ Any existing image data in the class instance is discarded. An Exception can be raised in LoadFromStream if Filename does not contain a valid file name.

    -Raises an Exception if an invalid file name is passed to the method. + +Raises an Exception if an invalid file name is passed to the method. @@ -5197,14 +5549,15 @@ be raised in LoadFromStream if Filename does not contain a valid file name. The name of the file containing the graphic data. + Reads graphic data from a stream.

    LoadFromStream is an abstract virtual method used to load graphic -data from the stream instance specified in -Stream. It must be implemented in a descendent class to provide -support for reading a specific image format from the stream. +data from the stream instance specified in Stream. It must be +implemented in a descendent class to provide support for reading a specific +image format from the stream.

    LoadFromStream is used in the implementation of methods like: @@ -5225,6 +5578,7 @@ LoadFromStream is used in the implementation of methods like: TStream instance with the graphic data read in the method. + Loads the from the specified stream for the given MIME type. @@ -5252,6 +5606,7 @@ representing a specific image format. MIME type representing the stream content. + Load the graphic data from a Lazarus Resource (.lrs) file. @@ -5260,6 +5615,7 @@ representing a specific image format. Name of the .lrs file with the content loaded in the method. + Loads a resource with the specified name from the given handle. @@ -5293,8 +5649,10 @@ Use LoadFromLazarusResource to load a Lazarus resource from a Name for the resource loaded in the method. + -Load graphic data from a resource identified by the integer identifier + +Load graphic data from a resource identified by the integer identifier ResID. @@ -5338,6 +5696,7 @@ the resource type or the resource handle is invalid. Pointer to the Integer Resource ID for the resource. + LoadFromClipboardFormat - Replace the current image with the @@ -5358,6 +5717,7 @@ exception. + Load the data from the clipboard using the format type specified by @@ -5372,14 +5732,15 @@ Load the data from the clipboard using the format type specified by + Writes graphic data to the specified file name.

    SaveToFile is a procedure used to write the graphic data in the -class instance to the specified file name. -Filename is the fully-qualified file name on the local file system -where the data is stored, and may contain UTF-8-encoded characters. +class instance to the specified file name. Filename is the +fully-qualified file name on the local file system where the data is stored, +and may contain UTF-8-encoded characters.

    SaveToFile creates a temporary TFileStreamUTF8 instance that is @@ -5391,6 +5752,7 @@ used to write graphic data by calling the SaveToStream method. The name of the file where the graphic data is stored. + SaveToStream - write graphic data to a stream. @@ -5407,6 +5769,7 @@ support for a specific graphic format. Stream instance where the graphic data is stored. + SaveToClipboardFormats - Converts the image to a clipboard format. @@ -5422,6 +5785,7 @@ format it will generate an exception Identity of the clipboard format. + Saves the data to a clipboard of Type ClipboardType using the @@ -5436,6 +5800,7 @@ format FormatID. + Gets a list of supported MIME types for data used in the graphic. @@ -5446,6 +5811,7 @@ Gets a list of supported MIME types for data used in the graphic. + Gets the Integer Resource Type for the class instance. @@ -5469,6 +5835,7 @@ GetResourceType is used in the implementation of methods including: TResourceType value used in the class instance. + Returns a list of the file extensions available. @@ -5493,6 +5860,7 @@ TGraphic, the return value is always an empty string (''). File extensions supported for the graphic format used in the class. + Indicates whether the specified stream type is supported in the class. @@ -5529,6 +5897,7 @@ data into the class instance using the specified stream. Stream with content examined in the method. + Indicates if the graphic is empty (contains no data). @@ -5540,6 +5909,7 @@ when no image data exists for the graphic. + The native, unstretched height for the graphic. @@ -5558,6 +5928,7 @@ class to provide support for a specific graphic format. + Indicates if the graphic data in the class instance has been modified. @@ -5576,6 +5947,7 @@ Modified is updated when methods in descendent classes call the + MimeType - the MIME type of the graphic. @@ -5606,6 +5978,7 @@ example: + Event handler signalled when data in the class instance is changed. @@ -5630,6 +6003,7 @@ triggered the event notification. + Event handler signalled to track the progress of operations in the class @@ -5639,19 +6013,20 @@ instance.

    OnProgress is a TProgressEvent property with the event handler signalled to track the progress of operations in the class instance. -See the Progress topic for more detailed -information. +See the TProgressEvent topic for more +detailed information.

    Applications must assign an object procedure to the event handler to respond to progress notification messages. The Sender argument contains -the object with triggered the notification. +the object which triggered the notification.

    - +     + Handle to the color palette used in image data. @@ -5667,6 +6042,7 @@ a new value is not implemented. + Indicates whether the palette of colors been modified. @@ -5677,6 +6053,7 @@ Currently, it is used in the jvcllaz package in the + Indicates whether some parts of the image are not opaque. @@ -5689,6 +6066,7 @@ Indicates whether some parts of the image are not opaque. + TGraphicClass - class of TGraphic. @@ -5696,6 +6074,7 @@ Indicates whether some parts of the image are not opaque. + Implements a container for TGraphic and descendent classes. @@ -5805,9 +6184,12 @@ contents are discarded and a blank jpeg ( + + + Ensures that the Graphic property is an instance of the specified class. @@ -5838,6 +6220,7 @@ various supported image formats, like: Bitmap, Icon, Class type required in the Graphic member. + Gets the value for the Bitmap property. @@ -5856,6 +6239,7 @@ Calls ForceType to ensure that Graphic is a Value for the property. + Gets the value for the Icon property. @@ -5874,6 +6258,7 @@ Calls ForceType to ensure that Graphic is a Value for the property. + Gets the value for the Jpeg property. @@ -5892,6 +6277,7 @@ Calls ForceType to ensure that Graphic is a + Gets the value for the PNG property. @@ -5910,6 +6296,7 @@ Calls ForceType to ensure that Graphic is a Value for the property. + Gets the value for the PNM property. @@ -5928,6 +6315,7 @@ Calls ForceType to ensure that Graphic is a Value for the property. + Gets the value for the Pixmap property. @@ -5946,6 +6334,7 @@ Calls ForceType to ensure that Graphic is a Value for the property. + Gets the Height of the image stored in the Graphic property. @@ -5965,6 +6354,7 @@ Use Width to the width of the image in the Graphic property. Height of the image in the Graphic property. + Gets the width of the image stored in the Graphic property. @@ -5984,6 +6374,7 @@ Use Height to the height of the image in the Graphic property. Width of the image stored in the Graphic property. + Reads data for the persistent object during LCL streaming. @@ -6001,6 +6392,7 @@ ReadData is used by the TFiler instance for the class type. TStream instance with the data for the persistent object. + Sets the value for the Bitmap property. @@ -6018,6 +6410,7 @@ Calls SetGraphic to assign the new property value to the New value for the property. + Sets the value for the Icon property. @@ -6035,6 +6428,7 @@ Calls SetGraphic to assign the new property value to the New value for the property. + Sets the value for the Jpeg property. @@ -6051,6 +6445,7 @@ Calls SetGraphic to assign the new property value to the New value for the property. + Sets the value for the PNG property. @@ -6068,6 +6463,7 @@ Calls SetGraphic to assign the new property value to the New value for the property. + Sets the value for the PNM property. @@ -6085,6 +6481,7 @@ Calls SetGraphic to assign the new property value to the New value for the property. + Sets the value for the Pixmap property. @@ -6102,6 +6499,7 @@ property. New value for the property. + Sets the value for the Graphic property. @@ -6155,6 +6553,7 @@ a specific image format, like: New value for the property. + Writes data for the persistent object during LCL component streaming. @@ -6165,6 +6564,7 @@ Writes data for the persistent object during LCL component streaming. + AssignTo if Dest is the correct (Graphic) class type, @@ -6181,6 +6581,7 @@ calls Assign for Dest, otherwise calls inherited Persistent object where the values from the class instance are stored. + Performs actions needed when value(s) in the class instance have been @@ -6201,6 +6602,7 @@ in the method when OnChange has not been assigned (contains Nil). + Defines properties handled during LCL component streaming. @@ -6220,6 +6622,7 @@ internal method is used to determine whether binary data is available in the TFiler instance used to read and write the persistent object. + Monitors progress of a drawing process. @@ -6243,12 +6646,12 @@ No actions are performed in the method when OnProgress has not been assigned (contains Nil). In this scenario, DoContine returns True.

    -See Progress for more details on progress -monitoring. +See TProgressEvent for more details on progress monitoring.

    - + +     @@ -6272,6 +6675,7 @@ monitoring. + Loads values for the Graphic property from a stream using the specified class @@ -6286,6 +6690,7 @@ type. + Create - constructor for TPicture: performs inherited @@ -6307,6 +6712,7 @@ needed. TObject.Create     + Destroy - destructor for TPicture: frees graphic then @@ -6322,6 +6728,7 @@ in ancestor classes. TPersistent.Destroy + Clear - removes the Graphic in the class instance. @@ -6329,6 +6736,7 @@ in ancestor classes. + LoadFromClipboardFormat - Reads the picture from the handle @@ -6347,6 +6755,7 @@ If the format is not supported, an exception is generated. The identifier for the clipboard format. + Reads the picture from a clipboard of type ClipboardType using the @@ -6361,6 +6770,7 @@ format FormatID. + LoadFromFile - Reads a picture from disk. @@ -6380,6 +6790,7 @@ If the file extension is not recognized, an exception is raised. The name of the file containing the picture, stored as a string. + Loads content from the specified resource into the Graphic property. @@ -6431,6 +6842,7 @@ signal the OnChange event handler (when assigned). File name with resource retrieved in the method. + Loads a supported image format from the specified stream. @@ -6439,8 +6851,12 @@ signal the OnChange event handler (when assigned). + -Loads picture from a stream with a specified file extension. + +Loads the picture from a stream containing data for the specified file +extension. + @@ -6448,6 +6864,7 @@ signal the OnChange event handler (when assigned). + SaveToClipboardFormats - Allocates a global handle and writes the @@ -6467,6 +6884,7 @@ to by Formats and Datas or would be written if either Formats or Datas are Identity of the clipboard format. + SaveToFile - Writes the picture to disk. @@ -6477,6 +6895,7 @@ to by Formats and Datas or would be written if either Formats or Datas are The name of the file to save the picture, stored as a string. + Saves the graphic to the specified stream. @@ -6485,6 +6904,7 @@ to by Formats and Datas or would be written if either Formats or Datas are TStream instance where the graphic is stored. + Saves the graphic to a stream using the class type for the specified file @@ -6499,6 +6919,7 @@ extension. + SupportsClipboardFormat - Returns True if the given @@ -6511,6 +6932,7 @@ clipboard format is supported by LoadFromClipboardFormat. Identity of the clipboard format. + Assign - if the Source is a valid graphic type, copy the relevant @@ -6529,6 +6951,7 @@ most often in the implementation of TPicture properties. + Registers a new TGraphic class for use in LoadFromFile. @@ -6543,6 +6966,7 @@ Registers a new TGraphic class for use in LoadFromFile. + Registers a new TGraphic class for use in @@ -6557,6 +6981,7 @@ Registers a new TGraphic class for use in + Removes all references to the specified TGraphic. @@ -6572,6 +6997,7 @@ clipboard format internal lists. + Finds a graphic class with the named file extension Ext, and @@ -6590,6 +7016,7 @@ bitmap, the contents are discarded and a blank bitmap is returned. + Icon contained within the picture. @@ -6597,6 +7024,7 @@ bitmap, the contents are discarded and a blank bitmap is returned. + Jpeg - returns a JPEG image. @@ -6610,6 +7038,7 @@ blank JPEG is returned.

    + Pixmap - Returns a pixmap. @@ -6621,6 +7050,7 @@ pixmap, the contents are discarded and a blank pixmap is returned.

    + PNG - Returns a png. @@ -6633,6 +7063,7 @@ is returned.

    + PNM - a PortableAnyMapGraphic image. @@ -6647,22 +7078,26 @@ and a blank PNM is generated.

    + Graphic - The TGraphic object contained by the TPicture. + Height - The native, unstretched, height of the picture. + Width - The native, unstretched, width of the picture. + OnChange - Event handler for any change in the picture. @@ -6670,15 +7105,31 @@ and a blank PNM is generated. + -OnProgress - Event handler for monitoring progress in drawing the -picture. +Event handler signalled to track the progress of operations in the class +instance. + +

    +OnProgress is a TProgressEvent property with the event +handler signalled to track the progress of operations in the class instance. +See the TProgressEvent topic for more +detailed information. +

    +

    +Applications must assign an object procedure to the event handler to respond +to progress notification messages. The Sender argument contains +the object which triggered the notification. +

    +     + - +     + Base exception type for an error in a graphic operation. @@ -6692,6 +7143,7 @@ provides a means to handle any of the descendent exceptions, like     + EInvalidGraphic - exception handler for an invalid graphic. @@ -6699,6 +7151,7 @@ provides a means to handle any of the descendent exceptions, like + EInvalidGraphicOperation - exception handler for invalid graphic @@ -6707,6 +7160,7 @@ operation. + Represents fill directions for gradients. @@ -6718,6 +7172,7 @@ operation. Gradient fill direction is horizontally oriented. + Represents anti-aliasing modes used in TCanvas. @@ -6732,6 +7187,7 @@ operation. Disabled. + Represents text metrics used in the LCL. @@ -6817,6 +7273,8 @@ drawing operations using bitmap data. TControlCanvas + + @@ -6835,6 +7293,7 @@ drawing operations using bitmap data. + Performs actions needed when the Brush for the canvas is changed. @@ -6864,6 +7323,7 @@ BrushChanged is assigned as the OnChange event handler in the Brush instance generating the change notification. + Performs actions needed when the Font for the canvas is changed. @@ -6892,6 +7352,7 @@ FontChanged is assigned as the OnChange event handler in the Font instance generating the change notification. + Performs actions needed when the Pen for the canvas is changed. @@ -6918,6 +7379,7 @@ PenChanged is assigned as the OnChange event handler in the Pen instance generating the change notification. + Performs actions needed when the Region for the canvas is changed. @@ -6947,6 +7409,7 @@ RegionChanged is assigned as the OnChange event handler in the Region instance generating the change notification. + Gets the value for the Handle property. @@ -6957,6 +7420,7 @@ RegionChanged is assigned as the OnChange event handler in the Value for the property. + Sets the value for the AntialiasingMode property. @@ -6967,6 +7431,7 @@ RegionChanged is assigned as the OnChange event handler in the Value for the property. + Sets the value for the AutoRedraw property. @@ -6977,6 +7442,7 @@ RegionChanged is assigned as the OnChange event handler in the Value for the property. + Sets the value for the Font property. @@ -6987,6 +7453,7 @@ RegionChanged is assigned as the OnChange event handler in the New value for the property. + Sets the value for the Pen property. @@ -6997,6 +7464,7 @@ RegionChanged is assigned as the OnChange event handler in the New value for the property. + Sets the value for the Brush property. @@ -7007,6 +7475,7 @@ RegionChanged is assigned as the OnChange event handler in the New value for the property. + Sets the value for the Region property. @@ -7017,6 +7486,7 @@ RegionChanged is assigned as the OnChange event handler in the New value for the property. + Creates the TFont instance used as the default font for the canvas. @@ -7042,6 +7512,7 @@ been allocated for the Font property. TFont instance created in the method. + DoCreateDefaultPen - calls @@ -7055,6 +7526,7 @@ been allocated for the Font property. + DoCreateDefaultBrush - calls @@ -7068,6 +7540,7 @@ been allocated for the Font property. + Sets the value for the indexed Colors property. @@ -7091,6 +7564,7 @@ color value using the Pixels property. Color for the specified pixel. + Gets the Color for the pixel at the given coordinates as a TFPColor value. @@ -7116,6 +7590,7 @@ to convert the TColor value to the TFPColor type used in the return value. Vertical position for the pixel. + SetHeight should never be called for Canvas: raises an exception @@ -7130,6 +7605,7 @@ If called, raises an exception: 'TCanvas.SetHeight not allowed for LCL canvas. + GetHeight - if a handle has been allocated, returns the height @@ -7141,6 +7617,7 @@ from the device size. + SetWidth - should never be called; raises an exception if it is @@ -7155,6 +7632,7 @@ Raises an exception: 'TCanvas.SetWidth not allowed for LCL canvas' + Gets the value for the Width property. @@ -7168,6 +7646,7 @@ the value for the property is 0 (zero). Value for the property. + Moves the pen to the specified position. @@ -7182,6 +7661,7 @@ specified in Value. Does not call the inherited method. TPoint instance with the canvas coordinates for the pen. + Enters the critical section used to lock the canvas, and calls the inherited @@ -7190,6 +7670,7 @@ method. + Leaves the critical section used to lock the canvas, and calls the inherited @@ -7198,6 +7679,7 @@ method. + DoTextOut calls TextOut for the specified coordinates @@ -7217,6 +7699,7 @@ and string. + Calls TextExtent to find the width and height of the specified text. @@ -7235,6 +7718,7 @@ Calls TextExtent to find the width and height of the specified text. + DoGetTextHeight calls TextHeight to return the height @@ -7251,6 +7735,7 @@ of the text. + DoGetTextWidth calls TextWidth to return the width of @@ -7267,6 +7752,7 @@ the given text string. + DoRectangle calls Frame to draw a rectangle in the @@ -7280,6 +7766,7 @@ given bounds. + DoRectangleFill calls @@ -7293,6 +7780,7 @@ given bounds. + DoRectangleAndFill - calls Rectangle to draw a @@ -7306,6 +7794,7 @@ rectangle and fill it. + Draws an Arc of 360 degrees within the specified Bounds. @@ -7322,6 +7811,7 @@ rectangle and fill it. + DoEllipseFill calls Ellipse. @@ -7334,6 +7824,7 @@ rectangle and fill it. + DoEllipseAndFill calls the inherited DoEllipseAndFill. @@ -7344,6 +7835,7 @@ rectangle and fill it. + DoPolygon calls PolyLine to draw a series of lines @@ -7357,6 +7849,7 @@ through the points. + DoPolygonFill calls Polygon for the supplied points. @@ -7379,6 +7872,7 @@ through the points. + DoPolyline calls PolyLine. @@ -7391,6 +7885,7 @@ through the points. + Performs actions needed to draw a Bézier curve using the specified control @@ -7424,6 +7919,7 @@ Calls the PolyBezier method using the values in Points, is False. + DoFloodFill calls the FloodFill method. @@ -7439,6 +7935,7 @@ is False. + DoMoveTo calls the MoveTo method. @@ -7452,6 +7949,7 @@ is False. + DoLineTo calls the LineTo method. @@ -7484,6 +7982,7 @@ is False. + Verifies and copies the source canvas. @@ -7512,6 +8011,7 @@ warning to the debug output that copying is not supported + DoDraw checks that Image is of the right type, makes a @@ -7529,6 +8029,7 @@ local copy, creates the necessary handles and bitmaps for drawing. + Ignored in the current implementation of the class. @@ -7542,6 +8043,7 @@ Writes a message to debug output indicating the call is ignored. + Gets the default color value for the canvas. @@ -7553,6 +8055,7 @@ Writes a message to debug output indicating the call is ignored. Not used in the current implementation. + GetClipRect - if an error is encountered in finding the Clipping @@ -7564,6 +8067,7 @@ Rectangle dimensions, sets some defaults anyway. + Sets the value for the ClipRect property. @@ -7579,6 +8083,7 @@ converted values. New value for the property. + GetClipping returns True if clipping is being performed. @@ -7587,6 +8092,7 @@ converted values. + SetClipping specifies whether clipping is to be performed. @@ -7597,6 +8103,7 @@ converted values. + Gets the value for the indexed Pixels property. @@ -7613,6 +8120,7 @@ converted values. Vertical canvas coordinate for the pixel. + Ensures that the handle for the Brush is valid and configured with the Brush @@ -7637,6 +8145,7 @@ is set to OPAQUE. Otherwise, the TRANSPARENT background mode is used. + Ensures that the Font for the canvas is valid and uses the correct color. @@ -7655,6 +8164,7 @@ from the Font to the canvas Handle. + Creates a new Handle for the Canvas. @@ -7664,6 +8174,7 @@ CreateHandle has an empty implementation in TCanvas. + Ensures that the Pen for the canvas is valid, configured, and positioned. @@ -7694,6 +8205,7 @@ valid pen handle. + Ensures that the handle for the canvas Region is valid. @@ -7717,12 +8229,14 @@ CreateRegion is not used in the current LCL implementation. + Deselects all sub-handles in the current device context. + Implements the default OnChanging event handler used for the Pen in the canvas. @@ -7923,6 +8437,7 @@ operation which requires a specific canvas state (or handles). Required state flags. + Sets the value for the Handle property. @@ -7939,6 +8454,7 @@ Updates the state flags for the canvas. New value for the property. + SetInternalPenPos - specify position for the Pen. @@ -7949,8 +8465,9 @@ Updates the state flags for the canvas. + -Sets the value for the indexed Pixels property. +Sets a value in the indexed Pixels property. @@ -7965,6 +8482,7 @@ Updates the state flags for the canvas. New value for the indexed property. + Frees the Handle for the canvas. @@ -8021,11 +8539,13 @@ ancestor. + TryLock - examines the Lock state, and performs Lock if necessary. + Unlock or release a previously locked Canvas. @@ -8038,6 +8558,7 @@ ancestor. + Sets Pen, Brush, and Font handles to their default values. @@ -8049,6 +8570,7 @@ Brush, and Font are released. + Signals the OnChanging event handler (when assigned). @@ -8062,6 +8584,7 @@ canvas. + Signals the OnChange event handler (when assigned). @@ -8173,6 +8696,7 @@ Horizontal coordinate for the the ending radial point in the arc. Vertical coordinate for the the ending radial point in the arc. + Draws an elliptically curved line and updates the Pen position. @@ -9134,6 +9658,7 @@ values mean clockwise direction. Zero degrees is at the 3 o'clock position. + Pie draws a filled Pie-shaped wedge on the canvas. @@ -9171,6 +9696,7 @@ and ending radial-points between which the Bounding-Arc is drawn. + Polybezier draws cubic Bézier curves. @@ -9508,6 +10034,7 @@ handler (when assigned). Values written in the text output operation. + Draws text on the canvas at the specified location using the given style. @@ -9646,6 +10173,7 @@ return value for the method. Text measured in the method. + Gets the width for the specified text using the canvas Font. @@ -9826,6 +10354,7 @@ and Font handles to be reset to their default values. The + Text style attributes used to draw text on the canvas. @@ -9849,6 +10378,7 @@ record and their usage. + Controls anti-aliasing for canvas drawing operations. @@ -9868,6 +10398,7 @@ widgetset classes when a Handle has been allocated. + AutoRedraw - if True, the Canvas is to be redrawn @@ -9889,6 +10420,7 @@ The default value for the property is False. + The Brush used to paint on the Canvas. @@ -9920,6 +10452,7 @@ on the drawing surface. + Indicates the raster operation used to combine pixel colors on the drawing @@ -10007,6 +10540,7 @@ Copy mode constants are not provided for the CAPTUREBLT and + Contains the Font used to render text on the drawing surface. @@ -10034,6 +10568,7 @@ and TextFitInfo. + Height of the canvas. @@ -10065,6 +10600,7 @@ device, and are normally handled in classes which implement the canvas. GetDeviceSize + The Pen to be used for writing in this canvas. @@ -10103,6 +10639,7 @@ drawing surface. + The Region where the Canvas is located. @@ -10116,6 +10653,7 @@ See TRegion for more information. + The Width of the Canvas. @@ -10145,6 +10683,7 @@ device, and are normally handled in classes which implement the canvas. + Event handler signalled after a change to the canvas. @@ -10168,6 +10707,7 @@ a drawing operation. + Event handler signalled prior to changing the canvas. @@ -10175,7 +10715,7 @@ a drawing operation. OnChanging is a TNotifyEvent property which contains an event handler signalled before changing values in the canvas. The event handler is signalled (when assigned) from the Changing method, -which is called before start drawing operations that alter the +which is called before starting a drawing operation that alters the Pixels on the canvas.

    @@ -10191,6 +10731,7 @@ drawing operation is completed. + Specifies the base class for reference-counted shared images. @@ -10221,27 +10762,34 @@ TSharedImage is the ancestor for the TSharedRasterImage class. + + + Increases the reference count. + Decreases the reference count. + Release the handle for this image and free its resources. + The number of references to this shared image. + Indicates whether a handle been allocated for the image. @@ -10250,6 +10798,7 @@ TSharedImage is the ancestor for the TSharedRasterImage class. True when Handle is a non-zero value. + Represents handle types used for Bitmaps. @@ -10280,6 +10829,7 @@ property in TCustomBitmap and TSharedCustomBitmap. Device-Dependent Bitmap handle. + Implements a reference counted raster image that may be shared between @@ -10313,6 +10863,7 @@ No actions are performed in the method when the handle is already set to + ReleaseHandle - returns the identity of the handle that has just @@ -10340,6 +10891,7 @@ free the handle for its shared image. + Indicates if image content has been assigned for the shared image. @@ -10359,6 +10911,7 @@ is Nil. True if both the handle and the storage stream are not assigned. + Constructor for the class instance. @@ -10371,6 +10924,7 @@ constructor on entry. TObject.Create + Not implemented in the current LCL version. @@ -10386,6 +10940,7 @@ constructor on entry. + Destructor for the class instance. @@ -10396,6 +10951,7 @@ Calls the inherited destructor prior to exiting from the method. + Determines whether the Handle for the class has been allocated. @@ -10413,6 +10969,7 @@ The return value is True when the Handle contains a non-zero value. True when the handle for the shared image has been allocated. + Canvas used to render the bitmap for the raster image. @@ -10432,6 +10989,7 @@ which uses the shared image paradigm. It normally contains an instance of + SaveStream - the memory stream to be used for saving this image. @@ -10449,6 +11007,7 @@ maintained by the image class that uses the shared image paradigm (like + TSharedRasterImageClass - class of TSharedRasterImage. @@ -10462,6 +11021,7 @@ Class reference used to create new instances of TSharedRasterImage. + TRasterImage - base class for a number of graphic controls, @@ -10493,12 +11053,15 @@ specific image format. + + + Performs actions needed before the canvas is modified. @@ -10513,6 +11076,7 @@ prevent changes in copies. Object for the notification message. + Creates a Canvas for the raster image, and assigns its event handlers. @@ -10542,6 +11106,7 @@ member has not already been initialized. + Ensures that a mask bitmap is allocated, configured, and applied when needed. @@ -10574,6 +11139,7 @@ CreateMask is used in the implementation of the Mask method. Color used for transparent pixels in the image mask. + Frees the Device Context (DC) for the Canvas (when assigned). @@ -10605,6 +11171,7 @@ FreeCanvasContext is called when values in the BitmapHandle, + Gets the value for the Canvas property. @@ -10615,6 +11182,7 @@ FreeCanvasContext is called when values in the BitmapHandle, Value for the property. + Gets the value for the RawImage property. @@ -10630,6 +11198,7 @@ property. Value for the property. + Gets the value for the indexed ScanLine property. @@ -10643,6 +11212,7 @@ property. Ordinal position for the row of pixels in the raster image. + Gets the value for the TransparentColor property. @@ -10660,6 +11230,7 @@ property. + Value for the property. @@ -10668,6 +11239,7 @@ property. + CanShareImage - returns True if specified class of image @@ -10691,6 +11263,7 @@ shared. Class type requested in the method. + Changed - method to call when properties have changed. @@ -10719,6 +11292,7 @@ handler (when assigned). Object for the change notification. + Gets the default value for the Bitmap handle used in the class instance. @@ -10735,6 +11309,7 @@ instance. Not used in the current implementation. + Renders the image to the specified canvas. @@ -10778,6 +11353,7 @@ DestCanvas is called after the image is drawn. Canvas coordinates where the image is drawn. + Gets the value for the Empty property. @@ -10795,6 +11371,7 @@ for the class instance. Value for the property. + Gets the value for the Handle property. @@ -10812,6 +11389,7 @@ a valid handle in the shared raster image for the class instance. Value for the property. + Gets the value for the BitmapHandle property. @@ -10826,6 +11404,7 @@ implementation. Value for the property. + Gets the value for the Masked property. @@ -10834,6 +11413,7 @@ implementation. Value for the property. + Gets the value for the MaskHandle property. @@ -10848,6 +11428,7 @@ image type or implementation. Value for the property. + Gets the value for the MimeType property. @@ -10858,6 +11439,7 @@ image type or implementation. Value for the property. + GetPixelFormat - returns the pixel format for the Image. @@ -10868,6 +11450,7 @@ image type or implementation. Value for the property. + Gets a pointer with the raw image data. @@ -10881,6 +11464,7 @@ class to provide support for a specific image format. + Gets a pointer to the metadata for the raw image data. @@ -10894,6 +11478,7 @@ class to provide support for a specific image format. + Gets the value for the Transparent property. @@ -10907,6 +11492,7 @@ class to provide support for a specific image format. Value for the property. + Gets the class reference used to create new shared image instances in the class. @@ -10930,6 +11516,7 @@ is the request image type is the one used in the current class instance. Class reference used to create the shared image in the class. + Gets the value for the Height property. @@ -10941,6 +11528,7 @@ is the request image type is the one used in the current class instance. Value for the property. + Gets the value for the Width property. @@ -10952,6 +11540,7 @@ is the request image type is the one used in the current class instance. Value for the property. + Ensures that handles for the image and mask are valid for the raw image data. @@ -10985,6 +11574,7 @@ Canvas creates a new DC (Device Context). + Ensures that a handle for the image is allocated in widgetset classes. @@ -10997,6 +11587,7 @@ class. + Ensures that a handle is allocated for the image mask (when needed). @@ -11009,6 +11600,7 @@ class. + Ensures that a handle for the palette is allocated. @@ -11019,6 +11611,7 @@ class. + InternalReleaseBitmapHandle - releases Bitmap Handle and returns @@ -11035,6 +11628,7 @@ class. + InternalReleaseMaskHandle - releases Mask Handle and returns its @@ -11051,6 +11645,7 @@ class. + InternalReleasePalette - releases Palette Handle and returns its @@ -11067,6 +11662,7 @@ class. + Sets the value for the BitmapHandle property. @@ -11077,6 +11673,7 @@ class. New value for the property. + Sets the value for the Masked property. @@ -11087,6 +11684,7 @@ class. New value for the property. + Sets the value for the MaskHandle property. @@ -11097,6 +11695,7 @@ class. New value for the property. + Sets the value for the Transparent property. @@ -11107,6 +11706,7 @@ class. New value for the property. + Unshares a shared image when its handle is changed or the save stream is freed. @@ -11123,6 +11723,7 @@ abstract virtual method. Must be implemented in a descendent class. + Updates image handles when the raw image data is loaded. @@ -11145,6 +11746,7 @@ be implemented in a descendent class. Handle for the Mask. + Ensures that the save stream for the shared image is allocated. @@ -11170,6 +11772,7 @@ save stream. + Frees the save stream assigned to the internal shared image. @@ -11192,6 +11795,7 @@ FreeSaveStream is used in the implementation of methods like: + Reads image data during component streaming. @@ -11222,6 +11826,7 @@ ReadData calls LoadFromStream to complete the operation. Stream with the raw image data read in the method. + ReadStream - loads image data into the raw image. @@ -11241,6 +11846,7 @@ This method should not call Changed(). Number of bytes read from the stream. + SetSize - specifies height and width of Image. @@ -11264,6 +11870,7 @@ image data for a specific image format. New height for the image. + Sets the Handle used for the image. @@ -11293,6 +11900,7 @@ are pending, the Changed method is called. New value for the Handle. + Sets the value for the Height property. @@ -11309,6 +11917,7 @@ property and the value for the AHeight parameter. New value for the property. + Sets the value for the Width property. @@ -11325,6 +11934,7 @@ property and the value for the AWidth parameter. New value for the property. + Sets the value for the TransparentMode property. @@ -11349,6 +11959,7 @@ in the bottom-left pixel in the raw image data. New value for the property. + Sets the value for the PixelFormat property. @@ -11364,6 +11975,7 @@ class to use the storage format supported for a specific image format. New value for the property. + Writes raw image data to the specified stream. @@ -11400,6 +12012,7 @@ the shared image data. Stream instance where image data is written in the method. + Writes the image content to the specified stream instance. @@ -11413,6 +12026,7 @@ in a descendant class to write data for a specific image format. Stream where image data is written in the method. + Gets the color used to represent transparent pixels in the image. @@ -11440,6 +12054,7 @@ the return value is clNone. + Constructor for the class instance. @@ -11461,6 +12076,7 @@ color. + Destroy is the destructor for TRasterImage: frees the @@ -11472,6 +12088,7 @@ canvas, and releases image then calls inherited TPersistent.Destroy + Assign - copies details from Source according to data type. @@ -11537,6 +12154,7 @@ Source as an argument. Persistent object with values copied in the method. + Removes raw image data and frees the internal save stream. @@ -11560,6 +12178,7 @@ Clears set the values in Height and Width to 0 + BeginUpdate - start the update process. @@ -11598,6 +12217,7 @@ and a subsequent update requests a full update. loading. + EndUpdate - finishes the update process. @@ -11639,6 +12259,7 @@ when EndUpdate is called. Indicates if the save stream for a shared image is valid. + Frees the image by resetting its handle. @@ -11650,6 +12271,7 @@ classes. + BitmapHandleAllocated - returns True if a handle has been @@ -11670,6 +12292,7 @@ class to provide support for a specific image format. True when a handle has been allocated for bitmap data in the image. + MaskHandleAllocated - returns True if a handle has been @@ -11690,6 +12313,7 @@ class to provide support for a specific image format. True when a handle has been allocated for mask data in the image. + PaletteAllocated - returns True if a Palette has been @@ -11708,6 +12332,7 @@ class to provide support for a specific image format. True when a handle has been allocated for the palette in the image. + Loads the image data from the specified Bitmap and Mask handles. @@ -11724,6 +12349,7 @@ Loads the image data from the specified Bitmap and Mask handles. Pointer to the source rectangle for the image data. + Loads image data from the specified device context. @@ -11732,6 +12358,7 @@ Loads the image data from the specified Bitmap and Mask handles. Device context used for the operation. + LoadFromStream - loads data for the image from a specified data @@ -11779,6 +12406,7 @@ called to load the image data for the class instance. Number of byte to read from the stream. + Loads image data from a stream for the specified MIME type. @@ -11820,6 +12448,7 @@ LoadFromMimeStream is used in the implementation of the MIME type for the image data in the stream. + Loads image data from the specified TRawImage instance. @@ -11861,6 +12490,7 @@ the palette. When set to False, storage for values is allocated using True if the image owns the raw image data. + Loads the image from a TLazIntfImage instance. @@ -11873,6 +12503,7 @@ Calls SetHandles to apply the image and mask handles to the class instance. TLazIntfImage instance with image data loaded in the method. + Saves image data to the specified stream. @@ -11913,6 +12544,7 @@ An Exception may be raised in SaveToStream (called in the method). Stream where the image data is stored. + Gets a list of supported MIME types for image data used in the image type. @@ -11945,6 +12577,7 @@ method in TClipboard. + Gets the image Width and Height from the metadata for the raw image. @@ -11967,6 +12600,7 @@ used as the output parameter values. Height for the raw image data. + Applies the color used for transparent pixels to the image. @@ -11980,6 +12614,7 @@ color transparency. Color used to represent transparent pixels in the mask. + Sets handles for the bitmap and the mask to the specified values. @@ -12004,6 +12639,7 @@ store handle values in the shared image used in the image format. Handle to use for the Mask. + Releases the handle in the shared image without freeing the BitmapHandle. @@ -12029,6 +12665,7 @@ when the handle been has changed. Value for the handle in the shared image before it is released. + ReleaseMaskHandle - releases the Handle used for the Mask. @@ -12039,6 +12676,7 @@ Value for the handle in the shared image before it is released. + ReleasePalette - release the Handle used for the Palette. @@ -12049,6 +12687,7 @@ Value for the handle in the shared image before it is released. + CreateIntfImage - creates an image on the Interface. @@ -12059,6 +12698,7 @@ Value for the handle in the shared image before it is released. + The Canvas where the raster image is rendered. @@ -12088,6 +12728,7 @@ transferred to a destination canvas. Canvas is also used to auto-detect the + Indicates if a handle has been assigned for the shared image in the class. @@ -12116,6 +12757,7 @@ handle has been assigned for the Mask in the class instance. True when a handle has been assigned for the shared image. + BitmapHandle - the Handle that has been allocated for the Bitmap. @@ -12123,6 +12765,7 @@ handle has been assigned for the Mask in the class instance. + Masked - returns True if a Mask is being applied. @@ -12130,11 +12773,13 @@ handle has been assigned for the Mask in the class instance. + The handle allocated for the Bitmap Mask. + Storage format for the Pixels in the Image. @@ -12160,6 +12805,7 @@ for a specific image format. + Provides access to the raw image data for the image type. @@ -12181,6 +12827,7 @@ action which modifies member values in RawImage. TRawImage + Provides indexed access to a scan line in the raw image data. @@ -12215,6 +12862,7 @@ platforms or widgetsets. Row number for the pixels accessed in the raw image data. + Color used for transparent pixels in the image. @@ -12264,6 +12912,7 @@ signal the OnChange event handler (when assigned). + Determines how transparent pixels are represented in the image. @@ -12296,6 +12945,7 @@ The default value for the property is tmAuto. + Implements the base class for a reference-counted shared image. @@ -12315,10 +12965,13 @@ and TSharedPortableAnyMapGraphic. + + + Gets the value for the Height property. @@ -12329,6 +12982,7 @@ and TSharedPortableAnyMapGraphic. Value for the property. + Gets the value for the Width property. @@ -12339,6 +12993,7 @@ and TSharedPortableAnyMapGraphic. Value for the property. + Frees the Handle and the Palette for the shared Bitmap. @@ -12351,6 +13006,7 @@ and TSharedPortableAnyMapGraphic. + Frees the handle in the Palette property. @@ -12367,6 +13023,7 @@ No actions are performed in the method when the Palette handle contains + Frees raw image data for the shared bitmap and resets its image descriptor. @@ -12386,6 +13043,7 @@ FreeImage is called from the destructor when the class instance is destroyed. TRawImage + Returns the Handle of the released Palette. @@ -12408,6 +13066,7 @@ Use FreePalette to remove the palette handle in widgetset classes. + Gets the value for the PixelFormat property. @@ -12418,6 +13077,7 @@ Use FreePalette to remove the palette handle in widgetset classes. Value for the property. + Determines if the shared bitmap is empty. @@ -12444,6 +13104,7 @@ The return value is True when all of the following conditions are met: True if the shared bitmap is empty. + Create - constructor for @@ -12464,6 +13125,7 @@ to their default values in both the raw image and its image descriptor. TObject.Create + Destructor for the class instance. @@ -12484,6 +13146,7 @@ method. + Determines if the handle for the shared bitmap has been allocated. @@ -12505,6 +13168,7 @@ The return value is True when the internal handle has a non-zero value. True when the handle has a non-zero value. + ImageAllocated - returns True if an image has been @@ -12529,6 +13193,7 @@ class has a value other than ricfNone in its image descriptor. True when the color format for the raw image data has been assigned. + HandleType the type of Bitmap Handle that has been allocated. @@ -12544,6 +13209,7 @@ Use of HandleType is not implemented in the current LCL version. + The Height of the Bitmap. @@ -12560,6 +13226,7 @@ descriptor for the internal raw image data contains ricfNone. TRawImageColorFormat + Storage format for pixels in the raw image data. @@ -12578,6 +13245,7 @@ meanings in the enumeration. TRawImageDescription.Depth + The Width of the Bitmap. @@ -12594,6 +13262,7 @@ descriptor for the internal raw image data contains ricfNone. TRawImageColorFormat + TCustomBitmap - the base class for TBitmap. @@ -12618,9 +13287,12 @@ Do not create instances of TCustomBitmap; use the TBitmap descendant.

    + + + Gets the value for the HandleType property. @@ -12631,6 +13303,7 @@ Do not create instances of TCustomBitmap; use the TBitmap descendant. Value for the property. + Gets the value for the Monochrome property. @@ -12641,6 +13314,7 @@ Do not create instances of TCustomBitmap; use the TBitmap descendant. Value for the property. + Sets the value for the Handle property. @@ -12651,6 +13325,7 @@ Do not create instances of TCustomBitmap; use the TBitmap descendant. New value for the property. + Sets the value for the HandleType property. @@ -12661,6 +13336,7 @@ Do not create instances of TCustomBitmap; use the TBitmap descendant. New value for the property. + Sets the value for the Monochrome property. @@ -12671,6 +13347,7 @@ Do not create instances of TCustomBitmap; use the TBitmap descendant. New value for the property. + Updates the value in PixelFormat from the shared Bitmap image. @@ -12681,6 +13358,7 @@ descriptor has not already been read for the shared image. + Ensures that a handle is allocated for the image mask (when needed). @@ -12694,6 +13372,7 @@ Implements the abstract virtual method defined in the ancestor class. + Ensures that a handle is allocated for the Palette in the image. @@ -12708,6 +13387,7 @@ Ensures that a handle is allocated for the Palette in the image. + Indicates if the image uses the specified shared image class. @@ -12727,6 +13407,7 @@ uses the same shared image class type. Shared image class type compared in the method. + Performs actions needed when the image data for the bitmap has been changed. @@ -12753,6 +13434,7 @@ assigned). Object instance for the change notification. + Creates a handle for the bitmap using the bitmap handle type in the bitmap @@ -12789,6 +13471,7 @@ method in the ancestor class. Device description information for the bitmap. + FreeMaskHandle - method to release Mask handle. @@ -12808,6 +13491,7 @@ in the widgetset class. + Gets the value for the Handle property. @@ -12819,6 +13503,7 @@ in the widgetset class. Value for the property. + Gets the value for the MaskHandle property. @@ -12830,6 +13515,7 @@ in the widgetset class. Value for the property. + Gets the value for the Palette property. @@ -12841,6 +13527,7 @@ in the widgetset class. Value for the property. + Gets the value for the PixelFormat property. @@ -12852,6 +13539,7 @@ in the widgetset class. Value for the property. + Gets a pointer with the raw image data. @@ -12868,6 +13556,7 @@ the raw image pointer (when needed) prior to exiting from the method. Pointer to the TRawImage instance for the shared bitmap image. + Gets a pointer to the image descriptor for the shared Bitmap image. @@ -12926,6 +13615,7 @@ and its mask (when needed). + @@ -12936,6 +13626,7 @@ and its mask (when needed). + @@ -12954,6 +13645,7 @@ and its mask (when needed). + Ensures that the RawImage data is allocated prior to use. @@ -12988,6 +13680,7 @@ before the value in RawImage is accessed. For example: True when only the image descriptor in the raw image data is needed. + Re-implements the method from the ancestor class. @@ -13006,6 +13699,7 @@ re-implements the method from the TRasterImage ancestor class. New value used as the handle for the bitmap. + Sets the value for the PixelFormat property. @@ -13027,6 +13721,7 @@ value. New value for the property. + Frees the shared image in the bitmap, and creates a new one. @@ -13060,6 +13755,7 @@ for the Canvas used in the image. True copies the existing content in the shared image. + Sets the handles for the image and mask in the shared Bitmap to the specified @@ -13104,6 +13800,7 @@ UpdateHandles is used in the implementation of the Handle assigned to the mask in the image. + Constructor for the class instance. @@ -13120,6 +13817,7 @@ the + Destructor for the class instance. @@ -13136,6 +13834,7 @@ prior to exiting from the method. + Copies values from the specified persistent object into the class instance. @@ -13157,6 +13856,7 @@ copied into the members in the class instance. Persistent object with values copied in the method. + Clears the content for the bitmap image. @@ -13174,6 +13874,7 @@ shared image. + Releases the resources for the image when it is discarded. @@ -13190,6 +13891,7 @@ FreeImage is called when a new value is assigned to the + Determines if the specified resource type is valid for the image format. @@ -13238,6 +13940,7 @@ Returns True if the resource type is valid for the image format. The resource type examined in the method. + Returns True if a handle has been allocated for the Bitmap. @@ -13265,6 +13968,7 @@ BitmapHandleAllocated is used in the implementation of the + Determines if the mask handle has been allocated for the image. @@ -13300,6 +14004,7 @@ MaskHandleAllocated is used in the implementation of methods like: Returns True if a mask handle has been allocated for the image. + Indicates whether a handle has been allocated for a palette in the image. @@ -13325,6 +14030,7 @@ image contains a non-zero value. Returns True if a palette handle has been allocated for the image. + Releases the bitmap handle for the shared image. @@ -13340,6 +14046,7 @@ the bitmap. Returns True when the handle is successfully released. + Sets handles for the bitmap and the mask to the specified values. @@ -13370,6 +14077,7 @@ properties. New Mask handle for the image. + Sets the Height and Width for the image to the specified values. @@ -13419,6 +14127,7 @@ signal the OnChange event handler (when assigned). New height for the image. + The operating system Handle associated with this bitmap. @@ -13432,6 +14141,7 @@ image class (TSharedCustomBitmap) and stored in the + Handle type for the Bitmap. @@ -13455,6 +14165,7 @@ current implementation; the value is always read from the raw image data. + True when the image contains monochrome image data. @@ -13487,6 +14198,7 @@ property. + Implements a Bitmap using the FPImage reader and writer from the FCL. @@ -13499,6 +14211,7 @@ an FPImage reader and writer. + Gets the MIME type used for the image data in the image type. @@ -13540,6 +14253,7 @@ GetMimeType is not implemented in the current LCL version. MIME type used for the image data in the class. + Gets the class reference used to create new instances of the FCL-compatible @@ -13558,6 +14272,7 @@ in a descendent class which provides support for a specific image format. TFPCustomImageReaderClass descendent used for the image class type. + Gets the class reference used to create new instances of the FCL-compatible @@ -13576,6 +14291,7 @@ in a descendent class which provides support for a specific image format. TFPCustomImageWriterClass descendent used for the image class type. + Configures the reader class instance for the image type. @@ -13601,6 +14317,7 @@ operation that reads the image descriptor, header, or data. FCL image reader instance updated in the method. + Configures the writer class instance for the image type. @@ -13628,6 +14345,7 @@ LCL interface image with the image data for the write class instance. FCL image write instance updated in the method. + Finalizes the FCL image reader when a read operation has been completed. @@ -13645,6 +14363,7 @@ reader. FCL reader class instance examined in the method. + FinalizeWriter - ends the Image writing process. @@ -13663,6 +14382,7 @@ interface image. FCL image writer class examined in the method. + Read the image data from the specified Stream. @@ -13699,6 +14419,7 @@ value for the PixelFormat property in the calling routine. Not used in the current implementation. + Write the data to a stream. @@ -13727,6 +14448,7 @@ is 0. Stream where the image data is stored. + Returns a list of the file extensions available for the image type. @@ -13742,6 +14464,7 @@ Returns a list of the file extensions available for the image type. List of file extensions supported for the image type. + Determines if the specified stream contains image data supported for the @@ -13771,6 +14494,7 @@ the position prior to exiting from the method. True when the stream contains a image data in a supported format. + Indicates whether the given file extension is supported for the image type. @@ -13802,6 +14526,7 @@ IsFileExtensionSupported is used in the implementation of File extension checked for the image type. + Determines if the specified resource type is valid for the image format. @@ -13840,6 +14565,7 @@ format. Resource type examined in the method. + Class reference used to create new instances of TFPImageBitmap. @@ -13847,6 +14573,7 @@ format. + Defines a reference-counted shared Bitmap graphic. @@ -13858,6 +14585,7 @@ TSharedBitmap is a TSharedCustomBitmap descendant. + Implements a FCL-compatible reader/writer for a Bitmap image. @@ -13904,6 +14632,7 @@ has been refactored into ancestor or descendent classes. TLazWriterBMP + Initializes the image reader to use the transparency settings in the class @@ -13974,6 +14703,7 @@ and MaskColor properties in AReader as required. Reader used to access raw data for the image. + Gets the class reference used to create the FCL-compatible reader for the @@ -14007,6 +14737,7 @@ reader class type. Class reference used to create instances of the reader class. + Gets the class reference used to create instances of the FCL-compatible image @@ -14029,6 +14760,7 @@ writer. Class reference used to create instances of the writer class. + Gets the class reference used to create new instances of a shared image. @@ -14053,6 +14785,7 @@ GetSharedImageClass is called from methods like Create, Class reference used to create new instances of the shared image class. + Gets the file extensions supported for the image type. @@ -14076,6 +14809,7 @@ format supported in the class. File extensions used for the image type. + Gets the resource type identifier for the image format. @@ -14090,6 +14824,7 @@ type identifier for the image format. GetResourceType returns the value in the Returns the RT_BITMAP constant. + Loads image data from the specified stream. @@ -14121,6 +14856,7 @@ the header for a resource stream). Number of bytes to read in the method. + Implements a reference-counted shared Pixmap image type. @@ -14129,6 +14865,7 @@ the header for a resource stream). + Implements support for the XPM (Pixmap) image format. @@ -14149,6 +14886,7 @@ are of the correct type and format. + Gets the class reference for a reader used during component streaming. @@ -14159,6 +14897,7 @@ Gets the class reference for a reader used during component streaming. Class reference for a reader used during component streaming. + Gets the class reference for a writer used during component streaming. @@ -14169,6 +14908,7 @@ Gets the class reference for a writer used during component streaming. Class reference for a writer used during component streaming. + Gets the class reference used to create the shared image in the class @@ -14182,6 +14922,7 @@ instance. class reference used to create the shared image in the class instance. + Determines if the specified resource type is valid for the image format. @@ -14195,6 +14936,7 @@ Determines if the specified resource type is valid for the image format. Resource type examined in the method. + Gets the file extensions supported for the image type. @@ -14218,6 +14960,7 @@ supported in the class. File extension(s) supported for the image format. + TSharedPortableNetworkGraphic - a reference counted PNG Image. @@ -14235,6 +14978,7 @@ TSharedPortableNetworkGraphic is the type returned by the + Implements support for the PNG image format. @@ -14261,6 +15005,7 @@ MIME media type 'image/png'. + @@ -14269,6 +15014,7 @@ MIME media type 'image/png'. + @@ -14289,6 +15035,7 @@ MIME media type 'image/png'. + Determines if the specified stream contains image data supported for the @@ -14303,6 +15050,7 @@ image type. + @@ -14311,6 +15059,7 @@ image type. + TSharedPortableAnyMapGraphic - a reference counted shared PNM. @@ -14320,6 +15069,7 @@ image type. + Implements an image which supports for the Portable Any Map (PNM) graphic @@ -14341,6 +15091,7 @@ extension. + @@ -14349,6 +15100,7 @@ extension. + @@ -14357,6 +15109,7 @@ extension. + @@ -14364,6 +15117,7 @@ extension. + Determines if the specified stream contains image data supported for the @@ -14378,6 +15132,7 @@ image type. + @@ -14386,6 +15141,7 @@ image type. + Class reference used to create new instances of TIconImage. @@ -14393,6 +15149,7 @@ image type. + Implements a reference-counted shared Icon image type. @@ -14410,7 +15167,10 @@ TSharedIcon is the type used to implement the internal shared image in + + + Frees the handle for the shared reference-counted icon. @@ -14425,6 +15185,7 @@ performed in the method when Handle contains 0 (zero). + Frees the existing icon image and reloads it from the specified handle. @@ -14442,6 +15203,7 @@ Images. + Indicates if the shared icon is empty (contains no icon images). @@ -14454,6 +15216,7 @@ Indicates if the shared icon is empty (contains no icon images). + Gets the value for the indexed Images property. @@ -14467,6 +15230,7 @@ TIconImage instance at the specified position in the image list. Ordinal position for the image retrieved from the image list. + Create - constructor for TSharedIcon: performs inherited @@ -14477,6 +15241,7 @@ TIconImage instance at the specified position in the image list. TObject.Create + Destroy - destructor for TSharedIcon: frees the list of @@ -14487,6 +15252,7 @@ images and performs inherited Destroy. TObject.Destroy + Clear - remove the icon and free its resources. @@ -14494,6 +15260,7 @@ images and performs inherited Destroy. + Removes the icon image with the specified index. @@ -14502,6 +15269,7 @@ images and performs inherited Destroy. Ordinal position for the icon image removed in the method. + Gets the Index of an image with specified pixel format, height and width. @@ -14523,6 +15291,7 @@ Ordinal position for the icon image matching the requested value(s). Width for the requested image. + Gets the class reference used to create a new icon image in the Images @@ -14534,6 +15303,7 @@ property. + Adds the specified image to the list of Images in the icon. @@ -14541,11 +15311,13 @@ property. + Sorts values in Images using the IconCompare routine. + Count - returns the number of references to the shared icon. @@ -14554,6 +15326,7 @@ property. + Provides indexed access to the images available in the Icon. @@ -14562,6 +15335,7 @@ property. Ordinal position for an icon image in the list of images. + TIconImage - a primitive Icon class with handles for the Bitmap, @@ -14570,6 +15344,8 @@ Mask and Palette. + + @@ -14577,6 +15353,7 @@ Mask and Palette. + Gets the value for the Palette property. @@ -14587,6 +15364,7 @@ Mask and Palette. Value for the property. + RawImageNeeded - if ADescOnly is True @@ -14598,6 +15376,7 @@ Mask and Palette. + Updates the icon image from the specified raw image data. @@ -14627,17 +15406,18 @@ UpdateFromImage is called from the Create constructor when a Raw image data stored in the method. + -Create - Specifies a Raw image to be used, then used Inherited -Create. +Constructor for the class instance.

    -Create is the overloaded constructor for the class instance. +Create is the overloaded constructor for the class instance. It +specifies a Raw image to be used, and calls the inherited Create method. Variants are provided with parameters which specify the dimensions and/or -content for the icon image. The variant with the TIconInfo -argument is used to create a new icon image when a handle is assigned in +content for the icon image. The variant with the TIconInfo argument +is used to create a new icon image when a handle is assigned in TSharedIcon.

    @@ -14662,6 +15442,7 @@ argument is used to create a new icon image when a handle is assigned in Structure with Hotspot, Mask and Color information for the icon image.     + Destructor for the class instance. @@ -14678,6 +15459,7 @@ method. TObject.Destroy + Releases the Handle for the icon image. @@ -14706,6 +15488,7 @@ in the icon image. + ReleaseMaskHandle - returns mask Bitmap handle to operating system. @@ -14716,6 +15499,7 @@ in the icon image. + ReleasePalette - returns Palette handle to operating system. @@ -14767,11 +15551,13 @@ method. + The Width of the Icon. + PixelFormat - the format of the Pixels in the Image. @@ -14779,6 +15565,7 @@ method. + Handle - for the Bitmap. @@ -14786,6 +15573,7 @@ method. + MaskHandle - Bitmap handle for the Mask. @@ -14793,6 +15581,7 @@ method. + Handle for the Palette. @@ -14807,6 +15596,7 @@ Palette is not implemented in the current LCL version. + Raw image data for the icon image. @@ -14826,6 +15616,7 @@ to examine the raw image data and get the values stored in properties. TRawImage + TCustomIcon - base class for TIcon. @@ -14867,6 +15658,7 @@ TCustomIcon (or descendent classes). + Gets the value for the Count property. @@ -14879,6 +15671,7 @@ TCustomIcon (or descendent classes). Value for the property. + Sets the value for the Current property. @@ -14889,18 +15682,21 @@ TCustomIcon (or descendent classes). New value for the property. + -FCurrent - local variable to hold current sequence number. +Local member variable used to hold the current sequence number. + Member used for the requested icon size. + Ensures that a handle for the mask in the icon is valid. @@ -14908,6 +15704,7 @@ TCustomIcon (or descendent classes). + An empty implementation in TCustomIcon. @@ -14919,6 +15716,7 @@ Palette information is handled in the .ICO image format. + Indicates whether the image class type has a shared handle. @@ -14941,6 +15739,7 @@ icnsicons. + CheckRequestedSize - method to ensure correct size requested. @@ -14948,6 +15747,7 @@ icnsicons. + GetIndex - returns the Index value of the Icon with specified @@ -14990,6 +15790,7 @@ found. Width for the requested icon image. + Gets the value for the BitmapHandle property. @@ -15004,6 +15805,7 @@ found. Value for the property. + GetDefaultSize - returns default size for Icon. @@ -15021,6 +15823,7 @@ its cx and cy members. TSize instance with the default width and height for an icon. + Gets the value for the MaskHandle property. @@ -15037,6 +15840,7 @@ ancestor class. Value for the property. + Gets the value for the Palette property. @@ -15048,6 +15852,7 @@ ancestor class. Value for the property. + Gets the value for the PixelFormat property. @@ -15062,6 +15867,7 @@ ancestor class. Value for the property. + Gets a pointer to the raw image data for the icon. @@ -15096,6 +15902,7 @@ to the icon. It is also used to get mask image data in the Pointer to the raw image data, or Nil when Current is not assigned. + @@ -15104,6 +15911,7 @@ Pointer to the raw image data, or Nil when Current is not assigned. + @@ -15112,6 +15920,7 @@ Pointer to the raw image data, or Nil when Current is not assigned. + @@ -15120,6 +15929,7 @@ Pointer to the raw image data, or Nil when Current is not assigned. + Gets the stream signature used for icon data. @@ -15142,6 +15952,7 @@ GetStreamSignature is defined as a virtual method, and is overridden in Cardinal value with the stream signature for the class. + Gets the icon type identifier used in the image list header. @@ -15164,6 +15975,7 @@ return value is always returns 0. GetTypeId is overridden in Type identifier for images in the icon. + Ensures that a handle for the image has been allocated. @@ -15185,6 +15997,7 @@ widgetset to get the value used as the Handle for the shared image. + @@ -15193,6 +16006,7 @@ widgetset to get the value used as the Handle for the shared image. + @@ -15201,6 +16015,7 @@ widgetset to get the value used as the Handle for the shared image. + @@ -15209,6 +16024,7 @@ widgetset to get the value used as the Handle for the shared image. + Reads data for the class instance from a stream. @@ -15245,6 +16061,7 @@ ReadData is also called from the LoadFromResourceHandle method in + Reads the content for the icon from the specified stream. @@ -15296,6 +16113,7 @@ and/or Height specified in the class instance. Number of bytes expected for the icon data. + Sets the value for the Masked property. @@ -15310,6 +16128,7 @@ and/or Height specified in the class instance. New value for the property. + Sets the value for the PixelFormat property. @@ -15326,6 +16145,7 @@ Changing the value for PixelFormat raises an New value for the property. + Sets the value for the Transparent property. @@ -15342,6 +16162,7 @@ Changing the value for PixelFormat raises an New value for the property. + Unshares the shared image when the content in the icon is changed. @@ -15394,6 +16215,7 @@ for the icon, including: True if existing image content is copied in the method. + UpdateCurrentView - updates the current appearance of the Icon. @@ -15474,6 +16296,7 @@ shared icon image. Handle compared to the shared icon image. + Sets the Bitmap and Mask handles for the current image in the icon. @@ -15526,6 +16349,7 @@ UpdateHandles is called from methods like: Mask handle for the current image in the icon. + Writes the content for the multi-image icon to the specified stream. @@ -15559,6 +16383,7 @@ WriteStream is called from SaveStreamNeeded when the TMemoryStream instance where icon data is stored. + Constructor for the class instance. @@ -15587,6 +16412,7 @@ icon. + Add - an Icon formatted as AFormat, with specified @@ -15623,6 +16449,7 @@ Use Current to make an icon image active for the class instance. Use Width in pixels for the icon image. + Copies values from the specified persistent object into the current class @@ -15667,6 +16494,7 @@ is called. Persistent object with values copied into the current class instance. + Copies image data from the source image to the current icon image. @@ -15691,6 +16519,7 @@ store a single raster image to the icon. Image with the values assigned to the current icon image. + Removes the image content for the icon. @@ -15717,6 +16546,7 @@ Clear does not call the method inherited from TRasterImage. + Deletes the image at the specified position in the list of images for the @@ -15755,6 +16585,7 @@ for the icon. Ordinal position for the icon image deleted in the method. + Removes an icon image with the specified attributes. @@ -15791,6 +16622,7 @@ index for the icon image removed in the method. Width for the icon image. + Gets metadata which describes the icon image at the specified position in the @@ -15831,6 +16663,7 @@ instance used in the class. AWidth - the width of the Icon. + Sets the size (width, height) for the image in the Icon. @@ -15869,6 +16702,7 @@ when Current contains a value other than -1. New Height for the icon. + Gets a delimited list of file extensions supported for the image type. @@ -15888,6 +16722,7 @@ is always 'ico'. Delimited list of file extensions supported for the image type. + Determines if the specified resource type is valid for the image format. @@ -15921,6 +16756,7 @@ uppercase in the method. Resource type identifier examined in the method. + Loads the icon with the specified resource name from the instance handle. @@ -15964,6 +16800,7 @@ Use LoadFromLazarusResource to load a Lazarus resource from a Name for the resource loaded in the method. + Load icon data from a resource with the specified integer resource identifier. @@ -16016,6 +16853,7 @@ and type is not valid. Integer resource identifier loaded in the method. + Loads icon data from the specified instance and resource handles. @@ -16036,6 +16874,7 @@ re-implemented in TIcon descendant. Resource handle with the icon data loaded in the method. + Indicates if a handle for the icon image has been allocated. @@ -16072,6 +16911,7 @@ handle prior to performing actions using the image data. For example: True when a valid handle has been assigned for the shared icon image. + True if a handle has been allocated for the mask in the image. @@ -16118,6 +16958,7 @@ to performing actions using the mask image data. For example: True when the MaskHandle has been allocated for the icon image. + Determine if a handle has been allocated for the Palette in the icon. @@ -16151,6 +16992,7 @@ PaletteAllocated will always return False. True when the Palette handle has been allocated for the icon. + Not implemented in TCustomIcon. @@ -16167,6 +17009,7 @@ PaletteAllocated will always return False. Handle for the Mask in the icon. + Sorts the images for the icon. @@ -16190,6 +17033,7 @@ image list is called determine the new position for the referenced image. + Gets the ordinal position for the image closest to the requested size. @@ -16220,6 +17064,7 @@ Ordinal position for the image, or -1 when no images are available. TSize instance with the height and width for the requested image size. + Ordinal position for the current image displayed for the icon. @@ -16238,6 +17083,7 @@ values in Height and Width) to avoid raising an + Number of images in the image list for the shared icon. @@ -16255,6 +17101,7 @@ the list of images available in the icon. + Implements an icon image type; small images typically associated with @@ -16275,6 +17122,7 @@ When loading, the largest/most colorful image is loaded as the Writing to icon files is not (yet) implemented. + Gets the value for the Handle property. @@ -16285,6 +17133,7 @@ Writing to icon files is not (yet) implemented. Value for the property. + Sets the value for the Handle property. @@ -16295,10 +17144,12 @@ Writing to icon files is not (yet) implemented. New value for the property. + + Ensures that handle values for the icon are valid. @@ -16320,6 +17171,7 @@ image has already been assigned. + Loads icon data from the specified instance and resource handles. @@ -16335,6 +17187,7 @@ Loads icon data from the specified instance and resource handles. Resource handle with the icon data loaded in the method. + Frees the Handle used for the Icon. @@ -16343,6 +17196,7 @@ Loads icon data from the specified instance and resource handles. HICON value removed from the Handle in the class instance. + Gets the Integer Resource Type for the class instance. @@ -16408,6 +17262,7 @@ image. + Contains the TRawImage instance with the data for an icon image. @@ -16415,11 +17270,13 @@ Contains the TRawImage instance with the data for an icon image. + Pointer to a TIcnsRec instance. + Implements a list used to maintain TIcnsIcon instances. @@ -16440,6 +17297,7 @@ TIcnsList is the type used to implement storage for images and masks in TList + @@ -16451,6 +17309,7 @@ TIcnsList is the type used to implement storage for images and masks in + @@ -16462,6 +17321,7 @@ TIcnsList is the type used to implement storage for images and masks in + Handles the notification when an icon image is added to or removed from the @@ -16481,6 +17341,7 @@ notification. Action performed for the icon image. + Creates and stores a entry in the list for the specified icon type and raw @@ -16500,6 +17361,7 @@ Type for the image data, mask, or alpha channel image in the raw data. Raw image instance added to the container. + Provides indexed access to the icon images in the list by their ordinal @@ -16511,6 +17373,7 @@ position. Ordinal position in the list for the property value. + Declares the shared icon for the TIcnsIcon type. @@ -16518,6 +17381,7 @@ position. + Implements a macOS Icon Resource file. @@ -16534,8 +17398,11 @@ Icon files include: 16x16, 32x32, 48x48, 128x128, 256x256, 512x512, and + + + @@ -16547,11 +17414,13 @@ Icon files include: 16x16, 32x32, 48x48, 128x128, 256x256, 512x512, and + + Gets the class reference used to create the shared image for the icon. @@ -16562,6 +17431,7 @@ Gets the class reference used to create the shared image for the icon. + Reads icon data from the specified stream, and performs byte order conversion @@ -16573,6 +17443,7 @@ when needed. + Reads each of the icon resources from the specified stream, and adds them to @@ -16587,6 +17458,7 @@ the list of icon images. + Writes each of the icon resources in the list to the specified stream. @@ -16602,16 +17474,19 @@ version. + Constructor for the class instance. + Destructor for the class instance. + Gets the file extension(s) used for the icon type. @@ -16622,6 +17497,7 @@ version. Always returns 'icns' in TIcnsIcon. + Checks whether the specified Resource Type name is valid for the icon type. @@ -16635,11 +17511,13 @@ Checks whether the specified Resource Type name is valid for the icon type. Resource type name checked in the method. + Implements a reference-counted shared image used for cursors. + Frees the handle for the cursor image. @@ -16647,6 +17525,7 @@ Checks whether the specified Resource Type name is valid for the icon type. + Gets the class reference used to create a new cursor image in the Images @@ -16662,6 +17541,7 @@ property. Class reference used to create images in the shared cursor image list. + Implements the image for a cursor, stored as an Icon. @@ -16674,7 +17554,10 @@ that is the point that interacts with other elements on the screen. + + + Constructor for the class instance. @@ -16691,6 +17574,7 @@ as an argument. AInfo contains the coordinates that are assigned to the TIconInfo instance with the hotspot information for the cursor image. + HotSpot - the coordinates of the point to which the cursor refers, @@ -16699,6 +17583,7 @@ and which represents the 'active' position on the current form or canvas. + TCursorImage - an Icon to be used to represent a cursor. @@ -16708,6 +17593,7 @@ and which represents the 'active' position on the current form or canvas. + Gets the value for the HotSpot property. @@ -16718,6 +17604,7 @@ and which represents the 'active' position on the current form or canvas. Value for the property. + Gets the value for the CursorHandle property. @@ -16738,19 +17625,23 @@ and which represents the 'active' position on the current form or canvas. New value for the property. + + + + @@ -16759,6 +17650,7 @@ and which represents the 'active' position on the current form or canvas. + @@ -16767,6 +17659,7 @@ and which represents the 'active' position on the current form or canvas. + @@ -16775,6 +17668,7 @@ and which represents the 'active' position on the current form or canvas. + @@ -16783,6 +17677,7 @@ and which represents the 'active' position on the current form or canvas. + Gets the resource type identifier for the cursor image. @@ -16798,6 +17693,7 @@ Returns RT_GROUP_CURSOR in TCursorImage. + @@ -16811,6 +17707,7 @@ Returns RT_GROUP_CURSOR in TCursorImage. + @@ -16822,6 +17719,7 @@ Returns RT_GROUP_CURSOR in TCursorImage. + ReleaseHandle - free the handle used for the cursor Image. @@ -16832,6 +17730,7 @@ Returns RT_GROUP_CURSOR in TCursorImage. + Updates the HotSpot coordinate to the center point for the Current image in @@ -16840,6 +17739,7 @@ the cursor. + HotSpot - the coordinates of the point to which the cursor refers, @@ -16848,6 +17748,7 @@ and which represents the 'active' position on the current form or canvas. + Handle for the cursor image. @@ -16872,6 +17773,7 @@ shared image and signal the OnChange event handler (when assigned). + TSharedJpegImage - a reference counted shared image of type JPEG. @@ -16881,6 +17783,7 @@ shared image and signal the OnChange event handler (when assigned). + Represents JPEG compression quality values. @@ -16893,6 +17796,7 @@ TJPEGQualityRange is the type used to implement the + Represents JPEG read performance setting values. @@ -16905,6 +17809,7 @@ the type used to implement the Performance property in + TJPEGImage - a class for handling images stored in JPEG @@ -16935,6 +17840,8 @@ states: BestQuality or BestSpeed (for compression). + + @@ -16943,6 +17850,7 @@ states: BestQuality or BestSpeed (for compression). + Sets the value for the CompressionQuality property. @@ -16953,6 +17861,7 @@ states: BestQuality or BestSpeed (for compression). New value for the property. + Sets the value for the GrayScale property. @@ -16963,6 +17872,7 @@ states: BestQuality or BestSpeed (for compression). New value for the property. + Sets the value for the ProgressiveEncoding property. @@ -16973,6 +17883,7 @@ states: BestQuality or BestSpeed (for compression). New value for the property. + Initializes the FCL-compatible image reader for the image type. @@ -16999,6 +17910,7 @@ AReader: FCL-compatible image reader class updated in the method. + Initializes the FCL-compatible Image Writer for the image type. @@ -17010,6 +17922,7 @@ AReader: FCL-compatible image writer class updated in the method. + Finalizes the FCL Image reader. @@ -17018,6 +17931,7 @@ AReader: FCL-compatible image reader examined in the method. + @@ -17026,6 +17940,7 @@ AReader: + @@ -17034,6 +17949,7 @@ AReader: + @@ -17041,6 +17957,7 @@ AReader: + Constructor for the class instance. @@ -17064,6 +17981,7 @@ default values for properties, including: TCustomBitmap.Create + Applies compression settings in the class instance to the image data. @@ -17074,6 +17992,7 @@ Applies compression settings in the class instance to the image data. + Indicates if the stream contains a format supported for the image type. @@ -17089,6 +18008,7 @@ Indicates if the stream contains a format supported for the image type. TStream instance examined in the method. + Gets the file extension(s) supported for the image format. @@ -17097,6 +18017,7 @@ Indicates if the stream contains a format supported for the image type. Delimited list of file extensions supported for the image type. + Determine the compression quality for the image data. @@ -17111,11 +18032,13 @@ and 25 is pretty awful. + Indicates if the image contains grayscale image data. + Minimum height allowed for the image when read using an FCL image reader. @@ -17123,6 +18046,7 @@ Minimum height allowed for the image when read using an FCL image reader. + Minimum width allowed for the image when read using an FCL image reader. @@ -17130,16 +18054,19 @@ Minimum width allowed for the image when read using an FCL image reader. + Indicates if progressive encoding is used for the image data. + Set for best quality or best speed. + A predefined scaling value applied to the image data. @@ -17160,6 +18087,7 @@ the predefined scaling values applied to the raw image data. For instance: + Indicates if smoothing is applied to the raw image data. @@ -17177,6 +18105,7 @@ FCL-compatible image reader. + Declares the shared image for the TTiffImage type. @@ -17184,6 +18113,7 @@ FCL-compatible image reader. + Represents units of measure used in TIFF image data. @@ -17208,6 +18138,7 @@ absolute dimensions. Unit of measure is Centimeters. + Implements support for the TIFF (Tag Image File Format) graphic format. @@ -17257,6 +18188,8 @@ data, including: + + @@ -17275,6 +18208,7 @@ data, including: + Initializes the FCL-compatible image reader for the image. @@ -17286,6 +18220,7 @@ data, including: + Initializes the FCL-compatible image writer for the image. @@ -17297,6 +18232,7 @@ data, including: + Captures values from the image reader after loading an image. @@ -17305,6 +18241,7 @@ data, including: + @@ -17313,6 +18250,7 @@ data, including: + @@ -17321,6 +18259,7 @@ data, including: + @@ -17329,6 +18268,7 @@ data, including: + Constructor for the class instance. @@ -17342,6 +18282,7 @@ FPC version. + Gets the delimited list of file extension(s) for files which support the @@ -17357,26 +18298,31 @@ In TTiffImage, the return value is: 'tif;tiff'. + Person who created the image. + Copyright notice for the image. + Date and time the image was created. + Name of the document from which the image was scanned. + The computer and/or operating system where the image was created. @@ -17384,26 +18330,31 @@ The computer and/or operating system where the image was created. + A string that describes the subject of the image. + The scanner manufacturer. + The scanner model name or number. + The unit of measurement for XResolution and YResolution. + Name and version number for the software used to create the image. @@ -17411,16 +18362,19 @@ Name and version number for the software used to create the image. + Number of pixels in ResolutionUnits for the image width. + Number of pixels in ResolutionUnits for the image height. + Implements a reference-counted shared GIF image. @@ -17429,6 +18383,7 @@ Name and version number for the software used to create the image. + Implements an image using the GIF (Graphics Interchange Format) image format. @@ -17447,9 +18402,12 @@ feature. + + + @@ -17461,6 +18419,7 @@ feature. + Updates the image when the reader has finished loading the image content. @@ -17492,6 +18451,7 @@ instance. FCL-compatible reader for the image type. + @@ -17502,6 +18462,7 @@ instance. + Gets the class reference used to create the shared image in new class @@ -17513,6 +18474,7 @@ instances. + Constructor for the class instance. @@ -17521,6 +18483,7 @@ instances. + Determines if the specified Stream contains a valid GIF image format. @@ -17536,6 +18499,7 @@ Determines if the specified Stream contains a valid GIF image format. TStream instance with values examined in the method. + Gets the file extensions used for the GIF image format. @@ -17544,11 +18508,13 @@ Determines if the specified Stream contains a valid GIF image format. Returns the value 'gif' + Indicates if the image is drawn with transparent pixels. + Indicates if the image uses the "venetian blind" effect during display. @@ -17556,6 +18522,7 @@ Indicates if the image uses the "venetian blind" effect during display. + Number of bits needed to represent a pixel in the image. @@ -17566,6 +18533,7 @@ be represented in the image data. + Gets a filter string for files using the specified image class type. @@ -17579,6 +18547,7 @@ Gets a filter string for files using the specified image class type. + Gets a string with the file extension used for the specified image class type. @@ -17606,6 +18575,7 @@ GraphicClass is not found in the list. Graphic class used to determine the file extension. + Gets a file filter which can be used to select image files for the specified @@ -17625,6 +18595,7 @@ class is not supported. TGraphicsClass instance to locate in the supported graphic formats. + Gets the TGraphicClass instance used for images with the specified file @@ -17641,6 +18612,7 @@ extension. File extension used to determine the TGraphicClass for an image format. + Specifies an object procedure used to process color value to color identifier @@ -17654,6 +18626,7 @@ map entries. + Checks whether a given Entry exists in a Map of color names. @@ -17697,6 +18670,7 @@ table. returned from the look-up table of Colors. + ColorToIdent - given a Color value, find its name (Ident) in the @@ -17718,6 +18692,7 @@ look-up table. look-up table of Colors. + IdentToColor - given a color identifier (name) returns the color @@ -17743,6 +18718,7 @@ The Color returned from the look-up table, with the name supplied in Ident. + Finds the position in the color identifier map for the specified value. @@ -17776,6 +18752,7 @@ the value is assigned to the Index output parameter. The return value is Position in Colors where the color value was found. + SysColorToSysColorIndex - if Color is one of the system @@ -17795,6 +18772,7 @@ returns -1 The Color to examine in the routine. + Converts a TColor value to an RGB color constant. @@ -17811,6 +18789,7 @@ the non-RGB values in the constant. TColor value converted in the method. + ColorToString - given a color value, returns a corresponding color @@ -17827,6 +18806,7 @@ Returns the name of the color, expressed as a string (like 'Green'). The Color to examine in the routine. + StringToColor - given a color name like 'clBlue', returns the @@ -17844,6 +18824,7 @@ corresponding color value. S - the name of the required color, expressed as a string. + Converts a color name, like "clBlue", to a TColor value with an optional @@ -17861,6 +18842,7 @@ default value when the color name does not exist. + Executes the specified procedure for each of the non-deprecated Color names @@ -17872,6 +18854,7 @@ defined for the platform. + InvertColor - returns the complementary color to the supplied @@ -17888,6 +18871,7 @@ Returns the inverse of the original color (i.e. a 'negative' effect). AColor - the original color for processing. + DecColor - decrease the component RGBs of a color by the quantity @@ -17946,6 +18930,7 @@ Does not work with system color values. The color for processing, expressed as a RGB value. + Finds the Green component of the supplied color. @@ -17961,6 +18946,7 @@ Does not work with system color values. The color for processing, expressed as RGB. + Finds the Red component of the supplied color. @@ -17977,6 +18963,7 @@ Does not work with system color values. The color for processing, expressed as RGB. + Combines the values for Red, Green and Blue into a TColor value. @@ -17993,6 +18980,7 @@ Does not work with system color values. Byte with the Blue color component. + RedGreenBlue - decomposes a composite color into its component @@ -18019,6 +19007,7 @@ Red, Green and Blue values. The Blue component of the color defined in RGB. + Converts a TFPColor value to a Cardinal color reference used in API system color constants. @@ -18032,6 +19021,7 @@ system color constants. + FPColorToTColor - converts a color specified as a @@ -18050,6 +19040,7 @@ system color constants. The color for processing, expressed as a FPColor. + TColorToFPColor - converts a color of type TColor to @@ -18070,6 +19061,7 @@ Does not work with system color values. c - the supplied color specified as type TColor. + Calls the specified procedure for each of the character set names in @@ -18187,6 +19179,7 @@ font handle is valid, the following members in the return value are updated: Font handle with the logical font data read in the routine. + Gets the default TFontCharSet value for the platform. @@ -18203,6 +19196,7 @@ Returns the value for the DEFAULT_CHARSET constant. + Determines if the specified font name is a valid X Logical Font Description. @@ -18222,6 +19216,7 @@ Description (XLFD). Font name with segments examined in the routine. + Gets a logical font record with values representing the specified XLFD font @@ -18278,6 +19273,7 @@ the values expected in the logical font record. Font descriptor examined in the routine. + Gets the value for the specified segment in an XLFD font descriptor. @@ -18296,6 +19292,7 @@ Gets the value for the specified segment in an XLFD font descriptor. Ordinal position (starting at 0) for the requested segment in XLFDName. + Gets the family name for the typeface used in the XLFD font descriptor. @@ -18314,6 +19311,7 @@ the typeface family name. XLFD font descriptor examined in the routine. + Replaces the specified XLFD segment value with the '*' wildcard. @@ -18330,6 +19328,7 @@ Replaces the specified XLFD segment value with the '*' wildcard. + Replaces the PixelSize, PointSize, ResolutionX, ResolutionY and AverageWidth @@ -18344,6 +19343,7 @@ segments in an XLFD font name with the '*' wildcard. + Replaces the spacing for a XLFD font descriptor format with a '*' wildcard. @@ -18357,6 +19357,7 @@ Replaces the spacing for a XLFD font descriptor format with a '*' wildcard. + Replaces the WeightName, Slant and SetwidthName segments in an XLFD font name @@ -18371,6 +19372,7 @@ with the '*' wildcard. + Checks whether an explicit value is assigned to XLFD segments controlling @@ -18385,6 +19387,7 @@ font height. + Parses the specified font name into X Logical Font Descriptor attributes. @@ -18412,6 +19415,7 @@ logical fonts. + Specifies a procedure type used to load a graphic image from a clipboard @@ -18429,6 +19433,7 @@ format. + Specifies a procedure type used to save a graphic image to a clipboard format. @@ -18445,6 +19450,7 @@ Specifies a procedure type used to save a graphic image to a clipboard format. + Specifies a function type which returns a HFONT handle for a system font. @@ -18471,6 +19477,7 @@ for the application. + Address of the routine used to load a graphic from a clipboard format. @@ -18478,6 +19485,7 @@ Address of the routine used to load a graphic from a clipboard format. + Address of the routine used to save a graphic to a clipboard format. @@ -18485,6 +19493,7 @@ Address of the routine used to save a graphic to a clipboard format. + Address of the routine used to get the handle for the system font. @@ -18492,6 +19501,7 @@ Address of the routine used to get the handle for the system font. + Examines values in the specified stream to determine if it contains a .BMP @@ -18509,6 +19519,7 @@ position. TStream instance examined in the routine. + Examines values in the specified stream to determine if it contains a .XPM @@ -18528,6 +19539,7 @@ statement in the stream. TStream instance examined in the routine. + Examines values in the specified stream to determine if it contains a .ICO @@ -18542,6 +19554,7 @@ image. TStream instance examined in the routine. + Examines values in the specified stream to determine if it contains a .CUR @@ -18556,6 +19569,7 @@ cursor image. TStream instance examined in the routine. + Converts an XPM image file into an array of PChar values. @@ -18599,6 +19613,7 @@ values. See XPMToPPChar for more information. Name of the XPM image resource loaded in the routine. + Converts an XPM image stored in the specified stream into an array of PChar @@ -18620,6 +19635,7 @@ See XPMToPPChar for more info. + Reads the first line from an XPM PChar array which contains the width, height @@ -18643,6 +19659,7 @@ and number of colors for the XPM data. + LoadCursorFromLazarusResource - loads a named cursor handle from @@ -18655,6 +19672,7 @@ the Lazarus Resource (.LRS). + Deprecated - technically a bitmap is created, not loaded. @@ -18677,6 +19695,7 @@ the Lazarus Resource (.LRS). + Creates and loads a TGraphic instance using the specified instance handle and @@ -18694,6 +19713,7 @@ resource name. + Creates a TCustomBitmap instance with the content for the named Lazarus @@ -18737,6 +19757,7 @@ Handle for the Lazarus resource with the content for the bitmap. + Creates a TLazIntfImage instance for the specified raw image data, and @@ -18763,6 +19784,7 @@ image data. + Creates a Bitmap with the content from the specified TFPCustomImage instance. @@ -18784,6 +19806,7 @@ return value. TFPCustomImage with the content copied into the return value. + Ensures that a Pattern Bitmap with the specified colors exists in the Pattern @@ -18868,6 +19891,7 @@ finalized.

    +     @@ -18878,6 +19902,7 @@ finalized.     + Variable used as the cache for Brush resources. @@ -18885,6 +19910,7 @@ finalized. + Array constant with TIdentMapEntry values for character sets in TFont @@ -18901,6 +19927,7 @@ value. TIdentMapEntry + Creates a formatted debugger message with values from the TFontStyles set. @@ -18919,6 +19946,7 @@ The return value contains the formatted set of font styles, with content like: Set of TFontStyle values included in the formatted string. + Resizes the specified horizontal size from a given display density to the @@ -18945,6 +19973,7 @@ member in ScreenInfo, and divides the product by the value in Original display density (Pixels per Inch). + Resizes the specified vertical size from a given display density to the @@ -18971,6 +20000,7 @@ member in ScreenInfo, and divides the product by the value in Original display density (Pixels per Inch). + Registers TPersistent classes for use in the RTL. @@ -18997,84 +20027,13 @@ persistent objects to the list of classes available in the RTL: RegisterClass + Renews handles for Fonts, Pens, and Brushes. - -Monitoring the progress of drawing a complicated Graphic. - -

    -TProgressEvent is a generic progress notification event which may -be used by TGraphic classes with computationally intensive (slow) -operations, such as loading, storing, or transforming image data. -

    - - - - - - - - - - - - - - - - - - - - - - -
    Event parameters
    Stage -

    -Indicates whether this call to the OnProgress event is to prepare -for, process, or clean up after a graphic operation. -

    -

    -If OnProgress is called at all, the first call for a graphic -operation will be with Stage = psStarting, to allow the -OnProgress event handler to allocate whatever resources it needs -to process subsequent progress notifications. After Stage = -psStarting, you are guaranteed that OnProgress will be -called again with Stage = psEnding to allow you to free those -resources, even if the graphic operation is aborted by an exception. -

    -

    -Zero or more calls to OnProgress with Stage = psRunning -may occur between the psStarting and psEnding calls. -

    -
    PercentDone -The ratio of work done to work remaining, on a scale of 0 to 100. Values may -repeat or even regress (get smaller) in successive calls. -PercentDone is usually only a guess, and the guess may be -dramatically altered as new information is discovered in decoding the image. -The value of this property could usefully be passed to a ProgressBar to show -the user how drawing is progressing -
    RedrawNow -Indicates whether the graphic can be/should be redrawn immediately. Useful -for showing successive approximations of an image as data is available -instead of waiting for all the data to arrive before drawing anything. Since -there is no message loop activity during graphic operations, you should call -Update to force a control to be redrawn immediately in the -OnProgress event handler. Redrawing a graphic when RedrawNow = -False could corrupt the image and/or cause exceptions. -
    RectArea of image that has changed and needs to be redrawn.
    Msg -Optional text describing in one or two words what the graphic class is -currently working on. For example: "Loading", "Storing", "Reducing colors", -etc. The Msg string can also be empty. Msg strings -should be resourced for translation, should not contain trailing periods, and -should be used only for display purposes. (Do not use the construct: if Msg = -'Loading' then...) -
    -     -     +