1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_sheet_AccessiblePageHeaderFooterAreasView_idl__ 28#define __com_sun_star_sheet_AccessiblePageHeaderFooterAreasView_idl__ 29 30#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__ 31#include <com/sun/star/accessibility/XAccessibleContext.idl> 32#endif 33 34#ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__ 35#include <com/sun/star/accessibility/XAccessibleComponent.idl> 36#endif 37 38#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__ 39#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl> 40#endif 41 42//============================================================================= 43 44module com { module sun { module star { module sheet { 45 46//============================================================================= 47 48/** The accessible view of the Header/Footer in a spreadsheet page preview 49 50 @since OOo 1.1.2 51 52 */ 53published service AccessiblePageHeaderFooterAreasView 54{ 55 /** This interface gives access to the three Header/Footer areas in the 56 page preview. 57 58 <ul> 59 <li>The parent returned by <method scope="::com::sun::star::accessibility" 60 >XAccessibleContext::getAccessibleParent</method> 61 is the accessible spreadsheet page preview.</li> 62 <li>The children returned by 63 <method scope="::com::sun::star::accessibility" 64 >XAccessibleContext::getAccessibleChild</method> all 65 support the interface 66 <type scope="::com::sun::star::accessibility">XAccessible</type. 67 Calling 68 <method scope="::com::sun::star::accessibility" 69 >XAccessible::getAccessibleContext</method> for these children 70 returns an object that supports one of the following services.</li> 71 <ul> 72 <li><type scope="::com::sun::star::text">AccessibleHeaderFooterView</type>: 73 A child where calling <method scope="::com::sun::star::text" 74 >XAccessibleContext::getAccessibleChild</method> 75 an object that supports this service is returned for 76 every header and footer that is at least partially visible.</li> 77 </ul> 78 <p>The following rules apply to the children order.</p> 79 <ul> 80 <li>The first is the left area, than the centre area and the last 81 is the right area.</li> 82 </ul> 83 <li>The description is ???.</li> 84 <li>The name is Header or Footer respectively.</li> 85 <li>The role is <const scope="::com::sun::star::accessibility" 86 >AccessibleRole::HEADER</const> or 87 <const scope="::com::sun::star::accessibility" 88 >AccessibleRole::FOOTER</const>.</li> 89 <li>There are no relations.</li> 90 <li>The following states are supported: 91 <ul> 92 <li><const scope="::com::sun::star::accessibility" 93 >AccessibleStateType::DEFUNC</const> is always false until 94 the preview is closed.</li> 95 <li><const scope="::com::sun::star::accessibility" 96 >AccessibleStateType::EDITABLE</const> is always false, 97 because the document is not editable in the page preview. 98 So it is left out of the list.</li> 99 <li><const scope="::com::sun::star::accessibility" 100 >AccessibleStateType::ENABLED</const> is always true.</li> 101 <li><const scope="::com::sun::star::accessibility" 102 >AccessibleStateType::MULTILINE</const> makes no sense on 103 a document and so it is left out of the list.</li> 104 <li><const scope="::com::sun::star::accessibility" 105 >AccessibleStateType::MULTISELECTABLE</const> is always 106 false, because in a page preview a selection is not 107 possible. So it is left out of the list.</li> 108 <li><const scope="::com::sun::star::accessibility" 109 >AccessibleStateType::OPAQUE</const> is always true.</li> 110 <li><const scope="::com::sun::star::accessibility" 111 >AccessibleStateType::RESIZEABLE</const> is always false, 112 because you can resize the window of the page preview, but 113 not the page preview itself. So it is left out of the 114 list.</li> 115 <li><const scope="::com::sun::star::accessibility" 116 >AccessibleStateType::SELECTABLE</const> is always false, 117 because in the page preview is no selection possible. So it 118 is left out of the list.</li> 119 <li><const scope="::com::sun::star::accessibility" 120 >AccessibleStateType::SELECTED</const> is always false, 121 because in the page preview is no selection possible. So it 122 is left out of the list.</li> 123 <li><const scope="::com::sun::star::accessibility" 124 >AccessibleStateType::SHOWING</const>Is true if the 125 Bounding Box lies in the Bounding Box of the parent. 126 Otherwise it is false.</li> 127 <li><const scope="::com::sun::star::accessibility" 128 >AccessibleStateType::VISIBLE</const>Is always true.</li> 129 </ul> 130 </li> 131 </ul> 132 133 */ 134 interface ::com::sun::star::accessibility::XAccessibleContext; 135 136 /** This interface gives access to the visibility of the document. 137 */ 138 interface ::com::sun::star::accessibility::XAccessibleComponent; 139 140 /** This is the interface for listeners */ 141 interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; 142}; 143 144//============================================================================= 145 146}; }; }; }; 147 148#endif 149