offapi/com/sun/star/text/AccessibleFootnoteView.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: AccessibleFootnoteView.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_text_AccessibleFootnoteView_idl__
  31 #define __com_sun_star_text_AccessibleFootnoteView_idl__
  32
  33 #ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
  34 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
  38 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
  42 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module text {
  49
  50 //=============================================================================
  51
  52 /** The accessible view of footnotes.
  53
  54      @since OOo 1.1.2
  55
  56  */
  57 published service AccessibleFootnoteView
  58 {
  59     /** This interface gives access to any paragraph fragment and table
  60         fragment that is contained in a footnote and is at least
  61         partially visible on the screen.
  62
  63         <ul>
  64             <li>The parent returned by <method scope="::com::sun::star::accessibility"
  65                 >XAccessibleContext::getAccessibleParent</method>
  66                 is either the accessible view of a text document,
  67                 a page of the accessible page preview of a text document,
  68                 or the accessible page preview of a spreadsheet document.
  69             <li>The children returned by <method scope="::com::sun::star::accessibility"
  70                 >XAccessibleContext::getAccessibleChild</method> all
  71                 support the interface XAccessible. Calling
  72                 <method scope="::com::sun::star::accessibility"
  73                 >XAccessible::getAccessibleContext</method> for these children returns
  74                 an object that supports one of the following services.
  75                 <ul>
  76                     <li><type scope="::com::sun::star::text"
  77                         >AccessibleParagraphView</type>:
  78                         A child of this kind is returned for every paragraph
  79                         fragment that is contained in the document body and
  80                         is at least partially visible. A paragraph fragment is
  81                         the part of a paragraph that is displayed on a
  82                         certain page.
  83                     <li><type scope="::com::sun::star::table"
  84                         >AccessibleTableView</type>:
  85                         A child of this kind is returned for every table
  86                         fragment that is contained in the document body
  87                         and is at least partially visible. A table fragment is
  88                         the part of a table that is displayed on a certain page.
  89                 </ul>
  90                 <p>The logical order of paragraph and table fragments is never
  91                    changed.
  92             <li>The role is <const scope="::com::sun::star::accessibility"
  93                 >AccessibleRole::FOOTNOTE</const>
  94             <li>The name is "footnote" (or the equivalent term
  95                 in application's language) with a number appended.
  96             <li>The description is footnote" (or the equivalent term
  97                 in application's language) with the footnote number or
  98                 character appended in the format that is specified in the
  99                 footnote settings.
 100             <li>There are no relations. <em>TODO: One might specify a relation
 101                 to the footnote anchor's paragraph.</em>
 102             <li>The following states might be contained in the state set
 103                 returned by <method scope="::com::sun::star::accessibility"
 104                 >XAccessible::getAccessibleStateSet</type>:
 105                 <ul>
 106                     <li><const scope="::com::sun::star::accessibility"
 107                         >AccessibleStateType::DEFUNC</const> (indicates that
 108                         the document window has been closed or the footnote is
 109                         not existing any longer)
 110                     <li><const scope="::com::sun::star::accessibility"
 111                         >AccessibleStateType::EDITABLE</const>
 112                     <li><const scope="::com::sun::star::accessibility"
 113                         >AccessibleStateType::ENABLED</const> (always contained)
 114                     <li><const scope="::com::sun::star::accessibility"
 115                         >AccessibleStateType::OPAQUE</const>
 116                     <li><const scope="::com::sun::star::accessibility"
 117                         >AccessibleStateType::SHOWING</const>
 118                     <li><const scope="::com::sun::star::accessibility"
 119                         >AccessibleStateType::VISIBLE</const>
 120                 </ul>
 121             <li>Depending of the application's region setting, the locale is
 122                 the western, asian or complex default language of the document.
 123         </ul>
 124
 125      */
 126     interface ::com::sun::star::accessibility::XAccessibleContext;
 127
 128     /** This interface describes the graphical representation of a
 129           footnote.
 130      */
 131     interface ::com::sun::star::accessibility::XAccessibleComponent;
 132
 133     /** This is the interface for listeners */
 134     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 135 };
 136
 137 //=============================================================================
 138
 139 }; }; }; };
 140
 141 #endif