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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: AccessibleDropDownComboBox.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_awt_AccessibleDropDownComboBox_idl__
  32 #define __com_sun_star_awt_AccessibleDropDownComboBox_idl__
  33
  34 #ifndef __com_sun_star_accessibility_AccessibleContext_idl__
  35 #include <com/sun/star/accessibility/AccessibleContext.idl>
  36 #endif
  37
  38
  39 module com { module sun { module star { module accessibility {
  40
  41  published interface XAccessibleAction;
  42  published interface XAccessibleExtendedComponent;
  43  published interface XAccessibleComponent;
  44
  45 }; }; }; };
  46
  47 module com { module sun { module star { module awt {
  48
  49 /** specifies accessibility support for a dropdown combo box.
  50
  51     @see com::sun::star::accessibility::AccessibleContext
  52
  53     @see com::sun::star::accessibility::XAccessibleComponent
  54     @see com::sun::star::accessibility::XAccessibleExtendedComponent
  55     @see com::sun::star::accessibility::XAccessibleAction
  56
  57     @since OOo 1.1.2
  58 */
  59 published service AccessibleDropDownComboBox
  60 {
  61     /** This interface gives access to the structural information of a dropdown combo box:
  62
  63        <ul>
  64        <li>Role: The role of a dropdown combo box is <const
  65            scope="com::sun::star::accessibility"
  66            >AccessibleRole::COMBO_BOX</const>.</li>
  67        <li>Name: The name of a dropdown combo box is its localized label.</li>
  68        <li>Description: The description of a dropdown combo box is its localized
  69            help text.</li>
  70        <li>Children: There exists two children.
  71             The first is a <type scope="com::sun::star::awt">AccessibleTextField</type>
  72             and the 2nd is a <type scope="com::sun::star::awt">AccessibleList</type>. </li>
  73        <li>Parent: The parent is the window that contains the dropdown combo box.</li>
  74        <li>Relations: There are no relations.</li>
  75        <li>States: The states supported by this service are
  76            <ul>
  77            <li><const scope="com::sun::star::accessibility"
  78                >AccessibleStateType::DEFUNC</const>
  79                is set if the object has already been disposed
  80                and subsequent calls to this object result in
  81                <type scope="com::sun::star::lang">DisposedException</type>
  82                exceptions.</li>
  83            <li><const scope="com::sun::star::accessibility"
  84                >AccessibleStateType::ENABLED</const> is set
  85                if the object is enabled.</li>
  86            <li><const scope="com::sun::star::accessibility"
  87                >AccessibleStateType::FOCUSABLE</const> is always set.</li>
  88            <li><const scope="com::sun::star::accessibility"
  89                >AccessibleStateType::FOCUSED</const> is set
  90                if the object currently has the keyboard focus.</li>
  91            <li><const scope="com::sun::star::accessibility"
  92                >AccessibleStateType::ACTIVE</const> is set
  93                if a child has currently the focus.</li>
  94            <li><const scope="com::sun::star::accessibility"
  95                >AccessibleStateType::RESIZABLE</const> is set
  96                if the object can be resized.</li>
  97            <li><const scope="com::sun::star::accessibility"
  98                >AccessibleStateType::SHOWING</const> is set
  99                if the object is displayed on the screen.</li>
 100            <li><const scope="com::sun::star::accessibility"
 101                >AccessibleStateType::VISIBLE</const> is always set.</li>
 102            </ul>
 103            </li>
 104        </ul>
 105     */
 106     service   com::sun::star::accessibility::AccessibleContext;
 107
 108     interface com::sun::star::accessibility::XAccessibleComponent;
 109     interface com::sun::star::accessibility::XAccessibleExtendedComponent;
 110
 111     /** This interface gives access to the actions that can be executed for
 112         a dropdown combo box. The supported actions for a dropdown combo box are:
 113         <ul>
 114         <li>togglePopup</li>
 115         </ul>
 116      */
 117     interface com::sun::star::accessibility::XAccessibleAction;
 118 };
 119
 120 }; }; }; };
 121
 122 #endif