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