docs/tmpl/atktable.sgml

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