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