merge the formfield patch from ooo-build
[ooovba.git] / offapi / com / sun / star / awt / AccessibleTabBarPage.idl
blob05c08712e9dc653208d1070d3fd81c04f26ce8d4
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: AccessibleTabBarPage.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_AccessibleTabBarPage_idl__
32 #define __com_sun_star_awt_AccessibleTabBarPage_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
47 module com { module sun { module star { module awt {
49 /** specifies accessibility support for a tabbar page.
51 @since OOo 1.1.2
52 */
53 published service AccessibleTabBarPage
55 /** This interface gives access to the structural information of a
56 tabbar page:
58 <ul>
59 <li>Role: The role of a tabbar page is <const
60 scope="com::sun::star::accessibility"
61 >AccessibleRole::PAGE_TAB</const>.</li>
62 <li>Name: The name of a tabbar page is the localized
63 tabbar page text.</li>
64 <li>Description: The description of a tabbar page is its localized
65 help text.</li>
66 <li>Children: There are no children.</li>
67 <li>Parent: The parent of a tabbar page is the tabbar page list,
68 whose accessible context supports the service
69 <type>AccessibleTabBarPageList</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 set
81 if the object is enabled.</li>
82 <li><const scope="com::sun::star::accessibility"
83 >AccessibleStateType::SELECTABLE</const> is always set.</li>
84 <li><const scope="com::sun::star::accessibility"
85 >AccessibleStateType::SELECTED</const> is set
86 if the object is selected.</li>
87 <li><const scope="com::sun::star::accessibility"
88 >AccessibleStateType::SHOWING</const> is set
89 if the object is displayed on the screen.</li>
90 <li><const scope="com::sun::star::accessibility"
91 >AccessibleStateType::VISIBLE</const> is always set.</li>
92 </ul>
93 </li>
94 </ul>
96 interface ::com::sun::star::accessibility::XAccessibleContext;
98 interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
100 interface ::com::sun::star::accessibility::XAccessibleComponent;
102 interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
106 }; }; }; };
108 #endif