1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
|
<?xml version="1.0" encoding="UTF-8"?>
<node xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<!--
org.a11y.atspi.Table:
@short_description: An interface used by containers whose data is
arranged in a tabular form.
-->
<interface name="org.a11y.atspi.Table">
<!--
Version: The version of this interface.
This property is incremented by one every time a new method, signal, or property
is added to this interface.
-->
<property name="version" type="u" access="read"/>
<!--
NRows: the number of rows in a table, exclusive of any rows that are
programmatically hidden, but inclusive of rows that may be outside
of the current scrolling window or viewport.
-->
<property name="NRows" type="i" access="read"/>
<!--
NColumn: the number of columns in a table, exclusive of any columns
that are programmatically hidden, but inclusive of columns that may
be outside of the current scrolling window or viewport.
-->
<property name="NColumns" type="i" access="read"/>
<!--
Caption: an accessible representation of the caption for a table.
Returns: An object reference (bus name + object path) for the
accessible representing the caption.
-->
<property name="Caption" type="(so)" access="read">
<annotation name="org.qtproject.QtDBus.QtTypeName" value="QSpiObjectReference"/>
</property>
<!--
Summary: an accessible object which summarizes the contents of a
table.
Returns: An object reference (bus name + object path) for the
accessible representing the table's summary (often a reduced table).
-->
<property name="Summary" type="(so)" access="read">
<annotation name="org.qtproject.QtDBus.QtTypeName" value="QSpiObjectReference"/>
</property>
<!--
NSelectedRows: the number of rows that are currently selected.
Not all tables support row selection.
-->
<property name="NSelectedRows" type="i" access="read"/>
<!--
NSelectedColumns: the number of columns that are currently selected.
Not all tables support column selection.
-->
<property name="NSelectedColumns" type="i" access="read"/>
<!--
GetAccessibleAt:
@row: the specified table row, zero-indexed.
@column: the specified table column, zero-indexed.
Gets the table cell at the specified row and column indices.
To get the accessible object at a particular (x, y) screen
coordinate, use org.a11y.Atspi.Component.GetAccessibleAtPoint.
Returns: a refernce (bus name + object path) to the accessible
object at the specified table cell. If there is no object at the
specified row/column, then the special object path
"/org/a11y/atspi/null" will be returned.
-->
<method name="GetAccessibleAt">
<arg direction="in" name="row" type="i"/>
<arg direction="in" name="column" type="i"/>
<arg direction="out" type="(so)"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QSpiObjectReference"/>
</method>
<!--
GetIndexAt:
@row: the specified table row, zero-indexed.
@column: the specified table column, zero-indexed.
Gets the 1-D child index corresponding to the specified 2-D row and
column indices. To get the accessible object at a particular (x, y)
screen coordinate, use org.a11y.Atspi.Component.GetAccessibleAtPoint.
Returns: an integer which serves as the index of a specified cell in
the table, in a form usable by org.a11y.Atspi.GetChildAtInde.
-->
<method name="GetIndexAt">
<arg direction="in" name="row" type="i"/>
<arg direction="in" name="column" type="i"/>
<arg direction="out" type="i"/>
</method>
<!--
GetRowAtIndex:
@index: the specified child index, zero-indexed.
Gets the table row index occupied by the child at a particular 1-D
child index.
Returns: an integer indicating the first row spanned by the child of a
table, at the specified 1-D (zero-offset) @index.
-->
<method name="GetRowAtIndex">
<arg direction="in" name="index" type="i"/>
<arg direction="out" type="i"/>
</method>
<!--
GetColumnAtIndex:
@index: the specified child index, zero-indexed.
Gets the table column index occupied by the child at a particular 1-D
child index.
Returns: an integer indicating the first column spanned by the child
of a table, at the specified 1-D (zero-offset) @index.
-->
<method name="GetColumnAtIndex">
<arg direction="in" name="index" type="i"/>
<arg direction="out" type="i"/>
</method>
<!--
GetRowDescription:
@row: the specified table row, zero-indexed.
Gets a text description of a particular table row. This differs from
GetRowHeader, which returns an accessible object.
Returns: a UTF-8 string describing the specified table row, if
available.
-->
<method name="GetRowDescription">
<arg direction="in" name="row" type="i"/>
<arg direction="out" type="s"/>
</method>
<!--
GetColumnDescription:
@column: the specified table column, zero-indexed.
Gets a text description of a particular table column. This differs
from GetColumnHeader, which returns an accessible object.
Returns: a UTF-8 string describing the specified table column, if
available.
-->
<method name="GetColumnDescription">
<arg direction="in" name="column" type="i"/>
<arg direction="out" type="s"/>
</method>
<!--
GetRowExtentAt:
@row: the specified table row, zero-indexed.
@column: the specified table column, zero-indexed.
Gets the number of rows spanned by the table cell at the specific row
and column. (some tables can have cells which span multiple rows
and/or columns).
The returned values are meaningful only if the Table has both
STATE_VISIBLE and STATE_SHOWING.
Returns: an integer indicating the number of rows spanned by the specified cell.
-->
<method name="GetRowExtentAt">
<arg direction="in" name="row" type="i"/>
<arg direction="in" name="column" type="i"/>
<arg direction="out" type="i"/>
</method>
<!--
GetColumnExtentAt:
@row: the specified table row, zero-indexed.
@column: the specified table column, zero-indexed.
Gets the number of columns spanned by the table cell at the specific
row and column (some tables can have cells which span multiple
rows and/or columns).
The returned values are meaningful only if the Table has both
STATE_VISIBLE and STATE_SHOWING.
Returns: an integer indicating the number of columns spanned by the specified cell.
-->
<method name="GetColumnExtentAt">
<arg direction="in" name="row" type="i"/>
<arg direction="in" name="column" type="i"/>
<arg direction="out" type="i"/>
</method>
<!--
GetRowHeader:
@row: the specified table row, zero-indexed.
Gets the header associated with a table row, if available. This
differs from GetRowDescription, which returns a string.
Returns: An accessible reference (bus name + object path)
representing the specified table row, if available.
-->
<method name="GetRowHeader">
<arg direction="in" name="row" type="i"/>
<arg direction="out" type="(so)"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QSpiObjectReference"/>
</method>
<!--
GetColumnHeader:
@column: the specified table column, zero-indexed.
Gets the header associated with a table column, if available. This
differs from GetColumnDescription, which returns a string.
Returns: An accessible reference (bus name + object path)
representing the specified table column, if available.
-->
<method name="GetColumnHeader">
<arg direction="in" name="column" type="i"/>
<arg direction="out" type="(so)"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QSpiObjectReference"/>
</method>
<!--
GetSelectedRows:
Queries a table for a list of indices of rows which are currently
selected.
Returns: an array of integer values, specifying which rows are
currently selected.
-->
<method name="GetSelectedRows">
<arg direction="out" type="ai"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QSpiIntList"/>
</method>
<!--
GetSelectedColumns:
Queries a table for a list of indices of columns which are currently
selected.
Returns: an array of integer values, specifying which columns are
currently selected.
-->
<method name="GetSelectedColumns">
<arg direction="out" type="ai"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QSpiIntList"/>
</method>
<!--
IsRowSelected:
@row: the zero-indexed row number of the row being queried.
Determines whether a table row is selected. Not all tables support
row selection.
Returns: true if the specified row is currently selected, false
if not.
-->
<method name="IsRowSelected">
<arg direction="in" name="row" type="i"/>
<arg direction="out" type="b"/>
</method>
<!--
IsColumnSelected:
@column: the zero-indexed column number of the column being queried.
Determines whether a table column is selected. Not all tables
support row selection.
Returns: true if the specified column is currently selected, false
if not.
-->
<method name="IsColumnSelected">
<arg direction="in" name="column" type="i"/>
<arg direction="out" type="b"/>
</method>
<!--
IsSelected:
@row: the zero-indexed row of the cell being queried.
@column: the zero-indexed column of the cell being queried.
Determines whether the cell at a specific row and column is selected.
Returns: true if the specified cell is currently selected, false
if not.
-->
<method name="IsSelected">
<arg direction="in" name="row" type="i"/>
<arg direction="in" name="column" type="i"/>
<arg direction="out" type="b"/>
</method>
<!--
AddRowSelection:
@row: the zero-indexed row number of the row being selected.
Selects the specified row, adding it to the current row selection.
Not all tables support row selection.
Returns: true if the specified row was successfully selected,
false if not.
-->
<method name="AddRowSelection">
<arg direction="in" name="row" type="i"/>
<arg direction="out" type="b"/>
</method>
<!--
AddColumnSelection:
@column: the zero-indexed column number of the column being selected.
Selects the specified column, adding it to the current column
selection. Not all tables support column selection.
Returns: true if the specified column was successfully selected,
false if not.
-->
<method name="AddColumnSelection">
<arg direction="in" name="column" type="i"/>
<arg direction="out" type="b"/>
</method>
<!--
RemoveRowSelection:
@row: the zero-indexed number of the row being de-selected.
De-selects the specified row, removing it from the current row
selection. Not all tables support row selection.
Returns: true if the specified row was successfully de-selected,
false if not.
-->
<method name="RemoveRowSelection">
<arg direction="in" name="row" type="i"/>
<arg direction="out" type="b"/>
</method>
<!--
RemoveColumnSelection:
@column: the zero-indexed number of the column being de-selected.
De-selects the specified column, removing it from the current column
selection. Not all tables support column selection.
Returns: true if the specified column was successfully de-selected,
false if not.
-->
<method name="RemoveColumnSelection">
<arg direction="in" name="column" type="i"/>
<arg direction="out" type="b"/>
</method>
<!--
GetRowColumnExtentsAtIndex:
@index: the index of the Table child whose row/column extents are
requested.
@row: (out): back-filled with the first table row associated with
the cell with child index.
@col: (out): back-filled with the first table column associated
with the cell with child index.
@rowExtents: (out): back-filled with the number of table rows
across which child i extends.
@colExtents: (out): back-filled with the number of table columns
across which child i extends.
@isSelected: (out): a boolean which is back-filled with true
if the child at index i corresponds to a selected table cell,
false otherwise.
Given a child index, determines the row and column indices and
extents, and whether the cell is currently selected. If
the child at index is not a cell (for instance, if it is
a summary, caption, etc.), false is returned.
The returned values are meaningful only if the Table has both
STATE_VISIBLE and STATE_SHOWING.
Example:
If the Table child at index '6' extends across columns 5 and 6 of
row 2 of a Table and is currently selected, then
GetRowColumnExtentsAtIndex(6)
will return true, and after the call
row, col, row_extents, col_extents,
and isSelected will contain 2, 5, 1, 2, and
true, respectively.
Returns: true if the index is associated with a valid table cell,
false if the index does not correspond to a cell. If
false is returned, the values of the out parameters are
undefined.
-->
<method name="GetRowColumnExtentsAtIndex">
<arg direction="in" name="index" type="i"/>
<arg direction="out" type="b"/>
<arg direction="out" name="row" type="i"/>
<arg direction="out" name="col" type="i"/>
<arg direction="out" name="row_extents" type="i"/>
<arg direction="out" name="col_extents" type="i"/>
<arg direction="out" name="is_selected" type="b"/>
</method>
</interface>
</node>
|