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 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.Accessible:
==========================================================================================================================================
|phoenix_title| **wx.Accessible**
==========================================================================================================================================
The :ref:`wx.Accessible` class allows wxWidgets applications, and wxWidgets itself, to return extended information about user interface elements to client applications such as screen readers.
This is the main way in which wxWidgets implements accessibility features.
At present, only Microsoft Active Accessibility is supported by this class.
To use this class, derive from :ref:`wx.Accessible`, implement appropriate functions, and associate an object of the class with a window using :meth:`wx.Window.SetAccessible` .
All functions return an indication of success, failure, or not implemented using values of the AccStatus enum type.
If you return ``ACC_NOT_IMPLEMENTED`` from any function, the system will try to implement the appropriate functionality. However this will not work with all functions.
Most functions work with an object `id`, which can be zero to refer to 'this' UI element, or greater than zero to refer to the nth child element. This allows you to specify elements that don't have a corresponding :ref:`wx.Window` or :ref:`wx.Accessible`; for example, the sash of a splitter window.
For details on the semantics of functions and types, please refer to the Microsoft Active Accessibility 1.2 documentation.
This class is compiled into wxWidgets only if the ``wx.USE_ACCESSIBILITY`` setup symbol is set to 1.
.. availability:: Only available for MSW.
.. seealso:: :ref:`Accessibility Sample <accessibility sample>`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>Accessible</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.Accessible_inheritance.png" alt="Inheritance diagram of Accessible" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Accessible.html" title="wx.Accessible" alt="" coords="5,83,115,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="19,5,100,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.Accessible.__init__` Constructor, taking an optional window.
:meth:`~wx.Accessible.DoDefaultAction` Performs the default action for the object.
:meth:`~wx.Accessible.GetChild` Gets the specified child (starting from 1).
:meth:`~wx.Accessible.GetChildCount` Returns the number of children in `childCount`.
:meth:`~wx.Accessible.GetDefaultAction` Gets the default action for this object (0) or a child (greater than 0).
:meth:`~wx.Accessible.GetDescription` Returns the description for this object or a child.
:meth:`~wx.Accessible.GetFocus` Gets the window with the keyboard focus.
:meth:`~wx.Accessible.GetHelpText` Returns help text for this object or a child, similar to tooltip text.
:meth:`~wx.Accessible.GetKeyboardShortcut` Returns the keyboard shortcut for this object or child.
:meth:`~wx.Accessible.GetLocation` Returns the rectangle for this object (id is 0) or a child element (id is greater than 0).
:meth:`~wx.Accessible.GetName` Gets the name of the specified object.
:meth:`~wx.Accessible.GetParent` Returns the parent of this object, or ``None``.
:meth:`~wx.Accessible.GetRole` Returns a role constant describing this object.
:meth:`~wx.Accessible.GetSelections` Gets a variant representing the selected children of this object.
:meth:`~wx.Accessible.GetState` Returns a state constant.
:meth:`~wx.Accessible.GetValue` Returns a localized string representing the value for the object or child.
:meth:`~wx.Accessible.GetWindow` Returns the window associated with this object.
:meth:`~wx.Accessible.HitTest` Returns a status value and object id to indicate whether the given point was on this or a child object.
:meth:`~wx.Accessible.Navigate` Navigates from `fromId` to `toId` or to `toObject`.
:meth:`~wx.Accessible.NotifyEvent` Allows the application to send an event when something changes in an accessible object.
:meth:`~wx.Accessible.Select` Selects the object or child.
:meth:`~wx.Accessible.SetWindow` Sets the window associated with this object.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.Accessible.Window` See :meth:`~wx.Accessible.GetWindow` and :meth:`~wx.Accessible.SetWindow`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.Accessible(Object)
**Possible constructors**::
Accessible(win=None)
The Accessible class allows wxWidgets applications, and wxWidgets
itself, to return extended information about user interface elements
to client applications such as screen readers.
.. method:: __init__(self, win=None)
Constructor, taking an optional window.
The object can be associated with a window later.
:param `win`:
:type `win`: wx.Window
.. method:: DoDefaultAction(self, childId)
Performs the default action for the object.
`childId` is 0 (the action for this object) or greater than 0 (the action for a child).
:param `childId`:
:type `childId`: int
:rtype: :ref:`wx.AccStatus`
:returns:
``wx.ACC_NOT_SUPPORTED`` if there is no default action for this window (e.g. an edit control).
.. method:: GetChild(self, childId)
Gets the specified child (starting from 1).
If `child` is ``None`` and the return value is ``wx.ACC_OK``, this means that the child is a simple element and not an accessible object.
:param `childId`:
:type `childId`: int
:rtype: `tuple`
:returns:
( :ref:`wx.AccStatus`, `child` )
.. method:: GetChildCount(self)
Returns the number of children in `childCount`.
:rtype: `tuple`
:returns:
( :ref:`wx.AccStatus`, `childCount` )
.. method:: GetDefaultAction(self, childId)
Gets the default action for this object (0) or a child (greater than 0).
Return ``wx.ACC_OK`` even if there is no action. `actionName` is the action, or the empty string if there is no action. The retrieved string describes the action that is performed on an object, not what the object does as a result. For example, a toolbar button that prints a document has a default action of "Press" rather than "Prints
the current document."
:param `childId`:
:type `childId`: int
:rtype: `tuple`
:returns:
( :ref:`wx.AccStatus`, `actionName` )
.. method:: GetDescription(self, childId)
Returns the description for this object or a child.
:param `childId`:
:type `childId`: int
:rtype: `tuple`
:returns:
( :ref:`wx.AccStatus`, `description` )
.. method:: GetFocus(self, childId)
Gets the window with the keyboard focus.
If childId is 0 and child is ``None``, no object in this subhierarchy has the focus. If this object has the focus, child should be 'this'.
:param `childId`:
:type `childId`: int
:rtype: `tuple`
:returns:
( :ref:`wx.AccStatus`, `child` )
.. method:: GetHelpText(self, childId)
Returns help text for this object or a child, similar to tooltip text.
:param `childId`:
:type `childId`: int
:rtype: `tuple`
:returns:
( :ref:`wx.AccStatus`, `helpText` )
.. method:: GetKeyboardShortcut(self, childId)
Returns the keyboard shortcut for this object or child.
Returns e.g. ``ALT+K``.
:param `childId`:
:type `childId`: int
:rtype: `tuple`
:returns:
( :ref:`wx.AccStatus`, `shortcut` )
.. method:: GetLocation(self, elementId)
Returns the rectangle for this object (id is 0) or a child element (id is greater than 0).
`rect` is in screen coordinates.
:param `elementId`:
:type `elementId`: int
:rtype: `tuple`
:returns:
( :ref:`wx.AccStatus`, `rect` )
.. method:: GetName(self, childId)
Gets the name of the specified object.
:param `childId`:
:type `childId`: int
:rtype: `tuple`
:returns:
( :ref:`wx.AccStatus`, `name` )
.. method:: GetParent(self)
Returns the parent of this object, or ``None``.
:rtype: `tuple`
:returns:
( :ref:`wx.AccStatus`, `parent` )
.. method:: GetRole(self, childId)
Returns a role constant describing this object.
See AccRole for a list of these roles.
:param `childId`:
:type `childId`: int
:rtype: `tuple`
:returns:
( :ref:`wx.AccStatus`, `role` )
.. method:: GetSelections(self)
Gets a variant representing the selected children of this object.
Acceptable values are:
- a null variant (IsNull() returns ``True``)
- a list variant (GetType() == "list")
- an integer representing the selected child element, or 0 if this object is selected (GetType() == "long")
- a "voidx" pointer to a :ref:`wx.Accessible` child object
:rtype: `tuple`
:returns:
( :ref:`wx.AccStatus`, `selections` )
.. method:: GetState(self, childId)
Returns a state constant.
See AccStatus for a list of these states.
:param `childId`:
:type `childId`: int
:rtype: `tuple`
:returns:
( :ref:`wx.AccStatus`, `state` )
.. method:: GetValue(self, childId)
Returns a localized string representing the value for the object or child.
:param `childId`:
:type `childId`: int
:rtype: `tuple`
:returns:
( :ref:`wx.AccStatus`, `strValue` )
.. method:: GetWindow(self)
Returns the window associated with this object.
:rtype: :ref:`wx.Window`
.. method:: HitTest(self, pt, childId, childObject)
Returns a status value and object id to indicate whether the given point was on this or a child object.
Can return either a child object, or an integer representing the child element, starting from 1.
`pt` is in screen coordinates.
:param `pt`:
:type `pt`: wx.Point
:param `childId`:
:type `childId`: int
:param `childObject`:
:type `childObject`: Accessible
:rtype: :ref:`wx.AccStatus`
.. method:: Navigate(self, navDir, fromId, toId, toObject)
Navigates from `fromId` to `toId` or to `toObject`.
:param `navDir`:
:type `navDir`: wx.NavDir
:param `fromId`:
:type `fromId`: int
:param `toId`:
:type `toId`: int
:param `toObject`:
:type `toObject`: Accessible
:rtype: :ref:`wx.AccStatus`
.. staticmethod:: NotifyEvent(eventType, window, objectType, objectId)
Allows the application to send an event when something changes in an accessible object.
:param `eventType`:
:type `eventType`: int
:param `window`:
:type `window`: wx.Window
:param `objectType`:
:type `objectType`: wx.AccObject
:param `objectId`:
:type `objectId`: int
.. method:: Select(self, childId, selectFlags)
Selects the object or child.
See AccSelectionFlags for a list of the selection actions.
:param `childId`:
:type `childId`: int
:param `selectFlags`:
:type `selectFlags`: wx.AccSelectionFlags
:rtype: :ref:`wx.AccStatus`
.. method:: SetWindow(self, window)
Sets the window associated with this object.
:param `window`:
:type `window`: wx.Window
.. attribute:: Window
See :meth:`~wx.Accessible.GetWindow` and :meth:`~wx.Accessible.SetWindow`
|