offapi/com/sun/star/text/AccessibleEndnoteView.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 #ifndef __com_sun_star_text_AccessibleEndnoteView_idl__
  20 #define __com_sun_star_text_AccessibleEndnoteView_idl__
  21
  22 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  23 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  24 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  25
  26
  27
  28 module com {  module sun {  module star {  module text {
  29
  30
  31 /** The accessible view of endnotes.
  32     @since OOo 1.1.2
  33  */
  34 service AccessibleEndnoteView
  35 {
  36     /** This interface gives access to any paragraph fragment and table
  37         fragment that is contained in a endnote and is at least
  38         partially visible on the screen.
  39
  40         <ul>
  41             <li>The parent returned by
  42                 <method scope="::com::sun::star::accessibility"
  43                 >XAccessibleContext::getAccessibleParent</method>
  44                 is either the accessible view of a text document,
  45                 a page of the accessible page preview of a text document,
  46                 or the accessible page preview of a spreadsheet document.
  47             <li>The children returned by
  48                 <method scope="::com::sun::star::accessibility"
  49                 >XAccessibleContext::getAccessibleChild</method> all
  50                 support the interface XAccessible. Calling
  51                 <method scope="::com::sun::star::accessibility"
  52                 >XAccessible::getAccessibleContext</method> for these children returns
  53                 an object that supports one of the following services.
  54                 <ul>
  55                     <li><type scope="::com::sun::star::text"
  56                         >AccessibleParagraphView</type>:
  57                         A child of this kind is returned for every paragraph
  58                         fragment that is contained in the document body and
  59                         is at least partially visible. A paragraph fragment is
  60                         the part of a paragraph that is displayed on a
  61                         certain page.
  62                     <li><type scope="::com::sun::star::table"
  63                         >AccessibleTableView</type>:
  64                         A child of this kind is returned for every table
  65                         fragment that is contained in the document body
  66                         and is at least partially visible. A table fragment is
  67                         the part of a table that is displayed on a certain page.
  68                 </ul>
  69                 <p>The logical order of paragraph and table fragments is never
  70                    changed.
  71             <li>The role is <const scope="::com::sun::star::accessibility"
  72                 >AccessibleRole::ENDNOTE</const>
  73             <li>The name is "endnote" (or the equivalent term
  74                 in application's language) with a number appended.
  75             <li>The description is endnote" (or the equivalent term
  76                 in application's language) with the endnote number or
  77                 character appended in the format that is specified in the
  78                 endnote settings.
  79             <li>There are no relations. <em>TODO: One might specify a relation
  80                 to the endnote anchor's paragraph.</em>
  81             <li>The following states might be contained in the state set
  82                 returned by <method scope="::com::sun::star::accessibility"
  83                 >XAccessibleContext::getAccessibleStateSet</method>:
  84                 <ul>
  85                     <li><const scope="::com::sun::star::accessibility"
  86                         >AccessibleStateType::DEFUNC</const> (indicates that the
  87                         document window has been closed or the endnote is
  88                         not existing any longer)
  89                     <li><const scope="::com::sun::star::accessibility"
  90                         >AccessibleStateType::EDITABLE</const>
  91                     <li><const scope="::com::sun::star::accessibility"
  92                         >AccessibleStateType::ENABLED</const> (always contained)
  93                     <li><const scope="::com::sun::star::accessibility"
  94                         >AccessibleStateType::OPAQUE</const>
  95                     <li><const scope="::com::sun::star::accessibility"
  96                         >AccessibleStateType::SHOWING</const>
  97                     <li><const scope="::com::sun::star::accessibility"
  98                         >AccessibleStateType::VISIBLE</const>
  99                 </ul>
 100             <li>Depending of the application's region setting, the locale is
 101                 the western, Asian or complex default language of the document.
 102         </ul>
 103
 104      */
 105     interface ::com::sun::star::accessibility::XAccessibleContext;
 106
 107     /** This interface describes the graphical representation of a
 108           endnote.
 109      */
 110     interface ::com::sun::star::accessibility::XAccessibleComponent;
 111
 112     /** This is the interface for listeners */
 113     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 114 };
 115
 116
 117 }; }; }; };
 118
 119 #endif
 120
 121 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */