diff options
Diffstat (limited to 'offapi/com/sun/star/awt/AccessibleMenu.idl')
-rw-r--r-- | offapi/com/sun/star/awt/AccessibleMenu.idl | 152 |
1 files changed, 152 insertions, 0 deletions
diff --git a/offapi/com/sun/star/awt/AccessibleMenu.idl b/offapi/com/sun/star/awt/AccessibleMenu.idl new file mode 100644 index 000000000000..440d49543787 --- /dev/null +++ b/offapi/com/sun/star/awt/AccessibleMenu.idl @@ -0,0 +1,152 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_awt_AccessibleMenu_idl__ +#define __com_sun_star_awt_AccessibleMenu_idl__ + +#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__ +#include <com/sun/star/accessibility/XAccessibleContext.idl> +#endif +#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__ +#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl> +#endif +#ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__ +#include <com/sun/star/accessibility/XAccessibleComponent.idl> +#endif +#ifndef __com_sun_star_accessibility_XAccessibleExtendedComponent_idl__ +#include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl> +#endif +#ifndef __com_sun_star_accessibility_XAccessibleText_idl__ +#include <com/sun/star/accessibility/XAccessibleText.idl> +#endif +#ifndef __com_sun_star_accessibility_XAccessibleAction_idl__ +#include <com/sun/star/accessibility/XAccessibleAction.idl> +#endif +#ifndef __com_sun_star_accessibility_XAccessibleValue_idl__ +#include <com/sun/star/accessibility/XAccessibleValue.idl> +#endif +#ifndef __com_sun_star_accessibility_XAccessibleSelection_idl__ +#include <com/sun/star/accessibility/XAccessibleSelection.idl> +#endif + +module com { module sun { module star { module awt { + +/** specifies accessibility support for a menu. + + @since OOo 1.1.2 + */ +published service AccessibleMenu +{ + /** This interface gives access to the structural information of a menu: + + <ul> + <li>Role: The role of a menu is <const + scope="com::sun::star::accessibility" + >AccessibleRole::MENU</const>.</li> + <li>Name: The name of a menu is the localized item text.</li> + <li>Description: The description of a menu is its localized + help text.</li> + <li>Children: The children of a menu are menus, menu items or + menu separators, whose accessible context supports the services + <type>AccessibleMenu</type>, <type>AccessibleMenuItem</type> or + <type>AccessibleMenuSeparator</type>.</li> + <li>Parent: The parent of a menu is a menu bar, a popup menu or + a menu, whose accessible context supports the services + <type>AccessibleMenuBar</type>, <type>AccessiblePopupMenu</type> + or <type>AccessibleMenu</type>.</li> + <li>Relations: There are no relations.</li> + <li>States: The states supported by this service are + <ul> + <li><const scope="com::sun::star::accessibility" + >AccessibleStateType::ARMED</const> is set + if the object is highlighted.</li> + <li><const scope="com::sun::star::accessibility" + >AccessibleStateType::CHECKED</const> is set + if the object is currently checked.</li> + <li><const scope="com::sun::star::accessibility" + >AccessibleStateType::DEFUNC</const> + is set if the object has already been disposed + and subsequent calls to this object result in + <type scope="com::sun::star::lang">DisposedException</type> + exceptions.</li> + <li><const scope="com::sun::star::accessibility" + >AccessibleStateType::ENABLED</const> is set + if the object is enabled.</li> + <li><const scope="com::sun::star::accessibility" + >AccessibleStateType::OPAQUE</const> is always set.</li> + <li><const scope="com::sun::star::accessibility" + >AccessibleStateType::SELECTABLE</const> is always set.</li> + <li><const scope="com::sun::star::accessibility" + >AccessibleStateType::SELECTED</const> is set + if the object is selected.</li> + <li><const scope="com::sun::star::accessibility" + >AccessibleStateType::SHOWING</const> is set + if the object is displayed on the screen.</li> + <li><const scope="com::sun::star::accessibility" + >AccessibleStateType::VISIBLE</const> is always set.</li> + </ul> + </li> + </ul> + */ + interface ::com::sun::star::accessibility::XAccessibleContext; + + interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; + + interface ::com::sun::star::accessibility::XAccessibleComponent; + + interface ::com::sun::star::accessibility::XAccessibleExtendedComponent; + + /** This interface gives read-only access to the text representation + of a menu. + */ + interface ::com::sun::star::accessibility::XAccessibleText; + + /** This interface gives access to the actions that can be executed for + a menu. The supported actions for a menu are: + <ul> + <li>select</li> + </ul> + */ + interface ::com::sun::star::accessibility::XAccessibleAction; + + /** This interface gives access to the numerical value of a + menu, which is related to the menu's + <const scope="com::sun::star::accessibility" + >AccessibleStateType::SELECTED</const> state. + */ + interface ::com::sun::star::accessibility::XAccessibleValue; + + /** This interface gives access to the selectable children of a + menu. + */ + interface ::com::sun::star::accessibility::XAccessibleSelection; + +}; + +}; }; }; }; + +#endif |