offapi/com/sun/star/sheet/AccessiblePageHeaderFooterAreasView.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: AccessiblePageHeaderFooterAreasView.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_sheet_AccessiblePageHeaderFooterAreasView_idl__
  31 #define __com_sun_star_sheet_AccessiblePageHeaderFooterAreasView_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 module com {  module sun {  module star {  module sheet {
  48
  49 //=============================================================================
  50
  51 /** The accessible view of the Header/Footer in a spreadsheet page preview
  52
  53      @since OOo 1.1.2
  54
  55  */
  56 published service AccessiblePageHeaderFooterAreasView
  57 {
  58     /** This interface gives access to the three Header/Footer areas in the
  59         page preview.
  60
  61     <ul>
  62         <li>The parent returned by <method scope="::com::sun::star::accessibility"
  63             >XAccessibleContext::getAccessibleParent</method>
  64             is the accessible spreadsheet page preview.</li>
  65         <li>The children returned by
  66             <method scope="::com::sun::star::accessibility"
  67             >XAccessibleContext::getAccessibleChild</method> all
  68             support the interface
  69             <type scope="::com::sun::star::accessibility">XAccessible</type.
  70             Calling
  71             <method scope="::com::sun::star::accessibility"
  72             >XAccessible::getAccessibleContext</method> for these children
  73             returns an object that supports one of the following services.</li>
  74         <ul>
  75             <li><type scope="::com::sun::star::text">AccessibleHeaderFooterView</type>:
  76                 A child where calling <method scope="::com::sun::star::text"
  77                 >XAccessibleContext::getAccessibleChild</method>
  78                 an object that supports this service is returned for
  79                 every header and footer that is at least partially visible.</li>
  80         </ul>
  81         <p>The following rules apply to the children order.</p>
  82         <ul>
  83             <li>The first is the left area, than the centre area and the last
  84             is the right area.</li>
  85         </ul>
  86         <li>The description is ???.</li>
  87         <li>The name is Header or Footer respectively.</li>
  88         <li>The role is <const scope="::com::sun::star::accessibility"
  89             >AccessibleRole::HEADER</const> or
  90             <const scope="::com::sun::star::accessibility"
  91             >AccessibleRole::FOOTER</const>.</li>
  92         <li>There are no relations.</li>
  93         <li>The following states are supported:
  94             <ul>
  95                 <li><const scope="::com::sun::star::accessibility"
  96                     >AccessibleStateType::DEFUNC</const> is always false until
  97                     the preview is closed.</li>
  98                 <li><const scope="::com::sun::star::accessibility"
  99                     >AccessibleStateType::EDITABLE</const> is always false,
 100                     because the document is not editable in the page preview.
 101                     So it is left out of the list.</li>
 102                 <li><const scope="::com::sun::star::accessibility"
 103                     >AccessibleStateType::ENABLED</const> is always true.</li>
 104                 <li><const scope="::com::sun::star::accessibility"
 105                     >AccessibleStateType::MULTILINE</const> makes no sense on
 106                     a document and so it is left out of the list.</li>
 107                 <li><const scope="::com::sun::star::accessibility"
 108                     >AccessibleStateType::MULTISELECTABLE</const> is always
 109                     false, because in a page preview a selection is not
 110                     possible. So it is left out of the list.</li>
 111                 <li><const scope="::com::sun::star::accessibility"
 112                     >AccessibleStateType::OPAQUE</const> is always true.</li>
 113                 <li><const scope="::com::sun::star::accessibility"
 114                     >AccessibleStateType::RESIZEABLE</const> is always false,
 115                     because you can resize the window of the page preview, but
 116                     not the page preview itself. So it is left out of the
 117                     list.</li>
 118                 <li><const scope="::com::sun::star::accessibility"
 119                     >AccessibleStateType::SELECTABLE</const> is always false,
 120                     because in the page preview is no selection possible. So it
 121                     is left out of the list.</li>
 122                 <li><const scope="::com::sun::star::accessibility"
 123                     >AccessibleStateType::SELECTED</const> is always false,
 124                     because in the page preview is no selection possible. So it
 125                     is left out of the list.</li>
 126                 <li><const scope="::com::sun::star::accessibility"
 127                     >AccessibleStateType::SHOWING</const>Is true if the
 128                     Bounding Box lies in the Bounding Box of the parent.
 129                     Otherwise it is false.</li>
 130                 <li><const scope="::com::sun::star::accessibility"
 131                     >AccessibleStateType::VISIBLE</const>Is always true.</li>
 132             </ul>
 133         </li>
 134     </ul>
 135
 136      */
 137     interface ::com::sun::star::accessibility::XAccessibleContext;
 138
 139     /** This interface gives access to the visibility of the document.
 140     */
 141     interface ::com::sun::star::accessibility::XAccessibleComponent;
 142
 143     /** This is the interface for listeners */
 144     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 145 };
 146
 147 //=============================================================================
 148
 149 }; }; }; };
 150
 151 #endif