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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef __com_sun_star_awt_AccessibleTreeListBoxEntry_idl__
  30 #define __com_sun_star_awt_AccessibleTreeListBoxEntry_idl__
  31
  32 #include <com/sun/star/accessibility/AccessibleContext.idl>
  33
  34
  35 module com { module sun { module star { module accessibility {
  36
  37  published interface XAccessibleAction;
  38  published interface XAccessibleSelection;
  39  published interface XAccessibleText;
  40  published interface XAccessibleComponent;
  41
  42 }; }; }; };
  43
  44 module com { module sun { module star { module awt {
  45
  46
  47 /** specifies accessibility support for a treelistbox entry.
  48
  49     @see com::sun::star::accessibility::AccessibleContext
  50
  51     @see com::sun::star::accessibility::XAccessibleAction
  52     @see com::sun::star::accessibility::XAccessibleSelection
  53     @see com::sun::star::accessibility::XAccessibleText
  54
  55     @since OOo 1.1.2
  56 */
  57 published service AccessibleTreeListBoxEntry
  58 {
  59     /** This interface gives access to the structural information of a tree list box entry:
  60
  61        <ul>
  62        <li>Role: The role of a tree list box entry is <const
  63            scope="com::sun::star::accessibility"
  64            >AccessibleRole::LABEL</const>.</li>
  65        <li>Name: The name of a tree list box entry is it's text.</li>
  66        <li>Description: The description of a tree list box entry is empty.</li>
  67        <li>Children: There can exist children of type <type scope="com::sun::star::awt">AccessibleTreeListBoxEntry</type>.
  68         </li>
  69        <li>Parent: The parent is either the <type scope="com::sun::star::awt">AccessibleTreeListBox</type>
  70             or an <type scope="com::sun::star::awt">AccessibleTreeListBoxEntry</type> that contains the tree list box entry.</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::SHOWING</const> is set
  85                if the object is displayed on the screen.</li>
  86            <li><const scope="com::sun::star::accessibility"
  87                >AccessibleStateType::VISIBLE</const> is always set.</li>
  88            <li><const scope="com::sun::star::accessibility"
  89                >AccessibleStateType::EDITABLE</const> is set when a tree list box entry can be edited.</li>
  90            <li><const scope="com::sun::star::accessibility"
  91                >AccessibleStateType::EXPANDABLE</const> is always set.</li>
  92            <li><const scope="com::sun::star::accessibility"
  93                >AccessibleStateType::EXPANDED</const> is set when it is expanded.</li>
  94            <li><const scope="com::sun::star::accessibility"
  95                >AccessibleStateType::COLLAPSED</const> is set when it is collapsed.</li>
  96            <li><const scope="com::sun::star::accessibility"
  97                >AccessibleStateType::CHECKED</const> is set when it is checked.</li>
  98            <li><const scope="com::sun::star::accessibility"
  99                >AccessibleStateType::SELECTABLE</const> is always set.</li>
 100            <li><const scope="com::sun::star::accessibility"
 101                >AccessibleStateType::SELECTED</const> is set when it is selected.</li>
 102            </ul>
 103            </li>
 104        </ul>
 105     */
 106     service   com::sun::star::accessibility::AccessibleContext;
 107
 108     interface com::sun::star::accessibility::XAccessibleComponent;
 109
 110     /** This interface gives access to the actions that can be executed for
 111         a menu. The supported actions for a tree list box entry are:
 112         <ul>
 113         <li>toggleExpand</li>
 114         </ul>
 115      */
 116     interface com::sun::star::accessibility::XAccessibleAction;
 117
 118     /** This interface gives access to the selectable children of a
 119         tree list box entry.
 120      */
 121     interface com::sun::star::accessibility::XAccessibleSelection;
 122
 123     /** This interface gives read-only access to the text representation
 124         of a tool box item.
 125      */
 126     interface com::sun::star::accessibility::XAccessibleText;
 127 };
 128
 129 }; }; }; };
 130
 131 #endif
 132
 133 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */