controlTypes.py 27.1 KB
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
#controlTypes.py
#A part of NonVisual Desktop Access (NVDA)
#This file is covered by the GNU General Public License.
#See the file COPYING for more details.
#Copyright (C) 2007-2014 NV Access Limited

ROLE_UNKNOWN=0
ROLE_WINDOW=1
ROLE_TITLEBAR=2
ROLE_PANE=3
ROLE_DIALOG=4
ROLE_CHECKBOX=5
ROLE_RADIOBUTTON=6
ROLE_STATICTEXT=7
ROLE_EDITABLETEXT=8
ROLE_BUTTON=9
ROLE_MENUBAR=10
ROLE_MENUITEM=11
ROLE_POPUPMENU=12
ROLE_COMBOBOX=13
ROLE_LIST=14
ROLE_LISTITEM=15
ROLE_GRAPHIC=16
ROLE_HELPBALLOON=17
ROLE_TOOLTIP=18
ROLE_LINK=19
ROLE_TREEVIEW=20
ROLE_TREEVIEWITEM=21
ROLE_TAB=22
ROLE_TABCONTROL=23
ROLE_SLIDER=24
ROLE_PROGRESSBAR=25
ROLE_SCROLLBAR=26
ROLE_STATUSBAR=27
ROLE_TABLE=28
ROLE_TABLECELL=29
ROLE_TABLECOLUMN=30
ROLE_TABLEROW=31
ROLE_TABLECOLUMNHEADER=32
ROLE_TABLEROWHEADER=33
ROLE_FRAME=34
ROLE_TOOLBAR=35
ROLE_DROPDOWNBUTTON=36
ROLE_CLOCK=37
ROLE_SEPARATOR=38
ROLE_FORM=39
ROLE_HEADING=40
ROLE_HEADING1=41
ROLE_HEADING2=42
ROLE_HEADING3=43
ROLE_HEADING4=44
ROLE_HEADING5=45
ROLE_HEADING6=46
ROLE_PARAGRAPH=47
ROLE_BLOCKQUOTE=48
ROLE_TABLEHEADER=49
ROLE_TABLEBODY=50
ROLE_TABLEFOOTER=51
ROLE_DOCUMENT=52
ROLE_ANIMATION=53
ROLE_APPLICATION=54
ROLE_BOX=55
ROLE_GROUPING=56
ROLE_PROPERTYPAGE=57
ROLE_CANVAS=58
ROLE_CAPTION=59
ROLE_CHECKMENUITEM=60
ROLE_DATEEDITOR=61
ROLE_ICON=62
ROLE_DIRECTORYPANE=63
ROLE_EMBEDDEDOBJECT=64
ROLE_ENDNOTE=65
ROLE_FOOTER=66
ROLE_FOOTNOTE=67
ROLE_GLASSPANE=69
ROLE_HEADER=70
ROLE_IMAGEMAP=71
ROLE_INPUTWINDOW=72
ROLE_LABEL=73
ROLE_NOTE=74
ROLE_PAGE=75
ROLE_RADIOMENUITEM=76
ROLE_LAYEREDPANE=77
ROLE_REDUNDANTOBJECT=78
ROLE_ROOTPANE=79
ROLE_EDITBAR=80
ROLE_TERMINAL=82
ROLE_RICHEDIT=83
ROLE_RULER=84
ROLE_SCROLLPANE=85
ROLE_SECTION=86
ROLE_SHAPE=87
ROLE_SPLITPANE=88
ROLE_VIEWPORT=89
ROLE_TEAROFFMENU=90
ROLE_TEXTFRAME=91
ROLE_TOGGLEBUTTON=92
ROLE_BORDER=93
ROLE_CARET=94
ROLE_CHARACTER=95
ROLE_CHART=96
ROLE_CURSOR=97
ROLE_DIAGRAM=98
ROLE_DIAL=99
ROLE_DROPLIST=100
ROLE_SPLITBUTTON=101
ROLE_MENUBUTTON=102
ROLE_DROPDOWNBUTTONGRID=103
ROLE_MATH=104
ROLE_EQUATION=ROLE_MATH # Deprecated; for backwards compatibility.
ROLE_GRIP=105
ROLE_HOTKEYFIELD=106
ROLE_INDICATOR=107
ROLE_SPINBUTTON=108
ROLE_SOUND=109
ROLE_WHITESPACE=110
ROLE_TREEVIEWBUTTON=111
ROLE_IPADDRESS=112
ROLE_DESKTOPICON=113
ROLE_ALERT=114
ROLE_INTERNALFRAME=115
ROLE_DESKTOPPANE=116
ROLE_OPTIONPANE=117
ROLE_COLORCHOOSER=118
ROLE_FILECHOOSER=119
ROLE_FILLER=120
ROLE_MENU=121
ROLE_PANEL=122
ROLE_PASSWORDEDIT=123
ROLE_FONTCHOOSER=124
ROLE_LINE=125
ROLE_FONTNAME=126
ROLE_FONTSIZE=127
ROLE_BOLD=128
ROLE_ITALIC=129
ROLE_UNDERLINE=130
ROLE_FGCOLOR=131
ROLE_BGCOLOR=132
ROLE_SUPERSCRIPT=133
ROLE_SUBSCRIPT=134
ROLE_STYLE=135
ROLE_INDENT=136
ROLE_ALIGNMENT=137
ROLE_ALERT=138
ROLE_DATAGRID=139
ROLE_DATAITEM=140
ROLE_HEADERITEM=141
ROLE_THUMB=142
ROLE_CALENDAR=143

STATE_UNAVAILABLE=0X1
STATE_FOCUSED=0X2
STATE_SELECTED=0X4
STATE_BUSY=0X8
STATE_PRESSED=0X10
STATE_CHECKED=0X20
STATE_HALFCHECKED=0X40
STATE_READONLY=0X80
STATE_EXPANDED=0X100
STATE_COLLAPSED=0X200
STATE_INVISIBLE=0X400
STATE_VISITED=0X800
STATE_LINKED=0X1000
STATE_HASPOPUP=0X2000
STATE_PROTECTED=0X4000
STATE_REQUIRED=0X8000
STATE_DEFUNCT=0X10000
STATE_INVALID_ENTRY=0X20000
STATE_MODAL=0X40000
STATE_AUTOCOMPLETE=0x80000
STATE_MULTILINE=0X100000
STATE_ICONIFIED=0x200000
STATE_OFFSCREEN=0x400000
STATE_SELECTABLE=0x800000
STATE_FOCUSABLE=0x1000000
STATE_CLICKABLE=0x2000000
STATE_EDITABLE=0x4000000
STATE_CHECKABLE=0x8000000
STATE_DRAGGABLE=0x10000000
STATE_DRAGGING=0x20000000
STATE_DROPTARGET=0x40000000
STATE_SORTED=0x80000000
STATE_SORTED_ASCENDING=0x100000000
STATE_SORTED_DESCENDING=0x200000000
STATES_SORTED=frozenset([STATE_SORTED,STATE_SORTED_ASCENDING,STATE_SORTED_DESCENDING])
STATE_HASLONGDESC=0x400000000
STATE_PINNED=0x800000000
STATE_HASFORMULA=0x1000000000 #Mostly for spreadsheets
STATE_HASCOMMENT=0X2000000000
STATE_OBSCURED=0x4000000000
STATE_CROPPED=0x8000000000
STATE_OVERFLOWING=0x10000000000
STATE_UNLOCKED=0x20000000000

roleLabels={
	# Translators: The word for an unknown control type.
	ROLE_UNKNOWN:_("unknown"),
	# Translators: The word for window of a program such as document window.
	ROLE_WINDOW:_("window"),
	# Translators: Used to identify title bar of a program.
	ROLE_TITLEBAR:_("title bar"),
	# Translators: The word used for pane such as desktop pane.
	ROLE_PANE:_("pane"),
	# Translators: The word used to denote a dialog box such as open dialog.
	ROLE_DIALOG:_("dialog"),
	# Translators: The text used to identify check boxes such as select check box.
	ROLE_CHECKBOX:_("check box"),
	# Translators: The text used to identify radio buttons such as yes or no radio button.
	ROLE_RADIOBUTTON:_("radio button"),
	# Translators: The word used to identify a static text such as dialog text.
	ROLE_STATICTEXT:_("text"),
	# Translators: The word used to identify edit fields such as subject edit field.
	ROLE_EDITABLETEXT:_("edit"),
	# Translators: The word used to identify a button such as OK button.
	ROLE_BUTTON:_("button"),
	# Translators: Text used to identify menu bar of a program.
	ROLE_MENUBAR:_("menu bar"),
	# Translators: Used to identify a menu item such as an item in file menu.
	ROLE_MENUITEM:_("menu item"),
	# Translators: The word used for menus such as edit menu.
	ROLE_POPUPMENU:_("menu"),
	# Translators: Used to identify combo boxes such as file type combo box.
	ROLE_COMBOBOX:_("combo box"),
	# Translators: The word used for lists such as folder list.
	ROLE_LIST:_("list"),
	# Translators: Used to identify a list item such as email list items.
	ROLE_LISTITEM:_("list item"),
	# Translators: The word used to identify graphics such as webpage graphics.
	ROLE_GRAPHIC:_("graphic"),
	# Translators: Used to identify help balloon (a circular window with helpful text such as notification text).
	ROLE_HELPBALLOON:_("help balloon"),
	# Translators: Used to identify a tooltip (a small window with additional text about selected item such as file information).
	ROLE_TOOLTIP:_("tool tip"),
	# Translators: Identifies a link in webpage documents.
	ROLE_LINK:_("link"),
	# Translators: Identifies a treeview (a tree-like structure such as treeviews for subfolders).
	ROLE_TREEVIEW:_("tree view"),
	# Translators: Identifies a tree view item.
	ROLE_TREEVIEWITEM:_("tree view item"),
	# Translators: The word presented for tabs in a tab enabled window.
	ROLE_TAB: pgettext("controlType", "tab"),
	# Translators: Identifies a tab control such as webpage tabs in web browsers.
	ROLE_TABCONTROL:_("tab control"),
	# Translators: Identifies a slider such as volume slider.
	ROLE_SLIDER:_("slider"),
	# Translators: Identifies a progress bar such as NvDA update progress.
	ROLE_PROGRESSBAR:_("progress bar"),
	# Translators: Identifies a scroll bar.
	ROLE_SCROLLBAR:_("scroll bar"),
	# Translators: Identifies a status bar (text at the bottom bar of the screen such as cursor position in a document).
	ROLE_STATUSBAR:_("status bar"),
	# Translators: Identifies a table such as ones used in various websites.
	ROLE_TABLE:_("table"),
	# Translators: Identifies a cell in a table.
	ROLE_TABLECELL:_("cell"),
	# Translators: Identifies a column (a group of vertical cells in a table).
	ROLE_TABLECOLUMN:_("column"),
	# Translators: Identifies a row (a group of horizontal cells in a table).
	ROLE_TABLEROW:_("row"),
	# Translators: Identifies a frame (a smaller window in a webpage or a document).
	ROLE_FRAME:_("frame"),
	# Translators: Identifies a tool bar.
	ROLE_TOOLBAR:_("tool bar"),
	# Translators: Identifies a column header in tables and spreadsheets.
	ROLE_TABLECOLUMNHEADER:_("column header"),
	# Translators: Identifies a row header in tables and spreadsheets.
	ROLE_TABLEROWHEADER:_("row header"),
	# Translators: Identifies a drop down button (a button that, when clicked, opens a menu of its own).
	ROLE_DROPDOWNBUTTON:_("drop down button"),
	# Translators: Identifies an element.
	ROLE_CLOCK:_("clock"),
	# Translators: Identifies a separator (a horizontal line drawn on the screen).
	ROLE_SEPARATOR:_("separator"),
	# Translators: Identifies a form (controls such as edit boxes, combo boxes and so on).
	ROLE_FORM:_("form"),
	# Translators: Identifies a heading (a bold text used for identifying a section).
	ROLE_HEADING:_("heading"),
	# Translators: Identifies a heading level.
	ROLE_HEADING1:_("heading 1"),
	# Translators: Identifies a heading level.
	ROLE_HEADING2:_("heading 2"),
	# Translators: Identifies a heading level.
	ROLE_HEADING3:_("heading 3"),
	# Translators: Identifies a heading level.
	ROLE_HEADING4:_("heading 4"),
	# Translators: Identifies a heading level.
	ROLE_HEADING5:_("heading 5"),
	# Translators: Identifies a heading level.
	ROLE_HEADING6:_("heading 6"),
	# Translators: Identifies a paragraph (a group of text surrounded by blank lines).
	ROLE_PARAGRAPH:_("paragraph"),
	# Translators: Presented for a section in a document which is a block quotation;
	# i.e. a long quotation in a separate paragraph distinguished by indentation, etc.
	# See http://en.wikipedia.org/wiki/Block_quotation
	ROLE_BLOCKQUOTE:_("block quote"),
	# Translators: Identifies a table header (a short text at the start of a table which describes what the table is about).
	ROLE_TABLEHEADER:_("table header"),
	# Translators: Identifies a table body (the main body of the table).
	ROLE_TABLEBODY:_("table body"),
	# Translators: Identifies a table footer (text placed at the end of the table).
	ROLE_TABLEFOOTER:_("table footer"),
	# Translators: Identifies a document (for example, a webpage document).
	ROLE_DOCUMENT:_("document"),
	# Translators: Identifies an animation in a document or a webpage.
	ROLE_ANIMATION:_("animation"),
	# Translators: Identifies an application in webpages.
	ROLE_APPLICATION:_("application"),
	# Translators: Identifies a box element.
	ROLE_BOX:_("box"),
	# Translators: Identifies a grouping (a number of related items grouped together, such as related options in dialogs).
	ROLE_GROUPING:_("grouping"),
	# Translators: Identifies a property page such as drive properties dialog.
	ROLE_PROPERTYPAGE:_("property page"),
	# Translators: Identifies a canvas element on webpages (a box with some background color with some text drawn on the box, like a canvas).
	ROLE_CANVAS:_("canvas"),
	# Translators: Identifies a caption (usually a short text identifying a picture or a graphic on websites).
	ROLE_CAPTION:_("caption"),
	# Translators: Identifies a check menu item (a menu item with a checkmark as part of the menu item's name).
	ROLE_CHECKMENUITEM:_("check menu item"),
	# Translators: Identifies a data edit field.
	ROLE_DATEEDITOR:_("date edit"),
	# Translators: Identifies an icon.
	ROLE_ICON:_("icon"),
	# Translators: Identifies a directory pane.
	ROLE_DIRECTORYPANE:_("directory pane"),
	# Translators: Identifies an embedded object such as flash content on webpages.
	ROLE_EMBEDDEDOBJECT:_("embedded object"),
	# Translators: Identifies an end note.
	ROLE_ENDNOTE:_("end note"),
	# Translators: Identifies a footer (usually text).
	ROLE_FOOTER:_("footer"),
	# Translators: Identifies a foot note (text at the end of a passage or used for anotations).
	ROLE_FOOTNOTE:_("foot note"),
	# Translators: Reported for an object which is a glass pane; i.e.
	# a pane that is guaranteed to be on top of all panes beneath it.
	ROLE_GLASSPANE:_("glass pane"),
	# Translators: Identifies a header (usually text at top of documents or on tops of pages).
	ROLE_HEADER:_("header"),
	# Translators: Identifies an image map (a type of graphical link).
	ROLE_IMAGEMAP:_("image map"),
	# Translators: Identifies an input window.
	ROLE_INPUTWINDOW:_("input window"),
	# Translators: Identifies a label.
	ROLE_LABEL:_("label"),
	# Translators: Identifies a note field.
	ROLE_NOTE:_("note"),
	# Translators: Identifies a page.
	ROLE_PAGE:_("page"),
	# Translators: Identifies a radio menu item.
	ROLE_RADIOMENUITEM:_("radio menu item"),
	# Translators: Identifies a layered pane.
	ROLE_LAYEREDPANE:_("layered pane"),
	# Translators: Identifies a redundant object.
	ROLE_REDUNDANTOBJECT:_("redundant object"),
	# Translators: Identifies a root pane.
	ROLE_ROOTPANE:_("root pane"),
	# Translators: May be reported for an editable text object in a toolbar.
	# This is deprecated and is not often (if ever) used.
	ROLE_EDITBAR:_("edit bar"),
	# Translators: Identifies a terminal window such as command prompt.
	ROLE_TERMINAL:_("terminal"),
	# Translators: Identifies a rich edit box (an edit box which allows entering formatting commands in addition to text; encountered on webpages and NvDA log viewer).
	ROLE_RICHEDIT:_("rich edit"),
	# Translators: Identifies a ruler object (commonly seen on some webpages and in some Office programs).
	ROLE_RULER:_("ruler"),
	# Translators: Identifies a scroll pane.
	ROLE_SCROLLPANE:_("scroll pane"),
	# Translators: Identifies a section of text.
	ROLE_SECTION:_("section"),
	# Translators: Identifies a shape.
	ROLE_SHAPE:_("shape"),
	# Translators: Identifies a split pane.
	ROLE_SPLITPANE:_("split pane"),
	# Translators: Reported for a view port; i.e. an object usually used in a scroll pane
	# which represents the portion of the entire data that the user can see.
	# As the user manipulates the scroll bars, the contents of the view port can change.
	ROLE_VIEWPORT:_("view port"),
	# Translators: Reported for an object that forms part of a menu system
	# but which can be undocked from or torn off the menu system
	# to exist as a separate window.
	ROLE_TEAROFFMENU:_("tear off menu"),
	# Translators: Identifies a text frame (a frame window which contains text).
	ROLE_TEXTFRAME:_("text frame"),
	# Translators: Identifies a toggle button (a button used to toggle something).
	ROLE_TOGGLEBUTTON:_("toggle button"),
	ROLE_BORDER:_("border"),
	# Translators: Identifies a caret object.
	ROLE_CARET:_("caret"),
	# Translators: Identifies a character field (should not be confused with edit fields).
	ROLE_CHARACTER:_("character"),
	# Translators: Identifies a chart (commonly seen on some websites and in some Office documents).
	ROLE_CHART:_("chart"),
	# Translators: Identifies a cursor object.
	ROLE_CURSOR:_("cursor"),
	# Translators: Identifies a diagram (seen on some websites and on Office documents).
	ROLE_DIAGRAM:_("diagram"),
	# Translators: Identifies a dial object.
	ROLE_DIAL:_("dial"),
	# Translators: Identifies a drop list.
	ROLE_DROPLIST:_("drop list"),
	# Translators: Identifies a split button (a control which performs different actions when different parts are clicked).
	ROLE_SPLITBUTTON:_("split button"),
	# Translators: Identifies a menu button (a button which opens a menu of items).
	ROLE_MENUBUTTON:_("menu button"),
	# Translators: Reported for a button which expands a grid when it is pressed.
	ROLE_DROPDOWNBUTTONGRID:_("drop down button grid"),
	# Translators: Identifies mathematical content.
	ROLE_MATH:_("math"),
	# Translators: Identifies a grip control.
	ROLE_GRIP:_("grip"),
	# Translators: Identifies a hot key field (a field where one can enter a hot key for something, such as assigning shortcut for icons on the desktop).
	ROLE_HOTKEYFIELD:_("hot key field"),
	# Translators: Identifies an indicator control.
	ROLE_INDICATOR:_("indicator"),
	# Translators: Identifies a spin button (a button used to go through options in a spinning fashion).
	ROLE_SPINBUTTON:_("spin button"),
	# Translators: Identifies a sound clip on websites.
	ROLE_SOUND:_("sound"),
	# Translators: Identifies a whitespace.
	ROLE_WHITESPACE:_("white space"),
	# Translators: Identifies a tree view button.
	ROLE_TREEVIEWBUTTON:_("tree view button"),
	# Translators: Identifies an IP address (an IP address field element).
	ROLE_IPADDRESS:_("IP address"),
	# Translators: Identifies a desktop icon (the icons on the desktop such as computer and various shortcuts for programs).
	ROLE_DESKTOPICON:_("desktop icon"),
	# Translators: Identifies an alert message such as file download alert in Internet explorer 9 and above.
	ROLE_ALERT:_("alert"),
	# Translators: Identifies an internal frame (commonly called iframe; usually seen when browsing some sites with Internet Explorer).
	ROLE_INTERNALFRAME:_("IFrame"),
	# Translators: Identifies desktop pane (the desktop window).
	ROLE_DESKTOPPANE:_("desktop pane"),
	# Translators: Identifies an option pane.
	ROLE_OPTIONPANE:_("option pane"),
	# Translators: Identifies a color chooser.
	ROLE_COLORCHOOSER:_("color chooser"),
	# Translators: Identifies a file chooser (to select a file or groups of files from a list).
	ROLE_FILECHOOSER:_("file chooser"),
	ROLE_FILLER:_("filler"),
	# Translators: Identifies a menu such as file menu.
	ROLE_MENU:_("menu"),
	# Translators: Identifies a panel control for grouping related options.
	ROLE_PANEL:_("panel"),
	# Translators: Identifies a password field (a protected edit field for entering passwords such as when logging into web-based email sites).
	ROLE_PASSWORDEDIT:_("password edit"),
	# Translators: Identifies a font chooser.
	ROLE_FONTCHOOSER:_("font chooser"),
	ROLE_LINE:_("line"),
	# Translators: Identifies a font name.
	ROLE_FONTNAME:_("font name"),
	# Translators: Identifies font size.
	ROLE_FONTSIZE:_("font size"),
	# Translators: Describes text formatting.
	ROLE_BOLD:_("bold"),
	# Translators: Describes text formatting.
	ROLE_ITALIC:_("ITALIC"),
	# Translators: Describes text formatting.
	ROLE_UNDERLINE:_("underline"),
	# Translators: Describes text formatting.
	ROLE_FGCOLOR:_("foreground color"),
	# Translators: Describes text formatting.
	ROLE_BGCOLOR:_("background color"),
	# Translators: Describes text formatting.
	ROLE_SUPERSCRIPT:_("superscript"),
	# Translators: Describes text formatting.
	ROLE_SUBSCRIPT:_("subscript"),
	# Translators: Describes style of text.
	ROLE_STYLE:_("style"),
	# Translators: Describes text formatting.
	ROLE_INDENT:_("indent"),
	# Translators: Describes text formatting.
	ROLE_ALIGNMENT:_("alignment"),
	# Translators: Identifies an alert window or bar (usually on Internet Explorer 9 and above for alerts such as file downloads or pop-up blocker).
	ROLE_ALERT:_("alert"),
	# Translators: Identifies a data grid control (a grid which displays data).
	ROLE_DATAGRID:_("data grid"),
	ROLE_DATAITEM:_("data item"),
	ROLE_HEADERITEM:_("header item"),
	# Translators: Identifies a thumb control (a button-like control for changing options).
	ROLE_THUMB:_("thumb control"),
	ROLE_CALENDAR:_("calendar"),
}

stateLabels={
	# Translators: This is presented when a control or document is unavailable.
	STATE_UNAVAILABLE:_("unavailable"),
	# Translators: This is presented when a control has focus.
	STATE_FOCUSED:_("focused"),
	# Translators: This is presented when the control is selected.
	STATE_SELECTED:_("selected"),
	# Translators: This is presented when a document is busy.
	STATE_BUSY:_("busy"),
	# Translators: This is presented when a button is pressed.
	STATE_PRESSED:_("pressed"),
	# Translators: This is presented when a check box is checked.
	STATE_CHECKED:_("checked"),
	# Translators: This is presented when a three state check box is half checked.
	STATE_HALFCHECKED:_("half checked"),
	# Translators: This is presented when the control is a read-only control such as read-only edit box.
	STATE_READONLY:_("read only"),
	# Translators: This is presented when a tree view or submenu item is expanded.
	STATE_EXPANDED:_("expanded"),
	# Translators: This is presented when a tree view or submenu is collapsed.
	STATE_COLLAPSED:_("collapsed"),
	# Translators: This is presented when a control or a document becomes invisible.
	STATE_INVISIBLE:_("invisible"),
	# Translators: This is presented when a visited link is encountered.
	STATE_VISITED:_("visited"),
	# Translators: This is presented when a link is encountered.
	STATE_LINKED:_("linked"),
	# Translators: This is presented when the control menu item has a submenu.
	STATE_HASPOPUP:_("subMenu"),
	# Translators: This is presented when a protected control or a document is encountered.
	STATE_PROTECTED:_("protected"),
	# Translators: This is presented when a required form field is encountered.
	STATE_REQUIRED:_("required"),
	# Translators: Reported when an object no longer exists in the user interface;
	# i.e. it is dead and is no longer usable.
	STATE_DEFUNCT:_("defunct"),
	# Translators: This is presented when an invalid entry has been made.
	STATE_INVALID_ENTRY:_("invalid entry"),
	STATE_MODAL:_("modal"),
	# Translators: This is presented when a field supports auto completion of entered text such as email address field in Microsoft Outlook.
	STATE_AUTOCOMPLETE:_("has auto complete"),
	# Translators: This is presented when an edit field allows typing multiple lines of text such as comment fields on websites.
	STATE_MULTILINE:_("multi line"),
	STATE_ICONIFIED:_("iconified"),
	# Translators: Presented when the current control is located off screen.
	STATE_OFFSCREEN:_("off screen"),
	# Translators: Presented when the control allows selection such as text fields.
	STATE_SELECTABLE:_("selectable"),
	# Translators: Presented when a control can be moved to using system focus.
	STATE_FOCUSABLE:_("focusable"),
	# Translators: Presented when a control allows clicking via mouse (mostly presented on web controls).
	STATE_CLICKABLE:_("clickable"),
	STATE_EDITABLE:_("editable"),
	STATE_CHECKABLE:_("checkable"),
	STATE_DRAGGABLE:_("draggable"),
	STATE_DRAGGING:_("dragging"),
	# Translators: Reported where an object which is being dragged can be dropped.
	# This is only reported for objects which support accessible drag and drop.
	STATE_DROPTARGET:_("drop target"),
	STATE_SORTED:_("sorted"),
	STATE_SORTED_ASCENDING:_("sorted ascending"),
	STATE_SORTED_DESCENDING:_("sorted descending"),
	# Translators: a state that denotes that an object (usually a graphic) has a long description.
	STATE_HASLONGDESC:_("has long description"),
	# Translators: a state that denotes that an object is pinned in its current location
	STATE_PINNED:_("pinned"),
	# Translators: a state that denotes the existance of a formula on a spreadsheet cell
	STATE_HASFORMULA:_("has formula"),
	# Translators: a state that denotes the existance of a comment.
	STATE_HASCOMMENT:_("has comment"),
	# Translators: a state that denotes that the object is covered partially or fully by another object
	STATE_OBSCURED:_("obscured"),
	# Translators: a state that denotes that the object(text) is cropped as it couldn't be accommodated in the allocated/available space
	STATE_CROPPED:_("cropped"),
	# Translators: a state that denotes that the object(text) is overflowing into the adjacent space
	STATE_OVERFLOWING:_("overflowing"),
	# Translators: a state that denotes that the object is unlocked (such as an unlocked cell in a protected Excel spreadsheet). 
	STATE_UNLOCKED:_("unlocked"),
}

negativeStateLabels={
	# Translators: This is presented when a selectable object (e.g. a list item) is not selected.
	STATE_SELECTED:_("not selected"),
	# Translators: This is presented when a checkbox is not checked.
	STATE_CHECKED:_("not checked"),
}

silentRolesOnFocus={
	ROLE_PANE,
	ROLE_ROOTPANE,
	ROLE_FRAME,
	ROLE_UNKNOWN,
	ROLE_APPLICATION,
	ROLE_TABLECELL,
	ROLE_LISTITEM,
	ROLE_MENUITEM,
	ROLE_CHECKMENUITEM,
	ROLE_TREEVIEWITEM,
	ROLE_STATICTEXT,
	ROLE_BORDER,
}

silentValuesForRoles={
	ROLE_CHECKBOX,
	ROLE_RADIOBUTTON,
	ROLE_LINK,
	ROLE_MENUITEM,
	ROLE_APPLICATION,
}

#{ Output reasons
# These constants are used to specify the reason that a given piece of output was generated.
#: An object to be reported due to a focus change or similar.
REASON_FOCUS="focus"
#: An ancestor of the focus object to be reported due to a focus change or similar.
REASON_FOCUSENTERED="focusEntered"
#: An item under the mouse.
REASON_MOUSE="mouse"
#: A response to a user query.
REASON_QUERY="query"
#: Reporting a change to an object.
REASON_CHANGE="change"
#: A generic, screen reader specific message.
REASON_MESSAGE="message"
#: Text reported as part of a say all.
REASON_SAYALL="sayAll"
#: Content reported due to caret movement or similar.
REASON_CARET="caret"
#: No output, but any state should be cached as if output had occurred.
REASON_ONLYCACHE="onlyCache"
#}

def processPositiveStates(role, states, reason, positiveStates):
	positiveStates = positiveStates.copy()
	# The user never cares about certain states.
	if role==ROLE_EDITABLETEXT:
		positiveStates.discard(STATE_EDITABLE)
	if role!=ROLE_LINK:
		positiveStates.discard(STATE_VISITED)
	positiveStates.discard(STATE_SELECTABLE)
	positiveStates.discard(STATE_FOCUSABLE)
	positiveStates.discard(STATE_CHECKABLE)
	if STATE_DRAGGING in positiveStates:
		# It's obvious that the control is draggable if it's being dragged.
		positiveStates.discard(STATE_DRAGGABLE)
	if role == ROLE_COMBOBOX:
		# Combo boxes inherently have a popup, so don't report it.
		positiveStates.discard(STATE_HASPOPUP)
	import config
	if not config.conf['documentFormatting']['reportClickable'] or role in (ROLE_LINK, ROLE_BUTTON, ROLE_CHECKBOX, ROLE_RADIOBUTTON, ROLE_TOGGLEBUTTON, ROLE_MENUITEM, ROLE_TAB, ROLE_SLIDER, ROLE_DOCUMENT, ROLE_CHECKMENUITEM, ROLE_RADIOMENUITEM):
		# This control is clearly clickable according to its role,
		# or reporting clickable just isn't useful,
		# or the user has explicitly requested no reporting clickable
		positiveStates.discard(STATE_CLICKABLE)
	if reason == REASON_QUERY:
		return positiveStates
	positiveStates.discard(STATE_DEFUNCT)
	positiveStates.discard(STATE_MODAL)
	positiveStates.discard(STATE_FOCUSED)
	positiveStates.discard(STATE_OFFSCREEN)
	positiveStates.discard(STATE_INVISIBLE)
	if reason != REASON_CHANGE:
		positiveStates.discard(STATE_LINKED)
		if role in (ROLE_LISTITEM, ROLE_TREEVIEWITEM, ROLE_MENUITEM, ROLE_TABLEROW) and STATE_SELECTABLE in states:
			positiveStates.discard(STATE_SELECTED)
	if role != ROLE_EDITABLETEXT:
		positiveStates.discard(STATE_READONLY)
	if role == ROLE_CHECKBOX:
		positiveStates.discard(STATE_PRESSED)
	if role == ROLE_MENUITEM:
		# The user doesn't usually care if a menu item is expanded or collapsed.
		positiveStates.discard(STATE_COLLAPSED)
		positiveStates.discard(STATE_EXPANDED)
	if STATE_FOCUSABLE not in states:
		positiveStates.discard(STATE_EDITABLE)
	return positiveStates

def processNegativeStates(role, states, reason, negativeStates):
	speakNegatives = set()
	# Add the negative selected state if the control is selectable,
	# but only if it is either focused or this is something other than a change event.
	# The condition stops "not selected" from being spoken in some broken controls
	# when the state change for the previous focus is issued before the focus change.
	if role in (ROLE_LISTITEM, ROLE_TREEVIEWITEM, ROLE_TABLEROW) and STATE_SELECTABLE in states and (reason != REASON_CHANGE or STATE_FOCUSED in states):
		speakNegatives.add(STATE_SELECTED)
	# Restrict "not checked" in a similar way to "not selected".
	if (role in (ROLE_CHECKBOX, ROLE_RADIOBUTTON, ROLE_CHECKMENUITEM) or STATE_CHECKABLE in states)  and (STATE_HALFCHECKED not in states) and (reason != REASON_CHANGE or STATE_FOCUSED in states):
		speakNegatives.add(STATE_CHECKED)
	if role == ROLE_TOGGLEBUTTON:
		speakNegatives.add(STATE_PRESSED)
	if reason == REASON_CHANGE:
		# We want to speak this state only if it is changing to negative.
		speakNegatives.add(STATE_DROPTARGET)
		# We were given states which have changed to negative.
		# Return only those supplied negative states which should be spoken;
		# i.e. the states in both sets.
		speakNegatives &= negativeStates
		if STATES_SORTED & negativeStates and not STATES_SORTED & states:
			# If the object has just stopped being sorted, just report not sorted.
			# The user doesn't care how it was sorted before.
			speakNegatives.add(STATE_SORTED)
		return speakNegatives
	else:
		# This is not a state change; only positive states were supplied.
		# Return all negative states which should be spoken, excluding the positive states.
		return speakNegatives - states