Version 5.2.6.1, tag libreoffice-5.2.6.1
[LibreOffice.git] / offapi / com / sun / star / awt / AccessibleMenuBar.idl
blob5ed8059e3e568cfe5b38130f78061ed80cbf9c0a
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 * This file incorporates work covered by the following license notice:
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
20 #ifndef __com_sun_star_awt_AccessibleMenuBar_idl__
21 #define __com_sun_star_awt_AccessibleMenuBar_idl__
23 #include <com/sun/star/accessibility/XAccessibleContext.idl>
24 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
25 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
26 #include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
27 #include <com/sun/star/accessibility/XAccessibleSelection.idl>
29 module com { module sun { module star { module awt {
31 /** specifies accessibility support for a menu bar.
33 @since OOo 1.1.2
35 service AccessibleMenuBar
37 /** This interface gives access to the structural information of a
38 menu bar:
40 <ul>
41 <li>Role: The role of a menu bar is
42 com::sun::star::accessibility::AccessibleRole::MENU_BAR.</li>
43 <li>Name: There is no name.</li>
44 <li>Description: The description of a menu bar is its localized
45 help text.</li>
46 <li>Children: The children of a menu bar are menus, menu items or
47 menu separators, whose accessible context supports the services
48 AccessibleMenu, AccessibleMenuItem or
49 AccessibleMenuSeparator.</li>
50 <li>Parent: The parent is the window that contains the menu bar.</li>
51 <li>Relations: There are no relations.</li>
52 <li>States: The states supported by this service are
53 <ul>
54 <li>com::sun::star::accessibility::AccessibleStateType::DEFUNC
55 is set if the object has already been disposed
56 and subsequent calls to this object result in
57 com::sun::star::lang::DisposedException
58 exceptions.</li>
59 <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
60 is set if the object is enabled.</li>
61 <li>com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
62 is always set.</li>
63 <li>com::sun::star::accessibility::AccessibleStateType::FOCUSED
64 is set if the object currently has the keyboard focus.</li>
65 <li>com::sun::star::accessibility::AccessibleStateType::OPAQUE
66 is always set.</li>
67 <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
68 is set if the object is displayed on the screen.</li>
69 <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
70 is always set.</li>
71 </ul>
72 </li>
73 </ul>
75 interface ::com::sun::star::accessibility::XAccessibleContext;
77 interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
79 interface ::com::sun::star::accessibility::XAccessibleComponent;
81 interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
83 /** This interface gives access to the selectable children of a
84 menu bar.
86 interface ::com::sun::star::accessibility::XAccessibleSelection;
90 }; }; }; };
92 #endif
94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */