← Back to branch summary

~ubuntu-branches/ubuntu/saucy/lazarus/saucy

« back to all changes in this revision

Viewing changes to docs/xml/lcl/imglist.xml

  • Committer: Package Import Robot
  • Author(s): Paul Gevers, Abou Al Montacir, Bart Martens, Paul Gevers
  • Date: 2013-06-08 14:12:17 UTC
  • mfrom: (1.1.9)
  • Revision ID: package-import@ubuntu.com-20130608141217-7k0cy9id8ifcnutc
Tags: 1.0.8+dfsg-1
http://bugs.debian.org/708695
[ Abou Al Montacir ]
* New upstream major release and multiple maintenace release offering many
  fixes and new features marking a new milestone for the Lazarus development
  and its stability level.
  - The detailed list of changes can be found here:
    http://wiki.lazarus.freepascal.org/Lazarus_1.0_release_notes
    http://wiki.lazarus.freepascal.org/Lazarus_1.0_fixes_branch
* LCL changes:
  - LCL is now a normal package.
      + Platform independent parts of the LCL are now in the package LCLBase
      + LCL is automatically recompiled when switching the target platform,
        unless pre-compiled binaries for this target are already installed.
      + No impact on existing projects.
      + Linker options needed by LCL are no more added to projects that do
        not use the LCL package.
  - Minor changes in LCL basic classes behaviour
      + TCustomForm.Create raises an exception if a form resource is not
        found.
      + TNotebook and TPage: a new implementation of these classes was added.
      + TDBNavigator: It is now possible to have focusable buttons by setting
        Options = [navFocusableButtons] and TabStop = True, useful for
        accessibility and for devices with neither mouse nor touch screen.
      + Names of TControlBorderSpacing.GetSideSpace and GetSpace were swapped
        and are now consistent. GetSideSpace = Around + GetSpace.
      + TForm.WindowState=wsFullscreen was added
      + TCanvas.TextFitInfo was added to calculate how many characters will
        fit into a specified Width. Useful for word-wrapping calculations.
      + TControl.GetColorResolvingParent and
        TControl.GetRGBColorResolvingParent were added, simplifying the work
        to obtain the final color of the control while resolving clDefault
        and the ParentColor.
      + LCLIntf.GetTextExtentExPoint now has a good default implementation
        which works in any platform not providing a specific implementation.
        However, Widgetset specific implementation is better, when available.
      + TTabControl was reorganized. Now it has the correct class hierarchy
        and inherits from TCustomTabControl as it should.
  - New unit in the LCL:
      + lazdialogs.pas: adds non-native versions of various native dialogs,
        for example TLazOpenDialog, TLazSaveDialog, TLazSelectDirectoryDialog.
        It is used by widgetsets which either do not have a native dialog, or
        do not wish to use it because it is limited. These dialogs can also be
        used by user applications directly.
      + lazdeviceapis.pas: offers an interface to more hardware devices such
        as the accelerometer, GPS, etc. See LazDeviceAPIs
      + lazcanvas.pas: provides a TFPImageCanvas descendent implementing
        drawing in a LCL-compatible way, but 100% in Pascal.
      + lazregions.pas. LazRegions is a wholly Pascal implementation of
        regions for canvas clipping, event clipping, finding in which control
        of a region tree one an event should reach, for drawing polygons, etc.
      + customdrawncontrols.pas, customdrawndrawers.pas,
        customdrawn_common.pas, customdrawn_android.pas and
        customdrawn_winxp.pas: are the Lazarus Custom Drawn Controls -controls
        which imitate the standard LCL ones, but with the difference that they
        are non-native and support skinning.
  - New APIs added to the LCL to improve support of accessibility software
    such as screen readers.
* IDE changes:
  - Many improvments.
  - The detailed list of changes can be found here:
    http://wiki.lazarus.freepascal.org/New_IDE_features_since#v1.0_.282012-08-29.29
    http://wiki.lazarus.freepascal.org/Lazarus_1.0_release_notes#IDE_Changes
* Debugger / Editor changes:
  - Added pascal sources and breakpoints to the disassembler
  - Added threads dialog.
* Components changes:
  - TAChart: many fixes and new features
  - CodeTool: support Delphi style generics and new syntax extensions.
  - AggPas: removed to honor free licencing. (Closes: Bug#708695)
[Bart Martens]
* New debian/watch file fixing issues with upstream RC release.
[Abou Al Montacir]
* Avoid changing files in .pc hidden directory, these are used by quilt for
  internal purpose and could lead to surprises during build.
[Paul Gevers]
* Updated get-orig-source target and it compinion script orig-tar.sh so that they
  repack the source file, allowing bug 708695 to be fixed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/xml/lcl/imglist.xml
1
 
<?xml version="1.0"?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<fpdoc-descriptions>
3
3
  <package name="lcl">
4
4
    <!--
7
7
  ====================================================================
8
8
-->
9
9
    <module name="ImgList">
10
 
      <short>Contains definitions for TCustomImageList. base class for TImageList</short>
 
10
      <short>Contains definitions for TCustomImageList, the base class for TImageList.</short>
11
11
      <descr/>
12
 
      <!-- unresolved type reference Visibility: default -->
13
 
      <element name="SysUtils">
14
 
        <short/>
15
 
        <descr/>
16
 
        <seealso/>
17
 
      </element>
18
 
      <!-- unresolved type reference Visibility: default -->
19
 
      <element name="Classes">
20
 
        <short/>
21
 
        <descr/>
22
 
        <seealso/>
23
 
      </element>
24
 
      <!-- unresolved type reference Visibility: default -->
25
 
      <element name="FPCAdds">
26
 
        <short/>
27
 
        <descr/>
28
 
        <seealso/>
29
 
      </element>
30
 
      <!-- unresolved type reference Visibility: default -->
31
 
      <element name="LCLStrConsts">
32
 
        <short/>
33
 
        <descr/>
34
 
        <seealso/>
35
 
      </element>
36
 
      <!-- unresolved type reference Visibility: default -->
37
 
      <element name="LCLIntf">
38
 
        <short/>
39
 
        <descr/>
40
 
        <seealso/>
41
 
      </element>
42
 
      <!-- unresolved type reference Visibility: default -->
43
 
      <element name="LResources">
44
 
        <short/>
45
 
        <descr/>
46
 
        <seealso/>
47
 
      </element>
48
 
      <!-- unresolved type reference Visibility: default -->
49
 
      <element name="LCLType">
50
 
        <short/>
51
 
        <descr/>
52
 
        <seealso/>
53
 
      </element>
54
 
      <!-- unresolved type reference Visibility: default -->
55
 
      <element name="LCLProc">
56
 
        <short/>
57
 
        <descr/>
58
 
        <seealso/>
59
 
      </element>
60
 
      <!-- unresolved type reference Visibility: default -->
61
 
      <element name="Graphics">
62
 
        <short/>
63
 
        <descr/>
64
 
        <seealso/>
65
 
      </element>
66
 
      <!-- unresolved type reference Visibility: default -->
67
 
      <element name="GraphType">
68
 
        <short/>
69
 
        <descr/>
70
 
        <seealso/>
71
 
      </element>
72
 
      <!-- unresolved type reference Visibility: default -->
73
 
      <element name="LCLClasses">
74
 
        <short/>
75
 
        <descr/>
76
 
        <seealso/>
77
 
      </element>
78
 
      <!-- unresolved type reference Visibility: default -->
79
 
      <element name="IntfGraphics">
80
 
        <short/>
81
 
        <descr/>
82
 
        <seealso/>
83
 
      </element>
84
 
      <!-- unresolved type reference Visibility: default -->
85
 
      <element name="FPReadBMP">
86
 
        <short/>
87
 
        <descr/>
88
 
        <seealso/>
89
 
      </element>
90
12
      <!-- "type" alias type Visibility: default -->
91
13
      <element name="TImageIndex">
92
 
        <short/>
93
 
        <descr/>
 
14
        <short>Type of an ImageList index (integer), unused!</short>
 
15
        <descr>Exists for Delphi compatibility only, but is unused there as well.</descr>
94
16
        <seealso/>
95
17
      </element>
96
18
      <!-- object Visibility: default -->
97
19
      <element name="TChangeLink">
98
20
        <short>
99
 
          <var>TChangeLink</var> - class to notify when an Imagelist changes</short>
 
21
          Use a TChangelink to get notified of imagelist changes.</short>
100
22
        <descr/>
101
23
        <errors/>
102
 
        <seealso/>
103
 
      </element>
104
 
      <!-- variable Visibility: private -->
105
 
      <element name="TChangeLink.FSender">
106
 
        <short/>
107
 
        <descr/>
108
 
        <seealso/>
109
 
      </element>
110
 
      <!-- variable Visibility: private -->
111
 
      <element name="TChangeLink.FOnChange">
112
 
        <short/>
113
 
        <descr/>
114
 
        <seealso/>
115
 
      </element>
 
24
        <seealso><link id="TCustomImageList.RegisterChanges"/>
 
25
        </seealso>
 
26
      </element>
 
27
      <!-- variable Visibility: private -->
 
28
      <element name="TChangeLink.FSender" link="TChangeLink.Sender"/>
 
29
      <element name="TChangeLink.FOnChange" link="TChangeLink.OnChange"/>
116
30
      <!-- destructor Visibility: public -->
117
 
      <element name="TChangeLink.Destroy" link="#rtl.System.TObject.Destroy">
118
 
        <short/>
119
 
        <descr/>
120
 
        <errors/>
121
 
        <seealso/>
122
 
      </element>
 
31
      <element name="TChangeLink.Destroy"/>
123
32
      <!-- procedure Visibility: public -->
124
33
      <element name="TChangeLink.Change">
125
34
        <short>
144
53
      </element>
145
54
      <!-- enumeration type Visibility: default -->
146
55
      <element name="TDrawingStyle">
147
 
        <short/>
148
 
        <descr/>
 
56
        <short>Defines transparency and blending of rendered images.</short>
 
57
        <descr>Blending means that the Color is merged with the previous contents of
 
58
         the destination area by a degree defined by an alpha value.
 
59
        </descr>
149
60
        <seealso/>
 
61
      <notes><note>What's "blending"?</note><note>right?</note>
 
62
        </notes>
150
63
      </element>
151
 
      <!-- enumeration value Visibility: default -->
152
64
      <element name="TDrawingStyle.dsFocus">
153
 
        <short/>
 
65
        <short>Applies 25% of BlendColor.</short>
154
66
      </element>
155
 
      <!-- enumeration value Visibility: default -->
156
67
      <element name="TDrawingStyle.dsSelected">
157
 
        <short/>
 
68
        <short>Applies 50% of BlendColor.</short>
158
69
      </element>
159
 
      <!-- enumeration value Visibility: default -->
160
70
      <element name="TDrawingStyle.dsNormal">
161
 
        <short/>
 
71
        <short>Draw using BkColor for the background, transparent if BkColor is clNone.</short>
162
72
      </element>
163
 
      <!-- enumeration value Visibility: default -->
164
73
      <element name="TDrawingStyle.dsTransparent">
165
 
        <short/>
 
74
        <short>Always draw transparently, ignore BkColor and BlendColor.</short>
166
75
      </element>
167
76
      <!-- enumeration type Visibility: default -->
168
77
      <element name="TImageType">
169
 
        <short/>
170
 
        <descr/>
 
78
        <short>Indicates whether a mask shall be used in rendering an image.</short>
 
79
        <descr>The mask specifies the transparent part of the image</descr>
171
80
        <seealso/>
 
81
      <notes><note>What's the effect of applying a mask?</note><note>right?</note>
 
82
        </notes>
172
83
      </element>
173
84
      <!-- enumeration value Visibility: default -->
174
85
      <element name="TImageType.itImage">
175
 
        <short/>
 
86
        <short>Don't apply a mask.</short>
176
87
      </element>
177
88
      <!-- enumeration value Visibility: default -->
178
89
      <element name="TImageType.itMask">
179
 
        <short/>
 
90
        <short>Apply the mask.</short>
180
91
      </element>
181
92
      <!-- object Visibility: default -->
182
93
      <element name="TCustomImageList">
183
94
        <short>Base class for TImageList (not the same as a <var>TBitmap</var> collection)</short>
184
 
        <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!
185
 
 
186
 
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).
187
 
 
188
 
Transparency is implemented in the alpha channel of the raw 32 bit RGBA imagedata array - but not all platforms support such an alpha channel. [What exactly does this mean to the user?]
189
 
 
190
 
The painting of an image from the list is handled by the widgetset, no bitmap or icon component is involved. The widgetset can use a different internal organization of the data, optimized for immediate painting of an image.
191
 
 
192
 
<b>NOTE:</b> A TCustomImageList is <b>not</b> a TBitmap collection.
193
 
If a storage of distinct bitmaps is needed, create your own list of TBitMaps (array or TList).</descr>
194
 
        <errors>Currently only the insertion of Bitmaps is supported. Other image types should be rendered as bitmaps of Width and Height, which then can be inserted.</errors>
195
 
        <seealso/>
196
 
      </element>
197
 
      <!-- variable Visibility: private -->
198
 
      <element name="TCustomImageList.FDrawingStyle">
199
 
        <short/>
200
 
        <descr/>
201
 
        <seealso/>
202
 
      </element>
203
 
      <!-- variable Visibility: private -->
204
 
      <element name="TCustomImageList.FImageList">
205
 
        <short/>
206
 
        <descr/>
207
 
        <seealso/>
208
 
      </element>
209
 
      <!-- variable Visibility: private -->
210
 
      <element name="TCustomImageList.FMaskList">
211
 
        <short/>
212
 
        <descr/>
213
 
        <seealso/>
214
 
      </element>
215
 
      <!-- variable Visibility: private -->
216
 
      <element name="TCustomImageList.FBitmap">
217
 
        <short/>
218
 
        <descr/>
219
 
        <seealso/>
220
 
      </element>
221
 
      <!-- variable Visibility: private -->
222
 
      <element name="TCustomImageList.FImageType">
223
 
        <short/>
224
 
        <descr/>
225
 
        <seealso/>
226
 
      </element>
227
 
      <!-- variable Visibility: private -->
228
 
      <element name="TCustomImageList.FMaskBitmap">
229
 
        <short/>
230
 
        <descr/>
231
 
        <seealso/>
232
 
      </element>
233
 
      <!-- variable Visibility: private -->
234
 
      <element name="TCustomImageList.FHeight">
235
 
        <short/>
236
 
        <descr/>
237
 
        <seealso/>
238
 
      </element>
239
 
      <!-- variable Visibility: private -->
240
 
      <element name="TCustomImageList.FMasked">
241
 
        <short/>
242
 
        <descr/>
243
 
        <seealso/>
244
 
      </element>
245
 
      <!-- variable Visibility: private -->
246
 
      <element name="TCustomImageList.FShareImages">
247
 
        <short/>
248
 
        <descr/>
249
 
        <seealso/>
250
 
      </element>
251
 
      <!-- variable Visibility: private -->
252
 
      <element name="TCustomImageList.FWidth">
253
 
        <short/>
254
 
        <descr/>
255
 
        <seealso/>
256
 
      </element>
257
 
      <!-- variable Visibility: private -->
258
 
      <element name="TCustomImageList.FAllocBy">
259
 
        <short/>
260
 
        <descr/>
261
 
        <seealso/>
262
 
      </element>
263
 
      <!-- variable Visibility: private -->
264
 
      <element name="TCustomImageList.FCount">
265
 
        <short/>
266
 
        <descr/>
267
 
        <seealso/>
268
 
      </element>
 
95
        <descr>
 
96
          <p>An ImageList contains images (bitmaps or icons) of the same Width and Height, accessible by index.
 
97
            The images are stored in one big (wide) bitmap, whose width is Width*Count.
 
98
          </p><p>When an image of a different Width or Height is inserted, the previous contents of the list are discarded!
 
99
          </p><p>
 
100
            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.
 
101
            This allows one to insert e.g. other (compatible) ImageLists, or bitmaps for multiple states of essentially the same image (button pressed, released and disabled).
 
102
          </p><p>
 
103
            Transparency is implemented in the alpha channel of the raw 32 bit RGBA imagedata array - but not all platforms support such an alpha channel.
 
104
          </p><p>
 
105
            The painting of an image from the list is handled by the widgetset, no bitmap or icon component is involved.
 
106
            The widgetset can use a different internal organization of the data, optimized for immediate painting of an image.
 
107
          </p><p>
 
108
            <b>NOTE:</b> A TCustomImageList is <b>not</b> a TBitmap collection.
 
109
            If a storage of distinct bitmaps is needed, create your own list of TBitMaps (array or TList).
 
110
          </p><p>
 
111
            Please note also that inserting or moving images will affect the index of all following images,
 
112
            what can cause trouble with index constants. In such cases a bitmap collection may better fit your needs.
 
113
          </p>
 
114
          <remark>Windows ImgageLists can contain a list of monochrome mask bitmaps, present when Masked=True.
 
115
          </remark>
 
116
        </descr>
 
117
        <errors>
 
118
          <p>Currently only the insertion of Bitmaps is supported. Other image types should be rendered as bitmaps of Width and Height, which then can be inserted.</p>
 
119
          <p>Image overlays also are unsupported.</p>
 
120
        </errors>
 
121
        <seealso/>
 
122
      <notes><note>What exactly does this mean to the user?</note><note>What about Mask, HotSpot and ShareImages?</note><note>Does the LCL support this feature, or is only the TransparentColor used to make images transparent?</note>
 
123
        </notes>
 
124
      </element>
 
125
      <!-- variable Visibility: private -->
 
126
      <element name="TCustomImageList.FAllocBy" link="TCustomImageList.AllocBy"/>
 
127
      <element name="TCustomImageList.FBkColor" link="TCustomImageList.BkColor"/>
 
128
      <element name="TCustomImageList.FBlendColor" link="TCustomImageList.BlendColor"/>
 
129
      <element name="TCustomImageList.FCount" link="TCustomImageList.Count"/>
 
130
      <element name="TCustomImageList.FDrawingStyle" link="TCustomImageList.DrawingStyle"/>
 
131
      <element name="TCustomImageList.FHeight" link="TCustomImageList.Height"/>
 
132
      <element name="TCustomImageList.FImageType" link="TCustomImageList.ImageType"/>
 
133
      <element name="TCustomImageList.FMasked" link="TCustomImageList.Masked"/>
 
134
      <element name="TCustomImageList.FOnChange" link="TCustomImageList.OnChange"/>
 
135
      <element name="TCustomImageList.FShareImages" link="TCustomImageList.ShareImages"/>
 
136
      <element name="TCustomImageList.FReference" link="TCustomImageList.Reference"/>
 
137
      <element name="TCustomImageList.FWidth" link="TCustomImageList.Width"/>
269
138
      <!-- variable Visibility: private -->
270
139
      <element name="TCustomImageList.FAllocCount">
271
 
        <short/>
272
 
        <descr/>
273
 
        <seealso/>
274
 
      </element>
275
 
      <!-- variable Visibility: private -->
276
 
      <element name="TCustomImageList.FBlendColor">
277
 
        <short/>
278
 
        <descr/>
279
 
        <seealso/>
280
 
      </element>
281
 
      <!-- variable Visibility: private -->
282
 
      <element name="TCustomImageList.FOnChange">
283
 
        <short/>
284
 
        <descr/>
285
 
        <seealso/>
 
140
        <short>The size of the allocated Data list, in number of images.</short>
 
141
      </element>
 
142
      <!-- variable Visibility: private -->
 
143
      <element name="TCustomImageList.FChanged">
 
144
        <short>Change flag, remembers changes while update notifications are locked (FUpdateCount &gt; 0).</short>
286
145
      </element>
287
146
      <!-- variable Visibility: private -->
288
147
      <element name="TCustomImageList.FChangeLinkList">
289
 
        <short/>
290
 
        <descr/>
291
 
        <seealso/>
292
 
      </element>
293
 
      <!-- variable Visibility: private -->
294
 
      <element name="TCustomImageList.FBkColor">
295
 
        <short/>
296
 
        <descr/>
297
 
        <seealso/>
298
 
      </element>
299
 
      <!-- variable Visibility: private -->
300
 
      <element name="TCustomImageList.FHandle">
301
 
        <short/>
302
 
        <descr/>
303
 
        <seealso/>
304
 
      </element>
305
 
      <!-- variable Visibility: private -->
306
 
      <element name="TCustomImageList.FChanged">
307
 
        <short/>
308
 
        <descr/>
309
 
        <seealso/>
310
 
      </element>
311
 
      <!-- procedure Visibility: private -->
312
 
      <element name="TCustomImageList.AllocBitmap">
313
 
        <short/>
314
 
        <descr/>
315
 
        <errors/>
316
 
        <seealso/>
317
 
      </element>
318
 
      <!-- argument Visibility: default -->
319
 
      <element name="TCustomImageList.AllocBitmap.Amount">
320
 
        <short/>
 
148
        <short>List of TChangeLinks which are notified of changes.</short>
 
149
      </element>
 
150
      <!-- variable Visibility: private -->
 
151
      <element name="TCustomImageList.FData">
 
152
        <short>Holds the pixel data of all images.</short>
 
153
      </element>
 
154
      <!-- variable Visibility: protected -->
 
155
      <element name="TCustomImageList.FUpdateCount">
 
156
        <short>Counter for BeginUpdate/EndUpdate calls.</short>
 
157
      </element>
 
158
      <!-- procedure Visibility: private -->
 
159
      <element name="TCustomImageList.AllocData">
 
160
        <short>Allocates data for ACount images, rounded up by AllocBy.</short>
 
161
      </element>
 
162
      <element name="TCustomImageList.AllocData.ACount">
 
163
        <short>The number of images to allocate room for.</short>
 
164
        <descr>The list only can increase. Use Clear to reduce it to the empty list.</descr>
 
165
      </element>
 
166
      <element name="TCustomImageList.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
 
167
      <element name="TCustomImageList.InternalInsert">
 
168
        <short>Insert bitmap (with split if necessary) into position AIndex with shifting other images.</short>
 
169
      </element>
 
170
      <element name="TCustomImageList.InternalInsert.AIndex">
 
171
        <short>Where to insert the images.</short>
 
172
      </element>
 
173
      <element name="TCustomImageList.InternalInsert.AImage">
 
174
        <short>The image (BitMap) handle.</short>
 
175
      </element>
 
176
      <element name="TCustomImageList.InternalInsert.AMask">
 
177
        <short>The mask (BitMap) handle.</short>
 
178
      </element>
 
179
      <element name="TCustomImageList.InternalInsert.AWidth">
 
180
        <short>Width in pixels</short>
 
181
      <notes><note>of?</note>
 
182
        </notes>
 
183
      </element>
 
184
      <element name="TCustomImageList.InternalInsert.AHeight">
 
185
        <short>Height of all images in pixels.</short>
 
186
      </element>
 
187
      <element name="TCustomImageList.InternalInsert.ARawImage">
 
188
        <short/>
 
189
      <notes><note>?</note>
 
190
        </notes>
 
191
      </element>
 
192
      <!-- procedure Visibility: private -->
 
193
      <element name="TCustomImageList.InternalMove">
 
194
        <short>Moves an image from CurIndex to NewIndex, without notifying the widgetset.</short>
 
195
        <descr>
 
196
        </descr>
 
197
        <errors>
 
198
        </errors>
 
199
        <seealso>
 
200
        </seealso>
 
201
      </element>
 
202
      <element name="TCustomImageList.InternalMove.ACurIndex">
 
203
        <short>the index of the image to be moved</short>
 
204
      </element>
 
205
      <element name="TCustomImageList.InternalMove.ANewIndex">
 
206
        <short>the new index of the image</short>
 
207
      </element>
 
208
      <element name="TCustomImageList.InternalMove.AIgnoreCurrent">
 
209
        <short/>
 
210
      <notes><note>?</note>
 
211
        </notes>
 
212
      </element>
 
213
      <!-- procedure Visibility: private -->
 
214
      <element name="TCustomImageList.InternalReplace">
 
215
        <short/>
 
216
        <descr>
 
217
        </descr>
 
218
        <errors>
 
219
        </errors>
 
220
        <seealso>
 
221
        </seealso>
 
222
      <notes><note>?</note>
 
223
        </notes>
 
224
      </element>
 
225
      <element name="TCustomImageList.InternalReplace.AIndex">
 
226
        <short/>
 
227
      </element>
 
228
      <element name="TCustomImageList.InternalReplace.AImage">
 
229
        <short/>
 
230
      </element>
 
231
      <element name="TCustomImageList.InternalReplace.AMask">
 
232
        <short/>
 
233
      </element>
 
234
      <!-- function Visibility: private -->
 
235
      <element name="TCustomImageList.InternalSetImage">
 
236
        <short>Copies the imagedata into the FData array and then frees the image.</short>
 
237
        <descr>
 
238
        </descr>
 
239
        <errors>
 
240
        </errors>
 
241
        <seealso>
 
242
        </seealso>
 
243
      </element>
 
244
      <element name="TCustomImageList.InternalSetImage.Result">
 
245
        <short>Pointer to the updated image data</short>
 
246
      </element>
 
247
      <element name="TCustomImageList.InternalSetImage.AIndex">
 
248
        <short>the index of the location where the image should be set</short>
 
249
      </element>
 
250
      <element name="TCustomImageList.InternalSetImage.AImage">
 
251
        <short>the new image</short>
321
252
      </element>
322
253
      <!-- procedure Visibility: private -->
323
254
      <element name="TCustomImageList.NotifyChangeLink">
324
 
        <short/>
 
255
        <short>Notifies all subscribed objects of a change in the imagelist.</short>
325
256
        <descr/>
326
257
        <errors/>
327
258
        <seealso/>
328
259
      </element>
329
260
      <!-- procedure Visibility: private -->
330
 
      <element name="TCustomImageList.SetBkColor">
331
 
        <short/>
332
 
        <descr/>
333
 
        <errors/>
334
 
        <seealso/>
335
 
      </element>
336
 
      <!-- argument Visibility: default -->
 
261
      <element name="TCustomImageList.SetBkColor" link="TCustomImageList.BkColor"/>
337
262
      <element name="TCustomImageList.SetBkColor.Value">
338
263
        <short/>
339
264
      </element>
340
265
      <!-- procedure Visibility: private -->
341
 
      <element name="TCustomImageList.SetDrawingStyle">
342
 
        <short/>
343
 
        <descr/>
344
 
        <errors/>
345
 
        <seealso/>
346
 
      </element>
347
 
      <!-- argument Visibility: default -->
 
266
      <element name="TCustomImageList.SetDrawingStyle" link="TCustomImageList.DrawingStyle"/>
348
267
      <element name="TCustomImageList.SetDrawingStyle.AValue">
349
268
        <short/>
350
269
      </element>
351
270
      <!-- procedure Visibility: private -->
352
 
      <element name="TCustomImageList.SetHeight">
353
 
        <short/>
354
 
        <descr/>
355
 
        <errors/>
356
 
        <seealso/>
357
 
      </element>
358
 
      <!-- argument Visibility: default -->
 
271
      <element name="TCustomImageList.SetHeight" link="TCustomImageList.Height"/>
359
272
      <element name="TCustomImageList.SetHeight.Value">
360
273
        <short/>
361
274
      </element>
362
275
      <!-- procedure Visibility: private -->
363
 
      <element name="TCustomImageList.SetMasked">
364
 
        <short/>
365
 
        <descr/>
366
 
        <errors/>
367
 
        <seealso/>
368
 
      </element>
369
 
      <!-- argument Visibility: default -->
 
276
      <element name="TCustomImageList.SetMasked" link="TCustomImageList.Masked"/>
370
277
      <element name="TCustomImageList.SetMasked.AValue">
371
278
        <short/>
372
279
      </element>
373
280
      <!-- procedure Visibility: private -->
374
 
      <element name="TCustomImageList.SetShareImages">
375
 
        <short/>
376
 
        <descr/>
377
 
        <errors/>
378
 
        <seealso/>
379
 
      </element>
380
 
      <!-- argument Visibility: default -->
 
281
      <element name="TCustomImageList.SetShareImages" link="TCustomImageList.ShareImages"/>
381
282
      <element name="TCustomImageList.SetShareImages.AValue">
382
283
        <short/>
383
284
      </element>
384
285
      <!-- procedure Visibility: private -->
385
 
      <element name="TCustomImageList.SetWidth">
386
 
        <short/>
387
 
        <descr/>
388
 
        <errors/>
389
 
        <seealso/>
390
 
      </element>
391
 
      <!-- argument Visibility: default -->
 
286
      <element name="TCustomImageList.SetWidth" link="TCustomImageList.Width"/>
392
287
      <element name="TCustomImageList.SetWidth.Value">
393
288
        <short/>
394
289
      </element>
395
290
      <!-- function Visibility: private -->
396
 
      <element name="TCustomImageList.GetCount">
397
 
        <short/>
398
 
        <descr/>
399
 
        <errors/>
400
 
        <seealso/>
401
 
      </element>
402
 
      <!-- function result Visibility: default -->
403
 
      <element name="TCustomImageList.GetCount.Result">
404
 
        <short/>
405
 
      </element>
406
 
      <!-- procedure Visibility: private -->
407
 
      <element name="TCustomImageList.ShiftImages">
408
 
        <short/>
409
 
        <descr/>
410
 
        <errors/>
411
 
        <seealso/>
412
 
      </element>
413
 
      <!-- argument Visibility: default -->
414
 
      <element name="TCustomImageList.ShiftImages.Source">
415
 
        <short/>
416
 
      </element>
417
 
      <!-- argument Visibility: default -->
418
 
      <element name="TCustomImageList.ShiftImages.Start">
419
 
        <short/>
420
 
      </element>
421
 
      <!-- argument Visibility: default -->
422
 
      <element name="TCustomImageList.ShiftImages.Shift">
423
 
        <short/>
424
 
      </element>
425
 
      <!-- variable Visibility: protected -->
426
 
      <element name="TCustomImageList.FUpdateCount">
427
 
        <short/>
428
 
        <descr/>
429
 
        <seealso/>
430
 
      </element>
431
 
      <!-- procedure Visibility: protected -->
432
 
      <element name="TCustomImageList.GetImages">
433
 
        <short/>
434
 
        <descr/>
435
 
        <errors/>
436
 
        <seealso/>
437
 
      </element>
438
 
      <!-- argument Visibility: default -->
439
 
      <element name="TCustomImageList.GetImages.Index">
440
 
        <short/>
441
 
      </element>
442
 
      <!-- argument Visibility: default -->
443
 
      <element name="TCustomImageList.GetImages.Image">
444
 
        <short/>
445
 
      </element>
446
 
      <!-- argument Visibility: default -->
447
 
      <element name="TCustomImageList.GetImages.Mask">
 
291
      <element name="TCustomImageList.GetReference" link="TCustomImageList.Reference"/>
 
292
      <element name="TCustomImageList.GetReference.Result">
448
293
        <short/>
449
294
      </element>
450
295
      <!-- procedure Visibility: protected -->
451
296
      <element name="TCustomImageList.Initialize">
452
297
        <short>
453
298
          <var>Initialize</var> - sets up the list</short>
454
 
        <descr/>
 
299
        <descr>
 
300
          Initializes the internal bitmap structures and the changelink list.
 
301
          It is used by the Create and CreateSize constructors.
 
302
        </descr>
455
303
        <errors/>
456
304
        <seealso/>
457
305
      </element>
458
306
      <!-- procedure Visibility: protected -->
459
 
      <element name="TCustomImageList.DefineProperties">
460
 
        <short>
461
 
          <var>DefineProperties</var> - defines the properties of the ImageList (stored in a file)</short>
462
 
        <descr/>
463
 
        <errors/>
464
 
        <seealso/>
465
 
      </element>
466
 
      <!-- argument Visibility: default -->
 
307
      <element name="TCustomImageList.DefineProperties"/>
467
308
      <element name="TCustomImageList.DefineProperties.Filer">
468
309
        <short/>
469
310
      </element>
470
311
      <!-- procedure Visibility: protected -->
471
312
      <element name="TCustomImageList.SetWidthHeight">
472
313
        <short>
473
 
          <var>SetWidthHeight</var> - specifies the dimensions for display</short>
474
 
        <descr/>
 
314
          Sets both the Width and Height of all images.</short>
 
315
        <descr>Changed values clear the entire list.</descr>
475
316
        <errors/>
476
317
        <seealso/>
477
318
      </element>
478
 
      <!-- argument Visibility: default -->
479
319
      <element name="TCustomImageList.SetWidthHeight.NewWidth">
480
320
        <short/>
481
321
      </element>
482
 
      <!-- argument Visibility: default -->
483
322
      <element name="TCustomImageList.SetWidthHeight.NewHeight">
484
323
        <short/>
485
324
      </element>
486
325
      <!-- constructor Visibility: public -->
487
 
      <element name="TCustomImageList.Create" link="#rtl.Classes.TComponent.Create">
488
 
        <short/>
489
 
        <descr/>
490
 
        <errors/>
491
 
        <seealso/>
492
 
      </element>
493
 
      <!-- argument Visibility: default -->
494
 
      <element name="TCustomImageList.Create.TheOwner">
 
326
      <element name="TCustomImageList.Create"/>
 
327
      <element name="TCustomImageList.Create.AOwner">
495
328
        <short/>
496
329
      </element>
497
330
      <!-- procedure Visibility: public -->
498
 
      <element name="TCustomImageList.AssignTo" link="#rtl.Classes.TPersistent.AssignTo">
499
 
        <short/>
500
 
        <descr/>
501
 
        <errors/>
502
 
        <seealso/>
503
 
      </element>
504
 
      <!-- argument Visibility: default -->
 
331
      <element name="TCustomImageList.AssignTo"/>
505
332
      <element name="TCustomImageList.AssignTo.Dest">
506
333
        <short/>
507
334
      </element>
508
335
      <!-- procedure Visibility: public -->
509
 
      <element name="TCustomImageList.Assign" link="#rtl.Classes.TPersistent.Assign">
510
 
        <short/>
511
 
        <descr/>
512
 
        <errors/>
513
 
        <seealso/>
514
 
      </element>
515
 
      <!-- argument Visibility: default -->
 
336
      <element name="TCustomImageList.Assign"/>
516
337
      <element name="TCustomImageList.Assign.Source">
517
338
        <short/>
518
339
      </element>
519
340
      <!-- procedure Visibility: public -->
520
341
      <element name="TCustomImageList.WriteData">
521
 
        <short>Writes the ImageList data into the stream</short>
 
342
        <short>Writes the ImageList data into the stream.</short>
522
343
        <descr/>
523
344
        <errors/>
524
345
        <seealso/>
525
346
      </element>
526
 
      <!-- argument Visibility: default -->
527
347
      <element name="TCustomImageList.WriteData.AStream">
528
348
        <short/>
529
349
      </element>
530
350
      <!-- procedure Visibility: public -->
531
351
      <element name="TCustomImageList.ReadData">
532
 
        <short>Restores the ImageList data from the stream</short>
 
352
        <short>Restores the ImageList data from the stream.</short>
533
353
        <descr/>
534
354
        <errors/>
535
355
        <seealso/>
536
356
      </element>
537
 
      <!-- argument Visibility: default -->
538
357
      <element name="TCustomImageList.ReadData.AStream">
539
358
        <short/>
540
359
      </element>
541
360
      <!-- procedure Visibility: public -->
542
361
      <element name="TCustomImageList.BeginUpdate">
543
362
        <short>
544
 
          <var>BeginUpdate</var> - start updating the data</short>
545
 
        <descr>Use together with EndUpdate to speed up the insertion of multiple images.
546
 
 
547
 
Every BeginUpdate must be matched by an EndUpdate, i.e. update operations can be nested.
548
 
</descr>
 
363
          Start updating the data, block the OnChange event.</short>
 
364
        <descr>
 
365
          <p>Use together with EndUpdate to speed up the insertion of multiple images.
 
366
          </p><p>
 
367
            Every BeginUpdate must be matched by an EndUpdate, i.e. update operations can be nested.
 
368
          </p>
 
369
        </descr>
549
370
        <errors/>
550
371
        <seealso/>
551
372
      </element>
552
373
      <!-- procedure Visibility: public -->
553
374
      <element name="TCustomImageList.EndUpdate">
554
375
        <short>
555
 
          <var>EndUpdate</var> - finish updating the data</short>
 
376
          <var>EndUpdate</var> - finish updating the data, call Change.</short>
556
377
        <descr>Decrements the internal UpdateCount and, when it reaches zero, does whatever is required to reflect the new content.
557
378
</descr>
558
379
        <errors/>
563
384
      <!-- function Visibility: public -->
564
385
      <element name="TCustomImageList.Add">
565
386
        <short>
566
 
          <var>Add</var> an Image and Mask bitmap to the list. Returns the index of the added image or -1 if unsucessful</short>
567
 
        <descr/>
 
387
          Adds an Image and Mask bitmap to the list. Returns the index of the added image or -1 if unsucessful.</short>
 
388
        <descr>
 
389
<pre>
 
390
  Adds one or more (bitmap width / imagelist width) bitmaps to the list.
 
391
  If Mask is nil, the image has no transparent parts.
 
392
</pre>
 
393
        </descr>
568
394
        <errors/>
569
395
        <seealso/>
570
396
      </element>
571
 
      <!-- function result Visibility: default -->
572
397
      <element name="TCustomImageList.Add.Result">
573
 
        <short/>
 
398
        <short>The index of the added image, -1 if unsuccesful.</short>
574
399
      </element>
575
 
      <!-- argument Visibility: default -->
576
400
      <element name="TCustomImageList.Add.Image">
577
 
        <short/>
 
401
        <short>a bitmap image</short>
578
402
      </element>
579
 
      <!-- argument Visibility: default -->
580
403
      <element name="TCustomImageList.Add.Mask">
581
 
        <short/>
582
 
      </element>
583
 
      <!-- function Visibility: public -->
584
 
      <element name="TCustomImageList.AddDirect">
585
 
        <short/>
586
 
        <descr/>
587
 
        <errors/>
588
 
        <seealso/>
589
 
      </element>
590
 
      <!-- function result Visibility: default -->
591
 
      <element name="TCustomImageList.AddDirect.Result">
592
 
        <short/>
593
 
      </element>
594
 
      <!-- argument Visibility: default -->
595
 
      <element name="TCustomImageList.AddDirect.Image">
596
 
        <short/>
597
 
      </element>
598
 
      <!-- argument Visibility: default -->
599
 
      <element name="TCustomImageList.AddDirect.Mask">
600
 
        <short/>
601
 
      </element>
602
 
      <!-- function Visibility: public -->
603
 
      <element name="TCustomImageList.AddCopy">
604
 
        <short/>
605
 
        <descr/>
606
 
        <errors/>
607
 
        <seealso/>
608
 
      </element>
609
 
      <!-- function result Visibility: default -->
610
 
      <element name="TCustomImageList.AddCopy.Result">
611
 
        <short/>
612
 
      </element>
613
 
      <!-- argument Visibility: default -->
614
 
      <element name="TCustomImageList.AddCopy.SrcImage">
615
 
        <short/>
616
 
      </element>
617
 
      <!-- argument Visibility: default -->
618
 
      <element name="TCustomImageList.AddCopy.SrcMask">
619
 
        <short/>
 
404
        <short>a bitmap which defines the transparent parts of Image</short>
620
405
      </element>
621
406
      <!-- function Visibility: public -->
622
407
      <element name="TCustomImageList.AddIcon">
623
 
        <short>Adds an icon to the list (not yet!), returning the index of the icon or -1 if not successful</short>
624
 
        <descr>Adding graphics other than bitmaps can be implemented by converting the graphics item into a bitmap, which then can be added to the image list. Most graphics classes support such a conversion, so that specialized methods are redundant.</descr>
 
408
        <short>Adds an icon to the list, returning the index of the icon or -1 if not successful.</short>
 
409
        <descr>Adding graphics other than bitmaps can be implemented by converting the graphics item into a bitmap, which then can be added to the image list.
 
410
          Most graphics classes support such a conversion, so that specialized methods are redundant.</descr>
625
411
        <errors/>
626
 
        <seealso/>
 
412
        <seealso><link id="TCustomImageList.InsertIcon"/>
 
413
        </seealso>
627
414
      </element>
628
 
      <!-- function result Visibility: default -->
629
415
      <element name="TCustomImageList.AddIcon.Result">
630
 
        <short/>
 
416
        <short>The index of the added icon, -1 if unsuccesful.</short>
631
417
      </element>
632
 
      <!-- argument Visibility: default -->
633
418
      <element name="TCustomImageList.AddIcon.Image">
634
 
        <short/>
 
419
        <short>The Icon to be added.</short>
635
420
      </element>
636
421
      <!-- procedure Visibility: public -->
637
422
      <element name="TCustomImageList.AddImages">
638
423
        <short>
639
 
          <var>AddImages</var> - adds images from another imagelist to the list</short>
 
424
          Adds images from another imagelist to the list.</short>
640
425
        <descr>Both lists must have the same image Width and Height, else the old images are discarded.</descr>
641
426
        <errors/>
642
427
        <seealso/>
643
428
      </element>
644
 
      <!-- argument Visibility: default -->
645
 
      <element name="TCustomImageList.AddImages.Value">
646
 
        <short/>
 
429
      <element name="TCustomImageList.AddImages.AValue">
 
430
        <short>
 
431
          The ImageList containing the images to add.</short>
647
432
      </element>
648
433
      <!-- function Visibility: public -->
649
434
      <element name="TCustomImageList.AddMasked">
650
435
        <short>
651
 
          <var>AddMasked</var> - adds one or more bitmaps to the list</short>
652
 
        <descr>Every pixel of MaskColor will become transparent.
653
 
 
654
 
Image can contain multiple images of the same Width and Height.
655
 
 
656
 
Returns the index of the first added bitmap, or -1 if unsuccessful.</descr>
 
436
          Adds one or more (bitmap width / imagelist width) transparent bitmaps to the list.</short>
 
437
        <descr>
 
438
          <p>
 
439
            Every pixel of MaskColor will become transparent.
 
440
          </p><p>
 
441
            Image can contain multiple images of the same Width and Height.
 
442
            The image width must be a multiple of Width, and the image height must equal Height,
 
443
            else all old images in the list are discarded.
 
444
          </p>
 
445
        </descr>
657
446
        <errors/>
658
447
        <seealso/>
659
448
      </element>
660
 
      <!-- function result Visibility: default -->
661
449
      <element name="TCustomImageList.AddMasked.Result">
662
 
        <short/>
 
450
        <short>The index of the first added image, -1 if unsuccesful.</short>
663
451
      </element>
664
 
      <!-- argument Visibility: default -->
665
452
      <element name="TCustomImageList.AddMasked.Image">
666
 
        <short/>
 
453
        <short>The bitmap to be added.</short>
667
454
      </element>
668
 
      <!-- argument Visibility: default -->
669
455
      <element name="TCustomImageList.AddMasked.MaskColor">
670
 
        <short/>
 
456
        <short>The color acting as transparant color.</short>
671
457
      </element>
672
458
      <!-- function Visibility: public -->
673
 
      <element name="TCustomImageList.AddFromLazarusResource">
674
 
        <short/>
675
 
        <descr/>
676
 
        <errors/>
677
 
        <seealso/>
678
 
      </element>
679
 
      <!-- function result Visibility: default -->
680
 
      <element name="TCustomImageList.AddFromLazarusResource.Result">
681
 
        <short/>
682
 
      </element>
683
 
      <!-- argument Visibility: default -->
684
 
      <element name="TCustomImageList.AddFromLazarusResource.ResourceName">
685
 
        <short/>
 
459
      <element name="TCustomImageList.AddLazarusResource">
 
460
        <short>
 
461
          Loads a bitmap from a lazarus resources and adds it.</short>
 
462
      </element>
 
463
      <element name="TCustomImageList.AddLazarusResource.Result">
 
464
        <short>Index of the first added image.</short>
 
465
      </element>
 
466
      <element name="TCustomImageList.AddLazarusResource.ResourceName">
 
467
        <short>The name of the Lazarus resource.</short>
 
468
      </element>
 
469
      <element name="TCustomImageList.AddLazarusResource.MaskColor">
 
470
        <short>The mask color for transparent images, clNone for solid (opaque) images.</short>
686
471
      </element>
687
472
      <!-- procedure Visibility: public -->
688
473
      <element name="TCustomImageList.Change">
689
474
        <short>
690
 
          <var>Change</var> - send change notifications</short>
 
475
          Send change notifications, if the list has changed and updates are not locked.</short>
691
476
        <descr>Notifies all members of the ChangeLinkList, and calls the <var>OnChange</var> handler.</descr>
692
477
        <errors/>
693
478
        <seealso/>
694
479
      </element>
695
480
      <!-- procedure Visibility: public -->
696
481
      <element name="TCustomImageList.Clear">
697
 
        <short>
698
 
          <var>Clear</var> - removes all images from the list</short>
 
482
        <short>Removes all images from the list.</short>
699
483
        <descr/>
700
484
        <errors/>
701
485
        <seealso/>
702
486
      </element>
703
487
      <!-- constructor Visibility: public -->
704
488
      <element name="TCustomImageList.CreateSize">
705
 
        <short>Initialize the list for image(s) with the given height and width</short>
706
 
        <descr>The Width and Height is reset with every insertion of a bitmap. It may be useful, however, to initialize a list for the insertion of graphics other than bitmaps, so that the images can be rendered as bitmaps of the intended width and height, before they are inserted.</descr>
 
489
        <short>Initialize the list for image(s) with the given height and width.</short>
 
490
        <descr>
 
491
          <p>
 
492
            This constructor overrides the default initial size of the images (16x16 pixels).
 
493
          </p>
 
494
          <p>The Width and Height is reset with every insertion of a bitmap.
 
495
          It may be useful, however, to initialize a list for the insertion of graphics <b>other</b> than bitmaps,
 
496
          so that the images can be rendered as bitmaps of the intended width and height, before they are inserted.
 
497
          </p>
 
498
        </descr>
707
499
        <errors/>
708
500
        <seealso/>
709
501
      </element>
710
 
      <!-- argument Visibility: default -->
711
502
      <element name="TCustomImageList.CreateSize.AWidth">
712
 
        <short/>
 
503
        <short>The width of all images, in pixels.</short>
713
504
      </element>
714
 
      <!-- argument Visibility: default -->
715
505
      <element name="TCustomImageList.CreateSize.AHeight">
716
 
        <short/>
 
506
        <short>The height of all images, in pixels.</short>
717
507
      </element>
718
508
      <!-- procedure Visibility: public -->
719
509
      <element name="TCustomImageList.Delete">
720
 
        <short>Delete the specified image</short>
 
510
        <short>Delete the specified image.</short>
721
511
        <descr/>
722
512
        <errors/>
723
513
        <seealso/>
724
514
      </element>
725
 
      <!-- argument Visibility: default -->
726
 
      <element name="TCustomImageList.Delete.Index">
727
 
        <short/>
 
515
      <element name="TCustomImageList.Delete.AIndex">
 
516
        <short>the index of the image to be deleted. -1 for delete all.</short>
728
517
      </element>
729
518
      <!-- destructor Visibility: public -->
730
 
      <element name="TCustomImageList.Destroy" link="#rtl.Classes.TComponent.Destroy">
731
 
        <short/>
732
 
        <descr/>
733
 
        <errors/>
734
 
        <seealso/>
735
 
      </element>
 
519
      <element name="TCustomImageList.Destroy"/>
736
520
      <!-- procedure Visibility: public -->
737
521
      <element name="TCustomImageList.Draw">
738
522
        <short>Paint an image</short>
740
524
        <errors/>
741
525
        <seealso/>
742
526
      </element>
743
 
      <!-- argument Visibility: default -->
744
 
      <element name="TCustomImageList.Draw.Canvas">
745
 
        <short/>
746
 
      </element>
747
 
      <!-- argument Visibility: default -->
748
 
      <element name="TCustomImageList.Draw.X">
749
 
        <short/>
750
 
      </element>
751
 
      <!-- argument Visibility: default -->
752
 
      <element name="TCustomImageList.Draw.Y">
753
 
        <short/>
754
 
      </element>
755
 
      <!-- argument Visibility: default -->
756
 
      <element name="TCustomImageList.Draw.Index">
757
 
        <short/>
758
 
      </element>
759
 
      <!-- argument Visibility: default -->
760
 
      <element name="TCustomImageList.Draw.Enabled">
761
 
        <short/>
 
527
      <element name="TCustomImageList.Draw.ACanvas">
 
528
        <short/>
 
529
      </element>
 
530
      <element name="TCustomImageList.Draw.AX">
 
531
        <short/>
 
532
      </element>
 
533
      <element name="TCustomImageList.Draw.AY">
 
534
        <short/>
 
535
      </element>
 
536
      <element name="TCustomImageList.Draw.AIndex">
 
537
        <short>The image index.</short>
 
538
      </element>
 
539
      <element name="TCustomImageList.Draw.AEnabled">
 
540
         <short>If False, draw the image disabled (dithered).</short>
 
541
     </element>
 
542
      <element name="TCustomImageList.Draw.ADrawEffect">
 
543
        <short/>
 
544
      <notes><note>?</note>
 
545
        </notes>
 
546
      </element>
 
547
      <element name="TCustomImageList.Draw.ADrawingStyle">
 
548
        <short/>
 
549
      <notes><note>?</note>
 
550
        </notes>
 
551
      </element>
 
552
      <element name="TCustomImageList.Draw.AImageType">
 
553
        <short/>
 
554
      <notes><note>?</note>
 
555
        </notes>
762
556
      </element>
763
557
      <!-- procedure Visibility: public -->
764
558
      <element name="TCustomImageList.GetBitmap">
767
561
        <errors/>
768
562
        <seealso/>
769
563
      </element>
770
 
      <!-- argument Visibility: default -->
771
564
      <element name="TCustomImageList.GetBitmap.Index">
772
 
        <short/>
 
565
        <short>the index of the requested image</short>
773
566
      </element>
774
 
      <!-- argument Visibility: default -->
775
567
      <element name="TCustomImageList.GetBitmap.Image">
776
 
        <short/>
777
 
      </element>
778
 
      <!-- procedure Visibility: public -->
779
 
      <element name="TCustomImageList.GetInternalImage">
780
 
        <short/>
781
 
        <descr/>
782
 
        <errors/>
783
 
        <seealso/>
784
 
      </element>
785
 
      <!-- argument Visibility: default -->
786
 
      <element name="TCustomImageList.GetInternalImage.Index">
787
 
        <short/>
788
 
      </element>
789
 
      <!-- argument Visibility: default -->
790
 
      <element name="TCustomImageList.GetInternalImage.Image">
791
 
        <short/>
792
 
      </element>
793
 
      <!-- argument Visibility: default -->
794
 
      <element name="TCustomImageList.GetInternalImage.Mask">
795
 
        <short/>
796
 
      </element>
797
 
      <!-- argument Visibility: default -->
798
 
      <element name="TCustomImageList.GetInternalImage.ImageRect">
799
 
        <short/>
 
568
        <short>a bitmap as a container for the bitmap</short>
 
569
      </element>
 
570
      <element name="TCustomImageList.GetBitmap.AEffect">
 
571
        <short>how to copy</short>
800
572
      </element>
801
573
      <!-- function Visibility: public -->
802
574
      <element name="TCustomImageList.GetHotSpot">
803
575
        <short>
804
 
          <var>GetHotSpot</var> - returns the co-ordinates for the hotspot of the drag image</short>
805
 
        <descr/>
 
576
          Returns the offset from the drawing position to the image origin.</short>
 
577
        <descr>A HotSpot is used only in a TDragImageList, here it is (0,0).</descr>
806
578
        <errors/>
807
579
        <seealso/>
808
580
      </element>
809
 
      <!-- function result Visibility: default -->
810
581
      <element name="TCustomImageList.GetHotSpot.Result">
811
582
        <short/>
812
583
      </element>
813
 
      <!-- procedure Visibility: public -->
814
 
      <element name="TCustomImageList.GetIcon">
815
 
        <short/>
816
 
        <descr/>
817
 
        <errors/>
818
 
        <seealso/>
819
 
      </element>
820
 
      <!-- argument Visibility: default -->
821
 
      <element name="TCustomImageList.GetIcon.Index">
822
 
        <short/>
823
 
      </element>
824
 
      <!-- argument Visibility: default -->
825
 
      <element name="TCustomImageList.GetIcon.Image">
826
 
        <short/>
827
 
      </element>
828
584
      <!-- function Visibility: public -->
829
 
      <element name="TCustomImageList.HandleAllocated" link="#LCL.LCLClasses.TLCLReferenceComponent.HandleAllocated">
830
 
        <short/>
831
 
        <descr/>
832
 
        <errors/>
833
 
        <seealso/>
834
 
      </element>
 
585
      <element name="TCustomImageList.HandleAllocated"/>
835
586
      <!-- function result Visibility: default -->
836
587
      <element name="TCustomImageList.HandleAllocated.Result">
837
588
        <short/>
839
590
      <!-- procedure Visibility: public -->
840
591
      <element name="TCustomImageList.Insert">
841
592
        <short>
842
 
          <var>Insert</var> one or more images into the list at the index position.</short>
843
 
        <descr>The insterted bitmap can consist of multiple images, of the same width and height, which become accessible as distinct images in the ImageList.
844
 
 
845
 
The height of the inserted images must match the ImageList height, else the ImageList content is <b>replaced</b> by the added images. The width must be a multiple of the ImageList width, so that the list always contains an integral number of images.
846
 
 
847
 
If Mask is nil, the inserted images have no transparent parts.</descr>
 
593
          Inserts one or more images into the list at the index position.</short>
 
594
        <descr>
 
595
          <p>
 
596
          The inserted bitmap can consist of multiple images, of the same width and height, which become accessible as distinct images in the ImageList.
 
597
          </p><p>
 
598
            The height of the inserted images must match the ImageList height, else the ImageList content is <b>replaced</b> by the added images.
 
599
            The width must be a multiple of the ImageList width, so that the list always contains an integral number of images.
 
600
          </p><p>
 
601
            If Mask is nil, the inserted images have no transparent parts.
 
602
            Use InsertMasked to insert bitmaps with a specific transparent color.
 
603
          </p>
 
604
        </descr>
848
605
        <errors/>
849
606
        <seealso/>
850
607
      </element>
851
 
      <!-- argument Visibility: default -->
852
 
      <element name="TCustomImageList.Insert.Index">
853
 
        <short/>
854
 
      </element>
855
 
      <!-- argument Visibility: default -->
856
 
      <element name="TCustomImageList.Insert.Image">
857
 
        <short/>
858
 
      </element>
859
 
      <!-- argument Visibility: default -->
860
 
      <element name="TCustomImageList.Insert.Mask">
861
 
        <short/>
 
608
      <element name="TCustomImageList.Insert.AIndex">
 
609
        <short>insert position</short>
 
610
      </element>
 
611
      <element name="TCustomImageList.Insert.AImage">
 
612
        <short>bitmap to insert</short>
 
613
      </element>
 
614
      <element name="TCustomImageList.Insert.AMask">
 
615
        <short>transparency mask, Nil for opaque</short>
862
616
      </element>
863
617
      <!-- procedure Visibility: public -->
864
618
      <element name="TCustomImageList.InsertIcon">
865
 
        <short/>
 
619
        <short>Insert an Icon into the list.</short>
866
620
        <descr/>
867
621
        <errors/>
868
622
        <seealso/>
869
623
      </element>
870
 
      <!-- argument Visibility: default -->
871
 
      <element name="TCustomImageList.InsertIcon.Index">
872
 
        <short/>
 
624
      <element name="TCustomImageList.InsertIcon.AIndex">
 
625
        <short>insertion point</short>
873
626
      </element>
874
 
      <!-- argument Visibility: default -->
875
 
      <element name="TCustomImageList.InsertIcon.Image">
876
 
        <short/>
 
627
      <element name="TCustomImageList.InsertIcon.AIcon">
 
628
        <short>The Icon to insert.</short>
877
629
      </element>
878
630
      <!-- procedure Visibility: public -->
879
631
      <element name="TCustomImageList.InsertMasked">
880
632
        <short>
881
 
          <var>InsertMasked</var> - adds one or more transparent bitmaps to the list.</short>
 
633
          Adds one or more transparent bitmaps to the list.</short>
882
634
        <descr>MaskColor is the RGB color of the transparent pixels. Every occurence of a MaskColor pixel will be converted into a transparent pixel.</descr>
883
635
        <errors/>
884
636
        <seealso>
885
637
          <link id="TCustomImageList.Insert"/>
886
638
        </seealso>
887
639
      </element>
888
 
      <!-- argument Visibility: default -->
889
640
      <element name="TCustomImageList.InsertMasked.Index">
890
 
        <short/>
891
 
      </element>
892
 
      <!-- argument Visibility: default -->
893
 
      <element name="TCustomImageList.InsertMasked.Image">
894
 
        <short/>
895
 
      </element>
896
 
      <!-- argument Visibility: default -->
 
641
        <short>The index of the inserted image.</short>
 
642
      </element>
 
643
      <element name="TCustomImageList.InsertMasked.AImage">
 
644
        <short>The bitmap to be inserted.</short>
 
645
      </element>
897
646
      <element name="TCustomImageList.InsertMasked.MaskColor">
898
 
        <short/>
 
647
        <short>The color acting as transparant color.</short>
899
648
      </element>
900
649
      <!-- procedure Visibility: public -->
901
650
      <element name="TCustomImageList.Move">
902
651
        <short>
903
 
          <var>Move</var> an image from index <var>CurIndex</var> to <var>NewIndex</var>
 
652
          Move an image from index <var>CurIndex</var> to <var>NewIndex.</var>
904
653
        </short>
905
654
        <descr/>
906
655
        <errors/>
908
657
          <link id="TCustomImageList"/>
909
658
        </seealso>
910
659
      </element>
911
 
      <!-- argument Visibility: default -->
912
 
      <element name="TCustomImageList.Move.CurIndex">
913
 
        <short/>
 
660
      <element name="TCustomImageList.Move.ACurIndex">
 
661
        <short>the index of the image to be moved</short>
914
662
      </element>
915
 
      <!-- argument Visibility: default -->
916
 
      <element name="TCustomImageList.Move.NewIndex">
917
 
        <short/>
 
663
      <element name="TCustomImageList.Move.ANewIndex">
 
664
        <short>the new index of the image</short>
918
665
      </element>
919
666
      <!-- procedure Visibility: public -->
920
667
      <element name="TCustomImageList.Replace">
921
668
        <short>
922
 
          <var>Replace</var> an indexed image with the Bitmap given</short>
 
669
          <var>Replace</var> the indexed image with the Bitmap given</short>
923
670
        <descr>AMask can be nil, if the image has no transparent parts.</descr>
924
671
        <errors/>
925
672
        <seealso/>
926
673
      </element>
927
 
      <!-- argument Visibility: default -->
928
 
      <element name="TCustomImageList.Replace.Index">
929
 
        <short/>
930
 
      </element>
931
 
      <!-- argument Visibility: default -->
932
 
      <element name="TCustomImageList.Replace.Image">
933
 
        <short/>
934
 
      </element>
935
 
      <!-- argument Visibility: default -->
936
 
      <element name="TCustomImageList.Replace.Mask">
937
 
        <short/>
938
 
      </element>
939
 
      <!-- procedure Visibility: public -->
940
 
      <element name="TCustomImageList.ReplaceIcon">
941
 
        <short/>
942
 
        <descr/>
943
 
        <errors/>
944
 
        <seealso/>
945
 
      </element>
946
 
      <!-- argument Visibility: default -->
947
 
      <element name="TCustomImageList.ReplaceIcon.Index">
948
 
        <short/>
949
 
      </element>
950
 
      <!-- argument Visibility: default -->
951
 
      <element name="TCustomImageList.ReplaceIcon.Image">
952
 
        <short/>
 
674
      <element name="TCustomImageList.Replace.AIndex">
 
675
        <short>the index of the replaceded image</short>
 
676
      </element>
 
677
      <element name="TCustomImageList.Replace.AImage">
 
678
        <short>a bitmap image</short>
 
679
      </element>
 
680
      <element name="TCustomImageList.Replace.AMask">
 
681
        <short>a bitmap which defines the transparent parts of Image</short>
953
682
      </element>
954
683
      <!-- procedure Visibility: public -->
955
684
      <element name="TCustomImageList.ReplaceMasked">
956
685
        <short>
957
686
          <var>ReplaceMasked</var> - replaces the indexed image with the image given.</short>
958
 
        <descr>Every instance of MaskColor will be converted to transparent</descr>
 
687
        <descr>Every pixel of MaskColor will be converted to transparent.</descr>
959
688
        <errors/>
960
689
        <seealso>
961
690
          <link id="TCustomImageList.InsertMasked"/>
 
691
          <link id="TCustomImageList.AddMasked"/>
962
692
        </seealso>
963
693
      </element>
964
 
      <!-- argument Visibility: default -->
965
694
      <element name="TCustomImageList.ReplaceMasked.Index">
966
 
        <short/>
 
695
        <short>The index of the replaced image.</short>
967
696
      </element>
968
 
      <!-- argument Visibility: default -->
969
697
      <element name="TCustomImageList.ReplaceMasked.NewImage">
970
 
        <short/>
 
698
        <short>A bitmap image.</short>
971
699
      </element>
972
 
      <!-- argument Visibility: default -->
973
700
      <element name="TCustomImageList.ReplaceMasked.MaskColor">
974
 
        <short/>
 
701
        <short>The color acting as transparant color.</short>
975
702
      </element>
976
703
      <!-- procedure Visibility: public -->
977
704
      <element name="TCustomImageList.RegisterChanges">
978
 
        <short>Registers an object to get notified of a change of the imagelist</short>
 
705
        <short>Registers an TChangeLink object to get notified of a change of the imagelist.</short>
979
706
        <descr/>
980
707
        <errors/>
981
708
        <seealso/>
982
709
      </element>
983
 
      <!-- argument Visibility: default -->
984
710
      <element name="TCustomImageList.RegisterChanges.Value">
985
 
        <short/>
 
711
        <short>a reference to changelink object</short>
986
712
      </element>
987
713
      <!-- procedure Visibility: public -->
988
714
      <element name="TCustomImageList.UnRegisterChanges">
989
715
        <short>
990
 
          <var>UnRegisterChanges</var> - remove the changes from the register</short>
 
716
          Unregisters an notification object.</short>
991
717
        <descr/>
992
718
        <errors/>
993
719
        <seealso/>
994
720
      </element>
995
 
      <!-- argument Visibility: default -->
996
721
      <element name="TCustomImageList.UnRegisterChanges.Value">
997
 
        <short/>
 
722
        <short>Reference to the changelink object to remove.</short>
998
723
      </element>
999
724
      <!-- property Visibility: public -->
1000
725
      <element name="TCustomImageList.AllocBy">
1001
726
        <short>
1002
 
          <var>AllocBy</var> - allocate images by an integer value</short>
1003
 
        <descr/>
 
727
          The length of the image list is increased in multiples of AllocBy images. Default is 4.</short>
 
728
        <descr>Other list types allow to set the list Capacity directly - not so for an ImageList.</descr>
1004
729
        <seealso/>
1005
730
      </element>
1006
731
      <!-- property Visibility: public -->
1007
732
      <element name="TCustomImageList.BlendColor">
1008
733
        <short>
1009
 
          <var>BlendColor</var> - the colour for a blend</short>
 
734
          The color for used in blending (dithering) an image.</short>
1010
735
        <descr/>
1011
 
        <seealso/>
 
736
        <seealso><link id="TDrawingStyle"/>
 
737
        </seealso>
1012
738
      </element>
1013
739
      <!-- property Visibility: public -->
1014
740
      <element name="TCustomImageList.BkColor">
1015
741
        <short>
1016
 
          <var>BkColor</var> - background colour (default none)</short>
1017
 
        <descr/>
 
742
          The background color to use for transparent parts.</short>
 
743
        <descr>
 
744
          <p>BkColor is intended to speed up drawing of transparent images,
 
745
          on a background of known color (=BkColor). In this case the image can be drawn opaque,
 
746
          eliminating the need for really masking out and merging with existing background.
 
747
          </p>
 
748
        </descr>
1018
749
        <seealso/>
 
750
      <notes><note>does this really apply? depending on the widgetset?</note>
 
751
        </notes>
1019
752
      </element>
1020
753
      <!-- property Visibility: public -->
1021
754
      <element name="TCustomImageList.Count">
1022
755
        <short>
1023
 
          <var>Count</var> - number of images in the list</short>
 
756
          The number of images in the list</short>
1024
757
        <descr/>
1025
758
        <seealso/>
1026
759
      </element>
1027
760
      <!-- property Visibility: public -->
1028
761
      <element name="TCustomImageList.DrawingStyle">
1029
762
        <short>
1030
 
          <var>DrawingStyle</var> - focus, selected, normal or transparent</short>
1031
 
        <descr/>
1032
 
        <seealso/>
1033
 
      </element>
1034
 
      <!-- property Visibility: public -->
1035
 
      <element name="TCustomImageList.Handle">
1036
 
        <short/>
 
763
          The default drawing style - focussed, selected, normal or transparent.</short>
1037
764
        <descr/>
1038
765
        <seealso/>
1039
766
      </element>
1040
767
      <!-- property Visibility: public -->
1041
768
      <element name="TCustomImageList.Height">
1042
769
        <short>
1043
 
          <var>Height</var> of images on list</short>
1044
 
        <descr/>
 
770
          The unique height of all images in the list.</short>
 
771
        <descr>Setting to an different value clears the entire list!</descr>
1045
772
        <seealso/>
1046
773
      </element>
1047
774
      <!-- property Visibility: public -->
1048
775
      <element name="TCustomImageList.Width">
1049
776
        <short>
1050
 
          <var>Width</var> of images on list</short>
1051
 
        <descr/>
 
777
          The unique width of all images in the list.</short>
 
778
        <descr>Setting to an different value clears the entire list!</descr>
1052
779
        <seealso/>
1053
780
      </element>
1054
781
      <!-- property Visibility: public -->
1061
788
      <!-- property Visibility: public -->
1062
789
      <element name="TCustomImageList.Masked">
1063
790
        <short>
1064
 
          <var>Masked</var> - if True, a mask is applied to the bitmap</short>
1065
 
        <descr/>
1066
 
        <seealso/>
1067
 
      </element>
1068
 
      <!-- property Visibility: public -->
1069
 
      <element name="TCustomImageList.Bitmap">
1070
 
        <short/>
1071
 
        <descr/>
1072
 
        <seealso/>
1073
 
      </element>
1074
 
      <!-- property Visibility: public -->
1075
 
      <element name="TCustomImageList.MaskBitmap">
1076
 
        <short/>
1077
 
        <descr/>
1078
 
        <seealso/>
 
791
          True when mask images are stored with every image (unused!).</short>
 
792
        <descr>This property exists only for Delphi compatibility</descr>
 
793
        <seealso/>
 
794
      <notes><note>?</note>
 
795
        </notes>
1079
796
      </element>
1080
797
      <!-- property Visibility: public -->
1081
798
      <element name="TCustomImageList.ShareImages">
1082
799
        <short>
1083
 
          <var>ShareImages</var> - if True, images are allowed to be shared</short>
1084
 
        <descr/>
 
800
          True when this image list is shared. Unused!</short>
 
801
        <descr>This property exists only for Delphi compatibility.
 
802
          True means that the imagelist <b>widget</b> is freed together with the ImageList
 
803
        </descr>
1085
804
        <seealso/>
 
805
      <notes><note>?</note>
 
806
        </notes>
1086
807
      </element>
1087
808
      <!-- property Visibility: public -->
1088
809
      <element name="TCustomImageList.ImageType">
1089
810
        <short>
1090
 
          <var>ImageType</var> - an image or a mask</short>
1091
 
        <descr/>
 
811
          Unused!</short>
 
812
        <descr>This property exists only for Delphi compatibility</descr>
1092
813
        <seealso/>
1093
 
      </element>
1094
 
      <element name="TCustomImageList.AddImages.AValue">
1095
 
        <short>
1096
 
          <var>AValue</var> - the ImageList containing images to add</short>
1097
 
      </element>
1098
 
      <element name="TCustomImageList.AddLazarusResource">
1099
 
        <short>
1100
 
          <var>AddLazarusResource</var> - load <var>TBitmap</var> from lazarus resources and add it</short>
 
814
      <notes><note>?</note>
 
815
        </notes>
1101
816
      </element>
1102
817
      <element name="TCustomImageList.FillDescription">
1103
818
        <short>
1104
819
          <var>FillDescription</var> - fills the description with the default info of the imagedata</short>
1105
820
      </element>
 
821
      <element name="TCustomImageList.FillDescription.ADesc">
 
822
        <short>the description to copy</short>
 
823
      </element>
 
824
      <!-- procedure Visibility: public -->
 
825
      <element name="TCustomImageList.GetFullBitmap">
 
826
        <short/>
 
827
        <descr>
 
828
        </descr>
 
829
        <errors>
 
830
        </errors>
 
831
        <seealso>
 
832
        </seealso>
 
833
      <notes><note>?</note>
 
834
        </notes>
 
835
      </element>
 
836
      <element name="TCustomImageList.GetFullBitmap.Image">
 
837
        <short>the target bitmap</short>
 
838
      </element>
 
839
      <element name="TCustomImageList.GetFullBitmap.AEffect">
 
840
        <short>how to copy</short>
 
841
      </element>
 
842
      <!-- procedure Visibility: public -->
 
843
      <element name="TCustomImageList.GetFullRawImage">
 
844
        <short>Exports the entire internal image (color array) and description.</short>
 
845
      </element>
 
846
      <element name="TCustomImageList.GetFullRawImage.Image">
 
847
        <short/>
 
848
      </element>
 
849
      <!-- procedure Visibility: public -->
1106
850
      <element name="TCustomImageList.GetRawImage">
1107
851
        <short>
1108
 
          <var>GetRawImage</var> - primitive method for loading an image: you have to fill in all the description fields yourself</short>
1109
 
      </element>
 
852
          Exports an image as TRawImage.</short>
 
853
      </element>
 
854
      <element name="TCustomImageList.GetRawImage.Index">
 
855
        <short>the index of the image to copy</short>
 
856
      </element>
 
857
      <element name="TCustomImageList.GetRawImage.Image">
 
858
        <short>the target bitmap</short>
 
859
      </element>
 
860
      <!-- procedure Visibility: public -->
1110
861
      <element name="TCustomImageList.Reference">
1111
862
        <short>
1112
863
          <var>Reference</var> to the imagelist</short>
1113
864
      </element>
 
865
      <!-- procedure Visibility: public -->
1114
866
      <element name="TCustomImageList.CheckIndex">
1115
867
        <short>
1116
 
          <var>CheckIndex</var> - method for checking whether the indexed item is supposed to be inserted (default condition is False)</short>
1117
 
      </element>
 
868
          Assures that Index is not out of the list bound.</short>
 
869
        <errors>
 
870
          Raises an EInvalidOperation exception when the index is out of bounds.
 
871
        </errors>
 
872
      </element>
 
873
      <element name="TCustomImageList.CheckIndex.AIndex">
 
874
        <short>The index to check.</short>
 
875
      </element>
 
876
      <element name="TCustomImageList.CheckIndex.AForInsert">
 
877
        <short>Set to True when the index is used for insertion (default is False).</short>
 
878
      </element>
 
879
      <!-- procedure Visibility: protected -->
1118
880
      <element name="TCustomImageList.GetReferenceHandle">
1119
881
        <short>
1120
 
          <var>GetReferenceHandle</var> - returns a handle for the reference</short>
1121
 
      </element>
 
882
          Returns the Handle of the Reference.</short>
 
883
      </element>
 
884
      <element name="TCustomImageList.GetReferenceHandle.Result">
 
885
        <short>The widget handle.</short>
 
886
      </element>
 
887
      <!-- procedure Visibility: protected -->
1122
888
      <element name="TCustomImageList.WSCreateReference">
1123
889
        <short>
1124
 
          <var>WSCreateReference</var> - creates a reference for the Imagelist (returns this as a result), passing the defined parameters for the creation process</short>
 
890
          Instructs the widgtset to create an imagelist.</short>
 
891
      </element>
 
892
      <element name="TCustomImageList.WSCreateReference.Result">
 
893
        <short>Reference object for the created widget.</short>
 
894
      </element>
 
895
      <element name="TCustomImageList.WSCreateReference.AParams">
 
896
        <short>ignored</short>
1125
897
      </element>
1126
898
      <element name="TCustomImageList.StretchDraw">
1127
899
        <short>
1128
 
          <var>StretchDraw</var> - draw the image to fill the canvas</short>
1129
 
      </element>
1130
 
      <element name="TCustomImageList.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
1131
 
      <element name="TCustomImageList.InternalInsert"/>
 
900
          Draws an image stretched to ARect.</short>
 
901
      </element>
 
902
      <element name="TCustomImageList.StretchDraw.Canvas">
 
903
        <short/>
 
904
      <notes><note>?</note>
 
905
        </notes>
 
906
      </element>
 
907
      <element name="TCustomImageList.StretchDraw.Index">
 
908
        <short/>
 
909
      <notes><note>?</note>
 
910
        </notes>
 
911
      </element>
 
912
      <element name="TCustomImageList.StretchDraw.ARect">
 
913
        <short/>
 
914
      <notes><note>?</note>
 
915
        </notes>
 
916
      </element>
 
917
      <element name="TCustomImageList.StretchDraw.Enabled">
 
918
        <short/>
 
919
      <notes><note>?</note>
 
920
        </notes>
 
921
      </element>
1132
922
      <element name="TCustomImageList.Equals">
1133
923
        <short>Check for equivalence with another ImageList</short>
1134
924
        <descr>This is an expensive operation, since both imagelists are written into memory streams, which then are compared bytewise.</descr>
1135
925
      </element>
1136
 
      <element name="TCustomImageList.GetFullRawImage">
1137
 
        <short>Copies the image description and the data pointer</short>
 
926
      <element name="TCustomImageList.Equals.Result">
 
927
        <short>True when the image lists are equal.</short>
 
928
      </element>
 
929
      <element name="TCustomImageList.Equals.Obj">
 
930
        <short>The object (ImageList) to compare with.</short>
1138
931
      </element>
1139
932
    </module>
1140
933
    <!-- ImgList -->