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_AccessibleMenuItem_idl__
25#define __com_sun_star_awt_AccessibleMenuItem_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
49module com { module sun { module star { module awt {
50
51/** specifies accessibility support for a menu item.
52
53    @since OpenOffice 1.1.2
54 */
55published service AccessibleMenuItem
56{
57    /** This interface gives access to the structural information of a
58        menu item:
59
60        <ul>
61        <li>Role: The role of a menu item is <const
62            scope="com::sun::star::accessibility"
63            >AccessibleRole::MENU_ITEM</const>.</li>
64        <li>Name: The name of a menu item is the localized item text.</li>
65        <li>Description: The description of a menu item is its localized
66            help text.</li>
67        <li>Children: There are no children.</li>
68        <li>Parent: The parent of a menu item is a menu bar, a popup menu or
69            a menu, whose accessible context supports the services
70            <type>AccessibleMenuBar</type>, <type>AccessiblePopupMenu</type>
71            or <type>AccessibleMenu</type>.</li>
72        <li>Relations: There are no relations.</li>
73        <li>States: The states supported by this service are
74            <ul>
75            <li><const scope="com::sun::star::accessibility"
76                >AccessibleStateType::ARMED</const> is set
77                if the object is highlighted.</li>
78            <li><const scope="com::sun::star::accessibility"
79                >AccessibleStateType::CHECKED</const> is set
80                if the object is currently checked.</li>
81            <li><const scope="com::sun::star::accessibility"
82                >AccessibleStateType::DEFUNC</const>
83                is set if the object has already been disposed
84                and subsequent calls to this object result in
85                <type scope="com::sun::star::lang">DisposedException</type>
86                exceptions.</li>
87            <li><const scope="com::sun::star::accessibility"
88                >AccessibleStateType::ENABLED</const> is set
89                if the object is enabled.</li>
90            <li><const scope="com::sun::star::accessibility"
91                >AccessibleStateType::OPAQUE</const> is always set.</li>
92            <li><const scope="com::sun::star::accessibility"
93                >AccessibleStateType::SELECTABLE</const> is always set.</li>
94            <li><const scope="com::sun::star::accessibility"
95                >AccessibleStateType::SELECTED</const> is set
96                if the object is selected.</li>
97            <li><const scope="com::sun::star::accessibility"
98                >AccessibleStateType::SHOWING</const> is set
99                if the object is displayed on the screen.</li>
100            <li><const scope="com::sun::star::accessibility"
101                >AccessibleStateType::VISIBLE</const> is always set.</li>
102            </ul>
103            </li>
104        </ul>
105     */
106    interface ::com::sun::star::accessibility::XAccessibleContext;
107
108    interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
109
110    interface ::com::sun::star::accessibility::XAccessibleComponent;
111
112    interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
113
114    /** This interface gives read-only access to the text representation
115        of a menu item.
116     */
117    interface ::com::sun::star::accessibility::XAccessibleText;
118
119    /** This interface gives access to the actions that can be executed for
120        a menu item. The supported actions for a menu item are:
121        <ul>
122        <li>select</li>
123        </ul>
124     */
125    interface ::com::sun::star::accessibility::XAccessibleAction;
126
127    /** This interface gives access to the numerical value of a
128        menu item, which is related to the menu item's
129        <const scope="com::sun::star::accessibility"
130        >AccessibleStateType::SELECTED</const> state.
131     */
132    interface ::com::sun::star::accessibility::XAccessibleValue;
133};
134
135}; }; }; };
136
137#endif
138