1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_sheet_AccessiblePageHeaderFooterAreasView_idl__ 24#define __com_sun_star_sheet_AccessiblePageHeaderFooterAreasView_idl__ 25 26#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__ 27#include <com/sun/star/accessibility/XAccessibleContext.idl> 28#endif 29 30#ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__ 31#include <com/sun/star/accessibility/XAccessibleComponent.idl> 32#endif 33 34#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__ 35#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl> 36#endif 37 38//============================================================================= 39 40module com { module sun { module star { module sheet { 41 42//============================================================================= 43 44/** The accessible view of the Header/Footer in a spreadsheet page preview 45 46 @since OpenOffice 1.1.2 47 48 */ 49published service AccessiblePageHeaderFooterAreasView 50{ 51 /** This interface gives access to the three Header/Footer areas in the 52 page preview. 53 54 <ul> 55 <li>The parent returned by <method scope="::com::sun::star::accessibility" 56 >XAccessibleContext::getAccessibleParent</method> 57 is the accessible spreadsheet page preview.</li> 58 <li>The children returned by 59 <method scope="::com::sun::star::accessibility" 60 >XAccessibleContext::getAccessibleChild</method> all 61 support the interface 62 <type scope="::com::sun::star::accessibility">XAccessible</type. 63 Calling 64 <method scope="::com::sun::star::accessibility" 65 >XAccessible::getAccessibleContext</method> for these children 66 returns an object that supports one of the following services.</li> 67 <ul> 68 <li><type scope="::com::sun::star::text">AccessibleHeaderFooterView</type>: 69 A child where calling <method scope="::com::sun::star::text" 70 >XAccessibleContext::getAccessibleChild</method> 71 an object that supports this service is returned for 72 every header and footer that is at least partially visible.</li> 73 </ul> 74 <p>The following rules apply to the children order.</p> 75 <ul> 76 <li>The first is the left area, than the centre area and the last 77 is the right area.</li> 78 </ul> 79 <li>The description is ???.</li> 80 <li>The name is Header or Footer respectively.</li> 81 <li>The role is <const scope="::com::sun::star::accessibility" 82 >AccessibleRole::HEADER</const> or 83 <const scope="::com::sun::star::accessibility" 84 >AccessibleRole::FOOTER</const>.</li> 85 <li>There are no relations.</li> 86 <li>The following states are supported: 87 <ul> 88 <li><const scope="::com::sun::star::accessibility" 89 >AccessibleStateType::DEFUNC</const> is always false until 90 the preview is closed.</li> 91 <li><const scope="::com::sun::star::accessibility" 92 >AccessibleStateType::EDITABLE</const> is always false, 93 because the document is not editable in the page preview. 94 So it is left out of the list.</li> 95 <li><const scope="::com::sun::star::accessibility" 96 >AccessibleStateType::ENABLED</const> is always true.</li> 97 <li><const scope="::com::sun::star::accessibility" 98 >AccessibleStateType::MULTILINE</const> makes no sense on 99 a document and so it is left out of the list.</li> 100 <li><const scope="::com::sun::star::accessibility" 101 >AccessibleStateType::MULTISELECTABLE</const> is always 102 false, because in a page preview a selection is not 103 possible. So it is left out of the list.</li> 104 <li><const scope="::com::sun::star::accessibility" 105 >AccessibleStateType::OPAQUE</const> is always true.</li> 106 <li><const scope="::com::sun::star::accessibility" 107 >AccessibleStateType::RESIZEABLE</const> is always false, 108 because you can resize the window of the page preview, but 109 not the page preview itself. So it is left out of the 110 list.</li> 111 <li><const scope="::com::sun::star::accessibility" 112 >AccessibleStateType::SELECTABLE</const> is always false, 113 because in the page preview is no selection possible. So it 114 is left out of the list.</li> 115 <li><const scope="::com::sun::star::accessibility" 116 >AccessibleStateType::SELECTED</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::SHOWING</const>Is true if the 121 Bounding Box lies in the Bounding Box of the parent. 122 Otherwise it is false.</li> 123 <li><const scope="::com::sun::star::accessibility" 124 >AccessibleStateType::VISIBLE</const>Is always true.</li> 125 </ul> 126 </li> 127 </ul> 128 129 */ 130 interface ::com::sun::star::accessibility::XAccessibleContext; 131 132 /** This interface gives access to the visibility of the document. 133 */ 134 interface ::com::sun::star::accessibility::XAccessibleComponent; 135 136 /** This is the interface for listeners */ 137 interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; 138}; 139 140//============================================================================= 141 142}; }; }; }; 143 144#endif 145