xref: /AOO41X/main/offapi/com/sun/star/awt/AccessibleStatusBarItem.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_awt_AccessibleStatusBarItem_idl__
29#define __com_sun_star_awt_AccessibleStatusBarItem_idl__
30
31#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
32#include <com/sun/star/accessibility/XAccessibleContext.idl>
33#endif
34#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
35#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
36#endif
37#ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
38#include <com/sun/star/accessibility/XAccessibleComponent.idl>
39#endif
40#ifndef __com_sun_star_accessibility_XAccessibleExtendedComponent_idl__
41#include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
42#endif
43#ifndef __com_sun_star_accessibility_XAccessibleText_idl__
44#include <com/sun/star/accessibility/XAccessibleText.idl>
45#endif
46
47module com { module sun { module star { module awt {
48
49/** specifies accessibility support for a status bar item.
50
51    @since OOo 1.1.2
52 */
53published service AccessibleStatusBarItem
54{
55    /** This interface gives access to the structural information of a
56        status bar item:
57
58        <ul>
59        <li>Role: The role of a status bar item is <const
60            scope="com::sun::star::accessibility"
61            >AccessibleRole::LABEL</const>.</li>
62        <li>Name: The name of a status bar item is its localized
63            configuration name.</li>
64        <li>Description: The description of a status bar item is
65            its localized help text.</li>
66        <li>Children: There are no children.</li>
67        <li>Parent: The parent of a status bar item is the status bar,
68            whose accessible context supports the service
69            <type>AccessibleStatusBar</type>.</li>
70        <li>Relations: There are no relations.</li>
71        <li>States: The states supported by this service are
72            <ul>
73            <li><const scope="com::sun::star::accessibility"
74                >AccessibleStateType::DEFUNC</const>
75                is set if the object has already been disposed
76                and subsequent calls to this object result in
77                <type scope="com::sun::star::lang">DisposedException</type>
78                exceptions.</li>
79            <li><const scope="com::sun::star::accessibility"
80                >AccessibleStateType::ENABLED</const> is always set.</li>
81            <li><const scope="com::sun::star::accessibility"
82                >AccessibleStateType::SHOWING</const> is set
83                if the object is displayed on the screen.</li>
84            <li><const scope="com::sun::star::accessibility"
85                >AccessibleStateType::VISIBLE</const> is always set.</li>
86            </ul>
87            </li>
88        </ul>
89     */
90    interface ::com::sun::star::accessibility::XAccessibleContext;
91
92    interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
93
94    interface ::com::sun::star::accessibility::XAccessibleComponent;
95
96    interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
97
98    /** This interface gives read-only access to the text representation
99        of the status bar item.
100     */
101    interface ::com::sun::star::accessibility::XAccessibleText;
102
103};
104
105}; }; }; };
106
107#endif
108