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