mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-04-08 14:18:17 +02:00
FPDoc - further updates to TCustomBitmap in graphics.xml
git-svn-id: trunk@15374 -
This commit is contained in:
kirkpatc
parent
31c5d5d91e
commit
ad8b434a14
@ -257,6 +257,7 @@
|
||||
<short>
|
||||
<var>Default Data</var> for any new
|
||||
|
||||
|
||||
<var>Font</var>
|
||||
</short>
|
||||
<descr>
|
||||
@ -2082,8 +2083,10 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor.</descr>
|
||||
<short>
|
||||
<var>Assign</var> - copies the
|
||||
|
||||
|
||||
<var>LogFont</var> or
|
||||
|
||||
|
||||
<var>Source</var> settings to itself</short>
|
||||
<descr>
|
||||
<p>Method: <var>TFont.Assign</var>
|
||||
@ -2176,6 +2179,7 @@ Copies the logfont or source settings to itself
|
||||
<short>
|
||||
<var>Colour</var> of the current
|
||||
|
||||
|
||||
<var>Font</var>
|
||||
</short>
|
||||
<descr>Default is the same as the text used for the rest of the Window
|
||||
@ -2190,6 +2194,7 @@ Copies the logfont or source settings to itself
|
||||
<short>
|
||||
<var>Name</var> of the
|
||||
|
||||
|
||||
<var>Font</var>
|
||||
</short>
|
||||
</element>
|
||||
@ -2202,6 +2207,7 @@ Copies the logfont or source settings to itself
|
||||
|
||||
|
||||
|
||||
|
||||
<var>Font</var>
|
||||
</short>
|
||||
<descr>Fixed or variable pitch, or Default<br/>
|
||||
@ -2225,6 +2231,7 @@ Reads or writes a flag to determine pitch type</descr>
|
||||
|
||||
|
||||
|
||||
|
||||
<var>Font</var>
|
||||
</short>
|
||||
<descr>Bold, Italic, Strike out, Underline<br/>
|
||||
@ -2614,6 +2621,7 @@ Default is psSolid</descr>
|
||||
|
||||
|
||||
|
||||
|
||||
<var>Source</var>
|
||||
<var>Brush</var> to itself</short>
|
||||
<descr>Method: TBrush.Assign<br/>
|
||||
@ -2631,6 +2639,7 @@ Default is psSolid</descr>
|
||||
|
||||
|
||||
|
||||
|
||||
<var>Brush</var>
|
||||
</short>
|
||||
</element>
|
||||
@ -2652,12 +2661,14 @@ Default is psSolid</descr>
|
||||
|
||||
|
||||
|
||||
|
||||
<var>Brush</var> and frees
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<var>Handle</var>
|
||||
</descr>
|
||||
</element>
|
||||
@ -2686,6 +2697,7 @@ Default is psSolid</descr>
|
||||
<short>
|
||||
<var>Style</var> of the
|
||||
|
||||
|
||||
<var>Brush</var>
|
||||
</short>
|
||||
<descr>Enumerated type - default Solid
|
||||
@ -2813,6 +2825,7 @@ Default is psSolid</descr>
|
||||
|
||||
|
||||
|
||||
|
||||
<var>Source</var> to itself</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
@ -3103,6 +3116,7 @@ Default is psSolid</descr>
|
||||
|
||||
|
||||
|
||||
|
||||
<b>override</b> this method in descendant classes</descr>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
@ -3134,6 +3148,7 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
<short>
|
||||
<var>LoadFromStream</var> - reads graphic data from a stream (e.g.
|
||||
|
||||
|
||||
<var>TBlobStream</var> )</short>
|
||||
<descr>
|
||||
<var>LoadFromStream</var>
|
||||
@ -3143,6 +3158,7 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
|
||||
|
||||
|
||||
|
||||
<var>LoadFromFile</var>
|
||||
except source is a stream (e.g.
|
||||
|
||||
@ -3150,6 +3166,7 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
|
||||
|
||||
|
||||
|
||||
<var>TBlobStream</var>)
|
||||
</descr>
|
||||
</element>
|
||||
@ -3401,19 +3418,25 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
<short>
|
||||
<var>TPicture</var> is a
|
||||
|
||||
|
||||
<var>TGraphic</var> container, used in place of a
|
||||
|
||||
|
||||
<var>TGraphic</var> if the graphic can be of any
|
||||
|
||||
|
||||
<var>TGraphic</var> class.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TPicture</var> is a
|
||||
|
||||
|
||||
<var>TGraphic</var> container. It is used in place of a
|
||||
|
||||
|
||||
<var>TGraphic</var> if the graphic can be of any
|
||||
|
||||
|
||||
<var>TGraphic</var> class. </p>
|
||||
<p>It is not a direct descendant of <var>TGraphic</var>, so you will not see <var>TGraphic</var> listed in the <var>Inheritance</var> chart, but it contains a property <var>Graphic</var>, of type <var>TGraphic</var>, so can contain all the properties of a <var>TGraphic</var>
|
||||
</p>
|
||||
@ -3422,19 +3445,25 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
<p>
|
||||
<var>LoadFromFile</var> and
|
||||
|
||||
|
||||
<var>SaveToFile</var> are polymorphic. For example, if the
|
||||
|
||||
|
||||
<var>TPicture</var> is holding an
|
||||
|
||||
|
||||
<var>Icon</var>, you can
|
||||
|
||||
|
||||
<var>LoadFromFile</var> a bitmap file, whereas if the class is
|
||||
|
||||
|
||||
<var>TIcon</var> you could only read .ICO files.</p>
|
||||
<ul>
|
||||
<li>
|
||||
<var>LoadFromFile</var> - Reads a picture from disk. The
|
||||
|
||||
|
||||
<var>TGraphic</var> class created is determined by the file extension of the file. If the file extension is not recognized an exception is generated.</li>
|
||||
<li>
|
||||
<var>SaveToFile</var> - Writes the picture to disk.</li>
|
||||
@ -3445,27 +3474,34 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
<li>
|
||||
<var>SupportsClipboardFormat</var> - Returns true if the given clipboard format is supported by
|
||||
|
||||
|
||||
<var>LoadFromClipboardFormat</var>
|
||||
</li>
|
||||
<li>
|
||||
<var>Assign</var> - Copies the contents of the given
|
||||
|
||||
|
||||
<var>TPicture</var>. Used most often in the implementation of TPicture properties.</li>
|
||||
<li>
|
||||
<var>RegisterFileFormat</var> - Register a new
|
||||
|
||||
|
||||
<var>TGraphic</var> class for use in
|
||||
|
||||
|
||||
<var>LoadFromFile</var>.</li>
|
||||
<li>
|
||||
<var>RegisterClipboardFormat</var> - Registers a new
|
||||
|
||||
|
||||
<var>TGraphic</var> class for use in
|
||||
|
||||
|
||||
<var>LoadFromClipboardFormat</var>.</li>
|
||||
<li>
|
||||
<var>UnRegisterGraphicClass</var> - Removes all references to the specified
|
||||
|
||||
|
||||
<var>TGraphic</var> class and all its descendants from the file format and clipboard format internal lists.</li>
|
||||
<li>
|
||||
<var>Height</var> - The native, unstretched, height of the picture.</li>
|
||||
@ -3474,8 +3510,10 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
<li>
|
||||
<var>Graphic</var> - The
|
||||
|
||||
|
||||
<var>TGraphic</var> object contained by the
|
||||
|
||||
|
||||
<var>TPicture</var>
|
||||
</li>
|
||||
<li>
|
||||
@ -3485,14 +3523,17 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
<li>
|
||||
<var>PNG</var> - Returns a png. If the contents is not already a png, the contents are thrown away and a blank png (
|
||||
|
||||
|
||||
<var>TPortableNetworkGraphic</var>) is returned.</li>
|
||||
<li>
|
||||
<var>PNM</var> - Returns a pnm. If the contents is not already a pnm, the contents are thrown away and a blank pnm (
|
||||
|
||||
|
||||
<var>TPortableAnyMapGraphic</var>) is returned.</li>
|
||||
<li>
|
||||
<var>Jpeg</var> - Returns a jpeg. If the contents is not already a jpeg, the contents are thrown away and a blank jpeg (
|
||||
|
||||
|
||||
<var>TJPegImage</var>) is returned.</li>
|
||||
</ul>
|
||||
</descr>
|
||||
@ -3759,6 +3800,7 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
|
||||
|
||||
|
||||
|
||||
<var>TGraphic</var> class created is determined by the file extension of the file.</descr>
|
||||
<errors>If the file extension is not recognized an exception is generated</errors>
|
||||
</element>
|
||||
@ -3825,6 +3867,7 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
|
||||
|
||||
|
||||
|
||||
<var>LoadFromClipboardFormat</var>
|
||||
</short>
|
||||
</element>
|
||||
@ -3841,6 +3884,7 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
<short>
|
||||
<var>Assign</var> - Copies the contents of the given
|
||||
|
||||
|
||||
<var>TPicture</var>
|
||||
</short>
|
||||
<descr>
|
||||
@ -3850,6 +3894,7 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
|
||||
|
||||
|
||||
|
||||
<var>TPicture</var>. Used most often in the implementation of TPicture properties.
|
||||
</descr>
|
||||
</element>
|
||||
@ -3862,8 +3907,10 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
<short>
|
||||
<var>RegisterFileFormat</var> - Register a new
|
||||
|
||||
|
||||
<var>TGraphic</var> class for use in
|
||||
|
||||
|
||||
<var>LoadFromFile</var>
|
||||
</short>
|
||||
</element>
|
||||
@ -3884,8 +3931,10 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
<short>
|
||||
<var>RegisterClipboardFormat</var> - Registers a new
|
||||
|
||||
|
||||
<var>TGraphic</var> class for use in
|
||||
|
||||
|
||||
<var>LoadFromClipboardFormat</var>
|
||||
</short>
|
||||
</element>
|
||||
@ -3902,6 +3951,7 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
<short>
|
||||
<var>UnRegisterGraphicClass</var> - Removes all references to the specified
|
||||
|
||||
|
||||
<var>TGraphic</var>
|
||||
</short>
|
||||
<descr>
|
||||
@ -3912,6 +3962,7 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
|
||||
|
||||
|
||||
|
||||
<var>TGraphic</var>
|
||||
class and all its descendants from the file format and clipboard format internal lists
|
||||
</descr>
|
||||
@ -3946,6 +3997,7 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
<descr>
|
||||
<var>PNG</var> - Returns a png. If the contents is not already a png, the contents are thrown away and a blank png (
|
||||
|
||||
|
||||
<var>TPortableNetworkGraphic</var>) is returned
|
||||
</descr>
|
||||
</element>
|
||||
@ -3959,8 +4011,10 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
<short>
|
||||
<var>Graphic</var> - The
|
||||
|
||||
|
||||
<var>TGraphic</var> object contained by the
|
||||
|
||||
|
||||
<var>TPicture</var>
|
||||
</short>
|
||||
</element>
|
||||
@ -4424,6 +4478,7 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
|
||||
|
||||
|
||||
|
||||
<var>TCanvas</var>
|
||||
</descr>
|
||||
</element>
|
||||
@ -4438,6 +4493,7 @@ If the file is not of the right format, an exception will be generated.</descr>
|
||||
|
||||
|
||||
|
||||
|
||||
<var>TCanvas</var> and makes its resources available</descr>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
@ -4960,6 +5016,7 @@ Use <var>Ellipse</var>
|
||||
|
||||
|
||||
|
||||
|
||||
<var>X1, Y1</var>
|
||||
</short>
|
||||
</element>
|
||||
@ -5030,6 +5087,7 @@ Use <var>Ellipse</var>
|
||||
|
||||
|
||||
|
||||
|
||||
<var>Pie</var> to draw a filled pie-shaped wedge on the canvas</short>
|
||||
<descr>Method: TCanvas.RadialPie<br/>
|
||||
|
||||
@ -6628,6 +6686,7 @@ The boundaries of the rectangle are specified in <var>ARect</var><br/><var>X, Y<
|
||||
|
||||
|
||||
|
||||
|
||||
<b>override</b> the definition from ancestor classes</descr>
|
||||
</element>
|
||||
<!-- destructor Visibility: public -->
|
||||
@ -6641,6 +6700,7 @@ The boundaries of the rectangle are specified in <var>ARect</var><br/><var>X, Y<
|
||||
|
||||
|
||||
|
||||
|
||||
<b>override</b> the method defined for ancestor classes</descr>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
@ -6654,12 +6714,14 @@ The boundaries of the rectangle are specified in <var>ARect</var><br/><var>X, Y<
|
||||
|
||||
|
||||
|
||||
|
||||
<var>BitMap</var> data are already in use, the data are shared; if not, a new
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<var>BitMap</var> is produced</descr>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
@ -6734,12 +6796,14 @@ The boundaries of the rectangle are specified in <var>ARect</var><br/><var>X, Y<
|
||||
|
||||
|
||||
|
||||
|
||||
<var>BitMap</var> data from a device with Handle
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<var>DC</var>
|
||||
</short>
|
||||
</element>
|
||||
@ -6768,12 +6832,14 @@ The boundaries of the rectangle are specified in <var>ARect</var><br/><var>X, Y<
|
||||
|
||||
|
||||
|
||||
|
||||
<var>BitMap</var> data from a
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<var>Stream</var>
|
||||
</short>
|
||||
</element>
|
||||
@ -6792,6 +6858,7 @@ The boundaries of the rectangle are specified in <var>ARect</var><br/><var>X, Y<
|
||||
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
Checks for the presence of a valid Lazarus Resource, then uses
|
||||
|
||||
@ -6799,6 +6866,7 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
|
||||
|
||||
|
||||
|
||||
<var>LoadFromStream</var> to acquire the data</descr>
|
||||
<seealso>
|
||||
<link id="TBitmap.LoadFromStream"/>
|
||||
@ -6845,6 +6913,7 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
|
||||
|
||||
|
||||
|
||||
<var>Bitmap </var>data from the specified MIME stream</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
@ -6900,6 +6969,7 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
|
||||
|
||||
|
||||
|
||||
<var>PixMap</var> format</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
@ -7145,6 +7215,7 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
<short>
|
||||
<var>PixMap</var> - a class derived from
|
||||
|
||||
|
||||
<var>TBitMap</var> , with wrapper to deal specifically with PixMaps (ie using 'XPM' format)</short>
|
||||
<descr>
|
||||
<var>PixMap</var>
|
||||
@ -7448,6 +7519,7 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
|
||||
|
||||
|
||||
|
||||
<b>override</b> the destructor defined in ancestor classes</descr>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
@ -7577,7 +7649,9 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
<element name="ColorToIdent.Ident">
|
||||
<short>
|
||||
<var>Ident </var>- the name of the supplied
|
||||
|
||||
<var>Color</var> as found in the look-up table of
|
||||
|
||||
<var>Colors</var>
|
||||
</short>
|
||||
</element>
|
||||
@ -7595,6 +7669,7 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
<element name="IdentToColor.Ident">
|
||||
<short>
|
||||
<var>Ident</var> - the suppied name for the required
|
||||
|
||||
<var>Color</var>
|
||||
</short>
|
||||
</element>
|
||||
@ -7605,24 +7680,27 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
</element>
|
||||
<!-- function Visibility: default -->
|
||||
<element name="SysColorToSysColorIndex">
|
||||
<short/>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<short>
|
||||
<var>SysColorToSysColorIndex</var> - if
|
||||
<var>Color</var> is one of the system colours, returns the
|
||||
<var>Index</var> of the system colour</short>
|
||||
<errors>If <var>Color</var> is not a system color, returns -1</errors>
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="SysColorToSysColorIndex.Result">
|
||||
<short/>
|
||||
<short>Returns the Index value of the Color if it is a system colour, otherwise returns -1</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="SysColorToSysColorIndex.Color">
|
||||
<short/>
|
||||
<short>The <var>Color</var> for processing</short>
|
||||
</element>
|
||||
<!-- function Visibility: default -->
|
||||
<element name="ColorToRGB">
|
||||
<short>
|
||||
<var>ColorToRGB</var> - given a
|
||||
|
||||
<var>Color</var> value, converts into
|
||||
|
||||
<var>RGB</var>
|
||||
</short>
|
||||
</element>
|
||||
@ -7758,8 +7836,10 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
<short>
|
||||
<var>FPColorToTColor</var> - converts a colour specified as a
|
||||
|
||||
|
||||
<var>FPColor </var>to a colour of type
|
||||
|
||||
|
||||
<var>TColor</var>
|
||||
</short>
|
||||
<descr/>
|
||||
@ -7781,8 +7861,10 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
<short>
|
||||
<var>TColorToFPColor</var> - converts a colour of type
|
||||
|
||||
|
||||
<var>TColor </var>to one specified as a
|
||||
|
||||
|
||||
<var>FPColor</var>
|
||||
</short>
|
||||
<descr/>
|
||||
@ -7797,6 +7879,7 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
<element name="TColorToFPColor.c">
|
||||
<short>
|
||||
<var>c</var> - the supplied colour specified as type
|
||||
|
||||
<var>TColor</var>
|
||||
</short>
|
||||
</element>
|
||||
@ -8256,11 +8339,13 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
<short>
|
||||
<var>PNM </var>- a
|
||||
|
||||
|
||||
<b>PortableAnyMapGraphic </b>image</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>PNM </var>- a
|
||||
|
||||
|
||||
<b>PortableAnyMapGraphic </b>image</p>
|
||||
<p>Reads a PNM image. If it is not a valid PNM image, the contents are thrown away and a blank PNM is generated</p>
|
||||
</descr>
|
||||
@ -8308,6 +8393,7 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
|
||||
|
||||
|
||||
|
||||
<var>Bitmap</var> data from an interface image</short>
|
||||
</element>
|
||||
<element name="TBitmap.GetResourceType">
|
||||
@ -8350,6 +8436,7 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
|
||||
|
||||
|
||||
|
||||
<var>TGraphic</var> classes with computationally intensive (slow) operations, such as loading, storing, or transforming image data.</p>
|
||||
<table>
|
||||
<caption>Event params:
|
||||
@ -8617,6 +8704,7 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
<element name="TCustomBitmap">
|
||||
<short>
|
||||
<var>TCustomBitMap </var>- the base class for
|
||||
|
||||
<var>TBitmap</var>
|
||||
</short>
|
||||
</element>
|
||||
@ -9773,6 +9861,7 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
<element name="TCustomBitmapImage">
|
||||
<short>
|
||||
<var>TCustomBitmapImage</var> - the base type for
|
||||
|
||||
<var>TBitmapImage</var>
|
||||
</short>
|
||||
</element>
|
||||
@ -10126,18 +10215,15 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
</element>
|
||||
<!-- procedure Visibility: protected -->
|
||||
<element name="TCustomBitmap.Draw">
|
||||
<short/>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<short>Draw the bitmap on the specified Canvas at the specified coordinates</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomBitmap.Draw.DestCanvas">
|
||||
<short/>
|
||||
<short>The canvas on which the bitmap is to be drawn</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomBitmap.Draw.DestRect">
|
||||
<short/>
|
||||
<short>The rectangular coordinates where the canvas containing the bitmap is located</short>
|
||||
</element>
|
||||
<!-- function Visibility: protected -->
|
||||
<element name="TCustomBitmap.GetEmpty">
|
||||
@ -10439,6 +10525,7 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
<var>BitMap</var> constructor</short>
|
||||
<descr>
|
||||
<var>BitMap</var> constructor. The supplied code can
|
||||
|
||||
<b>override</b> the definition from ancestor classes</descr>
|
||||
</element>
|
||||
<!-- destructor Visibility: public -->
|
||||
@ -10448,16 +10535,19 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
<descr>
|
||||
<var>BitMap</var> destructor. The supplied code can
|
||||
|
||||
|
||||
<b>override</b> the method defined for ancestor classes</descr>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomBitmap.Assign">
|
||||
<short>
|
||||
<var>Assign</var>: find out about the
|
||||
|
||||
<var>Source</var> of the call.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Assign</var>: find out about the
|
||||
|
||||
<var>Source</var> of the call.</p>
|
||||
<p>If the <var>BitMap</var> data are already in use, the data are shared; if not, a new <var>BitMap</var> is produced
|
||||
</p>
|
||||
@ -10469,10 +10559,7 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomBitmap.FreeImage">
|
||||
<short/>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<short>Releases all the resources used for the image that is being discarded</short>
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TCustomBitmap.HandleAllocated">
|
||||
@ -10527,58 +10614,48 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
<short>The target resource type specified as a string</short>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomBitmap.LoadFromDevice"/>
|
||||
<element name="TCustomBitmap.LoadFromDevice">
|
||||
<short>Load a bitmap from the nominated Device</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomBitmap.LoadFromDevice.DC">
|
||||
<short/>
|
||||
<short>The handle for the device from which the bitmap is to be loaded</short>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomBitmap.LoadFromStream">
|
||||
<short/>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<short>Load a bitmap from a stream</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomBitmap.LoadFromStream.Stream">
|
||||
<short/>
|
||||
<short>The stream from which the bitmap is to be loaded</short>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomBitmap.LoadFromMimeStream">
|
||||
<short/>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<short>Load a bitmap from a MIME type stream</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomBitmap.LoadFromMimeStream.Stream">
|
||||
<short/>
|
||||
<short>The stream from which the bitmap is to be loaded</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomBitmap.LoadFromMimeStream.MimeType">
|
||||
<short/>
|
||||
<short>The MIME type of the stream from which the bitmap is to be loaded</short>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomBitmap.LoadFromIntfImage">
|
||||
<short/>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<short>Load a bitmap from a Lazarus interface image</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomBitmap.LoadFromIntfImage.IntfImage">
|
||||
<short/>
|
||||
<short>The Lazarus interface image from which the bitmap is to be loaded</short>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomBitmap.LoadFromXPMFile">
|
||||
<short/>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<short>Load a bitmap from a XPM file (pixmap)</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomBitmap.LoadFromXPMFile.Filename">
|
||||
<short/>
|
||||
<short>The name of the file from which the bitmap is to be loaded</short>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomBitmap.SaveToStream">
|
||||
@ -11126,11 +11203,16 @@ Checks for the presence of a valid Lazarus Resource, then uses
|
||||
</p>
|
||||
<p>A list of system <var>Colors</var> is specified as a look-up table of indices (Entry) and names (MapEntry)</p>
|
||||
This function checks that the value in
|
||||
|
||||
<var>Entry</var> is within the permitted range, and returns the data pair
|
||||
|
||||
<var>Value</var>,
|
||||
|
||||
<var>Name</var> of the corresponding colour in
|
||||
|
||||
<var>MapEntry</var>.
|
||||
|
||||
|
||||
<p>If <var>Entry</var> is out of range the Result is False</p>
|
||||
</descr>
|
||||
<errors>If <var>Entry</var> is out of the range [0..High(Colours)] the Result is returned as False</errors>
|
||||
@ -11148,8 +11230,11 @@ This function checks that the value in
|
||||
<element name="IdentEntry.MapEntry">
|
||||
<short>
|
||||
<var>MapEntry</var> - the record of
|
||||
|
||||
<var>Value</var>,
|
||||
|
||||
<var>Name</var> returned from the look-up table of
|
||||
|
||||
<var>Colors</var>
|
||||
</short>
|
||||
</element>
|
||||
@ -11310,6 +11395,15 @@ This function checks that the value in
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCustomBitmap.CanReadGraphicStreams">
|
||||
<short>Determine whether this instance of the class can read graphic streams</short>
|
||||
</element>
|
||||
<element name="TCustomBitmap.CanReadGraphicStreams.AClass">
|
||||
<short>Class of image processor to be used for reading the bitmap</short>
|
||||
</element>
|
||||
<element name="TCustomBitmap.CanReadGraphicStreams.Result">
|
||||
<short>Returns True if the supplied class is capable of reading graphic streams</short>
|
||||
</element>
|
||||
</module>
|
||||
<!-- Graphics -->
|
||||
</package>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user