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