offapi/com/sun/star/awt/AccessibleMenuItem.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_AccessibleMenuItem_idl__
  21 #define __com_sun_star_awt_AccessibleMenuItem_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/XAccessibleText.idl>
  28 #include <com/sun/star/accessibility/XAccessibleAction.idl>
  29 #include <com/sun/star/accessibility/XAccessibleValue.idl>
  30
  31 module com { module sun { module star { module awt {
  32
  33 /** specifies accessibility support for a menu item.
  34
  35     @since OOo 1.1.2
  36  */
  37 service AccessibleMenuItem
  38 {
  39     /** This interface gives access to the structural information of a
  40         menu item:
  41
  42         <ul>
  43         <li>Role: The role of a menu item is <const
  44             scope="com::sun::star::accessibility"
  45             >AccessibleRole::MENU_ITEM</const>.</li>
  46         <li>Name: The name of a menu item is the localized item text.</li>
  47         <li>Description: The description of a menu item is its localized
  48             help text.</li>
  49         <li>Children: There are no children.</li>
  50         <li>Parent: The parent of a menu item is a menu bar, a pop-up menu or
  51             a menu, whose accessible context supports the services
  52             <type>AccessibleMenuBar</type>, <type>AccessiblePopupMenu</type>
  53             or <type>AccessibleMenu</type>.</li>
  54         <li>Relations: There are no relations.</li>
  55         <li>States: The states supported by this service are
  56             <ul>
  57             <li><const scope="com::sun::star::accessibility"
  58                 >AccessibleStateType::ARMED</const> is set
  59                 if the object is highlighted.</li>
  60             <li><const scope="com::sun::star::accessibility"
  61                 >AccessibleStateType::CHECKED</const> is set
  62                 if the object is currently checked.</li>
  63             <li><const scope="com::sun::star::accessibility"
  64                 >AccessibleStateType::DEFUNC</const>
  65                 is set if the object has already been disposed
  66                 and subsequent calls to this object result in
  67                 <type scope="com::sun::star::lang">DisposedException</type>
  68                 exceptions.</li>
  69             <li><const scope="com::sun::star::accessibility"
  70                 >AccessibleStateType::ENABLED</const> is set
  71                 if the object is enabled.</li>
  72             <li><const scope="com::sun::star::accessibility"
  73                 >AccessibleStateType::OPAQUE</const> is always set.</li>
  74             <li><const scope="com::sun::star::accessibility"
  75                 >AccessibleStateType::SELECTABLE</const> is always set.</li>
  76             <li><const scope="com::sun::star::accessibility"
  77                 >AccessibleStateType::SELECTED</const> is set
  78                 if the object is selected.</li>
  79             <li><const scope="com::sun::star::accessibility"
  80                 >AccessibleStateType::SHOWING</const> is set
  81                 if the object is displayed on the screen.</li>
  82             <li><const scope="com::sun::star::accessibility"
  83                 >AccessibleStateType::VISIBLE</const> is always set.</li>
  84             </ul>
  85             </li>
  86         </ul>
  87      */
  88     interface ::com::sun::star::accessibility::XAccessibleContext;
  89
  90     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
  91
  92     interface ::com::sun::star::accessibility::XAccessibleComponent;
  93
  94     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
  95
  96     /** This interface gives read-only access to the text representation
  97         of a menu item.
  98      */
  99     interface ::com::sun::star::accessibility::XAccessibleText;
 100
 101     /** This interface gives access to the actions that can be executed for
 102         a menu item. The supported actions for a menu item are:
 103         <ul>
 104         <li>select</li>
 105         </ul>
 106      */
 107     interface ::com::sun::star::accessibility::XAccessibleAction;
 108
 109     /** This interface gives access to the numerical value of a
 110         menu item, which is related to the menu item's
 111         <const scope="com::sun::star::accessibility"
 112         >AccessibleStateType::SELECTED</const> state.
 113      */
 114     interface ::com::sun::star::accessibility::XAccessibleValue;
 115 };
 116
 117 }; }; }; };
 118
 119 #endif
 120
 121 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */