offapi/com/sun/star/awt/AccessibleMenuBar.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: AccessibleMenuBar.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_AccessibleMenuBar_idl__
  32 #define __com_sun_star_awt_AccessibleMenuBar_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_XAccessibleSelection_idl__
  47 #include <com/sun/star/accessibility/XAccessibleSelection.idl>
  48 #endif
  49
  50 module com { module sun { module star { module awt {
  51
  52 /** specifies accessibility support for a menu bar.
  53
  54     @since OOo 1.1.2
  55  */
  56 published service AccessibleMenuBar
  57 {
  58     /** This interface gives access to the structural information of a
  59         menu bar:
  60
  61         <ul>
  62         <li>Role: The role of a menu bar is <const
  63             scope="com::sun::star::accessibility"
  64             >AccessibleRole::MENU_BAR</const>.</li>
  65         <li>Name: There is no name.</li>
  66         <li>Description: The description of a menu bar is its localized
  67             help text.</li>
  68         <li>Children: The children of a menu bar are menus, menu items or
  69             menu separators, whose accessible context supports the services
  70             <type>AccessibleMenu</type>, <type>AccessibleMenuItem</type> or
  71             <type>AccessibleMenuSeparator</type>.</li>
  72         <li>Parent: The parent is the window that contains the menu bar.</li>
  73         <li>Relations: There are no relations.</li>
  74         <li>States: The states supported by this service are
  75             <ul>
  76             <li><const scope="com::sun::star::accessibility"
  77                 >AccessibleStateType::DEFUNC</const>
  78                 is set if the object has already been disposed
  79                 and subsequent calls to this object result in
  80                 <type scope="com::sun::star::lang">DisposedException</type>
  81                 exceptions.</li>
  82             <li><const scope="com::sun::star::accessibility"
  83                 >AccessibleStateType::ENABLED</const> is set
  84                 if the object is enabled.</li>
  85             <li><const scope="com::sun::star::accessibility"
  86                 >AccessibleStateType::FOCUSABLE</const> is always set.</li>
  87             <li><const scope="com::sun::star::accessibility"
  88                 >AccessibleStateType::FOCUSED</const> is set
  89                 if the object currently has the keyboard focus.</li>
  90             <li><const scope="com::sun::star::accessibility"
  91                 >AccessibleStateType::OPAQUE</const> is always set.</li>
  92             <li><const scope="com::sun::star::accessibility"
  93                 >AccessibleStateType::SHOWING</const> is set
  94                 if the object is displayed on the screen.</li>
  95             <li><const scope="com::sun::star::accessibility"
  96                 >AccessibleStateType::VISIBLE</const> is always set.</li>
  97             </ul>
  98             </li>
  99         </ul>
 100      */
 101     interface ::com::sun::star::accessibility::XAccessibleContext;
 102
 103     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 104
 105     interface ::com::sun::star::accessibility::XAccessibleComponent;
 106
 107     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
 108
 109     /** This interface gives access to the selectable children of a
 110         menu bar.
 111      */
 112     interface ::com::sun::star::accessibility::XAccessibleSelection;
 113
 114 };
 115
 116 }; }; }; };
 117
 118 #endif