mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-08-29 16:31:40 +02:00
docs: update more images
git-svn-id: trunk@23437 -
This commit is contained in:
dodi
parent
2f5e2f5d6a
commit
2f8e7da046
@ -11,8 +11,15 @@
|
||||
<var>TFPPalette</var> - FreePascal Palette definition: base for LCL TPalette etc</short>
|
||||
</element>
|
||||
<element name="TFPCustomImage">
|
||||
<short>
|
||||
<var>TFPCustomImage</var> - FreePascal base definition for all Image classes</short>
|
||||
<short>Abstract FreePascal base class for all Image classes</short>
|
||||
<descr>
|
||||
<link id="#LCL.intfgraphics.TLazIntfImage">TLazIntfImage</link> is an LCL implementation of this class.
|
||||
|
||||
TFPCustomImage only provides an image size and a palette, and methods to load, store and Assigne store images.
|
||||
The data storage and handling must be added in derived classes, by overriding the virtual (abstract) methods.</descr>
|
||||
<seealso>
|
||||
<link id="#LCL.intfgraphics.TLazIntfImage">TLazIntfImage</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TFPMemoryImage"/>
|
||||
<element name="TFPCustomImageHandler">
|
||||
@ -65,14 +72,18 @@
|
||||
</element>
|
||||
<element name="TFPPalette.Create">
|
||||
<short>
|
||||
<var>Create</var> - constructor for <var>TFPPalette</var>: calls inherited <var>Create</var> then finds how much memory to allocate for the specified number of colours</short>
|
||||
<var>Create</var> - constructor for
|
||||
<var>TFPPalette</var>: calls inherited
|
||||
<var>Create</var> then finds how much memory to allocate for the specified number of colours</short>
|
||||
<seealso>
|
||||
<link id="#rtl.System.TObject.Create">TObject.Create</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TFPPalette.Destroy">
|
||||
<short>
|
||||
<var>Destroy</var> - destructor for <var>TFPPalette</var>: frees memory then calls inherited <var>Destroy</var>
|
||||
<var>Destroy</var> - destructor for
|
||||
<var>TFPPalette</var>: frees memory then calls inherited
|
||||
<var>Destroy</var>
|
||||
</short>
|
||||
<seealso>
|
||||
<link id="#rtl.System.TObject.Destroy">TObject.Destroy</link>
|
||||
@ -84,11 +95,13 @@
|
||||
</element>
|
||||
<element name="TFPPalette.Copy">
|
||||
<short>
|
||||
<var>Copy</var> from the source (<var>APalette</var>) to the current Palette</short>
|
||||
<var>Copy</var> from the source (
|
||||
<var>APalette</var>) to the current Palette</short>
|
||||
</element>
|
||||
<element name="TFPPalette.Merge">
|
||||
<short>
|
||||
<var>Merge</var> the contents of another palette (<var>pal</var>) with the current palette</short>
|
||||
<var>Merge</var> the contents of another palette (
|
||||
<var>pal</var>) with the current palette</short>
|
||||
</element>
|
||||
<element name="TFPPalette.IndexOf">
|
||||
<short>
|
||||
@ -110,16 +123,20 @@
|
||||
<var>Count</var> - the total number of entries for colours in the palette</short>
|
||||
</element>
|
||||
<element name="TFPCustomImage.SetInternalColor">
|
||||
<short>
|
||||
<var>SetInternalColor</var> - specify the internal colour (using TFPColor format)</short>
|
||||
<short>Set RGBA pixel color.</short>
|
||||
<descr>This is a virtual method, that translates the RGBA color into an palette index, which then is stored in the pixel data.
|
||||
|
||||
Storage of true RGBA colors (not using a palette) has to be implemented in derived classes.</descr>
|
||||
</element>
|
||||
<element name="TFPCustomImage.GetInternalColor">
|
||||
<short>
|
||||
<var>GetInternalColor</var> - finds the internal colour from local store</short>
|
||||
<short>Get RGBA pixel color.</short>
|
||||
<descr>This is a virtual method, reading the RGBA color from the palette.
|
||||
|
||||
When true RGBA colors are stored, this must be reflected in a derived class.</descr>
|
||||
</element>
|
||||
<element name="TFPCustomImage.SetInternalPixel">
|
||||
<short>
|
||||
<var>SetInternalPixel</var> - specifies the integer Color of a pixel located at the given coordinates</short>
|
||||
<short>Set the internal color representation of a pixel.</short>
|
||||
<descr>This is an abstract method, expecting color information as an palette index by default, or RGBA data encoded as an Integer value.</descr>
|
||||
</element>
|
||||
<element name="TFPCustomImage.GetInternalPixel">
|
||||
<short>
|
||||
@ -146,20 +163,24 @@
|
||||
</element>
|
||||
<element name="TFPCustomImage.create">
|
||||
<short>
|
||||
<var>Create</var> - constructor for <var>TFPCustomImage</var>: calls inherited <var>Create</var> then initialises position and size, makes a stringlist</short>
|
||||
<var>Create</var> - constructor for
|
||||
<var>TFPCustomImage</var>: calls inherited
|
||||
<var>Create</var> then initialises position and size, makes a stringlist</short>
|
||||
<seealso>
|
||||
<link id="#rtl.System.TObject.Create">TObject.Create</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TFPCustomImage.destroy">
|
||||
<short>
|
||||
<var>Destroy</var> - destructor for <var>TFPCustomImage</var>: frees the Palette then calls inherited <var>Destroy</var>
|
||||
<var>Destroy</var> - destructor for
|
||||
<var>TFPCustomImage</var>: frees the Palette then calls inherited
|
||||
<var>Destroy</var>
|
||||
</short>
|
||||
<seealso>
|
||||
<link id="#rtl.Classes.TPersistent.Destroy">TPersistent.Destroy</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TFPCustomImage.Assign" link="#rtl.Classes.TPersistent.Assign"/>
|
||||
<element link="#rtl.Classes.TPersistent.Assign" name="TFPCustomImage.Assign"/>
|
||||
<element name="TFPCustomImage.LoadFromStream">
|
||||
<short>
|
||||
<var>LoadFromStream</var> loads data from the specified stream, optionally using the specified reader</short>
|
||||
@ -204,8 +225,7 @@
|
||||
<var>Extra</var> - Info unrelated with the image representation</short>
|
||||
</element>
|
||||
<element name="TFPCustomImage.ExtraValue">
|
||||
<short>
|
||||
<var>ExtraValue</var> - additional information stored with the image</short>
|
||||
<short>Additional information stored with the image</short>
|
||||
</element>
|
||||
<element name="TFPCustomImage.ExtraKey">
|
||||
<short>
|
||||
@ -225,7 +245,8 @@
|
||||
</element>
|
||||
<element name="TFPCustomImageClass">
|
||||
<short>
|
||||
<var>TFPCustomImageClass</var> - class of <var>TFPCustomImage</var>
|
||||
<var>TFPCustomImageClass</var> - class of
|
||||
<var>TFPCustomImage</var>
|
||||
</short>
|
||||
</element>
|
||||
<element name="PFPIntegerArray">
|
||||
@ -236,11 +257,11 @@
|
||||
<short>
|
||||
<var>TFPIntegerArray</var> - definition of integer array for use in images</short>
|
||||
</element>
|
||||
<element name="TFPMemoryImage.SetInternalPixel" link="#fcl.FPimage.TFPCustomImage.SetInternalPixel"/>
|
||||
<element name="TFPMemoryImage.GetInternalPixel" link="#fcl.FPimage.TFPCustomImage.GetInternalPixel"/>
|
||||
<element name="TFPMemoryImage.create" link="#fcl.FPimage.TFPCustomImage.create"/>
|
||||
<element name="TFPMemoryImage.destroy" link="#fcl.FPimage.TFPCustomImage.destroy"/>
|
||||
<element name="TFPMemoryImage.SetSize" link="#fcl.FPimage.TFPCustomImage.SetSize"/>
|
||||
<element link="#fcl.FPimage.TFPCustomImage.SetInternalPixel" name="TFPMemoryImage.SetInternalPixel"/>
|
||||
<element link="#fcl.FPimage.TFPCustomImage.GetInternalPixel" name="TFPMemoryImage.GetInternalPixel"/>
|
||||
<element link="#fcl.FPimage.TFPCustomImage.create" name="TFPMemoryImage.create"/>
|
||||
<element link="#fcl.FPimage.TFPCustomImage.destroy" name="TFPMemoryImage.destroy"/>
|
||||
<element link="#fcl.FPimage.TFPCustomImage.SetSize" name="TFPMemoryImage.SetSize"/>
|
||||
<element name="TFPCustomImageHandler.Progress">
|
||||
<short>
|
||||
<var>Progress</var> - method for displaying the progress of a drawing or painting action</short>
|
||||
@ -264,7 +285,7 @@
|
||||
<short>
|
||||
<var>TheImage</var> which is being read or written</short>
|
||||
</element>
|
||||
<element name="TFPCustomImageHandler.Create" link="#rtl.System.TObject.Create"/>
|
||||
<element link="#rtl.System.TObject.Create" name="TFPCustomImageHandler.Create"/>
|
||||
<element name="TFPCustomImageHandler.OnProgress">
|
||||
<short>
|
||||
<var>OnProgress</var> event handler for showing progress of drawing or painting</short>
|
||||
@ -277,7 +298,7 @@
|
||||
<short>
|
||||
<var>InternalCheck</var> - performs check on validity of stream, returns True if OK</short>
|
||||
</element>
|
||||
<element name="TFPCustomImageReader.Create" link="#rtl.System.TObject.Create"/>
|
||||
<element link="#rtl.System.TObject.Create" name="TFPCustomImageReader.Create"/>
|
||||
<element name="TFPCustomImageReader.ImageRead">
|
||||
<short>
|
||||
<var>ImageRead</var> read specified image from nominated stream; returns the image</short>
|
||||
@ -292,7 +313,8 @@
|
||||
</element>
|
||||
<element name="TFPCustomImageReaderClass">
|
||||
<short>
|
||||
<var>TFPCustomImageReaderClass</var> - class of <var>TFPCustomImageReader</var>
|
||||
<var>TFPCustomImageReaderClass</var> - class of
|
||||
<var>TFPCustomImageReader</var>
|
||||
</short>
|
||||
</element>
|
||||
<element name="TFPCustomImageWriter.InternalWrite">
|
||||
@ -305,7 +327,8 @@
|
||||
</element>
|
||||
<element name="TFPCustomImageWriterClass">
|
||||
<short>
|
||||
<var>TFPCustomImageWriterClass</var> - class of <var>TFPCustomImageWriter</var>
|
||||
<var>TFPCustomImageWriterClass</var> - class of
|
||||
<var>TFPCustomImageWriter</var>
|
||||
</short>
|
||||
</element>
|
||||
<element name="TIHData">
|
||||
@ -318,14 +341,18 @@
|
||||
</element>
|
||||
<element name="TImageHandlersManager.Create">
|
||||
<short>
|
||||
<var>Create</var> - constructor fro <var>TImageHandlersManager</var>: calls inherited <var>Create</var> then constructs list of handlers</short>
|
||||
<var>Create</var> - constructor fro
|
||||
<var>TImageHandlersManager</var>: calls inherited
|
||||
<var>Create</var> then constructs list of handlers</short>
|
||||
<seealso>
|
||||
<link id="#rtl.System.TObject.Create">TObject.Create</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TImageHandlersManager.Destroy">
|
||||
<short>
|
||||
<var>Destroy</var> - destructor for <var>TImageHandlersManager</var>: frees the list of handlers then calls inherited <var>Destroy</var>
|
||||
<var>Destroy</var> - destructor for
|
||||
<var>TImageHandlersManager</var>: frees the list of handlers then calls inherited
|
||||
<var>Destroy</var>
|
||||
</short>
|
||||
<seealso>
|
||||
<link id="#rtl.System.TObject.Destroy">TObject.Destroy</link>
|
||||
@ -364,11 +391,13 @@
|
||||
</element>
|
||||
<element name="TFPColor">
|
||||
<short>
|
||||
<var>TFPColor</var> - record type used as an internal representation for a colour: a <var>TColor</var> has been decomposed into its component Red, Green, Blue and Alpha parts, to allow easy manipulation of each</short>
|
||||
<var>TFPColor</var> - record type used as an internal representation for a colour: a
|
||||
<var>TColor</var> has been decomposed into its component Red, Green, Blue and Alpha parts, to allow easy manipulation of each</short>
|
||||
</element>
|
||||
<element name="PFPColor">
|
||||
<short>
|
||||
<var>PFPColor</var> - pointer to a <var>TFPColor</var>
|
||||
<var>PFPColor</var> - pointer to a
|
||||
<var>TFPColor</var>
|
||||
</short>
|
||||
</element>
|
||||
</module>
|
||||
|
||||
@ -336,7 +336,9 @@ xxxBitsPerPixel and xxxPrecisionMask applies to color data. For masked images, t
|
||||
<!-- record type Visibility: default -->
|
||||
<element name="TRawImage">
|
||||
<short>An uncompressed graphics image (bitmap)</short>
|
||||
<descr>This object hold the pixels, mask and color palette of the image, as well as a detailed <link id="TRawImageDescription">description</link> of the storage format of these parts.</descr>
|
||||
<descr>This object hold the pixels, mask and color palette of the image, as well as a detailed <link id="TRawImageDescription">description</link> of the storage format of these parts.
|
||||
|
||||
This object currently is subject to refactoring, don't use it in application code.</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- variable Visibility: default -->
|
||||
@ -922,12 +924,10 @@ A Mask value of 1 means that the pixel is masked (transparent); a value of 0 mea
|
||||
<short>The number of bits per Mask scanline.</short>
|
||||
</element>
|
||||
<element name="TRawImageDescription.AsString">
|
||||
<short>
|
||||
<var>AsString</var> - returns the image as a string</short>
|
||||
<short>The image descriptor as a string.</short>
|
||||
</element>
|
||||
<element name="TRawImageDescription.IsEqual">
|
||||
<short>
|
||||
<var>IsEqual</var> - compares th ecurrent descriptor with another, and returns True if they are equal</short>
|
||||
<short>Compares with the given description, returns True if it's equal.</short>
|
||||
</element>
|
||||
<element name="TRawImage.Init">
|
||||
<short>
|
||||
@ -938,8 +938,7 @@ A Mask value of 1 means that the pixel is masked (transparent); a value of 0 mea
|
||||
<var>CreateData</var> - method to create the data for the record</short>
|
||||
</element>
|
||||
<element name="TRawImage.FreeData">
|
||||
<short>
|
||||
<var>FreeData</var> - releases data that had previously been locked or made unavailable</short>
|
||||
<short>Destroys the allocated Data, Mask and Palette arrays.</short>
|
||||
</element>
|
||||
<element name="TRawImage.ReleaseData">
|
||||
<short>
|
||||
@ -958,16 +957,14 @@ A Mask value of 1 means that the pixel is masked (transparent); a value of 0 mea
|
||||
<var>ReadBits</var> - reads the bit values for the raw image data at a given position</short>
|
||||
</element>
|
||||
<element name="TRawImage.ReadChannels">
|
||||
<short>
|
||||
<var>ReadChannels</var> - reads the (R, G, B, Alpha) channel values at a given position in the raw data</short>
|
||||
<short>Reads the R, G, B and Alpha channel values at a given position in pixel data.</short>
|
||||
</element>
|
||||
<element name="TRawImage.ReadMask">
|
||||
<short>
|
||||
<var>ReadMask</var> - reads the Mask data at the given position in the raw image</short>
|
||||
<short>Read the Mask value at the given position in the image data. Returns AMask=True if the pixel is transparent.</short>
|
||||
<descr>The position in the Mask data typically differs from the position in the color data.</descr>
|
||||
</element>
|
||||
<element name="TRawImage.WriteBits">
|
||||
<short>
|
||||
<var>WriteBits</var> - writes the specified bit values at the nominated position in the data</short>
|
||||
<short>Writes ABits into Data at the given position.</short>
|
||||
</element>
|
||||
<element name="TRawImage.WriteChannels">
|
||||
<short>
|
||||
@ -1021,6 +1018,25 @@ A Mask value of 1 means that the pixel is masked (transparent); a value of 0 mea
|
||||
<element name="TRawImageQueryFlag">
|
||||
<short>Image formats supported by a device, or present in image data[?]</short>
|
||||
</element>
|
||||
<element name="RawImage_ReadBits">
|
||||
<short>Read color bits.</short>
|
||||
<descr>AData is the pointer to the pixel data.
|
||||
APosition is the position of a pixel within AData.
|
||||
ABitsPerPixel is the size of a stored pixel.
|
||||
APrec and AShift select the field (color channel or palette index).
|
||||
|
||||
The bits are extracted into the low order bits of the result (ABits).</descr>
|
||||
<seealso>
|
||||
<link id="RawImage_WriteBits"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="RawImage_WriteBits">
|
||||
<short>Write color or mask data, from the high bits of ABits.</short>
|
||||
<errors>ReadBits returns the value in the low order bits</errors>
|
||||
<seealso>
|
||||
<link id="RawImage_ReadBits"/>
|
||||
</seealso>
|
||||
</element>
|
||||
</module>
|
||||
<!-- GraphType -->
|
||||
</package>
|
||||
|
||||
@ -180,8 +180,7 @@
|
||||
</element>
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TCustomImageList">
|
||||
<short>
|
||||
<var>TCustomImageList</var> - base class for <var>TImageList</var> (not the same as a <var>TBitmap</var> collection)</short>
|
||||
<short>Base class for TImageList (not the same as a <var>TBitmap</var> collection)</short>
|
||||
<descr>An ImageList contains images (bitmaps or icons) of the same Width and Height, accessible by index. The images are stored in one big (wide) bitmap, whose width is Width*Count. When an image of a different Width or Height is inserted, the previous contents of the list are discarded!
|
||||
|
||||
It's okay, however, to insert an imagelist-like bitmap, that contains multiple bitmaps of the same Width and Height as used by the ImageList. This allows to insert e.g. other (compatible) ImageLists, or bitmaps for multiple states of essentially the same image (button pressed, released and disabled).
|
||||
|
||||
@ -165,11 +165,10 @@
|
||||
</element>
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TLazIntfImage">
|
||||
<short>
|
||||
<var>TLazIntfImage</var> - This descendant of <var>TFPCustomImage </var>stores its image data as raw images and is therefore able to interchange images directly with the LCL interfaces.</short>
|
||||
<short>Represents a graphical image.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TLazIntfImage</var> - This descendant of <var>TFPCustomImage</var> stores its image data as raw images and is therefore able to interchange images directly with the LCL interfaces.</p>
|
||||
<p>This descendant of <var>TFPCustomImage</var> stores the image data as TRawImage, and is therefore able to interchange images directly with the LCL interfaces.</p>
|
||||
<p>A large number of the protected methods (GetColorxxxxxx and SetColorxxxxxx) deal with direct interface to the operating system at the pixel level</p>
|
||||
<pre>Usage examples:
|
||||
|
||||
1. Loading a .xpm file into a TBitmap:
|
||||
@ -227,7 +226,6 @@
|
||||
end;
|
||||
}
|
||||
</pre>
|
||||
<p>A large number of the protected methods (GetColorxxxxxx and SetColorxxxxxx) deal with direct interface to the operating system at the pixel level</p>
|
||||
</descr>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
@ -2213,6 +2211,9 @@
|
||||
<short>
|
||||
<var>TLazReaderIconDIB</var> - this is a <var>FPImage</var> reader for a single DIB from an icon file</short>
|
||||
</element>
|
||||
<element name="TLazIntfImage.GetDataLineStart">
|
||||
<short>Returns an pointer to the scanline raw data.</short>
|
||||
</element>
|
||||
</module>
|
||||
<!-- IntfGraphics -->
|
||||
</package>
|
||||
|
||||
@ -95,20 +95,23 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TLCLReferenceComponent">
|
||||
<short>
|
||||
<var>TLCLReferenceComponent</var> - A base class for all components having a handle</short>
|
||||
<short>Base class for all components having a handle.</short>
|
||||
<descr>Apart from the OS/window manager specific window Handle, LCL components can include a Reference to an widgetset specific object.
|
||||
|
||||
Application use is restricted to sending messages to a windowed control, using its window Handle.
|
||||
</descr>
|
||||
</element>
|
||||
<element name="TLCLReferenceComponent.Destroy">
|
||||
<short>
|
||||
<var>Destroy</var> the reference, then perform inherited <var>Destroy</var>
|
||||
</short>
|
||||
<short>Destroys the Reference, prior to calling the inherited destructor.</short>
|
||||
<seealso>
|
||||
<link id="#LCL.LCLClasses.TLCLComponent.Destroy">TLCLComponent.Destroy</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TLCLReferenceComponent.Handle">
|
||||
<short>
|
||||
<var>Handle</var> a handle (sort of pointer or reference) allocated by the operating system to this component</short>
|
||||
<short>Get the Handle of this component.</short>
|
||||
<descr>The Handle is sort of pointer or reference, allocated by the operating system or widgetset to this component.
|
||||
|
||||
A window handle can be used for sending messages to the component.[?]</descr>
|
||||
</element>
|
||||
<element name="TLCLReferenceComponent.HandleAllocated">
|
||||
<short>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user