Updated docs.
[platform/upstream/atk.git] / docs / tmpl / atktable.sgml
1 <!-- ##### SECTION Title ##### -->
2 AtkTable
3
4 <!-- ##### SECTION Short_Description ##### -->
5 a user-interface component that presents data in two-dimensional table format
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 AtkTable describes a user-interface component that presents data in
10 two-dimensional table format.
11 </para>
12
13 <!-- ##### SECTION See_Also ##### -->
14 <para>
15
16 </para>
17
18 <!-- ##### STRUCT AtkTable ##### -->
19 <para>
20
21 </para>
22
23
24 <!-- ##### STRUCT AtkTableIface ##### -->
25 <para>
26
27 </para>
28
29 @parent: 
30 @ref_at: 
31 @get_index_at: 
32 @get_column_at_index: 
33 @get_row_at_index: 
34 @get_n_columns: 
35 @get_n_rows: 
36 @get_column_extent_at: 
37 @get_row_extent_at: 
38 @get_caption: 
39 @get_column_description: 
40 @get_column_header: 
41 @get_row_description: 
42 @get_row_header: 
43 @get_summary: 
44 @set_caption: 
45 @set_column_description: 
46 @set_column_header: 
47 @set_row_description: 
48 @set_row_header: 
49 @set_summary: 
50 @get_selected_columns: 
51 @get_selected_rows: 
52 @is_column_selected: 
53 @is_row_selected: 
54 @is_selected: 
55 @add_row_selection: 
56 @remove_row_selection: 
57 @add_column_selection: 
58 @remove_column_selection: 
59 @row_inserted: 
60 @column_inserted: 
61 @row_deleted: 
62 @column_deleted: 
63 @row_reordered: 
64 @column_reordered: 
65
66 <!-- ##### FUNCTION atk_table_ref_at ##### -->
67 <para>
68
69 </para>
70
71 @table: 
72 @row: 
73 @column: 
74 @Returns: 
75
76
77 <!-- ##### FUNCTION atk_table_get_index_at ##### -->
78 <para>
79
80 </para>
81
82 @table: 
83 @row: 
84 @column: 
85 @Returns: 
86
87
88 <!-- ##### FUNCTION atk_table_get_column_at_index ##### -->
89 <para>
90
91 </para>
92
93 @table: 
94 @index: 
95 @Returns: 
96
97
98 <!-- ##### FUNCTION atk_table_get_row_at_index ##### -->
99 <para>
100
101 </para>
102
103 @table: 
104 @index: 
105 @Returns: 
106
107
108 <!-- ##### FUNCTION atk_table_get_n_columns ##### -->
109 <para>
110
111 </para>
112
113 @table: 
114 @Returns: 
115
116
117 <!-- ##### FUNCTION atk_table_get_n_rows ##### -->
118 <para>
119
120 </para>
121
122 @table: 
123 @Returns: 
124
125
126 <!-- ##### FUNCTION atk_table_get_column_extent_at ##### -->
127 <para>
128
129 </para>
130
131 @table: 
132 @row: 
133 @column: 
134 @Returns: 
135
136
137 <!-- ##### FUNCTION atk_table_get_row_extent_at ##### -->
138 <para>
139
140 </para>
141
142 @table: 
143 @row: 
144 @column: 
145 @Returns: 
146
147
148 <!-- ##### FUNCTION atk_table_get_caption ##### -->
149 <para>
150
151 </para>
152
153 @table: 
154 @Returns: 
155
156
157 <!-- ##### FUNCTION atk_table_get_column_description ##### -->
158 <para>
159
160 </para>
161
162 @table: 
163 @column: 
164 @Returns: 
165
166
167 <!-- ##### FUNCTION atk_table_get_row_description ##### -->
168 <para>
169
170 </para>
171
172 @table: 
173 @r: 
174 @Returns: 
175
176
177 <!-- ##### FUNCTION atk_table_get_column_header ##### -->
178 <para>
179
180 </para>
181
182 @table: 
183 @column: 
184 @Returns: 
185
186
187 <!-- ##### FUNCTION atk_table_get_row_header ##### -->
188 <para>
189
190 </para>
191
192 @table: 
193 @row: 
194 @Returns: 
195
196
197 <!-- ##### FUNCTION atk_table_get_summary ##### -->
198 <para>
199
200 </para>
201
202 @table: 
203 @Returns: 
204
205
206 <!-- ##### FUNCTION atk_table_set_caption ##### -->
207 <para>
208
209 </para>
210
211 @table: 
212 @caption: 
213 <!-- # Unused Parameters # -->
214 @accessible: 
215
216
217 <!-- ##### FUNCTION atk_table_set_row_description ##### -->
218 <para>
219
220 </para>
221
222 @table: 
223 @row: 
224 @description: 
225 <!-- # Unused Parameters # -->
226 @accessible: 
227
228
229 <!-- ##### FUNCTION atk_table_set_column_description ##### -->
230 <para>
231
232 </para>
233
234 @table: 
235 @column: 
236 @description: 
237 <!-- # Unused Parameters # -->
238 @accessible: 
239
240
241 <!-- ##### FUNCTION atk_table_set_row_header ##### -->
242 <para>
243
244 </para>
245
246 @table: 
247 @row: 
248 @header: 
249
250
251 <!-- ##### FUNCTION atk_table_set_column_header ##### -->
252 <para>
253
254 </para>
255
256 @table: 
257 @column: 
258 @header: 
259
260
261 <!-- ##### FUNCTION atk_table_set_summary ##### -->
262 <para>
263
264 </para>
265
266 @table: 
267 @accessible: 
268
269
270 <!-- ##### FUNCTION atk_table_get_selected_columns ##### -->
271 <para>
272
273 </para>
274
275 @table: 
276 @selected: 
277 @Returns: 
278
279
280 <!-- ##### FUNCTION atk_table_get_selected_rows ##### -->
281 <para>
282
283 </para>
284
285 @table: 
286 @selected: 
287 @Returns: 
288
289
290 <!-- ##### FUNCTION atk_table_is_column_selected ##### -->
291 <para>
292
293 </para>
294
295 @table: 
296 @column: 
297 @Returns: 
298
299
300 <!-- ##### FUNCTION atk_table_is_row_selected ##### -->
301 <para>
302
303 </para>
304
305 @table: 
306 @row: 
307 @Returns: 
308
309
310 <!-- ##### FUNCTION atk_table_is_selected ##### -->
311 <para>
312
313 </para>
314
315 @table: 
316 @row: 
317 @column: 
318 @Returns: 
319
320
321 <!-- ##### FUNCTION atk_table_add_column_selection ##### -->
322 <para>
323
324 </para>
325
326 @table: 
327 @column: 
328 @Returns: 
329
330
331 <!-- ##### FUNCTION atk_table_add_row_selection ##### -->
332 <para>
333
334 </para>
335
336 @table: 
337 @row: 
338 @Returns: 
339
340
341 <!-- ##### FUNCTION atk_table_remove_column_selection ##### -->
342 <para>
343
344 </para>
345
346 @table: 
347 @column: 
348 @Returns: 
349
350
351 <!-- ##### FUNCTION atk_table_remove_row_selection ##### -->
352 <para>
353
354 </para>
355
356 @table: 
357 @row: 
358 @Returns: 
359
360