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