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