/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* This collection of constants defines the set of possible roles of
classes implementing the We are using constants instead of a more typesafe enum. The reason
for this is that IDL enums may not be extended. Therefore, in order to
include future extensions to the set of roles we have to use constants
here. For some roles there exist two labels with the same value. Please
use the one with the underscores. The other ones are somewhat
deprecated and will be removed in the future. The object contains some Accessible information, but its role is
not known. See also A choice that can be checked or unchecked and provides a separate
indicator for the current state. See also A list of choices the user can select from. Also optionally
allows the user to enter a choice of their own. A See also A pane that supports internal frames and iconified versions of
those internal frames. A pane that allows the user to navigate through and select the
contents of a directory. May be used by a file chooser. See also A top level window with title bar and a border. A dialog is
similar to a frame, but it has fewer properties and is often used as
a secondary window for an application. See also The view of an actual document. Its content depends on the
document type. A specialized dialog that displays the files in the directory
and lets the user select a file, browse a different directory, or
specify a filename. May use the directory pane to show the contents
of a directory. See also An object that fills up space in a user interface. It is often
used in interfaces to tweak the spacing between components, but
serves no other purpose. A A top level window with a title bar, border, menu bar, etc. It
is often used as the primary window for an application. See also A pane that is guaranteed to be painted on top of all panes
beneath it. See also A A frame-like object that is clipped by a desktop pane. The
desktop pane, internal frame, and desktop icon objects are often
used to create multiple document interfaces within an
application. See also A specialized pane that allows its children to be drawn in
layers, providing a form of stacking order. This is usually the pane
that holds the menu bar as well as the pane that contains most of
the visual components in a window. See also An object that presents a list of objects to the user and allows
the user to select one or more of them. A list is usually contained
within a scroll pane. See also An object that presents an element in a list. A list is usually
contained within a scroll pane. See also An object usually found inside a menu bar that contains a list of
actions the user can choose from. A menu can have any object as its
children, but most often they are menu items, other menus, or
rudimentary objects such as radio buttons, check boxes, or
separators. For example, an application may have an "Edit" menu that
contains menu items for "Cut" and "Paste." See also An object usually drawn at the top of the primary dialog box of
an application that contains a list of menus the user can choose
from. For example, a menu bar might contain menus for "File,"
"Edit," and "Help." See also An object usually contained in a menu that presents an action the
user can choose. For example, the "Cut" menu item in an "Edit" menu
would be an action the user can select to cut the selected area of
text in a document. See also See also An object that is a child of a page tab list. Its sole child is
the panel that is to be presented to the user when the user selects
the page tab from the list of tabs in the page tab list. See also An object that presents a series of panels (or page tabs), one at
a time, through some mechanism provided by the object. The most
common mechanism is a list of tabs at the top of the panel. The
children of a page tab list are all page tabs. See also A text object used for passwords, or other places where the text
contents is not shown visibly to the user. A temporary window that is usually used to offer the user a list
of choices, and then hides when the user selects one of those
choices. See also An object the user can manipulate to tell the application to do
something. See also A specialized check box that will cause other radio buttons in
the same group to become unchecked when this one is checked. See also A specialized pane that has a glass pane and a layered pane as
its children. See also An object usually used to allow a user to incrementally view a
large amount of data. Usually used only by a scroll pane. See also An object that allows a user to incrementally view a large amount
of information. Its children can include scroll bars and a
viewport. See also An object usually contained in a menu to provide a visual and
logical separation of the contents in a menu. For example, the
"File" menu of an application might contain menu items for "Open,"
"Close," and "Exit," and will place a separator between "Close" and
"Exit" menu items. See also An object that allows the user to select from a bounded
range. For example, a slider might be used to select a number
between 0 and 100. A A specialized panel that presents two other panels at the same
time. Between the two panels is a divider the user can manipulate to
make one panel larger and the other panel smaller. A An object used to present information in terms of rows and
columns. An example might include a spreadsheet application. An object that presents text to the user. The text is usually
editable by the user as opposed to a label. See also A specialized push button that can be checked or unchecked, but
does not provide a separate indicator for the current state. See also A bar or palette usually composed of push buttons or toggle
buttons. It is often used to provide the most frequently used
functions for an application. An object that provides information about another object. The
accessible Description property of the tool tip is often displayed to
the user in a small "help bubble" when the user causes the mouse to
hover over the object associated with the tool tip. An object used to present hierarchical information to the
user. The individual nodes in the tree can be collapsed and expanded
to provide selective disclosure of the tree's contents. An object usually used in a scroll pane. It represents the
portion of the entire data that the user can see. As the user
manipulates the scroll bars, the contents of the viewport can
change. See also See also The object represents a button that drops down a list of items. See also The object represents a button that drops down a menu. See also The object contains descriptive information, usually textual, about
another user interface element such as a table, chart, or image. The object is a graphical depiction of quantitative data. It may contain multiple
subelements whose attributes and/or description may be queried to obtain both
the quantitative data and information about how the data is being presented. A role indicating the object acts as a formula for calculating a value. The object is a container for form controls, for instance as part of a web form
or user-input form within a document. Usually a graphic with multiple hotspots, where each hotspot can be activated
resulting in the loading of another document or section of a document. An embedded note which is not visible until activated. An object representing a page of document content. It is used in documents
which are accessed by the user on a page by page basis. An object which describes margins and tab stops, etc. for text objects which it controls. The object is a containing instance of document content which constitutes a particular
"logical" section of the document. An object that presents an element in a tree
An object which represents both hierarchical and tabular information.
@since OOo 3.0 */ const short TREE_TABLE = 80; /** Comment roleAn object which represents a comment.
A comment is anchored at a certain content position in the document and annotates this document content position or a certain text range of the document content. In the OpenDocument file format a comment is known as an annotation.
See also
An invisible object which represents the end position of a text range which
is annotated by a comment - see
This object and the corresponding object representing the comment shall be
in relation of type