offapi/com/sun/star/awt/AccessibleListItem.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: AccessibleListItem.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_AccessibleListItem_idl__
  32 #define __com_sun_star_awt_AccessibleListItem_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 XAccessibleText;
  42  published interface XAccessibleComponent;
  43
  44 }; }; }; };
  45
  46 module com { module sun { module star { module awt {
  47
  48 /** specifies accessibility support for a list item.
  49
  50     @see com::sun::star::accessibility::AccessibleContext
  51     @see com::sun::star::accessibility::XAccessibleComponent
  52     @see com::sun::star::accessibility::XAccessibleText
  53
  54     @since OOo 1.1.2
  55 */
  56 published service AccessibleListItem
  57 {
  58     /** This interface gives access to the structural information of a list item:
  59
  60        <ul>
  61        <li>Role: The role of a list item is <const
  62            scope="com::sun::star::accessibility"
  63            >AccessibleRole::LIST_ITEM</const>.</li>
  64        <li>Name: The name of a list item is the text of the item.</li>
  65        <li>Description: The description of a list item is empty.</li>
  66        <li>Children: There exists no children.</li>
  67        <li>Parent: The parent is of type <type scope="com::sun::star::awt">AccessibleList</type>.</li>
  68        <li>Relations: There are no relations.</li>
  69        <li>States: The states supported by this service are
  70            <ul>
  71            <li><const scope="com::sun::star::accessibility"
  72                >AccessibleStateType::DEFUNC</const>
  73                is set if the object has already been disposed
  74                and subsequent calls to this object result in
  75                <type scope="com::sun::star::lang">DisposedException</type>
  76                exceptions.</li>
  77            <li><const scope="com::sun::star::accessibility"
  78                >AccessibleStateType::ENABLED</const> is always set.</li>
  79            <li><const scope="com::sun::star::accessibility"
  80                >AccessibleStateType::SHOWING</const> is set
  81                if the object is displayed on the screen.</li>
  82            <li><const scope="com::sun::star::accessibility"
  83                >AccessibleStateType::VISIBLE</const> is always set.</li>
  84            <li><const scope="com::sun::star::accessibility"
  85                >AccessibleStateType::TRANSIENT</const> is always set.</li>
  86            <li><const scope="com::sun::star::accessibility"
  87                >AccessibleStateType::SELECTABLE</const> is always set.</li>
  88            <li><const scope="com::sun::star::accessibility"
  89                >AccessibleStateType::SELECTED</const> is set
  90                when the item is selected.</li>
  91            </ul>
  92            </li>
  93        </ul>
  94     */
  95     service   com::sun::star::accessibility::AccessibleContext;
  96
  97     interface com::sun::star::accessibility::XAccessibleComponent;
  98
  99     /** This interface gives read-only access to the text representation
 100         of a list item.
 101      */
 102     interface com::sun::star::accessibility::XAccessibleText;
 103 };
 104
 105 }; }; }; };
 106
 107 #endif