offapi/com/sun/star/text/AccessibleHeaderFooterView.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: AccessibleHeaderFooterView.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_AccessibleHeaderFooterView_idl__
  31 #define __com_sun_star_text_AccessibleHeaderFooterView_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 headers and footers.
  53
  54      @since OOo 1.1.2
  55
  56  */
  57 published service AccessibleHeaderFooterView
  58 {
  59     /** This interface gives access to any paragraph and table that is
  60           contained in the header and footer and is at least partially visible
  61         on the screen.
  62
  63         <ul>
  64             <li>The parent returned by
  65                 <method scope="::com::sun::star::accessibility"
  66                 >XAccessibleContext::getAccessibleParent</method>
  67                 is either the accessible view of a text document,
  68                 a page of the accessible page preview of a text document,
  69                 or the accessible page preview of a spreadsheet document.
  70             <li>The children returned by
  71                 <method scope="::com::sun::star::accessibility"
  72                 >XAccessibleContext::getAccessibleChild</method> all
  73                 support the interface XAccessible. Calling
  74                 <method scope="::com::sun::star::accessibility"
  75                 >XAccessible::getAccessibleContext</method> for these children returns
  76                 an object that supports one of the following services.
  77                 <ul>
  78                     <li><type scope="::com::sun::star::text"
  79                         >AccessibleParagraphView</type>:
  80                         A child of this kind is returned for every paragraph
  81                         that is contained in the document body and
  82                         is at least partially visible. The child always
  83                         represents a whole paragarph (and not a fragment only),
  84                         because there are no page breaks within headers and
  85                         footers.
  86                     <li><type scope="::com::sun::star::table"
  87                         >AccessibleTableView</type>:
  88                         A child of this kind is returned for every table
  89                         that is contained in the document body
  90                         and is at least partially visible. The child always
  91                         represents a whole table (and not a fragment only),
  92                         because there are no page breaks within headers and
  93                         footers.
  94                 </ul>
  95             <p>The logical order of paragraphs and tables is never changed.
  96             <li>The role is either
  97                 <const scope="::com::sun::star::accessibility"
  98                 >AccessibleRole::HEADER</const> or
  99                 <const scope="::com::sun::star::accessibility"
 100                 >AccessibleRole::FOOTER</const>.
 101             <li>The name is "header" or "footer" (or the equivalent term
 102                 in application's language) with a number appended.
 103             <li>The description is "header" or "footer" (or the equivalent term
 104                 in application's language) with the page number appended in
 105                 the format that is specified in the page's style.
 106             <li>There are no relations.
 107             <li>The following states might be contained in the state set
 108                 returned by <method scope="::com::sun::star::accessibility"
 109                 >XAccessible::getAccessibleStateSet</type>:
 110                 <ul>
 111                     <li><const scope="::com::sun::star::accessibility"
 112                         >AccessibleStateType::DEFUNC</const> (indicates that
 113                         the document window has been closed or the header or
 114                         footer is not existing any longer)
 115                     <li><const scope="::com::sun::star::accessibility"
 116                         >AccessibleStateType::EDITABLE</const>
 117                     <li><const scope="::com::sun::star::accessibility"
 118                         >AccessibleStateType::ENABLED</const> (always contained)
 119                     <li><const scope="::com::sun::star::accessibility"
 120                         >AccessibleStateType::OPAQUE</const>
 121                     <li><const scope="::com::sun::star::accessibility"
 122                         >AccessibleStateType::SHOWING</const>
 123                     <li><const scope="::com::sun::star::accessibility"
 124                         >AccessibleStateType::VISIBLE</const>
 125                 </ul>
 126             <li>Depending of the application's region setting, the locale is
 127                 the western, asian or complex default language of the document.
 128         </ul>
 129
 130      */
 131     interface ::com::sun::star::accessibility::XAccessibleContext;
 132
 133     /** This interface describes the graphical representation of a header
 134           or footer.
 135      */
 136     interface ::com::sun::star::accessibility::XAccessibleComponent;
 137
 138     /** This is the interface for listeners */
 139     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 140 };
 141
 142 //=============================================================================
 143
 144 }; }; }; };
 145
 146 #endif