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 <!-- ##### STRUCT AtkTable ##### -->
  40 <para>
  41 The AtkTable structure does not contain any fields.
  42
  43 </para>
  44
  45
  46 <!-- ##### SIGNAL AtkTable::column-deleted ##### -->
  47 <para>
  48 The "column-deleted" signal is emitted by an object which implements the
  49 AtkTable interface when a column is deleted.
  50 </para>
  51
  52 @atktable: the object which received the signal.
  53 @arg1: The index of the first column deleted.
  54 @arg2: The number of columns deleted.
  55
  56 <!-- ##### SIGNAL AtkTable::column-inserted ##### -->
  57 <para>
  58 The "column-inserted" signal is emitted by an object which implements the
  59 AtkTable interface when a column is inserted.
  60
  61 </para>
  62
  63 @atktable: the object which received the signal.
  64 @arg1: The index of the column inserted.
  65 @arg2: The number of colums inserted.
  66
  67 <!-- ##### SIGNAL AtkTable::column-reordered ##### -->
  68 <para>
  69 The "column-reordered" signal is emitted by an object which implements the
  70 AtkTable interface when the columns are reordered.
  71 </para>
  72
  73 @atktable: the object which received the signal.
  74
  75 <!-- ##### SIGNAL AtkTable::model-changed ##### -->
  76 <para>
  77 The "model-changed" signal is emitted by an object which implements the
  78 AtkTable interface when the model displayed by the table changes.
  79 </para>
  80
  81 @atktable: the object which received the signal.
  82
  83 <!-- ##### SIGNAL AtkTable::row-deleted ##### -->
  84 <para>
  85 The "row-deleted" signal is emitted by an object which implements the
  86 AtkTable interface when a column is inserted.
  87
  88 </para>
  89
  90 @atktable: the object which received the signal.
  91 @arg1: The index of the first row deleted.
  92 @arg2: The number of rows deleted.
  93
  94 <!-- ##### SIGNAL AtkTable::row-inserted ##### -->
  95 <para>
  96 The "row-inserted" signal is emitted by an object which implements the
  97 AtkTable interface when a column is inserted.
  98 </para>
  99
 100 @atktable: the object which received the signal.
 101 @arg1: The index of the first row deleted.
 102 @arg2: The number of rows deleted.
 103
 104 <!-- ##### SIGNAL AtkTable::row-reordered ##### -->
 105 <para>
 106 The "row-reordered" signal is emitted by an object which implements the
 107 AtkTable interface when the columns are reordered.
 108 </para>
 109
 110 @atktable: the object which received the signal.
 111
 112 <!-- ##### FUNCTION atk_table_ref_at ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @table:
 118 @row:
 119 @column:
 120 @Returns:
 121
 122
 123 <!-- ##### FUNCTION atk_table_get_index_at ##### -->
 124 <para>
 125
 126 </para>
 127
 128 @table:
 129 @row:
 130 @column:
 131 @Returns:
 132
 133
 134 <!-- ##### FUNCTION atk_table_get_column_at_index ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @table:
 140 @index_:
 141 @Returns:
 142
 143
 144 <!-- ##### FUNCTION atk_table_get_row_at_index ##### -->
 145 <para>
 146
 147 </para>
 148
 149 @table:
 150 @index_:
 151 @Returns:
 152
 153
 154 <!-- ##### FUNCTION atk_table_get_n_columns ##### -->
 155 <para>
 156
 157 </para>
 158
 159 @table:
 160 @Returns:
 161
 162
 163 <!-- ##### FUNCTION atk_table_get_n_rows ##### -->
 164 <para>
 165
 166 </para>
 167
 168 @table:
 169 @Returns:
 170
 171
 172 <!-- ##### FUNCTION atk_table_get_column_extent_at ##### -->
 173 <para>
 174
 175 </para>
 176
 177 @table:
 178 @row:
 179 @column:
 180 @Returns:
 181
 182
 183 <!-- ##### FUNCTION atk_table_get_row_extent_at ##### -->
 184 <para>
 185
 186 </para>
 187
 188 @table:
 189 @row:
 190 @column:
 191 @Returns:
 192
 193
 194 <!-- ##### FUNCTION atk_table_get_caption ##### -->
 195 <para>
 196
 197 </para>
 198
 199 @table:
 200 @Returns:
 201
 202
 203 <!-- ##### FUNCTION atk_table_get_column_description ##### -->
 204 <para>
 205
 206 </para>
 207
 208 @table:
 209 @column:
 210 @Returns:
 211
 212
 213 <!-- ##### FUNCTION atk_table_get_row_description ##### -->
 214 <para>
 215
 216 </para>
 217
 218 @table:
 219 @row:
 220 @Returns:
 221
 222
 223 <!-- ##### FUNCTION atk_table_get_column_header ##### -->
 224 <para>
 225
 226 </para>
 227
 228 @table:
 229 @column:
 230 @Returns:
 231
 232
 233 <!-- ##### FUNCTION atk_table_get_row_header ##### -->
 234 <para>
 235
 236 </para>
 237
 238 @table:
 239 @row:
 240 @Returns:
 241
 242
 243 <!-- ##### FUNCTION atk_table_get_summary ##### -->
 244 <para>
 245
 246 </para>
 247
 248 @table:
 249 @Returns:
 250
 251
 252 <!-- ##### FUNCTION atk_table_set_caption ##### -->
 253 <para>
 254
 255 </para>
 256
 257 @table:
 258 @caption:
 259
 260
 261 <!-- ##### FUNCTION atk_table_set_row_description ##### -->
 262 <para>
 263
 264 </para>
 265
 266 @table:
 267 @row:
 268 @description:
 269
 270
 271 <!-- ##### FUNCTION atk_table_set_column_description ##### -->
 272 <para>
 273
 274 </para>
 275
 276 @table:
 277 @column:
 278 @description:
 279
 280
 281 <!-- ##### FUNCTION atk_table_set_row_header ##### -->
 282 <para>
 283
 284 </para>
 285
 286 @table:
 287 @row:
 288 @header:
 289
 290
 291 <!-- ##### FUNCTION atk_table_set_column_header ##### -->
 292 <para>
 293
 294 </para>
 295
 296 @table:
 297 @column:
 298 @header:
 299
 300
 301 <!-- ##### FUNCTION atk_table_set_summary ##### -->
 302 <para>
 303
 304 </para>
 305
 306 @table:
 307 @accessible:
 308
 309
 310 <!-- ##### FUNCTION atk_table_get_selected_columns ##### -->
 311 <para>
 312
 313 </para>
 314
 315 @table:
 316 @selected:
 317 @Returns:
 318
 319
 320 <!-- ##### FUNCTION atk_table_get_selected_rows ##### -->
 321 <para>
 322
 323 </para>
 324
 325 @table:
 326 @selected:
 327 @Returns:
 328
 329
 330 <!-- ##### FUNCTION atk_table_is_column_selected ##### -->
 331 <para>
 332
 333 </para>
 334
 335 @table:
 336 @column:
 337 @Returns:
 338
 339
 340 <!-- ##### FUNCTION atk_table_is_row_selected ##### -->
 341 <para>
 342
 343 </para>
 344
 345 @table:
 346 @row:
 347 @Returns:
 348
 349
 350 <!-- ##### FUNCTION atk_table_is_selected ##### -->
 351 <para>
 352
 353 </para>
 354
 355 @table:
 356 @row:
 357 @column:
 358 @Returns:
 359
 360
 361 <!-- ##### FUNCTION atk_table_add_column_selection ##### -->
 362 <para>
 363
 364 </para>
 365
 366 @table:
 367 @column:
 368 @Returns:
 369
 370
 371 <!-- ##### FUNCTION atk_table_add_row_selection ##### -->
 372 <para>
 373
 374 </para>
 375
 376 @table:
 377 @row:
 378 @Returns:
 379
 380
 381 <!-- ##### FUNCTION atk_table_remove_column_selection ##### -->
 382 <para>
 383
 384 </para>
 385
 386 @table:
 387 @column:
 388 @Returns:
 389
 390
 391 <!-- ##### FUNCTION atk_table_remove_row_selection ##### -->
 392 <para>
 393
 394 </para>
 395
 396 @table:
 397 @row:
 398 @Returns:
 399
 400