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