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