offapi/com/sun/star/awt/AccessibleDropDownComboBox.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_AccessibleDropDownComboBox_idl__
  21 #define __com_sun_star_awt_AccessibleDropDownComboBox_idl__
  22
  23 #include <com/sun/star/accessibility/AccessibleContext.idl>
  24
  25
  26 module com { module sun { module star { module accessibility {
  27
  28  interface XAccessibleAction;
  29  interface XAccessibleExtendedComponent;
  30  interface XAccessibleComponent;
  31
  32 }; }; }; };
  33
  34 module com { module sun { module star { module awt {
  35
  36 /** specifies accessibility support for a dropdown combo box.
  37
  38     @see com::sun::star::accessibility::AccessibleContext
  39
  40     @see com::sun::star::accessibility::XAccessibleComponent
  41     @see com::sun::star::accessibility::XAccessibleExtendedComponent
  42     @see com::sun::star::accessibility::XAccessibleAction
  43
  44     @since OOo 1.1.2
  45 */
  46 service AccessibleDropDownComboBox
  47 {
  48     /** This interface gives access to the structural information of a dropdown combo box:
  49
  50        <ul>
  51        <li>Role: The role of a dropdown combo box is
  52            com::sun::star::accessibility::AccessibleRole::COMBO_BOX.</li>
  53        <li>Name: The name of a dropdown combo box is its localized label.</li>
  54        <li>Description: The description of a dropdown combo box is its localized
  55            help text.</li>
  56        <li>Children: There exists two children.
  57             The first is a com::sun::star::awt::AccessibleTextField
  58             and the 2nd is a com::sun::star::awt::AccessibleList. </li>
  59        <li>Parent: The parent is the window that contains the dropdown combo box.</li>
  60        <li>Relations: There are no relations.</li>
  61        <li>States: The states supported by this service are
  62            <ul>
  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::FOCUSABLE
  71                is always set.</li>
  72            <li>com::sun::star::accessibility::AccessibleStateType::FOCUSED
  73                is set if the object currently has the keyboard focus.</li>
  74            <li>com::sun::star::accessibility::AccessibleStateType::ACTIVE
  75                is set if a child has currently the focus.</li>
  76            <li>com::sun::star::accessibility::AccessibleStateType::RESIZABLE
  77                is set if the object can be resized.</li>
  78            <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
  79                is set if the object is displayed on the screen.</li>
  80            <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
  81                is always set.</li>
  82            </ul>
  83            </li>
  84        </ul>
  85     */
  86     service   com::sun::star::accessibility::AccessibleContext;
  87
  88     interface com::sun::star::accessibility::XAccessibleComponent;
  89     interface com::sun::star::accessibility::XAccessibleExtendedComponent;
  90
  91     /** This interface gives access to the actions that can be executed for
  92         a dropdown combo box. The supported actions for a dropdown combo box are:
  93         <ul>
  94         <li>togglePopup</li>
  95         </ul>
  96      */
  97     interface com::sun::star::accessibility::XAccessibleAction;
  98 };
  99
 100 }; }; }; };
 101
 102 #endif
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */