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