offapi/com/sun/star/awt/AccessiblePopupMenu.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_AccessiblePopupMenu_idl__
  30 #define __com_sun_star_awt_AccessiblePopupMenu_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/XAccessibleSelection.idl>
  37
  38 module com { module sun { module star { module awt {
  39
  40 /** specifies accessibility support for a pop-up menu.
  41
  42     @since OOo 1.1.2
  43  */
  44 published service AccessiblePopupMenu
  45 {
  46     /** This interface gives access to the structural information of a
  47         pop-up menu:
  48
  49         <ul>
  50         <li>Role: The role of a pop-up menu is <const
  51             scope="com::sun::star::accessibility"
  52             >AccessibleRole::POPUP_MENU</const>.</li>
  53         <li>Name: There is no name.</li>
  54         <li>Description: The description of a pop-up menu is its localized
  55             help text.</li>
  56         <li>Children: The children of a pop-up menu are menus, menu items or
  57             menu separators, whose accessible context supports the services
  58             <type>AccessibleMenu</type>, <type>AccessibleMenuItem</type> or
  59             <type>AccessibleMenuSeparator</type>.</li>
  60         <li>Parent: The parent is the window that contains the pop-up menu.</li>
  61         <li>Relations: There are no relations.</li>
  62         <li>States: The states supported by this service are
  63             <ul>
  64             <li><const scope="com::sun::star::accessibility"
  65                 >AccessibleStateType::DEFUNC</const>
  66                 is set if the object has already been disposed
  67                 and subsequent calls to this object result in
  68                 <type scope="com::sun::star::lang">DisposedException</type>
  69                 exceptions.</li>
  70             <li><const scope="com::sun::star::accessibility"
  71                 >AccessibleStateType::ENABLED</const> is set
  72                 if the object is enabled.</li>
  73             <li><const scope="com::sun::star::accessibility"
  74                 >AccessibleStateType::FOCUSABLE</const> is always set.</li>
  75             <li><const scope="com::sun::star::accessibility"
  76                 >AccessibleStateType::FOCUSED</const> is set
  77                 if the object currently has the keyboard focus.</li>
  78             <li><const scope="com::sun::star::accessibility"
  79                 >AccessibleStateType::OPAQUE</const> is always set.</li>
  80             <li><const scope="com::sun::star::accessibility"
  81                 >AccessibleStateType::SHOWING</const> is set
  82                 if the object is displayed on the screen.</li>
  83             <li><const scope="com::sun::star::accessibility"
  84                 >AccessibleStateType::VISIBLE</const> is always set.</li>
  85             </ul>
  86             </li>
  87         </ul>
  88      */
  89     interface ::com::sun::star::accessibility::XAccessibleContext;
  90
  91     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
  92
  93     interface ::com::sun::star::accessibility::XAccessibleComponent;
  94
  95     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
  96
  97     /** This interface gives access to the selectable children of a
  98         pop-up menu.
  99      */
 100     interface ::com::sun::star::accessibility::XAccessibleSelection;
 101
 102 };
 103
 104 }; }; }; };
 105
 106 #endif
 107
 108 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */