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