offapi/com/sun/star/awt/AccessibleList.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 module com { module sun { module star { module accessibility {
  21
  22  interface XAccessible;
  23  interface XAccessibleExtendedComponent;
  24  interface XAccessibleComponent;
  25  interface XAccessibleSelection;
  26
  27 }; }; }; };
  28
  29 module com { module sun { module star { module awt {
  30
  31
  32
  33 /** Accessible lists are used by combo boxes as container for
  34     the list items.
  35
  36     @see com::sun::star::accessibility::AccessibleContext
  37
  38     @see com::sun::star::accessibility::XAccessibleComponent
  39     @see com::sun::star::accessibility::XAccessibleExtendedComponent
  40     @see ::com::sun::star::accessibility::XAccessibleSelection
  41
  42     @since OOo 1.1.2
  43 */
  44 service AccessibleList
  45 {
  46     /** This interface gives access to the structural information of a list:
  47
  48        <ul>
  49        <li>Role: The role of a list is
  50            ::com::sun::star::accessibility::AccessibleRole::LIST.</li>
  51        <li>Name: The name of a list is its localized label.</li>
  52        <li>Description: The description of a list is its localized
  53            help text.</li>
  54        <li>Children: There exists children.
  55             Each child is of type com::sun::star::awt::AccessibleListItem. </li>
  56        <li>Parent: The parent can be of type
  57             <ul>
  58             <li>com::sun::star::awt::AccessibleComboBox</li>
  59             <li>com::sun::star::awt::AccessibleListBox</li>
  60             <li>com::sun::star::awt::AccessibleDropDownListBox</li>
  61             <li>com::sun::star::awt::AccessibleDropDownComboBox</li>
  62             </ul>
  63        </li>
  64        <li>Relations: There are no relations.</li>
  65        <li>States: The states supported by this service are
  66            <ul>
  67            <li>com::sun::star::accessibility::AccessibleStateType::DEFUNC
  68                is set if the object has already been disposed
  69                and subsequent calls to this object result in
  70                com::sun::star::lang::DisposedException
  71                exceptions.</li>
  72            <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
  73                is set if the object is enabled.</li>
  74            <li>com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
  75                is always set.</li>
  76            <li>com::sun::star::accessibility::AccessibleStateType::FOCUSED
  77                is set if the object currently has the keyboard focus.</li>
  78            <li>com::sun::star::accessibility::AccessibleStateType::ACTIVE
  79                is set if a child has currently the focus.</li>
  80            <li>com::sun::star::accessibility::AccessibleStateType::RESIZABLE
  81                is set if the object can be resized.</li>
  82            <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
  83                is set if the object is displayed on the screen.</li>
  84            <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
  85                is always set.</li>
  86            <li>com::sun::star::accessibility::AccessibleStateType::MULTI_SELECTABLE
  87                is set if the list supports multi selection.</li>
  88            <li>com::sun::star::accessibility::AccessibleStateType::MANAGES_DESCENDANTS
  89                is always set.
  90                The children are transient.</li>
  91            </ul>
  92            </li>
  93        </ul>
  94     */
  95     service   com::sun::star::accessibility::AccessibleContext;
  96
  97     interface com::sun::star::accessibility::XAccessibleComponent;
  98     interface com::sun::star::accessibility::XAccessibleExtendedComponent;
  99
 100     /** Support of the com::sun::star::accessibility::XAccessible interface may be
 101         discontinued in the future.
 102     */
 103     interface com::sun::star::accessibility::XAccessible;
 104
 105     /** This interface gives access to the selectable children of a
 106         list.
 107      */
 108     interface com::sun::star::accessibility::XAccessibleSelection;
 109 };
 110
 111 }; }; }; };
 112
 113 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */