doc/libatspi/tmpl/atspi-table.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 atspi-table
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 An interface used by containers whose data is arranged in a tabular form.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 An interface used by containers whose contained data is arranged
  10 in a tabular (i.e. row-column) form. Tables may resemble
  11 a two-dimensional grid, as in a spreadsheet, or may feature objects
  12 which span multiple rows and/or columns, but whose bounds are
  13 aligned on a row/column matrix. Objects within tables are children
  14 of the table object, and they may be referenced either via a child
  15 index or via a row/column pair. Table 'cells' may implement other
  16 interfaces, such as Text, Action, Image, and Component, and should do
  17 so as appropriate to their onscreen rresentation and/or behavior.
  18 </para>
  19
  20 <!-- ##### SECTION See_Also ##### -->
  21 <para>
  22
  23 </para>
  24
  25 <!-- ##### SECTION Stability_Level ##### -->
  26
  27
  28 <!-- ##### SECTION Image ##### -->
  29
  30
  31 <!-- ##### STRUCT AtspiTable ##### -->
  32 <para>
  33
  34 </para>
  35
  36
  37 <!-- ##### FUNCTION atspi_table_get_caption ##### -->
  38 <para>
  39
  40 </para>
  41
  42 @obj:
  43 @error:
  44 @Returns:
  45
  46
  47 <!-- ##### FUNCTION atspi_table_get_summary ##### -->
  48 <para>
  49
  50 </para>
  51
  52 @obj:
  53 @error:
  54 @Returns:
  55
  56
  57 <!-- ##### FUNCTION atspi_table_get_n_rows ##### -->
  58 <para>
  59
  60 </para>
  61
  62 @obj:
  63 @error:
  64 @Returns:
  65
  66
  67 <!-- ##### FUNCTION atspi_table_get_n_columns ##### -->
  68 <para>
  69
  70 </para>
  71
  72 @obj:
  73 @error:
  74 @Returns:
  75
  76
  77 <!-- ##### FUNCTION atspi_table_get_accessible_at ##### -->
  78 <para>
  79
  80 </para>
  81
  82 @obj:
  83 @row:
  84 @column:
  85 @error:
  86 @Returns:
  87
  88
  89 <!-- ##### FUNCTION atspi_table_get_index_at ##### -->
  90 <para>
  91
  92 </para>
  93
  94 @obj:
  95 @row:
  96 @column:
  97 @error:
  98 @Returns:
  99
 100
 101 <!-- ##### FUNCTION atspi_table_get_row_at_index ##### -->
 102 <para>
 103
 104 </para>
 105
 106 @obj:
 107 @index:
 108 @error:
 109 @Returns:
 110
 111
 112 <!-- ##### FUNCTION atspi_table_get_column_at_index ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @obj:
 118 @index:
 119 @error:
 120 @Returns:
 121
 122
 123 <!-- ##### FUNCTION atspi_table_get_row_description ##### -->
 124 <para>
 125
 126 </para>
 127
 128 @obj:
 129 @row:
 130 @error:
 131 @Returns:
 132
 133
 134 <!-- ##### FUNCTION atspi_table_get_column_description ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @obj:
 140 @column:
 141 @error:
 142 @Returns:
 143
 144
 145 <!-- ##### FUNCTION atspi_table_get_row_extent_at ##### -->
 146 <para>
 147
 148 </para>
 149
 150 @obj:
 151 @row:
 152 @column:
 153 @error:
 154 @Returns:
 155
 156
 157 <!-- ##### FUNCTION atspi_table_get_column_extent_at ##### -->
 158 <para>
 159
 160 </para>
 161
 162 @obj:
 163 @row:
 164 @column:
 165 @error:
 166 @Returns:
 167
 168
 169 <!-- ##### FUNCTION atspi_table_get_row_header ##### -->
 170 <para>
 171
 172 </para>
 173
 174 @obj:
 175 @row:
 176 @error:
 177 @Returns:
 178
 179
 180 <!-- ##### FUNCTION atspi_table_get_column_header ##### -->
 181 <para>
 182
 183 </para>
 184
 185 @obj:
 186 @column:
 187 @error:
 188 @Returns:
 189
 190
 191 <!-- ##### FUNCTION atspi_table_get_n_selected_rows ##### -->
 192 <para>
 193
 194 </para>
 195
 196 @obj:
 197 @error:
 198 @Returns:
 199
 200
 201 <!-- ##### FUNCTION atspi_table_get_selected_rows ##### -->
 202 <para>
 203
 204 </para>
 205
 206 @obj:
 207 @error:
 208 @Returns:
 209
 210
 211 <!-- ##### FUNCTION atspi_table_get_selected_columns ##### -->
 212 <para>
 213
 214 </para>
 215
 216 @obj:
 217 @error:
 218 @Returns:
 219
 220
 221 <!-- ##### FUNCTION atspi_table_get_n_selected_columns ##### -->
 222 <para>
 223
 224 </para>
 225
 226 @obj:
 227 @error:
 228 @Returns:
 229
 230
 231 <!-- ##### FUNCTION atspi_table_is_row_selected ##### -->
 232 <para>
 233
 234 </para>
 235
 236 @obj:
 237 @row:
 238 @error:
 239 @Returns:
 240
 241
 242 <!-- ##### FUNCTION atspi_table_is_column_selected ##### -->
 243 <para>
 244
 245 </para>
 246
 247 @obj:
 248 @column:
 249 @error:
 250 @Returns:
 251
 252
 253 <!-- ##### FUNCTION atspi_table_add_row_selection ##### -->
 254 <para>
 255
 256 </para>
 257
 258 @obj:
 259 @row:
 260 @error:
 261 @Returns:
 262
 263
 264 <!-- ##### FUNCTION atspi_table_add_column_selection ##### -->
 265 <para>
 266
 267 </para>
 268
 269 @obj:
 270 @column:
 271 @error:
 272 @Returns:
 273
 274
 275 <!-- ##### FUNCTION atspi_table_remove_row_selection ##### -->
 276 <para>
 277
 278 </para>
 279
 280 @obj:
 281 @row:
 282 @error:
 283 @Returns:
 284
 285
 286 <!-- ##### FUNCTION atspi_table_remove_column_selection ##### -->
 287 <para>
 288
 289 </para>
 290
 291 @obj:
 292 @column:
 293 @error:
 294 @Returns:
 295
 296
 297 <!-- ##### FUNCTION atspi_table_get_row_column_extents_at_index ##### -->
 298 <para>
 299
 300 </para>
 301
 302 @obj:
 303 @index:
 304 @row:
 305 @col:
 306 @row_extents:
 307 @col_extents:
 308 @is_selected:
 309 @error:
 310 @Returns:
 311
 312
 313 <!-- ##### FUNCTION atspi_table_is_selected ##### -->
 314 <para>
 315
 316 </para>
 317
 318 @obj:
 319 @row:
 320 @column:
 321 @error:
 322 @Returns:
 323
 324