offapi/com/sun/star/awt/AccessibleTreeListBoxEntry.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: AccessibleTreeListBoxEntry.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_AccessibleTreeListBoxEntry_idl__
  32 #define __com_sun_star_awt_AccessibleTreeListBoxEntry_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 XAccessibleAction;
  42  published interface XAccessibleSelection;
  43  published interface XAccessibleText;
  44  published interface XAccessibleComponent;
  45
  46 }; }; }; };
  47
  48 module com { module sun { module star { module awt {
  49
  50
  51 /** specifies accessibility support for a treelistbox entry.
  52
  53     @see com::sun::star::accessibility::AccessibleContext
  54
  55     @see com::sun::star::accessibility::XAccessibleAction
  56     @see com::sun::star::accessibility::XAccessibleSelection
  57     @see com::sun::star::accessibility::XAccessibleText
  58
  59     @since OOo 1.1.2
  60 */
  61 published service AccessibleTreeListBoxEntry
  62 {
  63     /** This interface gives access to the structural information of a tree list box entry:
  64
  65        <ul>
  66        <li>Role: The role of a tree list box entry is <const
  67            scope="com::sun::star::accessibility"
  68            >AccessibleRole::LABEL</const>.</li>
  69        <li>Name: The name of a tree list box entry is it's text.</li>
  70        <li>Description: The description of a tree list box entry is empty.</li>
  71        <li>Children: There can exist children of type <type scope="com::sun::star::awt">AccessibleTreeListBoxEntry</type>.
  72         </li>
  73        <li>Parent: The parent is either the <type scope="com::sun::star::awt">AccessibleTreeListBox</type>
  74             or an <type scope="com::sun::star::awt">AccessibleTreeListBoxEntry</type> that contains the tree list box entry.</li>
  75        <li>Relations: There are no relations.</li>
  76        <li>States: The states supported by this service are
  77            <ul>
  78            <li><const scope="com::sun::star::accessibility"
  79                >AccessibleStateType::DEFUNC</const>
  80                is set if the object has already been disposed
  81                and subsequent calls to this object result in
  82                <type scope="com::sun::star::lang">DisposedException</type>
  83                exceptions.</li>
  84            <li><const scope="com::sun::star::accessibility"
  85                >AccessibleStateType::ENABLED</const> is set
  86                if the object is enabled.</li>
  87            <li><const scope="com::sun::star::accessibility"
  88                >AccessibleStateType::SHOWING</const> is set
  89                if the object is displayed on the screen.</li>
  90            <li><const scope="com::sun::star::accessibility"
  91                >AccessibleStateType::VISIBLE</const> is always set.</li>
  92            <li><const scope="com::sun::star::accessibility"
  93                >AccessibleStateType::EDITABLE</const> is set when a tree list box entry can be edited.</li>
  94            <li><const scope="com::sun::star::accessibility"
  95                >AccessibleStateType::EXPANDABLE</const> is always set.</li>
  96            <li><const scope="com::sun::star::accessibility"
  97                >AccessibleStateType::EXPANDED</const> is set when it is expanded.</li>
  98            <li><const scope="com::sun::star::accessibility"
  99                >AccessibleStateType::COLLAPSED</const> is set when it is collapsed.</li>
 100            <li><const scope="com::sun::star::accessibility"
 101                >AccessibleStateType::CHECKED</const> is set when it is checked.</li>
 102            <li><const scope="com::sun::star::accessibility"
 103                >AccessibleStateType::SELECTABLE</const> is always set.</li>
 104            <li><const scope="com::sun::star::accessibility"
 105                >AccessibleStateType::SELECTED</const> is set when it is selected.</li>
 106            </ul>
 107            </li>
 108        </ul>
 109     */
 110     service   com::sun::star::accessibility::AccessibleContext;
 111
 112     interface com::sun::star::accessibility::XAccessibleComponent;
 113
 114     /** This interface gives access to the actions that can be executed for
 115         a menu. The supported actions for a tree list box entry are:
 116         <ul>
 117         <li>toggleExpand</li>
 118         </ul>
 119      */
 120     interface com::sun::star::accessibility::XAccessibleAction;
 121
 122     /** This interface gives access to the selectable children of a
 123         tree list box entry.
 124      */
 125     interface com::sun::star::accessibility::XAccessibleSelection;
 126
 127     /** This interface gives read-only access to the text representation
 128         of a tool box item.
 129      */
 130     interface com::sun::star::accessibility::XAccessibleText;
 131 };
 132
 133 }; }; }; };
 134
 135 #endif
 136