1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_text_AccessibleHeaderFooterView_idl__ 24cdf0e10cSrcweir#define __com_sun_star_text_AccessibleHeaderFooterView_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__ 27cdf0e10cSrcweir#include <com/sun/star/accessibility/XAccessibleContext.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__ 31cdf0e10cSrcweir#include <com/sun/star/accessibility/XAccessibleComponent.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__ 35cdf0e10cSrcweir#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir 39cdf0e10cSrcweir//============================================================================= 40cdf0e10cSrcweir 41cdf0e10cSrcweirmodule com { module sun { module star { module text { 42cdf0e10cSrcweir 43cdf0e10cSrcweir//============================================================================= 44cdf0e10cSrcweir 45cdf0e10cSrcweir/** The accessible view of headers and footers. 46cdf0e10cSrcweir 47*2a413f17SJürgen Schmidt @since OpenOffice 1.1.2 48cdf0e10cSrcweir 49cdf0e10cSrcweir */ 50cdf0e10cSrcweirpublished service AccessibleHeaderFooterView 51cdf0e10cSrcweir{ 52cdf0e10cSrcweir /** This interface gives access to any paragraph and table that is 53cdf0e10cSrcweir contained in the header and footer and is at least partially visible 54cdf0e10cSrcweir on the screen. 55cdf0e10cSrcweir 56cdf0e10cSrcweir <ul> 57cdf0e10cSrcweir <li>The parent returned by 58cdf0e10cSrcweir <method scope="::com::sun::star::accessibility" 59cdf0e10cSrcweir >XAccessibleContext::getAccessibleParent</method> 60cdf0e10cSrcweir is either the accessible view of a text document, 61cdf0e10cSrcweir a page of the accessible page preview of a text document, 62cdf0e10cSrcweir or the accessible page preview of a spreadsheet document. 63cdf0e10cSrcweir <li>The children returned by 64cdf0e10cSrcweir <method scope="::com::sun::star::accessibility" 65cdf0e10cSrcweir >XAccessibleContext::getAccessibleChild</method> all 66cdf0e10cSrcweir support the interface XAccessible. Calling 67cdf0e10cSrcweir <method scope="::com::sun::star::accessibility" 68cdf0e10cSrcweir >XAccessible::getAccessibleContext</method> for these children returns 69cdf0e10cSrcweir an object that supports one of the following services. 70cdf0e10cSrcweir <ul> 71cdf0e10cSrcweir <li><type scope="::com::sun::star::text" 72cdf0e10cSrcweir >AccessibleParagraphView</type>: 73cdf0e10cSrcweir A child of this kind is returned for every paragraph 74cdf0e10cSrcweir that is contained in the document body and 75cdf0e10cSrcweir is at least partially visible. The child always 76cdf0e10cSrcweir represents a whole paragarph (and not a fragment only), 77cdf0e10cSrcweir because there are no page breaks within headers and 78cdf0e10cSrcweir footers. 79cdf0e10cSrcweir <li><type scope="::com::sun::star::table" 80cdf0e10cSrcweir >AccessibleTableView</type>: 81cdf0e10cSrcweir A child of this kind is returned for every table 82cdf0e10cSrcweir that is contained in the document body 83cdf0e10cSrcweir and is at least partially visible. The child always 84cdf0e10cSrcweir represents a whole table (and not a fragment only), 85cdf0e10cSrcweir because there are no page breaks within headers and 86cdf0e10cSrcweir footers. 87cdf0e10cSrcweir </ul> 88cdf0e10cSrcweir <p>The logical order of paragraphs and tables is never changed. 89cdf0e10cSrcweir <li>The role is either 90cdf0e10cSrcweir <const scope="::com::sun::star::accessibility" 91cdf0e10cSrcweir >AccessibleRole::HEADER</const> or 92cdf0e10cSrcweir <const scope="::com::sun::star::accessibility" 93cdf0e10cSrcweir >AccessibleRole::FOOTER</const>. 94cdf0e10cSrcweir <li>The name is "header" or "footer" (or the equivalent term 95cdf0e10cSrcweir in application's language) with a number appended. 96cdf0e10cSrcweir <li>The description is "header" or "footer" (or the equivalent term 97cdf0e10cSrcweir in application's language) with the page number appended in 98cdf0e10cSrcweir the format that is specified in the page's style. 99cdf0e10cSrcweir <li>There are no relations. 100cdf0e10cSrcweir <li>The following states might be contained in the state set 101cdf0e10cSrcweir returned by <method scope="::com::sun::star::accessibility" 102cdf0e10cSrcweir >XAccessible::getAccessibleStateSet</type>: 103cdf0e10cSrcweir <ul> 104cdf0e10cSrcweir <li><const scope="::com::sun::star::accessibility" 105cdf0e10cSrcweir >AccessibleStateType::DEFUNC</const> (indicates that 106cdf0e10cSrcweir the document window has been closed or the header or 107cdf0e10cSrcweir footer is not existing any longer) 108cdf0e10cSrcweir <li><const scope="::com::sun::star::accessibility" 109cdf0e10cSrcweir >AccessibleStateType::EDITABLE</const> 110cdf0e10cSrcweir <li><const scope="::com::sun::star::accessibility" 111cdf0e10cSrcweir >AccessibleStateType::ENABLED</const> (always contained) 112cdf0e10cSrcweir <li><const scope="::com::sun::star::accessibility" 113cdf0e10cSrcweir >AccessibleStateType::OPAQUE</const> 114cdf0e10cSrcweir <li><const scope="::com::sun::star::accessibility" 115cdf0e10cSrcweir >AccessibleStateType::SHOWING</const> 116cdf0e10cSrcweir <li><const scope="::com::sun::star::accessibility" 117cdf0e10cSrcweir >AccessibleStateType::VISIBLE</const> 118cdf0e10cSrcweir </ul> 119cdf0e10cSrcweir <li>Depending of the application's region setting, the locale is 120cdf0e10cSrcweir the western, asian or complex default language of the document. 121cdf0e10cSrcweir </ul> 122cdf0e10cSrcweir 123cdf0e10cSrcweir */ 124cdf0e10cSrcweir interface ::com::sun::star::accessibility::XAccessibleContext; 125cdf0e10cSrcweir 126cdf0e10cSrcweir /** This interface describes the graphical representation of a header 127cdf0e10cSrcweir or footer. 128cdf0e10cSrcweir */ 129cdf0e10cSrcweir interface ::com::sun::star::accessibility::XAccessibleComponent; 130cdf0e10cSrcweir 131cdf0e10cSrcweir /** This is the interface for listeners */ 132cdf0e10cSrcweir interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; 133cdf0e10cSrcweir}; 134cdf0e10cSrcweir 135cdf0e10cSrcweir//============================================================================= 136cdf0e10cSrcweir 137cdf0e10cSrcweir}; }; }; }; 138cdf0e10cSrcweir 139cdf0e10cSrcweir#endif 140