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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef __com_sun_star_awt_AccessibleMenu_idl__
  30 #define __com_sun_star_awt_AccessibleMenu_idl__
  31
  32 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  33 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  34 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  35 #include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
  36 #include <com/sun/star/accessibility/XAccessibleText.idl>
  37 #include <com/sun/star/accessibility/XAccessibleAction.idl>
  38 #include <com/sun/star/accessibility/XAccessibleValue.idl>
  39 #include <com/sun/star/accessibility/XAccessibleSelection.idl>
  40
  41 module com { module sun { module star { module awt {
  42
  43 /** specifies accessibility support for a menu.
  44
  45     @since OOo 1.1.2
  46  */
  47 published service AccessibleMenu
  48 {
  49     /** This interface gives access to the structural information of a menu:
  50
  51         <ul>
  52         <li>Role: The role of a menu is <const
  53             scope="com::sun::star::accessibility"
  54             >AccessibleRole::MENU</const>.</li>
  55         <li>Name: The name of a menu is the localized item text.</li>
  56         <li>Description: The description of a menu is its localized
  57             help text.</li>
  58         <li>Children: The children of a menu are menus, menu items or
  59             menu separators, whose accessible context supports the services
  60             <type>AccessibleMenu</type>, <type>AccessibleMenuItem</type> or
  61             <type>AccessibleMenuSeparator</type>.</li>
  62         <li>Parent: The parent of a menu is a menu bar, a pop-up menu or
  63             a menu, whose accessible context supports the services
  64             <type>AccessibleMenuBar</type>, <type>AccessiblePopupMenu</type>
  65             or <type>AccessibleMenu</type>.</li>
  66         <li>Relations: There are no relations.</li>
  67         <li>States: The states supported by this service are
  68             <ul>
  69             <li><const scope="com::sun::star::accessibility"
  70                 >AccessibleStateType::ARMED</const> is set
  71                 if the object is highlighted.</li>
  72             <li><const scope="com::sun::star::accessibility"
  73                 >AccessibleStateType::CHECKED</const> is set
  74                 if the object is currently checked.</li>
  75             <li><const scope="com::sun::star::accessibility"
  76                 >AccessibleStateType::DEFUNC</const>
  77                 is set if the object has already been disposed
  78                 and subsequent calls to this object result in
  79                 <type scope="com::sun::star::lang">DisposedException</type>
  80                 exceptions.</li>
  81             <li><const scope="com::sun::star::accessibility"
  82                 >AccessibleStateType::ENABLED</const> is set
  83                 if the object is enabled.</li>
  84             <li><const scope="com::sun::star::accessibility"
  85                 >AccessibleStateType::OPAQUE</const> is always set.</li>
  86             <li><const scope="com::sun::star::accessibility"
  87                 >AccessibleStateType::SELECTABLE</const> is always set.</li>
  88             <li><const scope="com::sun::star::accessibility"
  89                 >AccessibleStateType::SELECTED</const> is set
  90                 if the object is selected.</li>
  91             <li><const scope="com::sun::star::accessibility"
  92                 >AccessibleStateType::SHOWING</const> is set
  93                 if the object is displayed on the screen.</li>
  94             <li><const scope="com::sun::star::accessibility"
  95                 >AccessibleStateType::VISIBLE</const> is always set.</li>
  96             </ul>
  97             </li>
  98         </ul>
  99      */
 100     interface ::com::sun::star::accessibility::XAccessibleContext;
 101
 102     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 103
 104     interface ::com::sun::star::accessibility::XAccessibleComponent;
 105
 106     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
 107
 108     /** This interface gives read-only access to the text representation
 109         of a menu.
 110      */
 111     interface ::com::sun::star::accessibility::XAccessibleText;
 112
 113     /** This interface gives access to the actions that can be executed for
 114         a menu. The supported actions for a menu are:
 115         <ul>
 116         <li>select</li>
 117         </ul>
 118      */
 119     interface ::com::sun::star::accessibility::XAccessibleAction;
 120
 121     /** This interface gives access to the numerical value of a
 122         menu, which is related to the menu's
 123         <const scope="com::sun::star::accessibility"
 124         >AccessibleStateType::SELECTED</const> state.
 125      */
 126     interface ::com::sun::star::accessibility::XAccessibleValue;
 127
 128     /** This interface gives access to the selectable children of a
 129         menu.
 130      */
 131     interface ::com::sun::star::accessibility::XAccessibleSelection;
 132
 133 };
 134
 135 }; }; }; };
 136
 137 #endif
 138
 139 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */