offapi/com/sun/star/accessibility/AccessibleRole.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef __com_sun_star_accessibility_AccessibleRole_idl__
  30 #define __com_sun_star_accessibility_AccessibleRole_idl__
  31
  32 module com { module sun { module star { module accessibility {
  33
  34 /** Collection of roles.
  35
  36     <p>This collection of constants defines the set of possible roles of
  37     classes implementing the <type>XAccessible</type> interface according to
  38     the Java class javax.accessibility.AccessibleRole.  The role of an
  39     object describes its generic function like "button", "menu", or "text".
  40     You can obtain an object's role by calling the
  41     <member>getAccessibleRole</member> method of the
  42     <type>XAccessibleContext</type> interface.</p>
  43
  44     <p>We are using constants instead of a more typesafe enum.  The reason
  45     for this is that IDL enums may not be extended.  Therefore, in order to
  46     include future extensions to the set of roles we have to use constants
  47     here.</p>
  48
  49     <p>For some roles there exist two labels with the same value.  Please
  50     use the one with the underscores.  The other ones are somewhat
  51     deprecated and will be removed in the future. </p>
  52
  53     @see XAccessibleContext
  54
  55     @since OOo 1.1.2
  56 */
  57 published constants AccessibleRole
  58 {
  59
  60     /** Unknown role.
  61
  62         <p>The object contains some Accessible information, but its role is
  63         not known.</p>
  64     */
  65     const short UNKNOWN = 0;
  66
  67     /** Object is used to alert the user about something.
  68     */
  69     const short ALERT = 1;
  70
  71     /** The header for a column of data.
  72     */
  73     const short COLUMN_HEADER = 2;
  74
  75     /** Object that can be drawn into and is used to trap events.
  76
  77         <p>See also <const>FRAME</const>, <const>GLASS_PANE</const>, and
  78         <const>LAYERED_PANE</const>.</p>
  79     */
  80     const short CANVAS = 3;
  81
  82     /** Check box role.
  83
  84         <p>A choice that can be checked or unchecked and provides a separate
  85         indicator for the current state.</p>
  86
  87         <p>See also <const>PUSH_BUTTON</const>, <const>TOGGLE_BUTTON</const>,
  88         and <const>RADIO_BUTTON</const>.</p>
  89     */
  90     const short CHECK_BOX = 4;
  91
  92     /** This role is used for check buttons that are menu items.
  93
  94         @see CHECK_BOX, MENU_ITEM
  95     */
  96     const short CHECK_MENU_ITEM = 5;
  97
  98     /** A specialized dialog that lets the user choose a color.
  99     */
 100     const short COLOR_CHOOSER = 6;
 101
 102     /** Combo box role.
 103
 104         <p>A list of choices the user can select from.  Also optionally
 105         allows the user to enter a choice of their own.</p>
 106     */
 107     const short COMBO_BOX = 7;
 108
 109     /** Date editor role.
 110
 111         <p>A <const>DATE_EDITOR</const> is a component that allows users to
 112         edit java.util.Date and java.util.Time objects.</p>
 113     */
 114     const short DATE_EDITOR = 8;
 115
 116     /** An iconified internal frame in a DESKTOP_PANE.
 117
 118         <p>See also <const>DESKTOP_PANE</const> and
 119         <const>INTERNAL_FRAME</const>.</p>
 120     */
 121     const short DESKTOP_ICON = 9;
 122
 123     /** Desktop pane role.
 124
 125         <p>A pane that supports internal frames and iconified versions of
 126         those internal frames.</p>
 127     */
 128     const short DESKTOP_PANE = 10;
 129
 130     /** Directory pane role.
 131
 132         <p>A pane that allows the user to navigate through and select the
 133         contents of a directory. May be used by a file chooser.</p>
 134
 135         <p>See also <const>FILE_CHOOSER</const>.</p>
 136     */
 137     const short DIRECTORY_PANE = 11;
 138
 139     /** Dialog box role.
 140
 141         <p>A top level window with title bar and a border. A dialog is
 142         similar to a frame, but it has fewer properties and is often used as
 143         a secondary window for an application.</p>
 144
 145         <p>See also <const>FRAME</const> and <const>WINDOW</const>.</p>
 146     */
 147     const short DIALOG = 12;
 148
 149     /** View of a document.
 150
 151         <p>The view of an actual document.  Its content depends on the
 152         document type.</p>
 153     */
 154     const short DOCUMENT = 13;
 155
 156     /** Embedded (OLE) object.
 157     */
 158     const short EMBEDDED_OBJECT = 14;
 159
 160     /** Text that is used as an endnote (footnote at the end of a chapter or
 161         section.
 162     */
 163     const short END_NOTE = 15;
 164
 165     /** File chooser role.
 166
 167         <p>A specialized dialog that displays the files in the directory
 168         and lets the user select a file, browse a different directory, or
 169         specify a filename. May use the directory pane to show the contents
 170         of a directory.</p>
 171
 172         <p>See also <const>DIRECTORY_PANE</const>.</p>
 173     */
 174     const short FILE_CHOOSER = 16;
 175
 176     /** Filler role.
 177
 178         <p>An object that fills up space in a user interface. It is often
 179         used in interfaces to tweak the spacing between components, but
 180         serves no other purpose.</p>
 181     */
 182     const short FILLER = 17;
 183
 184     /** Font chooser role.
 185
 186         <p>A <const>FONT_CHOOSER</const> is a component that lets the user pick various
 187         attributes for fonts.</p>
 188     */
 189     const short FONT_CHOOSER = 18;
 190
 191     /** Footer of a document page.
 192         @see HEADER
 193     */
 194     const short FOOTER = 19;
 195
 196     /** Text that is used as a footnote.
 197     */
 198     const short FOOTNOTE = 20;
 199
 200     /** Frame role.
 201
 202         <p>A top level window with a title bar, border, menu bar, etc.  It
 203         is often used as the primary window for an application.</p>
 204
 205         <p>See also <const>DIALOG</const>, <const>CANVAS</const>, and
 206         <const>WINDOW</const>.</p>
 207     */
 208     const short FRAME = 21;
 209
 210     /** Glass pane role.
 211
 212         <p>A pane that is guaranteed to be painted on top of all panes
 213         beneath it.</p>
 214
 215         <p>See also <const>ROOT_PANE</const> and <const>CANVAS</const>.</p>
 216     */
 217     const short GLASS_PANE = 22;
 218
 219     /** Graphical object.
 220     */
 221     const short GRAPHIC = 23;
 222
 223     /** Group box role.
 224
 225         <p>A <const>GROUP_BOX</const> is a simple container that contains a
 226         border around it and contains components inside it.</p>
 227     */
 228     const short GROUP_BOX = 24;
 229
 230     /** Header of a document page.
 231         @see FOOTER
 232     */
 233     const short HEADER = 25;
 234
 235     /** Chapter or section heading.
 236     */
 237     const short HEADING = 26;
 238
 239     /** A hypertext anchor.
 240     */
 241     const short HYPER_LINK = 27;
 242
 243     /** A small fixed size picture, typically used to decorate components.
 244     */
 245     const short ICON = 28;
 246
 247     /** Internal frame role.
 248
 249         <p>A frame-like object that is clipped by a desktop pane.  The
 250         desktop pane, internal frame, and desktop icon objects are often
 251         used to create multiple document interfaces within an
 252         application.</p>
 253
 254         <p>See also <const>DESKTOP_ICON</const>, <const>DESKTOP_PANE</const>,
 255         and <const>FRAME</const>.</p>
 256     */
 257     const short INTERNAL_FRAME = 29;
 258
 259     /** An object used to present an icon or short string in an interface.
 260     */
 261     const short LABEL = 30;
 262
 263     /** layered pane role.
 264
 265         <p>A specialized pane that allows its children to be drawn in
 266         layers, providing a form of stacking order. This is usually the pane
 267         that holds the menu bar as well as the pane that contains most of
 268         the visual components in a window.</p>
 269
 270         <p>See also <const>GLASS_PANE</const> and
 271         <const>ROOT_PANE</const>.</p>
 272     */
 273     const short LAYERED_PANE = 31;
 274
 275     /** List role.
 276
 277         <p>An object that presents a list of objects to the user and allows
 278         the user to select one or more of them. A list is usually contained
 279         within a scroll pane.</p>
 280
 281         <p>See also <const>SCROLL_PANE</const> and
 282         <const>LIST_ITEM</const>.</p>
 283     */
 284     const short LIST = 32;
 285
 286     /** List item role.
 287
 288         <p>An object that presents an element in a list. A list is usually
 289         contained within a scroll pane.</p>
 290
 291         <p>See also <const>SCROLL_PANE</const> and <const>LIST</const>.</p>
 292     */
 293     const short LIST_ITEM = 33;
 294
 295     /** Menu role.
 296
 297         <p>An object usually found inside a menu bar that contains a list of
 298         actions the user can choose from. A menu can have any object as its
 299         children, but most often they are menu items, other menus, or
 300         rudimentary objects such as radio buttons, check boxes, or
 301         separators. For example, an application may have an "Edit" menu that
 302         contains menu items for "Cut" and "Paste."</p>
 303
 304         <p>See also <const>MENU_BAR</const>, <const>MENU_ITEM</const>,
 305         <const>SEPARATOR</const>, <const>RADIO_BUTTON</const>,
 306         <const>CHECK_BOX</const>, and <const>POPUP_MENU</const>.</p>
 307     */
 308     const short MENU = 34;
 309
 310     /** Menu bar role.
 311
 312         <p>An object usually drawn at the top of the primary dialog box of
 313         an application that contains a list of menus the user can choose
 314         from. For example, a menu bar might contain menus for "File,"
 315         "Edit," and "Help."</p>
 316
 317         <p>See also <const>MENU</const>, <const>POPUP_MENU</const>, and
 318         <const>LAYERED_PANE</const>.</p>
 319     */
 320     const short MENU_BAR = 35;
 321
 322     /** Menu item role.
 323
 324         <p>An object usually contained in a menu that presents an action the
 325         user can choose. For example, the "Cut" menu item in an "Edit" menu
 326         would be an action the user can select to cut the selected area of
 327         text in a document.</p>
 328
 329         <p>See also <const>MENUBAR</const>, <const>SEPARATOR</const>, and
 330         <const>POPUP_MENU</const>.</p>
 331     */
 332     const short MENU_ITEM = 36;
 333
 334     /** A specialized pane whose primary use is inside a <const>DIALOG</const>.
 335
 336         <p>See also <const>DIALOG</const>.</p>
 337     */
 338     const short OPTION_PANE = 37;
 339
 340     /** Page tab role.
 341
 342         <p>An object that is a child of a page tab list. Its sole child is
 343         the panel that is to be presented to the user when the user selects
 344         the page tab from the list of tabs in the page tab list.</p>
 345
 346         <p>See also <const>PAGE_TAB_LIST</const>.</p>
 347     */
 348     const short PAGE_TAB = 38;
 349
 350     /** Page tab list role.
 351
 352         <p>An object that presents a series of panels (or page tabs), one at
 353         a time, through some mechanism provided by the object. The most
 354         common mechanism is a list of tabs at the top of the panel. The
 355         children of a page tab list are all page tabs.</p>
 356
 357         <p>See also <const>PAGE_TAB</const>.</p>
 358     */
 359     const short PAGE_TAB_LIST = 39;
 360
 361     /** A generic container that is often used to group objects.
 362     */
 363     const short PANEL = 40;
 364
 365     /** Paragraph of text.
 366     */
 367     const short PARAGRAPH = 41;
 368
 369     /** Password text role.
 370
 371         <p>A text object used for passwords, or other places where the text
 372         contents is not shown visibly to the user.</p>
 373     */
 374     const short PASSWORD_TEXT = 42;
 375
 376     /** Pop-up menu role.
 377
 378         <p>A temporary window that is usually used to offer the user a list
 379         of choices, and then hides when the user selects one of those
 380         choices.</p>
 381
 382         <p>See also <const>MENU</const> and <const>MENU_ITEM</const>.</p>
 383     */
 384     const short POPUP_MENU = 43;
 385
 386     /** Push button role.
 387
 388         <p>An object the user can manipulate to tell the application to do
 389         something.</p>
 390
 391         <p>See also <const>CHECK_BOX</const>, <const>TOGGLE_BUTTON</const>,
 392         <const>RADIO_BUTTON</const>, <const>BUTTON_MENU</const> and
 393         <const>BUTTON_DROPDOWN</const>.</p>
 394     */
 395     const short PUSH_BUTTON = 44;
 396
 397     /** An object used to indicate how much of a task has been completed.
 398     */
 399     const short PROGRESS_BAR = 45;
 400
 401     /** Radio button role.
 402
 403         <p>A specialized check box that will cause other radio buttons in
 404         the same group to become unchecked when this one is checked.</p>
 405
 406         <p>See also <const>PUSH_BUTTON</const>, <const>TOGGLE_BUTTON</const>,
 407         and <const>CHECK_BOX</const>.</p>
 408     */
 409     const short RADIO_BUTTON = 46;
 410
 411     /** This role is used for radio buttons that are menu items.
 412
 413         @see RADIO_BUTTON, MENU_ITEM
 414     */
 415     const short RADIO_MENU_ITEM = 47;
 416
 417     /** The header for a row of data.
 418     */
 419     const short ROW_HEADER = 48;
 420
 421     /** Root pane role.
 422
 423         <p>A specialized pane that has a glass pane and a layered pane as
 424         its children.</p>
 425
 426         <p>See also <const>GLASS_PANE</const> and <const>LAYERED_PANE</const>.</p>
 427     */
 428     const short ROOT_PANE = 49;
 429
 430     /** Scroll bar role.
 431
 432         <p>An object usually used to allow a user to incrementally view a
 433         large amount of data. Usually used only by a scroll pane.</p>
 434
 435         <p>See also <const>SCROLL_PANE</const>.</p>
 436     */
 437     const short SCROLL_BAR = 50;
 438
 439     /** Scroll pane role.
 440
 441         <p>An object that allows a user to incrementally view a large amount
 442         of information. Its children can include scroll bars and a
 443         viewport.</p>
 444
 445         <p>See also <const>SCROLL_BAR</const> and <const>VIEW_PORT</const>.</p>
 446     */
 447     const short SCROLL_PANE = 51;
 448
 449     /** Object with graphical representation used to represent content on
 450         draw pages.
 451
 452         @see com::sun::star::drawing::AccessibleShape
 453     */
 454     const short SHAPE = 52;
 455
 456     /** Separator role.
 457
 458         <p>An object usually contained in a menu to provide a visual and
 459         logical separation of the contents in a menu. For example, the
 460         "File" menu of an application might contain menu items for "Open,"
 461         "Close," and "Exit," and will place a separator between "Close" and
 462         "Exit" menu items.</p>
 463
 464         <p>See also <const>MENU</const> and <const>MENU_ITEM</const>.</p>
 465     */
 466     const short SEPARATOR = 53;
 467
 468     /** Slider role.
 469
 470         <p>An object that allows the user to select from a bounded
 471         range. For example, a slider might be used to select a number
 472         between 0 and 100.</p>
 473     */
 474     const short SLIDER = 54;
 475
 476     /** Spin box role.
 477
 478         <p>A <const>SPIN_BOX</const> is a simple spinner component and its
 479         main use is for simple numbers.</p>
 480     */
 481     const short SPIN_BOX = 55;
 482
 483     /** Split pane role.
 484
 485         <p>A specialized panel that presents two other panels at the same
 486         time. Between the two panels is a divider the user can manipulate to
 487         make one panel larger and the other panel smaller.</p>
 488     */
 489     const short SPLIT_PANE = 56;
 490
 491     /** Status bar role.
 492
 493         <p>A <const>STATUS_BAR</const> is an simple component that can
 494         contain multiple labels of status information to the user.</p>
 495     */
 496     const short STATUS_BAR = 57;
 497
 498     /** Table component.
 499
 500         <p>An object used to present information in terms of rows and
 501         columns. An example might include a spreadsheet application.</p>
 502     */
 503     const short TABLE = 58;
 504
 505     /** Single cell in a table.
 506     */
 507     const short TABLE_CELL = 59;
 508
 509     /** Text role.
 510
 511         <p>An object that presents text to the user. The text is usually
 512         editable by the user as opposed to a label.</p>
 513
 514         <p>See also <const>LABEL</const>.</p>
 515     */
 516     const short TEXT = 60;
 517
 518     /** Collection of objects that constitute a logical text entity.
 519     */
 520     const short TEXT_FRAME = 61;
 521
 522     /** Toggle button role.
 523
 524         <p>A specialized push button that can be checked or unchecked, but
 525         does not provide a separate indicator for the current state.</p>
 526
 527         <p>See also <const>PUSH_BUTTON</const>, <const>CHECK_BOX</const> and
 528         <const>RADIO_BUTTON</const>.</p>
 529     */
 530     const short TOGGLE_BUTTON = 62;
 531
 532     /** Tool bar role.
 533
 534         <p>A bar or palette usually composed of push buttons or toggle
 535         buttons. It is often used to provide the most frequently used
 536         functions for an application.</p>
 537     */
 538     const short TOOL_BAR = 63;
 539
 540     /** Tool tip role.
 541
 542         <p>An object that provides information about another object. The
 543         accessible Description property of the tool tip is often displayed to
 544         the user in a small "help bubble" when the user causes the mouse to
 545         hover over the object associated with the tool tip.</p>
 546     */
 547     const short TOOL_TIP = 64;
 548
 549     /** Tree role.
 550
 551         <p>An object used to present hierarchical information to the
 552         user. The individual nodes in the tree can be collapsed and expanded
 553         to provide selective disclosure of the tree's contents.</p>
 554     */
 555     const short TREE = 65;
 556
 557     /** Viewport role.
 558
 559         <p>An object usually used in a scroll pane. It represents the
 560         portion of the entire data that the user can see. As the user
 561         manipulates the scroll bars, the contents of the viewport can
 562         change.</p>
 563
 564         <p>See also <const>SCROLL_PANE</const>.</p>
 565     */
 566     const short VIEW_PORT = 66;
 567
 568     /** A top level window with no title or border.
 569
 570         <p>See also <const>FRAME</const> and <const>DIALOG</const>.</p>
 571     */
 572     const short WINDOW = 67;
 573
 574     /** Button dropdown role
 575
 576         <p>The object represents a button that drops down a list of items.</p>
 577
 578         <p>See also <const>PUSH_BUTTON</const> and <const>BUTTON_MENU</const>.</p>
 579
 580         @since OOo 3.0
 581     */
 582     const short BUTTON_DROPDOWN = 68;
 583
 584     /** Button menu role
 585
 586         <p>The object represents a button that drops down a menu.</p>
 587
 588         <p>See also <const>PUSH_BUTTON</const> and <const>BUTTON_DROPDOWN</const>.</p>
 589
 590         @since OOo 3.0
 591     */
 592     const short BUTTON_MENU = 69;
 593
 594     /** Caption role
 595
 596         <p>The object contains descriptive information, usually textual, about
 597         another user interface element such as a table, chart, or image.</p>.
 598
 599         @since OOo 3.0
 600     */
 601     const short CAPTION = 70;
 602
 603     /** Chart role
 604
 605         <p>The object is a graphical depiction of quantitative data. It may contain multiple
 606         subelements whose attributes and/or description may be queried to obtain both
 607         the quantitative data and information about how the data is being presented.</p>
 608
 609         @since OOo 3.0
 610     */
 611     const short CHART = 71;
 612
 613     /** Edit bar role
 614
 615         <p>A role indicating the object acts as a formula for calculating a value.</p>
 616
 617          @since OOo 3.0
 618     */
 619     const short EDIT_BAR = 72;
 620
 621     /** Form role
 622
 623         <p>The object is a container for form controls, for instance as part of a web form
 624         or user-input form within a document.</p>
 625
 626         @since OOo 3.0
 627     */
 628     const short FORM = 73;
 629
 630     /** Image map role
 631
 632     <p>Usually a graphic with multiple hotspots, where each hotspot can be activated
 633         resulting in the loading of another document or section of a document.</p>
 634
 635         @since OOo 3.0
 636     */
 637     const short IMAGE_MAP = 74;
 638
 639     /** Note role
 640
 641         <p>An embedded note which is not visible until activated.</p>
 642
 643         @since OOo 3.0
 644     */
 645     const short NOTE = 75;
 646
 647     /** Page role
 648
 649         <p>An object representing a page of document content. It is used in documents
 650         which are accessed by the user on a page by page basis.</p>
 651
 652         @since OOo 3.0
 653     */
 654     const short PAGE = 76;
 655
 656     /** Ruler role
 657
 658         <p>An object which describes margins and tab stops, etc. for text objects which it controls.</p>
 659
 660         @since OOo 3.0
 661     */
 662     const short RULER = 77;
 663
 664     /** Section role
 665
 666         <p>The object is a containing instance of document content which constitutes a particular
 667         "logical" section of the document.</p>
 668
 669         @since OOo 3.0
 670     */
 671     const short SECTION = 78;
 672
 673     /** Tree item role
 674
 675         <p>An object that presents an element in a tree</p>
 676
 677         </p>See also <const>TREE</const> and <const>TREE_TABLE</const>.</p>
 678
 679         @since OOo 3.0
 680     */
 681     const short TREE_ITEM = 79;
 682
 683     /** Tree table role
 684
 685         <p>An object which represents both hierarchical and tabular information.</p>
 686
 687         @since OOo 3.0
 688     */
 689     const short TREE_TABLE = 80;
 690
 691     /** Comment role
 692
 693         <p>An object which represents a comment.</p>
 694
 695         <p>A comment is anchored at a certain content position in the document and
 696         annotates this document content position or a certain text range of the document content.
 697         In the OpenDocument file format a comment is known as an annotation.</p>
 698
 699         <p>See also <const>COMMENT_END</const>.</p>
 700
 701         @since OOo 3.2
 702     */
 703     const short COMMENT = 81;
 704
 705     /** Comment end role
 706
 707         <p>An invisible object which represents the end position of a text range which
 708         is annotated by a comment - see <const>COMMENT</const>.</p>
 709
 710         <p>This object and the corresponding object representing the comment shall be
 711         in relation of type <const>MEMBER_OF</const>.</p>
 712
 713         @since OOo 3.2
 714     */
 715     const short COMMENT_END = 82;
 716
 717 };
 718
 719 }; }; }; };
 720
 721 #endif
 722
 723 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */