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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_awt_AccessibleMenuBar_idl__
  21 #define __com_sun_star_awt_AccessibleMenuBar_idl__
  22
  23 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  24 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  25 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  26 #include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
  27 #include <com/sun/star/accessibility/XAccessibleSelection.idl>
  28
  29 module com { module sun { module star { module awt {
  30
  31 /** specifies accessibility support for a menu bar.
  32
  33     @since OOo 1.1.2
  34  */
  35 service AccessibleMenuBar
  36 {
  37     /** This interface gives access to the structural information of a
  38         menu bar:
  39
  40         <ul>
  41         <li>Role: The role of a menu bar is <const
  42             scope="com::sun::star::accessibility"
  43             >AccessibleRole::MENU_BAR</const>.</li>
  44         <li>Name: There is no name.</li>
  45         <li>Description: The description of a menu bar is its localized
  46             help text.</li>
  47         <li>Children: The children of a menu bar are menus, menu items or
  48             menu separators, whose accessible context supports the services
  49             <type>AccessibleMenu</type>, <type>AccessibleMenuItem</type> or
  50             <type>AccessibleMenuSeparator</type>.</li>
  51         <li>Parent: The parent is the window that contains the menu bar.</li>
  52         <li>Relations: There are no relations.</li>
  53         <li>States: The states supported by this service are
  54             <ul>
  55             <li><const scope="com::sun::star::accessibility"
  56                 >AccessibleStateType::DEFUNC</const>
  57                 is set if the object has already been disposed
  58                 and subsequent calls to this object result in
  59                 <type scope="com::sun::star::lang">DisposedException</type>
  60                 exceptions.</li>
  61             <li><const scope="com::sun::star::accessibility"
  62                 >AccessibleStateType::ENABLED</const> is set
  63                 if the object is enabled.</li>
  64             <li><const scope="com::sun::star::accessibility"
  65                 >AccessibleStateType::FOCUSABLE</const> is always set.</li>
  66             <li><const scope="com::sun::star::accessibility"
  67                 >AccessibleStateType::FOCUSED</const> is set
  68                 if the object currently has the keyboard focus.</li>
  69             <li><const scope="com::sun::star::accessibility"
  70                 >AccessibleStateType::OPAQUE</const> is always set.</li>
  71             <li><const scope="com::sun::star::accessibility"
  72                 >AccessibleStateType::SHOWING</const> is set
  73                 if the object is displayed on the screen.</li>
  74             <li><const scope="com::sun::star::accessibility"
  75                 >AccessibleStateType::VISIBLE</const> is always set.</li>
  76             </ul>
  77             </li>
  78         </ul>
  79      */
  80     interface ::com::sun::star::accessibility::XAccessibleContext;
  81
  82     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
  83
  84     interface ::com::sun::star::accessibility::XAccessibleComponent;
  85
  86     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
  87
  88     /** This interface gives access to the selectable children of a
  89         menu bar.
  90      */
  91     interface ::com::sun::star::accessibility::XAccessibleSelection;
  92
  93 };
  94
  95 }; }; }; };
  96
  97 #endif
  98
  99 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */