paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-11-07 09:49:37 +01:00
Code Issues Packages Projects Releases Wiki Activity

FPDoc - some more updates to TCustomImageList in imglist.xml

Browse Source 
git-svn-id: trunk@15716 -
This commit is contained in:
kirkpatc 2008-07-09 07:21:06 +00:00
parent 5dcea6ca0b
commit fa17781d1d
1 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/xml/lcl/imglist.xml
View File

@ -177,15 +177,17 @@
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TCustomImageList"> <element name="TCustomImageList">
<short> <short>
<var>TCustomImageList</var> base class for <var>TImageList</var> (not the same as a <var>TBitmap</var> collection)</short> <var>TCustomImageList</var> - base class for <var>TImageList</var> (not the same as a <var>TBitmap</var> collection)</short>
<descr> <descr>
<p> <p>
<printshort id="TCustomImageList"/> <printshort id="TCustomImageList"/>
</p> </p>
<p>Ancestor of <var>TDragImageList</var> which is base class for <var>TImageList</var> in Unit <var>Controls</var>
</p>
<pre>Delphi's TCustomImageList is based on the Win32 imagelists which has <pre>Delphi's TCustomImageList is based on the Win32 imagelists which has
internally only one bitmap to hold all images. This reduces handle internally only one bitmap to hold all images. This reduces handle
allocation. allocation.
The original TCustomImageList implementation was LCL only based, so for The original Lazarus TCustomImageList implementation was LCL only based, so for
other platforms the single bitmap implementation had some speed drawbacks. other platforms the single bitmap implementation had some speed drawbacks.
Therefore it was implemented as a list of bitmaps, however it doesn't reduce Therefore it was implemented as a list of bitmaps, however it doesn't reduce
handle allocation. handle allocation.
@ -198,8 +200,7 @@
NOTE: due to its implementation, the TCustomImageList is not a TBitmap NOTE: due to its implementation, the TCustomImageList is not a TBitmap
collection. If a fast storage of bitmaps is needed, create your own list! collection. If a fast storage of bitmaps is needed, create your own list!
</pre> </pre>
<p>Ancestor of <var>TDragImageList</var> which is base class for <var>TImageList</var> in Unit <var>Controls</var> <p/>
</p>
</descr> </descr>
<errors/> <errors/>
<seealso/> <seealso/>
@ -686,21 +687,24 @@
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TCustomImageList.Change"> <element name="TCustomImageList.Change">
<short/> <short>
<var>Change</var> - software method to force <var>OnChange</var> event</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TCustomImageList.Clear"> <element name="TCustomImageList.Clear">
<short/> <short>
<var>Clear</var> - removes all images from the list</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TCustomImageList.CreateSize"> <element name="TCustomImageList.CreateSize">
<short/> <short>
<var>CreateSize</var> - runtime constructor for image(s) with given height and width</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -803,7 +807,8 @@
</element> </element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TCustomImageList.GetHotSpot"> <element name="TCustomImageList.GetHotSpot">
<short/> <short>
<var>GetHotSpot</var> - returns the co-ordinates for the hotspot of the drag image</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
@ -1089,7 +1094,10 @@
<short> <short>
<var>FillDescription</var> - fills the description with the default info of the imagedata</short> <var>FillDescription</var> - fills the description with the default info of the imagedata</short>
</element> </element>
<element name="TCustomImageList.GetRawImage"/> <element name="TCustomImageList.GetRawImage">
<short>
<var>GetRawImage</var> - primitive method for loading an image: you have to fill in all the description fields yourself</short>
</element>
<element name="TCustomImageList.Reference"> <element name="TCustomImageList.Reference">
<short> <short>
<var>Reference</var> to the imagelist</short> <var>Reference</var> to the imagelist</short>