offapi/com/sun/star/text/AccessiblePageView.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: AccessiblePageView.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_AccessibleEndnoteView_idl__
  31 #define __com_sun_star_text_AccessibleEndnoteView_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 pagees.
  53
  54
  55      @since OOo 1.1.2
  56  */
  57 published service AccessiblePageView
  58 {
  59     /** This interface gives access to any page that is visible in the
  60           page preview of a text document.
  61
  62         <ul>
  63             <li>The parent returned by
  64                 <method scope="::com::sun::star::accessibility"
  65                 >XAccessibleContext::getAccessibleParent</method> is the
  66                 accessible page preview of a text document.  That is, the
  67                 object returned by
  68                 <method scope="::com::sun::star::accessibility"
  69                 >XAccessible::getAccessibleContext</method> supports
  70                 <type scope="::com::sun::star::text"
  71                 >AccessibleTextDocumentPageView</type>.
  72             <li>The children returned by
  73                 <method scope="::com::sun::star::accessibility"
  74                 >XAccessibleContext::getAccessibleChild</method> all
  75                 support the interface XAccessible. Calling
  76                 <method scope="::com::sun::star::accessibility"
  77                 >XAccessible::getAccessibleContext</method> for these
  78                 children returns an object that supports one of the
  79                 following services.
  80                 <ul>
  81                     <li><type scope="::com::sun::star::text"
  82                         >AccessibleHeaderFooterView</type>:
  83                         A child of this kind is returned for every header
  84                         and footer that is conatined in the page.
  85                     <li><type scope="::com::sun::star::text"
  86                         >AccessibleFootnoteView</type>:
  87                         A child of this kind is returned for every footnote
  88                         that is conatined in the page.
  89                     <li><type scope="::com::sun::star::text"
  90                         >AccessibleEndnoteView</type>:
  91                         A child of this kind is returned for every endnote
  92                         that is conatined in the page.
  93                     <li><type scope="::com::sun::star::text"
  94                         >AccessibleParagraphView</type>:
  95                         A child of this kind is returned for every paragraph
  96                         fragment that is contained in the page.
  97                         A paragraph fragment is the part of a paragraph that
  98                         is displayed on a certain page.
  99                     <li><type scope="::com::sun::star::table"
 100                         >AccessibleTableView</type>:
 101                         A child of this kind is returned for every table
 102                         fragment that is contained in the page.
 103                         A table fragment is the part of a table that is
 104                         displayed on a certain page.
 105                     <li><type scope="::com::sun::star::text"
 106                         >AccessibleTextFrameView</type>:
 107                         A child of this kind is returned for every text
 108                         frame that is conrtained in the page. These objects
 109                         are children of the <type>AccessiblePageView</type>
 110                         regardless whether they are bound to the page, a
 111                         paragarph, a frame, or a character. The only
 112                         exception are text frames that are bound as
 113                         character.  They are childen of the paragraph they
 114                         are contained in.
 115                     <li><type scope="::com::sun::star::text"
 116                         >AccessibleTextGraphicObject</type>:
 117                         A child of this kind is returned for every graphic that
 118                         is contained in the page. These objects are
 119                         children of the <type>AccessiblePageView</type>
 120                         regardless whether they are bound to a page, paragraph,
 121                         a frame or a character. The only exception
 122                         are text frames that are bound as character. They are
 123                         childen of the paragraph they are contained in.
 124                     <li><type scope="::com::sun::star::text"
 125                         >AccessibleTextEmbeddedObject</type>:
 126                         A child of this kind is returned for every embedded
 127                         object that is conatained in the page.
 128                         These objects are children of the
 129                         <type>AccessibleTextDocumentView</type> regardless
 130                         whether they are bound to a page, a paragarph, a frame,
 131                         or a character.  They are childen of the paragraph they
 132                         are contained in.
 133                     <li><type scope="::com::sun::star::drawing"
 134                         >AccessibleShape</type>:
 135                         A child of this kind (or one of its derived
 136                         interfaces) is returned for every shape that is
 137                         contained in the page. These objects are children of
 138                         the <type>AccessibleTextDocumentView</type>
 139                         regardless whether they are bound to a page, a
 140                         paragraph, a frame or a character.
 141                 </ul>
 142                 <p>The following rules apply to the children order:
 143                 <ul>
 144                     <li>The logical order of paragraph and table fragments is
 145                         never changed.
 146                     <li>Headers appear immediately before the first paragraph or
 147                         table fragment of the header's page.
 148                     <li>Footnotes appear immediately after the last paragraph or
 149                         table fragment of the footnote's page. The logical order
 150                         of footnotes isn't changed.
 151                     <li>Endnotes appear immediately after the last footnote of
 152                         the endnote's page or after the last paragraph or
 153                         table fragment of this page if there are no footnotes.
 154                         The logical order of endnotes isn't changed.
 155                     <li>Footers appear immediately after the last endnote,
 156                         footnote, paragraph or table fragment of the footer's
 157                         page.
 158                     <li>Text frames, graphics, embedded objects and shapes that
 159                         are painted in the background appear before any other
 160                         children. Their order reflects the z order.
 161                     <li>Text frames, graphics, embedded objects and shapes
 162                         that are painted in the foreground appear behind any
 163                            other children. Their order reflects the z order,
 164                         with the exception of controls that appear really last,
 165                         but also keep the z order.
 166                 </ul>
 167             <li>The role is <const scope="::com::sun::star::accessibility"
 168                 >AccessibleRole::PANEL</const>
 169             <li>The name is "page" (or the equivalent term
 170                 in application's language) with a number appended.
 171             <li>The description is "page" (or the equivalent term
 172                 in application's language) with the page number or
 173                 character appended in the format that is specified in the
 174                 page style.
 175             <li>There are no relations.</li>
 176             <li>The following states might be contained in the state set
 177                 returned by <method scope="::com::sun::star::accessibility"
 178                 >XAccessibleContext::getAccessibleStateSet</method>:
 179                 <ul>
 180                     <li><const scope="::com::sun::star::accessibility"
 181                         >AccessibleStateType::DEFUNC</const> (indicates that
 182                         the document window has been closed or the endnote
 183                         is not existing any longer)</li>
 184                     <li><const scope="::com::sun::star::accessibility"
 185                         >AccessibleStateType::ENABLED</const> (always
 186                         contained)</li>
 187                     <li><const scope="::com::sun::star::accessibility"
 188                         >AccessibleStateType::OPAQUE</const>
 189                     <li><const scope="::com::sun::star::accessibility"
 190                         >AccessibleStateType::FOCUSABLE</const>
 191                     <li><const scope="::com::sun::star::accessibility"
 192                         >AccessibleStateType::FOCUSED</const>
 193                     <li><const scope="::com::sun::star::accessibility"
 194                         >AccessibleStateType::SHOWING</const>
 195                     <li><const scope="::com::sun::star::accessibility"
 196                         >AccessibleStateType::VISIBLE</const>
 197                 </ul>
 198             <li>The locale is the application's locale.
 199         </ul>
 200
 201      */
 202     interface ::com::sun::star::accessibility::XAccessibleContext;
 203
 204     /** This interface describes the graphical representation of a
 205           endnote.
 206      */
 207     interface ::com::sun::star::accessibility::XAccessibleComponent;
 208
 209     /** This is the interface for listeners */
 210     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 211 };
 212
 213 //=============================================================================
 214
 215 }; }; }; };
 216
 217 #endif