docs/tmpl/atktable.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkTable
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 The ATK interface implemented for UI components which contain tabular or
   6 row/column information.
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9 <para>
  10 #AtkTable should be implemented by components which present elements
  11 ordered via rows and columns.  It may also be used to present
  12 tree-structured information if the nodes of the trees can be said to
  13 contain multiple "columns".  Individual elements of an #AtkTable are
  14 typically referred to as "cells", and these cells are exposed by
  15 #AtkTable as child #AtkObjects of the #AtkTable.  Both row/column and
  16 child-index-based access to these children is provided.
  17 </para>
  18 <para>
  19 Children of #AtkTable are frequently "lightweight" objects, that is,
  20 they may not have backing widgets in the host UI toolkit.  They are
  21 therefore often transient.
  22 </para>
  23 <para>
  24 Since tables are often very complex, #AtkTable includes provision for
  25 offering simplified summary information, as well as row and column
  26 headers and captions.  Headers and captions are #AtkObjects which may
  27 implement other interfaces (#AtkText, #AtkImage, etc.) as appropriate.
  28 #AtkTable summaries may themselves be (simplified) #AtkTables, etc.
  29 </para>
  30
  31 <!-- ##### SECTION See_Also ##### -->
  32 <para>
  33 #AtkObject, #ATK_STATE_TRANSIENT
  34 </para>
  35
  36 <!-- ##### SECTION Stability_Level ##### -->
  37
  38
  39 <!-- ##### SECTION Image ##### -->
  40
  41
  42 <!-- ##### STRUCT AtkTable ##### -->
  43 <para>
  44 The AtkTable structure does not contain any fields.
  45
  46 </para>
  47
  48
  49 <!-- ##### SIGNAL AtkTable::column-deleted ##### -->
  50 <para>
  51 The "column-deleted" signal is emitted by an object which implements the
  52 AtkTable interface when a column is deleted.
  53 </para>
  54
  55 @atktable: the object which received the signal.
  56 @arg1: The index of the first column deleted.
  57 @arg2: The number of columns deleted.
  58
  59 <!-- ##### SIGNAL AtkTable::column-inserted ##### -->
  60 <para>
  61 The "column-inserted" signal is emitted by an object which implements the
  62 AtkTable interface when a column is inserted.
  63
  64 </para>
  65
  66 @atktable: the object which received the signal.
  67 @arg1: The index of the column inserted.
  68 @arg2: The number of colums inserted.
  69
  70 <!-- ##### SIGNAL AtkTable::column-reordered ##### -->
  71 <para>
  72 The "column-reordered" signal is emitted by an object which implements the
  73 AtkTable interface when the columns are reordered.
  74 </para>
  75
  76 @atktable: the object which received the signal.
  77
  78 <!-- ##### SIGNAL AtkTable::model-changed ##### -->
  79 <para>
  80 The "model-changed" signal is emitted by an object which implements the
  81 AtkTable interface when the model displayed by the table changes.
  82 </para>
  83
  84 @atktable: the object which received the signal.
  85
  86 <!-- ##### SIGNAL AtkTable::row-deleted ##### -->
  87 <para>
  88 The "row-deleted" signal is emitted by an object which implements the
  89 AtkTable interface when a column is inserted.
  90
  91 </para>
  92
  93 @atktable: the object which received the signal.
  94 @arg1: The index of the first row deleted.
  95 @arg2: The number of rows deleted.
  96
  97 <!-- ##### SIGNAL AtkTable::row-inserted ##### -->
  98 <para>
  99 The "row-inserted" signal is emitted by an object which implements the
 100 AtkTable interface when a column is inserted.
 101 </para>
 102
 103 @atktable: the object which received the signal.
 104 @arg1: The index of the first row deleted.
 105 @arg2: The number of rows deleted.
 106
 107 <!-- ##### SIGNAL AtkTable::row-reordered ##### -->
 108 <para>
 109 The "row-reordered" signal is emitted by an object which implements the
 110 AtkTable interface when the columns are reordered.
 111 </para>
 112
 113 @atktable: the object which received the signal.
 114
 115 <!-- ##### FUNCTION atk_table_ref_at ##### -->
 116 <para>
 117
 118 </para>
 119
 120 @table:
 121 @row:
 122 @column:
 123 @Returns:
 124
 125
 126 <!-- ##### FUNCTION atk_table_get_index_at ##### -->
 127 <para>
 128
 129 </para>
 130
 131 @table:
 132 @row:
 133 @column:
 134 @Returns:
 135
 136
 137 <!-- ##### FUNCTION atk_table_get_column_at_index ##### -->
 138 <para>
 139
 140 </para>
 141
 142 @table:
 143 @index_:
 144 @Returns:
 145
 146
 147 <!-- ##### FUNCTION atk_table_get_row_at_index ##### -->
 148 <para>
 149
 150 </para>
 151
 152 @table:
 153 @index_:
 154 @Returns:
 155
 156
 157 <!-- ##### FUNCTION atk_table_get_n_columns ##### -->
 158 <para>
 159
 160 </para>
 161
 162 @table:
 163 @Returns:
 164
 165
 166 <!-- ##### FUNCTION atk_table_get_n_rows ##### -->
 167 <para>
 168
 169 </para>
 170
 171 @table:
 172 @Returns:
 173
 174
 175 <!-- ##### FUNCTION atk_table_get_column_extent_at ##### -->
 176 <para>
 177
 178 </para>
 179
 180 @table:
 181 @row:
 182 @column:
 183 @Returns:
 184
 185
 186 <!-- ##### FUNCTION atk_table_get_row_extent_at ##### -->
 187 <para>
 188
 189 </para>
 190
 191 @table:
 192 @row:
 193 @column:
 194 @Returns:
 195
 196
 197 <!-- ##### FUNCTION atk_table_get_caption ##### -->
 198 <para>
 199
 200 </para>
 201
 202 @table:
 203 @Returns:
 204
 205
 206 <!-- ##### FUNCTION atk_table_get_column_description ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @table:
 212 @column:
 213 @Returns:
 214
 215
 216 <!-- ##### FUNCTION atk_table_get_row_description ##### -->
 217 <para>
 218
 219 </para>
 220
 221 @table:
 222 @row:
 223 @Returns:
 224
 225
 226 <!-- ##### FUNCTION atk_table_get_column_header ##### -->
 227 <para>
 228
 229 </para>
 230
 231 @table:
 232 @column:
 233 @Returns:
 234
 235
 236 <!-- ##### FUNCTION atk_table_get_row_header ##### -->
 237 <para>
 238
 239 </para>
 240
 241 @table:
 242 @row:
 243 @Returns:
 244
 245
 246 <!-- ##### FUNCTION atk_table_get_summary ##### -->
 247 <para>
 248
 249 </para>
 250
 251 @table:
 252 @Returns:
 253
 254
 255 <!-- ##### FUNCTION atk_table_set_caption ##### -->
 256 <para>
 257
 258 </para>
 259
 260 @table:
 261 @caption:
 262
 263
 264 <!-- ##### FUNCTION atk_table_set_row_description ##### -->
 265 <para>
 266
 267 </para>
 268
 269 @table:
 270 @row:
 271 @description:
 272
 273
 274 <!-- ##### FUNCTION atk_table_set_column_description ##### -->
 275 <para>
 276
 277 </para>
 278
 279 @table:
 280 @column:
 281 @description:
 282
 283
 284 <!-- ##### FUNCTION atk_table_set_row_header ##### -->
 285 <para>
 286
 287 </para>
 288
 289 @table:
 290 @row:
 291 @header:
 292
 293
 294 <!-- ##### FUNCTION atk_table_set_column_header ##### -->
 295 <para>
 296
 297 </para>
 298
 299 @table:
 300 @column:
 301 @header:
 302
 303
 304 <!-- ##### FUNCTION atk_table_set_summary ##### -->
 305 <para>
 306
 307 </para>
 308
 309 @table:
 310 @accessible:
 311
 312
 313 <!-- ##### FUNCTION atk_table_get_selected_columns ##### -->
 314 <para>
 315
 316 </para>
 317
 318 @table:
 319 @selected:
 320 @Returns:
 321
 322
 323 <!-- ##### FUNCTION atk_table_get_selected_rows ##### -->
 324 <para>
 325
 326 </para>
 327
 328 @table:
 329 @selected:
 330 @Returns:
 331
 332
 333 <!-- ##### FUNCTION atk_table_is_column_selected ##### -->
 334 <para>
 335
 336 </para>
 337
 338 @table:
 339 @column:
 340 @Returns:
 341
 342
 343 <!-- ##### FUNCTION atk_table_is_row_selected ##### -->
 344 <para>
 345
 346 </para>
 347
 348 @table:
 349 @row:
 350 @Returns:
 351
 352
 353 <!-- ##### FUNCTION atk_table_is_selected ##### -->
 354 <para>
 355
 356 </para>
 357
 358 @table:
 359 @row:
 360 @column:
 361 @Returns:
 362
 363
 364 <!-- ##### FUNCTION atk_table_add_column_selection ##### -->
 365 <para>
 366
 367 </para>
 368
 369 @table:
 370 @column:
 371 @Returns:
 372
 373
 374 <!-- ##### FUNCTION atk_table_add_row_selection ##### -->
 375 <para>
 376
 377 </para>
 378
 379 @table:
 380 @row:
 381 @Returns:
 382
 383
 384 <!-- ##### FUNCTION atk_table_remove_column_selection ##### -->
 385 <para>
 386
 387 </para>
 388
 389 @table:
 390 @column:
 391 @Returns:
 392
 393
 394 <!-- ##### FUNCTION atk_table_remove_row_selection ##### -->
 395 <para>
 396
 397 </para>
 398
 399 @table:
 400 @row:
 401 @Returns:
 402
 403