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