offapi/com/sun/star/awt/AccessibleMenu.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: AccessibleMenu.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_awt_AccessibleMenu_idl__
  32 #define __com_sun_star_awt_AccessibleMenu_idl__
  33
  34 #ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
  35 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  36 #endif
  37 #ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
  38 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  39 #endif
  40 #ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
  41 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  42 #endif
  43 #ifndef __com_sun_star_accessibility_XAccessibleExtendedComponent_idl__
  44 #include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
  45 #endif
  46 #ifndef __com_sun_star_accessibility_XAccessibleText_idl__
  47 #include <com/sun/star/accessibility/XAccessibleText.idl>
  48 #endif
  49 #ifndef __com_sun_star_accessibility_XAccessibleAction_idl__
  50 #include <com/sun/star/accessibility/XAccessibleAction.idl>
  51 #endif
  52 #ifndef __com_sun_star_accessibility_XAccessibleValue_idl__
  53 #include <com/sun/star/accessibility/XAccessibleValue.idl>
  54 #endif
  55 #ifndef __com_sun_star_accessibility_XAccessibleSelection_idl__
  56 #include <com/sun/star/accessibility/XAccessibleSelection.idl>
  57 #endif
  58
  59 module com { module sun { module star { module awt {
  60
  61 /** specifies accessibility support for a menu.
  62
  63     @since OOo 1.1.2
  64  */
  65 published service AccessibleMenu
  66 {
  67     /** This interface gives access to the structural information of a menu:
  68
  69         <ul>
  70         <li>Role: The role of a menu is <const
  71             scope="com::sun::star::accessibility"
  72             >AccessibleRole::MENU</const>.</li>
  73         <li>Name: The name of a menu is the localized item text.</li>
  74         <li>Description: The description of a menu is its localized
  75             help text.</li>
  76         <li>Children: The children of a menu are menus, menu items or
  77             menu separators, whose accessible context supports the services
  78             <type>AccessibleMenu</type>, <type>AccessibleMenuItem</type> or
  79             <type>AccessibleMenuSeparator</type>.</li>
  80         <li>Parent: The parent of a menu is a menu bar, a popup menu or
  81             a menu, whose accessible context supports the services
  82             <type>AccessibleMenuBar</type>, <type>AccessiblePopupMenu</type>
  83             or <type>AccessibleMenu</type>.</li>
  84         <li>Relations: There are no relations.</li>
  85         <li>States: The states supported by this service are
  86             <ul>
  87             <li><const scope="com::sun::star::accessibility"
  88                 >AccessibleStateType::ARMED</const> is set
  89                 if the object is highlighted.</li>
  90             <li><const scope="com::sun::star::accessibility"
  91                 >AccessibleStateType::CHECKED</const> is set
  92                 if the object is currently checked.</li>
  93             <li><const scope="com::sun::star::accessibility"
  94                 >AccessibleStateType::DEFUNC</const>
  95                 is set if the object has already been disposed
  96                 and subsequent calls to this object result in
  97                 <type scope="com::sun::star::lang">DisposedException</type>
  98                 exceptions.</li>
  99             <li><const scope="com::sun::star::accessibility"
 100                 >AccessibleStateType::ENABLED</const> is set
 101                 if the object is enabled.</li>
 102             <li><const scope="com::sun::star::accessibility"
 103                 >AccessibleStateType::OPAQUE</const> is always set.</li>
 104             <li><const scope="com::sun::star::accessibility"
 105                 >AccessibleStateType::SELECTABLE</const> is always set.</li>
 106             <li><const scope="com::sun::star::accessibility"
 107                 >AccessibleStateType::SELECTED</const> is set
 108                 if the object is selected.</li>
 109             <li><const scope="com::sun::star::accessibility"
 110                 >AccessibleStateType::SHOWING</const> is set
 111                 if the object is displayed on the screen.</li>
 112             <li><const scope="com::sun::star::accessibility"
 113                 >AccessibleStateType::VISIBLE</const> is always set.</li>
 114             </ul>
 115             </li>
 116         </ul>
 117      */
 118     interface ::com::sun::star::accessibility::XAccessibleContext;
 119
 120     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 121
 122     interface ::com::sun::star::accessibility::XAccessibleComponent;
 123
 124     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
 125
 126     /** This interface gives read-only access to the text representation
 127         of a menu.
 128      */
 129     interface ::com::sun::star::accessibility::XAccessibleText;
 130
 131     /** This interface gives access to the actions that can be executed for
 132         a menu. The supported actions for a menu are:
 133         <ul>
 134         <li>select</li>
 135         </ul>
 136      */
 137     interface ::com::sun::star::accessibility::XAccessibleAction;
 138
 139     /** This interface gives access to the numerical value of a
 140         menu, which is related to the menu's
 141         <const scope="com::sun::star::accessibility"
 142         >AccessibleStateType::SELECTED</const> state.
 143      */
 144     interface ::com::sun::star::accessibility::XAccessibleValue;
 145
 146     /** This interface gives access to the selectable children of a
 147         menu.
 148      */
 149     interface ::com::sun::star::accessibility::XAccessibleSelection;
 150
 151 };
 152
 153 }; }; }; };
 154
 155 #endif