File: dynamicarray.xml

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