1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_awt_AccessibleMenu_idl__
25#define __com_sun_star_awt_AccessibleMenu_idl__
26
27#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
28#include <com/sun/star/accessibility/XAccessibleContext.idl>
29#endif
30#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
31#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
32#endif
33#ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
34#include <com/sun/star/accessibility/XAccessibleComponent.idl>
35#endif
36#ifndef __com_sun_star_accessibility_XAccessibleExtendedComponent_idl__
37#include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
38#endif
39#ifndef __com_sun_star_accessibility_XAccessibleText_idl__
40#include <com/sun/star/accessibility/XAccessibleText.idl>
41#endif
42#ifndef __com_sun_star_accessibility_XAccessibleAction_idl__
43#include <com/sun/star/accessibility/XAccessibleAction.idl>
44#endif
45#ifndef __com_sun_star_accessibility_XAccessibleValue_idl__
46#include <com/sun/star/accessibility/XAccessibleValue.idl>
47#endif
48#ifndef __com_sun_star_accessibility_XAccessibleSelection_idl__
49#include <com/sun/star/accessibility/XAccessibleSelection.idl>
50#endif
51
52module com { module sun { module star { module awt {
53
54/** specifies accessibility support for a menu.
55
56    @since OpenOffice 1.1.2
57 */
58published service AccessibleMenu
59{
60    /** This interface gives access to the structural information of a menu:
61
62        <ul>
63        <li>Role: The role of a menu is <const
64            scope="com::sun::star::accessibility"
65            >AccessibleRole::MENU</const>.</li>
66        <li>Name: The name of a menu is the localized item text.</li>
67        <li>Description: The description of a menu is its localized
68            help text.</li>
69        <li>Children: The children of a menu are menus, menu items or
70            menu separators, whose accessible context supports the services
71            <type>AccessibleMenu</type>, <type>AccessibleMenuItem</type> or
72            <type>AccessibleMenuSeparator</type>.</li>
73        <li>Parent: The parent of a menu is a menu bar, a popup menu or
74            a menu, whose accessible context supports the services
75            <type>AccessibleMenuBar</type>, <type>AccessiblePopupMenu</type>
76            or <type>AccessibleMenu</type>.</li>
77        <li>Relations: There are no relations.</li>
78        <li>States: The states supported by this service are
79            <ul>
80            <li><const scope="com::sun::star::accessibility"
81                >AccessibleStateType::ARMED</const> is set
82                if the object is highlighted.</li>
83            <li><const scope="com::sun::star::accessibility"
84                >AccessibleStateType::CHECKED</const> is set
85                if the object is currently checked.</li>
86            <li><const scope="com::sun::star::accessibility"
87                >AccessibleStateType::DEFUNC</const>
88                is set if the object has already been disposed
89                and subsequent calls to this object result in
90                <type scope="com::sun::star::lang">DisposedException</type>
91                exceptions.</li>
92            <li><const scope="com::sun::star::accessibility"
93                >AccessibleStateType::ENABLED</const> is set
94                if the object is enabled.</li>
95            <li><const scope="com::sun::star::accessibility"
96                >AccessibleStateType::OPAQUE</const> is always set.</li>
97            <li><const scope="com::sun::star::accessibility"
98                >AccessibleStateType::SELECTABLE</const> is always set.</li>
99            <li><const scope="com::sun::star::accessibility"
100                >AccessibleStateType::SELECTED</const> is set
101                if the object is selected.</li>
102            <li><const scope="com::sun::star::accessibility"
103                >AccessibleStateType::SHOWING</const> is set
104                if the object is displayed on the screen.</li>
105            <li><const scope="com::sun::star::accessibility"
106                >AccessibleStateType::VISIBLE</const> is always set.</li>
107            </ul>
108            </li>
109        </ul>
110     */
111    interface ::com::sun::star::accessibility::XAccessibleContext;
112
113    interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
114
115    interface ::com::sun::star::accessibility::XAccessibleComponent;
116
117    interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
118
119    /** This interface gives read-only access to the text representation
120        of a menu.
121     */
122    interface ::com::sun::star::accessibility::XAccessibleText;
123
124    /** This interface gives access to the actions that can be executed for
125        a menu. The supported actions for a menu are:
126        <ul>
127        <li>select</li>
128        </ul>
129     */
130    interface ::com::sun::star::accessibility::XAccessibleAction;
131
132    /** This interface gives access to the numerical value of a
133        menu, which is related to the menu's
134        <const scope="com::sun::star::accessibility"
135        >AccessibleStateType::SELECTED</const> state.
136     */
137    interface ::com::sun::star::accessibility::XAccessibleValue;
138
139    /** This interface gives access to the selectable children of a
140        menu.
141     */
142    interface ::com::sun::star::accessibility::XAccessibleSelection;
143
144};
145
146}; }; }; };
147
148#endif
149