offapi/com/sun/star/awt/AccessibleTreeListBox.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: AccessibleTreeListBox.idl,v $
  10  * $Revision: 1.10 $
  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_AccessibleTreeListBox_idl__
  32 #define __com_sun_star_awt_AccessibleTreeListBox_idl__
  33
  34 #ifndef __com_sun_star_accessibility_AccessibleContext_idl__
  35 #include <com/sun/star/accessibility/AccessibleContext.idl>
  36 #endif
  37
  38
  39 module com { module sun { module star { module accessibility {
  40
  41  published interface XAccessibleSelection;
  42  published interface XAccessibleComponent;
  43
  44 }; }; }; };
  45
  46 module com { module sun { module star { module awt {
  47
  48 /** specifies accessibility support for a tree list box.
  49
  50     @see com::sun::star::accessibility::AccessibleContext
  51
  52     @see com::sun::star::accessibility::XAccessibleComponent
  53     @see com::sun::star::accessibility::XAccessibleSelection
  54
  55     @since OOo 1.1.2
  56 */
  57 published service AccessibleTreeListBox
  58 {
  59     /** This interface gives access to the structural information of a tree list box:
  60
  61        <ul>
  62        <li>Role: The role of a tree list box is <const
  63            scope="com::sun::star::accessibility"
  64            >AccessibleRole::TREE</const>.</li>
  65        <li>Name: The name of a tree list box is its localized label.</li>
  66        <li>Description: The description of a tree list box is its localized
  67            help text.</li>
  68        <li>Children: There exists children of type <type scope="com::sun::star::awt">AccessibleTreeListBoxEntry</type>.
  69         </li>
  70        <li>Parent: The parent is the window that contains the tree list box.</li>
  71        <li>Relations: There are no relations.</li>
  72        <li>States: The states supported by this service are
  73            <ul>
  74            <li><const scope="com::sun::star::accessibility"
  75                >AccessibleStateType::DEFUNC</const>
  76                is set if the object has already been disposed
  77                and subsequent calls to this object result in
  78                <type scope="com::sun::star::lang">DisposedException</type>
  79                exceptions.</li>
  80            <li><const scope="com::sun::star::accessibility"
  81                >AccessibleStateType::ENABLED</const> is set
  82                if the object is enabled.</li>
  83            <li><const scope="com::sun::star::accessibility"
  84                >AccessibleStateType::FOCUSABLE</const> is always set.</li>
  85            <li><const scope="com::sun::star::accessibility"
  86                >AccessibleStateType::FOCUSED</const> is set
  87                if the object currently has the keyboard focus.</li>
  88            <li><const scope="com::sun::star::accessibility"
  89                >AccessibleStateType::ACTIVE</const> is set
  90                if a child has currently the focus.</li>
  91            <li><const scope="com::sun::star::accessibility"
  92                >AccessibleStateType::RESIZABLE</const> is set
  93                if the object can be resized.</li>
  94            <li><const scope="com::sun::star::accessibility"
  95                >AccessibleStateType::SHOWING</const> is set
  96                if the object is displayed on the screen.</li>
  97            <li><const scope="com::sun::star::accessibility"
  98                >AccessibleStateType::VISIBLE</const> is always set.</li>
  99            <li><const scope="com::sun::star::accessibility"
 100                >AccessibleStateType::MULTI_SELECTABLE</const> is set when mutli selection is enabled.</li>
 101            </ul>
 102            </li>
 103        </ul>
 104     */
 105     service   com::sun::star::accessibility::AccessibleContext;
 106
 107     interface com::sun::star::accessibility::XAccessibleComponent;
 108
 109     /** This interface gives access to the selectable children of a
 110         tree list box.
 111      */
 112     interface com::sun::star::accessibility::XAccessibleSelection;
 113 };
 114
 115 }; }; }; };
 116
 117 #endif
 118