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