offapi/com/sun/star/awt/AccessibleList.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: AccessibleList.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_awt_AccessibleList_idl__
  32 #define __com_sun_star_awt_AccessibleList_idl__
  33
  34 #ifndef __com_sun_star_accessibility_AccessibleContext_idl__
  35 #include <com/sun/star/accessibility/AccessibleContext.idl>
  36 #endif
  37
  38 module com { module sun { module star { module accessibility {
  39
  40  published interface XAccessible;
  41  published interface XAccessibleExtendedComponent;
  42  published interface XAccessibleComponent;
  43  published interface XAccessibleSelection;
  44
  45 }; }; }; };
  46
  47 module com { module sun { module star { module awt {
  48
  49
  50
  51 /** Accessible lists are used by combo boxes as container for
  52     the list items.
  53
  54     @see com::sun::star::accessibility::AccessibleContext
  55
  56     @see com::sun::star::accessibility::XAccessibleComponent
  57     @see com::sun::star::accessibility::XAccessibleExtendedComponent
  58     @see ::com::sun::star::accessibility::XAccessibleSelection
  59
  60     @since OOo 1.1.2
  61 */
  62 published service AccessibleList
  63 {
  64     /** This interface gives access to the structural information of a list:
  65
  66        <ul>
  67        <li>Role: The role of a list is <const
  68            scope="::com::sun::star::accessibility"
  69            >AccessibleRole::LIST</const>.</li>
  70        <li>Name: The name of a list is its localized label.</li>
  71        <li>Description: The description of a list is its localized
  72            help text.</li>
  73        <li>Children: There exists children.
  74             Each child is of type <type scope="com::sun::star::awt">AccessibleListItem</type>. </li>
  75        <li>Parent: The parent can be of type
  76             <ul>
  77             <li>
  78                 <type scope="com::sun::star::awt">AccessibleComboBox</type>
  79                 <type scope="com::sun::star::awt">AccessibleListBox</type>
  80                 <type scope="com::sun::star::awt">AccessibleDropDownListBox</type>
  81                 <type scope="com::sun::star::awt">AccessibleDropDownComboBox</type>
  82             </li>
  83             .
  84        </li>
  85        <li>Relations: There are no relations.</li>
  86        <li>States: The states supported by this service are
  87            <ul>
  88            <li><const scope="com::sun::star::accessibility"
  89                >AccessibleStateType::DEFUNC</const>
  90                is set if the object has already been disposed
  91                and subsequent calls to this object result in
  92                <type scope="com::sun::star::lang">DisposedException</type>
  93                exceptions.</li>
  94            <li><const scope="com::sun::star::accessibility"
  95                >AccessibleStateType::ENABLED</const> is set
  96                if the object is enabled.</li>
  97            <li><const scope="com::sun::star::accessibility"
  98                >AccessibleStateType::FOCUSABLE</const> is always set.</li>
  99            <li><const scope="com::sun::star::accessibility"
 100                >AccessibleStateType::FOCUSED</const> is set
 101                if the object currently has the keyboard focus.</li>
 102            <li><const scope="com::sun::star::accessibility"
 103                >AccessibleStateType::ACTIVE</const> is set
 104                if a child has currently the focus.</li>
 105            <li><const scope="com::sun::star::accessibility"
 106                >AccessibleStateType::RESIZABLE</const> is set
 107                if the object can be resized.</li>
 108            <li><const scope="com::sun::star::accessibility"
 109                >AccessibleStateType::SHOWING</const> is set
 110                if the object is displayed on the screen.</li>
 111            <li><const scope="com::sun::star::accessibility"
 112                >AccessibleStateType::VISIBLE</const> is always set.</li>
 113            <li><const scope="com::sun::star::accessibility"
 114                >AccessibleStateType::MULTI_SELECTABLE</const> is set
 115                if the list supports multi selection.</li>
 116            <li><const scope="com::sun::star::accessibility"
 117                >AccessibleStateType::MANAGES_DESCENDANTS</const> is always set.
 118                The children are transient.</li>
 119            </ul>
 120            </li>
 121        </ul>
 122     */
 123     service   com::sun::star::accessibility::AccessibleContext;
 124
 125     interface com::sun::star::accessibility::XAccessibleComponent;
 126     interface com::sun::star::accessibility::XAccessibleExtendedComponent;
 127
 128     /** Support of the <type scope="com::sun::star::accessibility">XAccessible</type> interface may be
 129         discontinued in the future.
 130     */
 131     interface com::sun::star::accessibility::XAccessible;
 132
 133     /** This interface gives access to the selectable children of a
 134         list.
 135      */
 136     interface com::sun::star::accessibility::XAccessibleSelection;
 137 };
 138
 139 }; }; }; };
 140
 141 #endif