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