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