/docs/xml/lcl/dynamicarray.xml

  1<?xml version="1.0" encoding="UTF-8"?>
  2<fpdoc-descriptions>
  3  <package name="lcl">
  4    <!--
  5  ====================================================================
  6    DynamicArray
  7  ====================================================================
  8-->  
  9    <module name="DynamicArray">
 10      <short>It implements a resizable 2d array containing pointers.</short>
 11      <descr/>
 12      <!-- unresolved type reference Visibility: default -->
 13      <element name="Classes">
 14        <short/>
 15        <descr/>
 16        <seealso/>
 17      </element>
 18      <!-- unresolved type reference Visibility: default -->
 19      <element name="SysUtils">
 20        <short/>
 21        <descr/>
 22        <seealso/>
 23      </element>
 24      <!-- object Visibility: default -->
 25      <element name="EArray">
 26        <short/>
 27        <descr/>
 28        <errors/>
 29        <seealso/>
 30      </element>
 31      <!-- procedure type Visibility: default -->
 32      <element name="TOnNotifyItem">
 33        <short>Type for event handling</short>
 34        <descr/>
 35        <seealso/>
 36      </element>
 37      <!-- argument Visibility: default -->
 38      <element name="TOnNotifyItem.Sender">
 39        <short>instance of the TArray that causes the event</short>
 40      </element>
 41      <!-- argument Visibility: default -->
 42      <element name="TOnNotifyItem.Col">
 43        <short>The related Col of the event</short>
 44      </element>
 45      <!-- argument Visibility: default -->
 46      <element name="TOnNotifyItem.Row">
 47        <short>The related Row of the event</short>
 48      </element>
 49      <!-- argument Visibility: default -->
 50      <element name="TOnNotifyItem.Item">
 51        <short>The related Item of the event</short>
 52      </element>
 53      <!-- procedure type Visibility: default -->
 54      <element name="TOnExchangeItem">
 55        <short/>
 56        <descr/>
 57        <seealso/>
 58      </element>
 59      <!-- argument Visibility: default -->
 60      <element name="TOnExchangeItem.Sender">
 61         <short>The instance of the TArray that causes the Exchange event</short>
 62      </element>
 63      <!-- argument Visibility: default -->
 64      <element name="TOnExchangeItem.Index">
 65        <short/>
 66      </element>
 67      <!-- argument Visibility: default -->
 68      <element name="TOnExchangeItem.WithIndex">
 69        <short/>
 70      </element>
 71      <!-- object Visibility: default -->
 72      <element name="TArray">
 73        <short>It implements a resizable 2d array.</short>
 74        <descr/>
 75        <errors/>
 76        <seealso/>
 77      </element>
 78      <!-- variable Visibility: private -->
 79      <element name="TArray.FCols">
 80        <short>It contains the first dimension of the array.</short>
 81        <descr/>
 82        <seealso/>
 83      </element>
 84      <!-- variable Visibility: private -->
 85      <element name="TArray.FOnDestroyItem">
 86       <short>A user-defined function to be called when an item is destroyed.</short>
 87        <descr>This can happen in ClearCol,Clear,SetLength</descr>
 88        <seealso/>
 89      </element>
 90      <!-- variable Visibility: private -->
 91      <element name="TArray.FOnNewItem">
 92        <short>A user-defined function to be called when a new item is created.</short>
 93        <descr/>
 94        <seealso/>
 95      </element>
 96      <!-- function Visibility: private -->
 97      <element name="TArray.Getarr">
 98        <short>Returns the stored item(actually pointer) in array</short>
 99        <descr/>
100        <errors/>
101        <seealso/>
102      </element>
103      <!-- function result Visibility: default -->
104      <element name="TArray.Getarr.Result">
105        <short>the stored item,pointer.</short>
106      </element>
107      <!-- argument Visibility: default -->
108      <element name="TArray.Getarr.Col">
109        <short>the first dimension of the array.</short>
110      </element>
111      <!-- argument Visibility: default -->
112      <element name="TArray.Getarr.Row">
113        <short>the second dimension of the array.</short>
114      </element>
115      <!-- procedure Visibility: private -->
116      <element name="TArray.Setarr">
117        <short>Sets an item in the array [col][row].</short>
118        <descr/>
119        <errors/>
120        <seealso/>
121      </element>
122      <!-- argument Visibility: default -->
123      <element name="TArray.Setarr.Col">
124         <short>the first dimension of the array.</short>
125      </element>
126      <!-- argument Visibility: default -->
127      <element name="TArray.Setarr.Row">
128        <short>the second dimension of the array.</short>
129      </element>
130      <!-- argument Visibility: default -->
131      <element name="TArray.Setarr.Avalue">
132        <short>the value to be stored.</short>
133      </element>
134      <!-- procedure Visibility: private -->
135      <element name="TArray.ClearCol">
136        <short>Clears the given TList</short>
137        <descr>The given TList is assumed to be the COL of the array.</descr>
138        <errors/>
139        <seealso/>
140      </element>
141      <!-- argument Visibility: default -->
142      <element name="TArray.ClearCol.L">
143        <short>Tlist to be cleared.</short>
144      </element>
145      <!-- argument Visibility: default -->
146      <element name="TArray.ClearCol.Col">
147        <short>the first dimension of the array.</short>
148      </element>
149      <!-- procedure Visibility: private -->
150      <element name="TArray.Aumentar_Rows">
151         <short>Extends a row to its new size(Rows)</short>
152        <descr/>
153        <errors/>
154        <seealso/>
155      </element>
156      <!-- argument Visibility: default -->
157      <element name="TArray.Aumentar_Rows.col">
158        <short>current column</short>
159      </element>
160      <!-- argument Visibility: default -->
161      <element name="TArray.Aumentar_Rows.Rows">
162        <short>new row size</short>
163      </element>
164      <!-- argument Visibility: default -->
165      <element name="TArray.Aumentar_Rows.L">
166        <short>The row to be operated on.</short>
167      </element>
168      <!-- procedure Visibility: private -->
169      <element name="TArray.DestroyItem">
170        <short>event handler called when an item is destroyed.</short>
171        <descr/>
172        <errors/>
173        <seealso/>
174      </element>
175      <!-- argument Visibility: default -->
176      <element name="TArray.DestroyItem.Col">
177        <short>the column of the destroyed item.</short>
178      </element>
179      <!-- argument Visibility: default -->
180      <element name="TArray.DestroyItem.Row">
181        <short>the row of the destroyed item.</short>
182      </element>
183      <!-- argument Visibility: default -->
184      <element name="TArray.DestroyItem.P">
185        <short>the item itself before it is unlinked.</short>
186      </element>
187      <!-- constructor Visibility: public -->
188      <element name="TArray.Create">
189        <short/>
190        <descr/>
191        <errors/>
192        <seealso/>
193        <example file="dynamicarray/tarrayexample.pas"/>
194      </element>
195      <!-- destructor Visibility: public -->
196      <element name="TArray.Destroy">
197        <short/>
198        <descr/>
199        <errors/>
200        <seealso/>
201        <example file="dynamicarray/tarrayexample.pas"/>
202      </element>
203      <!-- procedure Visibility: public -->
204      <element name="TArray.SetLength">
205        <short>Resizes the array.</short>
206        <descr/>
207        <errors/>
208        <seealso/>
209        <example file="dynamicarray/tarrayexample.pas"/>
210      </element>
211      <!-- argument Visibility: default -->
212      <element name="TArray.SetLength.Cols">
213        <short>new column size</short>
214      </element>
215      <!-- argument Visibility: default -->
216      <element name="TArray.SetLength.Rows">
217        <short>new row size</short>
218      </element>
219      <!-- procedure Visibility: public -->
220      <element name="TArray.DeleteColRow">
221        <short>Deletes a column or a row of an array.</short>
222        <descr/>
223        <errors/>
224        <seealso/>
225        <example file="dynamicarray/tarrayexample.pas"/>
226      </element>
227      <!-- argument Visibility: default -->
228      <element name="TArray.DeleteColRow.IsColumn">
229        <short>Do you want to delete a column?</short>
230      </element>
231      <!-- argument Visibility: default -->
232      <element name="TArray.DeleteColRow.Index">
233        <short>index of a row or a column</short>
234      </element>
235      <!-- procedure Visibility: public -->
236      <element name="TArray.MoveColRow">
237        <short>Moves a column to another column or a row to another row.</short>
238        <descr/>
239        <errors/>
240        <seealso/>
241        <example file="dynamicarray/tarrayexample.pas"/>
242      </element>
243      <!-- argument Visibility: default -->
244      <element name="TArray.MoveColRow.IsColumn">
245        <short>Do you want to move a column?</short>
246      </element>
247      <!-- argument Visibility: default -->
248      <element name="TArray.MoveColRow.FromIndex">
249        <short>source</short>
250      </element>
251      <!-- argument Visibility: default -->
252      <element name="TArray.MoveColRow.ToIndex">
253        <short>destination</short>
254      </element>
255      <!-- procedure Visibility: public -->
256      <element name="TArray.ExchangeColRow">
257        <short>Swaps two rows or two columns.</short>
258        <descr/>
259        <errors/>
260        <seealso/>
261        <example file="dynamicarray/tarrayexample.pas"/>
262      </element>
263      <!-- argument Visibility: default -->
264      <element name="TArray.ExchangeColRow.IsColumn">
265         <short>Do you want to move a column?</short>
266      </element>
267      <!-- argument Visibility: default -->
268      <element name="TArray.ExchangeColRow.Index">
269        <short>index of row or column</short>
270      </element>
271      <!-- argument Visibility: default -->
272      <element name="TArray.ExchangeColRow.WithIndex">
273        <short>index of row or column</short>
274      </element>
275      <!-- procedure Visibility: public -->
276      <element name="TArray.Clear">
277        <short>Removes all elements from the array.</short>
278        <descr/>
279        <errors/>
280        <example file="dynamicarray/tarrayexample.pas"/>
281        <seealso/>
282      </element>
283      <!-- property Visibility: public -->
284      <element name="TArray.Arr">
285        <short>Reads/Writes an element from the array.</short>
286        <descr/>
287        <seealso/>
288        <example file="dynamicarray/tarrayexample.pas"/>
289      </element>
290      <!-- argument Visibility: default -->
291      <element name="TArray.Arr.Col">
292        <short/>
293      </element>
294      <!-- argument Visibility: default -->
295      <element name="TArray.Arr.Row">
296        <short/>
297      </element>
298      <!-- property Visibility: public -->
299      <element name="TArray.OnDestroyItem">
300        <short>User-defined function which is called when an item is destroyed.</short>
301        <descr/>
302        <seealso/>
303      </element>
304      <!-- property Visibility: public -->
305      <element name="TArray.OnNewItem">
306        <short>User-defined function which is called when an item is created.</short>
307        <descr/>
308        <descr/>
309        <seealso/>
310      </element>
311    </module>
312    <!-- DynamicArray -->
313  </package>
314</fpdoc-descriptions>