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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module accessibility {
  22
  23  interface XAccessibleText;
  24  interface XAccessibleComponent;
  25
  26 }; }; }; };
  27
  28 module com { module sun { module star { module awt {
  29
  30 /** specifies accessibility support for a list item.
  31
  32     @see com::sun::star::accessibility::AccessibleContext
  33     @see com::sun::star::accessibility::XAccessibleComponent
  34     @see com::sun::star::accessibility::XAccessibleText
  35
  36     @since OOo 1.1.2
  37 */
  38 service AccessibleListItem
  39 {
  40     /** This interface gives access to the structural information of a list item:
  41
  42        <ul>
  43        <li>Role: The role of a list item is
  44        com::sun::star::accessibility::AccessibleRole::LIST_ITEM.</li>
  45        <li>Name: The name of a list item is the text of the item.</li>
  46        <li>Description: The description of a list item is empty.</li>
  47        <li>Children: There exists no children.</li>
  48        <li>Parent: The parent is of type com::sun::star::awt::AccessibleList.</li>
  49        <li>Relations: There are no relations.</li>
  50        <li>States: The states supported by this service are
  51            <ul>
  52            <li>com::sun::star::accessibility::AccessibleStateType::DEFUNC
  53                is set if the object has already been disposed
  54                and subsequent calls to this object result in
  55                com::sun::star::lang::DisposedException
  56                exceptions.</li>
  57            <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
  58                is always set.</li>
  59            <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
  60                is set if the object is displayed on the screen.</li>
  61            <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
  62                is always set.</li>
  63            <li>com::sun::star::accessibility::AccessibleStateType::TRANSIENT
  64                is always set.</li>
  65            <li>com::sun::star::accessibility::AccessibleStateType::SELECTABLE
  66                is always set.</li>
  67            <li>com::sun::star::accessibility::AccessibleStateType::SELECTED
  68                is set when the item is selected.</li>
  69            </ul>
  70            </li>
  71        </ul>
  72     */
  73     service   com::sun::star::accessibility::AccessibleContext;
  74
  75     interface com::sun::star::accessibility::XAccessibleComponent;
  76
  77     /** This interface gives read-only access to the text representation
  78         of a list item.
  79      */
  80     interface com::sun::star::accessibility::XAccessibleText;
  81 };
  82
  83 }; }; }; };
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */