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