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_AccessibleSpreadsheetPageView_idl__ 24#define __com_sun_star_sheet_AccessibleSpreadsheetPageView_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 a spreadsheet page preview 45 46 @since OpenOffice 1.1.2 47 48 */ 49published service AccessibleSpreadsheetPageView 50{ 51 /** This interface gives access to any object that is at least partially 52 visible on the screen in the page preview. 53 54 <ul> 55 <li>The parent returned by 56 <method scope="::com::sun::star::accessibility" 57 >XAccessibleContext::getAccessibleParent</method> 58 is the window wich contains the view of these page preview.</li> 59 <li>The children returned by 60 <method scope="::com::sun::star::accessibility" 61 >XAccessibleContext::getAccessibleChild</method> all 62 support the interface XAccessible. Calling 63 <method scope="::com::sun::star::accessibility" 64 >XAccessibleContext::getAccessibleContext</method> for these children returns 65 an object that supports one of the following services.</li> 66 <ul> 67 <li><type scope="::com::sun::star::sheet" 68 >AccessiblePageHeaderFooterAreasView</type>: A child where calling 69 <method scope="::com::sun::star::accessibility" 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 <li><type scope="::com::sun::star::table">AccessibleTableView</type>: 74 A child where calling 75 <method scope="::com::sun::star::accessibility" 76 >XAccessibleChild::getAccessibleChild</method> 77 an object that supports this service is returned for 78 every table fragment that is contained in the document body 79 and is at least partially visible. A table fragment is the 80 part of a table that is displayed on a certain page.</li> 81 <li><type scope="::com::sun::star::drawing">AccessibleShape</type>: 82 A child where calling 83 <method scope="::com::sun::star::accessibility" 84 >XAccessibleContext::getAccessibleChild</method> 85 an object that supports this service is returned 86 for every shape that is at least partially visible. These 87 objects are children of the 88 <type>AccessibleSpreadsheetPageView</type> regardless 89 whether they are bound to a table or a cell.</li> 90 <li><type scope="::com::sun::star::text">AccessibleParagraphView</type>: 91 A child where calling 92 <method scope="::com::sun::star::accessibility" 93 >XAccessibleContext::getAccessibleChild</method> 94 an object that supports this service is returned for 95 every note (its paragraphs) and its location (which is 96 represented as a paragraph with the cell name as content).</li> 97 </ul> 98 <p>The following rules apply to the children order. General it 99 represents the paint order. The object in the background came 100 first and than all over lying objects. The last painted object 101 is also the last child.</p> 102 <ul> 103 <li>The logical order of paragraph and table fragments is never 104 changed.</li> 105 <li>Headers appear immediately before the first table fragment 106 of the header's page.</li> 107 <li>Footers appear immediately after the last table fragment.</li> 108 <li>Shapes appear before any other children if they are painted 109 in the background. Their order reflects the z order.</li> 110 <li>Shapes appear behind any other children except controls if 111 they are painted in the foreground. Their order reflects the 112 z order.</li> 113 <li>Controls appear behind any other objects. Their order 114 reflects the z order.</li> 115 </ul> 116 <li>The description is ???.</li> 117 <li>The name is Spreadsheet Document Page Preview.</li> 118 <li>The role is <const scope="::com::sun::star::accessibility" 119 >AccessibleRole::DOCUMENT</const></li> 120 <li>There are no relations.</li> 121 <li>The following states are supported: 122 <ul> 123 <li><const scope="::com::sun::star::accessibility" 124 >AccessibleStateType::DEFUNC</const> is always false until 125 the preview is closed.</li> 126 <li><const scope="::com::sun::star::accessibility" 127 >AccessibleStateType::EDITABLE</const> is always false, 128 because the document is not editable in the page preview. 129 So it is left out of the list.</li> 130 <li><const scope="::com::sun::star::accessibility" 131 >AccessibleStateType::ENABLED</const> is always true.</li> 132 <li><const scope="::com::sun::star::accessibility" 133 >AccessibleStateType::MULTILINE</const> makes no sense on a 134 document and so it is left out of the list.</li> 135 <li><const scope="::com::sun::star::accessibility" 136 >AccessibleStateType::MULTI_SELECTABLE</const> is always 137 false, because in a page preview a selection is not 138 possible. So it is left out of the list.</li> 139 <li><const scope="::com::sun::star::accessibility" 140 >AccessibleStateType::OPAQUE</const> is always true.</li> 141 <li><const scope="::com::sun::star::accessibility" 142 >AccessibleStateType::RESIZEABLE</const> is always false, 143 because you can resize the window of the page preview, but 144 not the page preview itself. So it is left out of the 145 list.</li> 146 <li><const scope="::com::sun::star::accessibility" 147 >AccessibleStateType::SELECTABLE</const> is always false, 148 because in the page preview is no selection possible. So 149 it is left out of the list.</li> 150 <li><const scope="::com::sun::star::accessibility" 151 >AccessibleStateType::SELECTED</const> is always false, 152 because in the page preview is no selection possible. So 153 it is left out of the list.</li> 154 <li><const scope="::com::sun::star::accessibility" 155 >AccessibleStateType::SHOWING</const>Is true if the 156 Bounding Box lies in the Bounding Box of the parent. 157 Otherwise it is false.</li> 158 <li><const scope="::com::sun::star::accessibility" 159 >AccessibleStateType::VISIBLE</const>Is always true.</li> 160 </ul> 161 </li> 162 </ul> 163 164 */ 165 interface ::com::sun::star::accessibility::XAccessibleContext; 166 167 /** This interface gives access to the visibility of the document. 168 */ 169 interface ::com::sun::star::accessibility::XAccessibleComponent; 170 171 /** This is the interface for listeners */ 172 interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; 173}; 174 175//============================================================================= 176 177}; }; }; }; 178 179#endif 180