offapi/com/sun/star/awt/AccessibleDropDownComboBox.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_AccessibleDropDownComboBox_idl__
  30 #define __com_sun_star_awt_AccessibleDropDownComboBox_idl__
  31
  32 #include <com/sun/star/accessibility/AccessibleContext.idl>
  33
  34
  35 module com { module sun { module star { module accessibility {
  36
  37  published interface XAccessibleAction;
  38  published interface XAccessibleExtendedComponent;
  39  published interface XAccessibleComponent;
  40
  41 }; }; }; };
  42
  43 module com { module sun { module star { module awt {
  44
  45 /** specifies accessibility support for a dropdown combo box.
  46
  47     @see com::sun::star::accessibility::AccessibleContext
  48
  49     @see com::sun::star::accessibility::XAccessibleComponent
  50     @see com::sun::star::accessibility::XAccessibleExtendedComponent
  51     @see com::sun::star::accessibility::XAccessibleAction
  52
  53     @since OOo 1.1.2
  54 */
  55 published service AccessibleDropDownComboBox
  56 {
  57     /** This interface gives access to the structural information of a dropdown combo box:
  58
  59        <ul>
  60        <li>Role: The role of a dropdown combo box is <const
  61            scope="com::sun::star::accessibility"
  62            >AccessibleRole::COMBO_BOX</const>.</li>
  63        <li>Name: The name of a dropdown combo box is its localized label.</li>
  64        <li>Description: The description of a dropdown combo box is its localized
  65            help text.</li>
  66        <li>Children: There exists two children.
  67             The first is a <type scope="com::sun::star::awt">AccessibleTextField</type>
  68             and the 2nd is a <type scope="com::sun::star::awt">AccessibleList</type>. </li>
  69        <li>Parent: The parent is the window that contains the dropdown combo box.</li>
  70        <li>Relations: There are no relations.</li>
  71        <li>States: The states supported by this service are
  72            <ul>
  73            <li><const scope="com::sun::star::accessibility"
  74                >AccessibleStateType::DEFUNC</const>
  75                is set if the object has already been disposed
  76                and subsequent calls to this object result in
  77                <type scope="com::sun::star::lang">DisposedException</type>
  78                exceptions.</li>
  79            <li><const scope="com::sun::star::accessibility"
  80                >AccessibleStateType::ENABLED</const> is set
  81                if the object is enabled.</li>
  82            <li><const scope="com::sun::star::accessibility"
  83                >AccessibleStateType::FOCUSABLE</const> is always set.</li>
  84            <li><const scope="com::sun::star::accessibility"
  85                >AccessibleStateType::FOCUSED</const> is set
  86                if the object currently has the keyboard focus.</li>
  87            <li><const scope="com::sun::star::accessibility"
  88                >AccessibleStateType::ACTIVE</const> is set
  89                if a child has currently the focus.</li>
  90            <li><const scope="com::sun::star::accessibility"
  91                >AccessibleStateType::RESIZABLE</const> is set
  92                if the object can be resized.</li>
  93            <li><const scope="com::sun::star::accessibility"
  94                >AccessibleStateType::SHOWING</const> is set
  95                if the object is displayed on the screen.</li>
  96            <li><const scope="com::sun::star::accessibility"
  97                >AccessibleStateType::VISIBLE</const> is always set.</li>
  98            </ul>
  99            </li>
 100        </ul>
 101     */
 102     service   com::sun::star::accessibility::AccessibleContext;
 103
 104     interface com::sun::star::accessibility::XAccessibleComponent;
 105     interface com::sun::star::accessibility::XAccessibleExtendedComponent;
 106
 107     /** This interface gives access to the actions that can be executed for
 108         a dropdown combo box. The supported actions for a dropdown combo box are:
 109         <ul>
 110         <li>togglePopup</li>
 111         </ul>
 112      */
 113     interface com::sun::star::accessibility::XAccessibleAction;
 114 };
 115
 116 }; }; }; };
 117
 118 #endif
 119
 120 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */