mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-08-22 15:59:15 +02:00
Docs: LCL/imglist. Removes extra spaces in topics. Updates tagging for True and False values.
This commit is contained in:
dsiders
parent
34195c850e
commit
3abfbc970c
@ -1378,7 +1378,7 @@
|
||||
<short>Position for the overlay image applied in the method.</short>
|
||||
</element>
|
||||
<element name="TScaledImageListResolution.DrawOverlay.AEnabled">
|
||||
<short>True when the image is drawn in the enabled state (default).</short>
|
||||
<short><b>True</b> when the image is drawn in the enabled state (default).</short>
|
||||
</element>
|
||||
<element name="TScaledImageListResolution.DrawOverlay.ADrawEffect">
|
||||
<short>TGraphicsDrawEffect value applied to the image.</short>
|
||||
@ -1470,12 +1470,12 @@
|
||||
The return Value is <b>True</b> when an image resolution is located with the value specified in AImageWidth. The return value is <b>False</b> if an image resolution is not found using the specified image width.
|
||||
</p>
|
||||
<p>
|
||||
<var>Index</var> is an output parameter used to store the ordinal position of the image resolution that uses the specified image width. Index contains the closest (but larger) resolution when the return value is False.
|
||||
<var>Index</var> is an output parameter used to store the ordinal position of the image resolution that uses the specified image width. Index contains the closest (but larger) resolution when the return value is <b>False</b>.
|
||||
</p>
|
||||
</descr>
|
||||
</element>
|
||||
<element name="TCustomImageListResolutions.Find.Result">
|
||||
<short>True when the image resolution exists in the Items property.</short>
|
||||
<short><b>True</b> when the image resolution exists in the Items property.</short>
|
||||
</element>
|
||||
<element name="TCustomImageListResolutions.Find.AImageWidth">
|
||||
<short>Image width desired from the Items property.</short>
|
||||
@ -1870,7 +1870,7 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TCustomImageListResolutionEnumerator.MoveNext.Result">
|
||||
<short>True when another image resolution is available in the enumerator.</short>
|
||||
<short><b>True</b> when another image resolution is available in the enumerator.</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomImageListResolutionEnumerator.Current">
|
||||
@ -2485,7 +2485,9 @@
|
||||
<short>Index position validated in the method.</short>
|
||||
</element>
|
||||
<element name="TCustomImageList.CheckIndex.AForInsert">
|
||||
<short>True when the index position is used for insertion (default is False).</short>
|
||||
<short>
|
||||
<b>True</b> when the index position is used for insertion (default is <b>False</b>).
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomImageList.Initialize">
|
||||
@ -3020,7 +3022,7 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TCustomImageList.Equals.Result">
|
||||
<short>True when the image lists are equivalent.</short>
|
||||
<short><b>True</b> when the image lists are equivalent.</short>
|
||||
</element>
|
||||
<element name="TCustomImageList.Equals.Obj">
|
||||
<short>The image list object used for the comparison.</short>
|
||||
@ -3578,7 +3580,7 @@
|
||||
<short>Position in the list for the image drawn to the canvas.</short>
|
||||
</element>
|
||||
<element name="TCustomImageList.Draw.AEnabled">
|
||||
<short>If False, the image is drawn disabled (dithered).</short>
|
||||
<short>If <b>False</b>, the image is drawn disabled (dithered).</short>
|
||||
</element>
|
||||
<element name="TCustomImageList.Draw.ADrawEffect">
|
||||
<short>Drawing effect applied to the rendered image.</short>
|
||||
@ -4025,7 +4027,7 @@
|
||||
Move uses the Resolutions enumerator to visit each of the image resolutions in the image list. The InternalMove method in the TCustomImageListResolution instance is called to relocate image data using the specified positions. If the handle for the image resolution has been allocated, the widgetset class calls its Move method to mirror the change to the image list.
|
||||
</p>
|
||||
<p>
|
||||
Move sets the value in the internal Changed flag to True, and calls the Change method to perform notifications for the change event.
|
||||
Move sets the value in the internal Changed flag to <b>True</b>, and calls the Change method to perform notifications for the change event.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -4123,7 +4125,7 @@
|
||||
<var>AMask</var> is a TCustomBitmap type that contains the image mask which defines the transparent areas in the image. When AMask is omitted, the image is drawn opaque.
|
||||
</p>
|
||||
<p>
|
||||
<var>AllResolutions</var> indicates if the image at the specified position is replaced in all resolutions for the image list. When AllResolutions is False, the only resolution updated is the one which uses the width in AImage. When AllResolutions is True, the <var>Resolutions</var> enumerator is used to update each of the <var>TCustomImageListResolution</var> instances in the image list.
|
||||
<var>AllResolutions</var> indicates if the image at the specified position is replaced in all resolutions for the image list. When AllResolutions is <b>False</b>, the only resolution updated is the one which uses the width in AImage. When AllResolutions is <b>True</b>, the <var>Resolutions</var> enumerator is used to update each of the <var>TCustomImageListResolution</var> instances in the image list.
|
||||
</p>
|
||||
<p>
|
||||
The <var>ScaleImage</var> method is called to resize the image and its mask to the width required for an image resolution. The <var>InternalReplace</var> method in the image resolution is called to update the scaled 32-bit raw image data stored at the position in AIndex.
|
||||
@ -4164,7 +4166,7 @@
|
||||
<var>AImageRect</var> is a TRect type that defined the top, left, bottom, and right coordinates for the image data used in the method.
|
||||
</p>
|
||||
<p>
|
||||
<var>AllResolutions</var> indicates if the image stored at the specified position is updated in all of the image resolutions for the image list. When AllResolutions contains False, only the image resolution using the width defined in ARect is updated in the method. When AllResolutions is True, the <var>Resolutions</var> enumerator is used to update each of the image resolutions used in the image list.
|
||||
<var>AllResolutions</var> indicates if the image stored at the specified position is updated in all of the image resolutions for the image list. When AllResolutions contains <b>False</b>, only the image resolution using the width defined in ARect is updated in the method. When AllResolutions is <b>True</b>, the <var>Resolutions</var> enumerator is used to update each of the image resolutions used in the image list.
|
||||
</p>
|
||||
<p>
|
||||
The <var>ScaleImage</var> method is called to resize the Image rectangle to the height and width required for the image resolution(s). The <var>InternalReplace</var> method in each image resolution is called to store the scaled 32-bit RGBA raw image data.
|
||||
@ -4207,7 +4209,7 @@
|
||||
<var>Image</var> is a TCustomBitmap instance that contains the image data store in the image list.
|
||||
</p>
|
||||
<p>
|
||||
<var>AllResolutions</var> indicates if all image resolutions are updated in the method. When AllResolutions is False, only the image resolution using the image width in AImageWidth is updated in the method. When AllResolutions is True, the image stored at the specified position is updates in all <var>Resolutions</var> for the image list.
|
||||
<var>AllResolutions</var> indicates if all image resolutions are updated in the method. When AllResolutions is <b>False</b>, only the image resolution using the image width in AImageWidth is updated in the method. When AllResolutions is <b>True</b>, the image stored at the specified position is updates in all <var>Resolutions</var> for the image list.
|
||||
</p>
|
||||
<p>
|
||||
ReplaceSliceCentered calls the <var>ReplaceSlice</var> method to update the image at the specified position using the parameters passed to the method.
|
||||
@ -4280,7 +4282,7 @@
|
||||
<var>MaskColor</var> contains a TColor value that represents transparent pixels in the image. Every pixel in the image using the color in MaskColor is converted to a transparent pixel.
|
||||
</p>
|
||||
<p>
|
||||
<var>AllResolutions</var> indicates if all resolutions in the image list are affected in the method. When AllResolutions contains False, only the resolution using the Width in NewImage is updated with the new image data. When AllResolutions contains True, the <var>Resolutions</var> enumerator is used to scale and store the image for each <var>TCustomImageListResolution</var> instance.
|
||||
<var>AllResolutions</var> indicates if all resolutions in the image list are affected in the method. When AllResolutions contains <b>False</b>, only the resolution using the Width in NewImage is updated with the new image data. When AllResolutions contains <b>True</b>, the <var>Resolutions</var> enumerator is used to scale and store the image for each <var>TCustomImageListResolution</var> instance.
|
||||
</p>
|
||||
<p>
|
||||
ReplaceMasked creates a temporary TBitmap instance that is used to update the TransparentColor and Transparent properties for the image. It is also used when the image is scaled for the various image resolutions.
|
||||
@ -4412,7 +4414,7 @@
|
||||
<var>RegisterResolutions</var> is a procedure used to register image resolutions (or sizes) used in the image list. RegisterResolutions allows <var>TCustomImageListResolution</var> instances to be created and stored in the image resolution container for the image list.
|
||||
</p>
|
||||
<p>
|
||||
<var>AResolutionWidths</var> is an array of Integer values that contains the icon widths for the image resolutions used in the image list. Each image width is passed as an argument to the <var>GetResolution</var> method. This locates the image resolution class instance if it already exists, or creates a new one when needed. The <var>AutoCreatedInDesignTime</var> property in the image resolution is set to False to show that the resolution was created at run-time.
|
||||
<var>AResolutionWidths</var> is an array of Integer values that contains the icon widths for the image resolutions used in the image list. Each image width is passed as an argument to the <var>GetResolution</var> method. This locates the image resolution class instance if it already exists, or creates a new one when needed. The <var>AutoCreatedInDesignTime</var> property in the image resolution is set to <b>False</b> to show that the resolution was created at run-time.
|
||||
</p>
|
||||
<p>
|
||||
Use <var>RegisterResolutions</var> prior to adding images to the image list at run-time.
|
||||
@ -4459,7 +4461,7 @@
|
||||
AResolution is a <var>TCustomImageListResolution</var> output parameter used to return the image resolution using the specified image width. AResolution contains Nil when the image width is not used in the resolutions for the image list.
|
||||
</p>
|
||||
<p>
|
||||
FindResolution calls the <var>Find</var> method for the internal <var>TCustomImageListResolutions</var> container. The return value is True when an image resolution using the specified image width is found in the resolutions for the image list. The <var>ResolutionByIndex</var> property is used to get the class instance for AResolution when the return value is True.
|
||||
FindResolution calls the <var>Find</var> method for the internal <var>TCustomImageListResolutions</var> container. The return value is <b>True</b> when an image resolution using the specified image width is found in the resolutions for the image list. The <var>ResolutionByIndex</var> property is used to get the class instance for AResolution when the return value is <b>True</b>.
|
||||
</p>
|
||||
<p>
|
||||
FindResolution is used in the implementation of the <var>Replace</var>, <var>ReplaceMasked</var>, <var>ReplaceSlice</var>, and <var>ReplaceSliceCentered</var> methods.
|
||||
@ -4475,7 +4477,7 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TCustomImageList.FindResolution.Result">
|
||||
<short>True when an image resolution using the specified width is found.</short>
|
||||
<short><b>True</b> when an image resolution using the specified width is found.</short>
|
||||
</element>
|
||||
<element name="TCustomImageList.FindResolution.AImageWidth">
|
||||
<short>Image width for the resolution requested in the method.</short>
|
||||
@ -4685,7 +4687,7 @@
|
||||
<var>APPI</var> is an Integer value that contains the display density used to calculate the width of images.
|
||||
</p>
|
||||
<p>
|
||||
Reading the value for the property causes the image width to be calculated using the specified parameter values. If AWidth is 0 (zero) or a negative number, the value in the <var>Width</var> property is used as the initial image width. When <var>Scaled</var> contains True, the image width is calculated using the following formula:
|
||||
Reading the value for the property causes the image width to be calculated using the specified parameter values. If AWidth is 0 (zero) or a negative number, the value in the <var>Width</var> property is used as the initial image width. When <var>Scaled</var> contains <b>True</b>, the image width is calculated using the following formula:
|
||||
</p>
|
||||
<code>(AImageWidth * APPI) / 96</code>
|
||||
<p>
|
||||
@ -4714,7 +4716,7 @@
|
||||
</p>
|
||||
<code>AImageWidth * Factor div 100</code>
|
||||
<p>
|
||||
When <var>Scaled</var> is False, image width scaling is not performed and the value in AImageWidth is used as the property value.
|
||||
When <var>Scaled</var> is <b>False</b>, image width scaling is not performed and the value in AImageWidth is used as the property value.
|
||||
</p>
|
||||
<p>
|
||||
The <var>OnGetWidthForPPI</var> event handler is signalled (when assigned) to allow overriding the calculated image width. Applications can provide a <var>TCustomImageListGetWidthForPPI</var> procedure which uses custom scaling logic, or performs simple image width substitution for given display densities.
|
||||
@ -4790,10 +4792,10 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Masked</var> is a Boolean property which indicates if images in the image list contain an image mask that defines the transparent areas in the image. The default value for the property is False.
|
||||
<var>Masked</var> is a Boolean property which indicates if images in the image list contain an image mask that defines the transparent areas in the image. The default value for the property is <b>False</b>.
|
||||
</p>
|
||||
<p>
|
||||
Set the value in Masked to True if the <var>AddMasked</var> or <var>ReplaceMasked</var> method was used to store a masked bitmap image to the image list.
|
||||
Set the value in Masked to <b>True</b> if the <var>AddMasked</var> or <var>ReplaceMasked</var> method was used to store a masked bitmap image to the image list.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -5043,11 +5045,11 @@
|
||||
|
||||
<element name="TCustomImageList.ShareImages">
|
||||
<short>
|
||||
True when the handle for the image list is shared.
|
||||
<b>True</b> when the handle for the image list is shared.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ShareImages</var> is a <var>Boolean</var> property that indicates if the handle for an image list is shared. When ShareImages contains False, the handle to the image list is freed when the the image list is destroyed.
|
||||
<var>ShareImages</var> is a <var>Boolean</var> property that indicates if the handle for an image list is shared. When ShareImages contains <b>False</b>, the handle to the image list is freed when the the image list is destroyed.
|
||||
</p>
|
||||
<p>
|
||||
This property exists only for Delphi compatibility. ShareImages is not used in the current implementation of TCustomImageList.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user