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_AccessibleTextFrameView_idl__ 24cdf0e10cSrcweir#define __com_sun_star_text_AccessibleTextFrameView_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 35cdf0e10cSrcweir#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__ 36cdf0e10cSrcweir#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl> 37cdf0e10cSrcweir#endif 38cdf0e10cSrcweir 39cdf0e10cSrcweir//============================================================================= 40cdf0e10cSrcweir 41cdf0e10cSrcweirmodule com { module sun { module star { module text { 42cdf0e10cSrcweir 43cdf0e10cSrcweir//============================================================================= 44cdf0e10cSrcweir 45cdf0e10cSrcweir/** The accessible view of text frames. 46cdf0e10cSrcweir 47*2a413f17SJürgen Schmidt @since OpenOffice 1.1.2 48cdf0e10cSrcweir */ 49cdf0e10cSrcweirpublished service AccessibleTextFrameView 50cdf0e10cSrcweir{ 51cdf0e10cSrcweir /** This interface gives access to any paragraph fragment and table 52cdf0e10cSrcweir fragment that is contained in a text frame and at least 53cdf0e10cSrcweir partially visible on the screen. 54cdf0e10cSrcweir 55cdf0e10cSrcweir <ul> 56cdf0e10cSrcweir <li>The parent returned by 57cdf0e10cSrcweir <method scope="::com::sun::star::accessibility" 58cdf0e10cSrcweir >XAccessibleContext::getAccessibleParent</type> is the 59cdf0e10cSrcweir accessible view of a paragraph if the text frame is bound as 60cdf0e10cSrcweir character, and the accessible view (or of a page in the page 61cdf0e10cSrcweir preview) of the document in any other case. 62cdf0e10cSrcweir <li>The children returned by 63cdf0e10cSrcweir <method scope="::com::sun::star::accessibility" 64cdf0e10cSrcweir >XAccessibleContext::getAccessibleChild</type> all support the 65cdf0e10cSrcweir interface XAccessible. Calling 66cdf0e10cSrcweir <method scope="::com::sun::star::accessibility" 67cdf0e10cSrcweir >XAccessible::getAccessibleContext</type> for these children 68cdf0e10cSrcweir returns an object that supports one of the following 69cdf0e10cSrcweir services. 70cdf0e10cSrcweir <ul> 71cdf0e10cSrcweir <li><type scope="::com::sun::star::text" 72cdf0e10cSrcweir >AccessibleParagraphView</type>: A child of this 73cdf0e10cSrcweir kind is returned for every paragraph fragment that 74cdf0e10cSrcweir is contained in the document body and is at least 75cdf0e10cSrcweir partially visible. A paragraph fragment is the part 76cdf0e10cSrcweir of a paragraph that is displayed on a certain page 77cdf0e10cSrcweir or a certain column. 78cdf0e10cSrcweir <li><type scope="::com::sun::star::table" 79cdf0e10cSrcweir >AccessibleTableView</type>: A child of this kind is 80cdf0e10cSrcweir returned for every table fragment that is contained 81cdf0e10cSrcweir in the document body and is at least partially 82cdf0e10cSrcweir visible. A table fragment is the part of a table 83cdf0e10cSrcweir that is displayed on a certain page or a certain 84cdf0e10cSrcweir column. 85cdf0e10cSrcweir </ul> 86cdf0e10cSrcweir <p>The logical order of paragraph and table fragments is never 87cdf0e10cSrcweir changed. 88cdf0e10cSrcweir <li>The role is <const scope="::com::sun::star::accessibility" 89cdf0e10cSrcweir >AccessibleRole::TEXT_FRAME</const> 90cdf0e10cSrcweir <li>The name is the one assigned to the text frame in the text 91cdf0e10cSrcweir document. This means that it is not internationalized. 92cdf0e10cSrcweir <li>The description is the one assigned to the text frame in the 93cdf0e10cSrcweir text document. This means that it is not internationalized. If 94cdf0e10cSrcweir no description has been set, the description equals the name. 95cdf0e10cSrcweir <li>There are no relations. 96cdf0e10cSrcweir <li>The following states might be contained in the state set 97cdf0e10cSrcweir returned by <method scope="::com::sun::star::accessibility" 98cdf0e10cSrcweir >XAccessibleContext::getAccessibleStateSet</method>: 99cdf0e10cSrcweir <ul> 100cdf0e10cSrcweir <li><const scope="::com::sun::star::accessibility" 101cdf0e10cSrcweir >AccessibleStateType::DEFUNC</const> (indicates that 102cdf0e10cSrcweir the document window has been closed or the graphic 103cdf0e10cSrcweir is not existing any longer) 104cdf0e10cSrcweir <li><const scope="::com::sun::star::accessibility" 105cdf0e10cSrcweir >AccessibleStateType::EDITABLE</const> 106cdf0e10cSrcweir <li><const scope="::com::sun::star::accessibility" 107cdf0e10cSrcweir >AccessibleStateType::ENABLED</const> (always 108cdf0e10cSrcweir contained) 109cdf0e10cSrcweir <li><const scope="::com::sun::star::accessibility" 110cdf0e10cSrcweir >AccessibleStateType::OPAQUE</const> 111cdf0e10cSrcweir <li><const scope="::com::sun::star::accessibility" 112cdf0e10cSrcweir >AccessibleStateType::SELECTABLE</const> 113cdf0e10cSrcweir <li><const scope="::com::sun::star::accessibility" 114cdf0e10cSrcweir >AccessibleStateType::SELECTED</const> 115cdf0e10cSrcweir <li><const scope="::com::sun::star::accessibility" 116cdf0e10cSrcweir >AccessibleStateType::FOCUSABLE</const> 117cdf0e10cSrcweir <li><const scope="::com::sun::star::accessibility" 118cdf0e10cSrcweir >AccessibleStateType::FOCUSED</const> 119cdf0e10cSrcweir <li><const scope="::com::sun::star::accessibility" 120cdf0e10cSrcweir >AccessibleStateType::SHOWING</const> 121cdf0e10cSrcweir <li><const scope="::com::sun::star::accessibility" 122cdf0e10cSrcweir >AccessibleStateType::VISIBLE</const> 123cdf0e10cSrcweir </ul> 124cdf0e10cSrcweir <li>The locale is the one the text document itself. 125cdf0e10cSrcweir <li>There are the two relations CONTENT_FLOWS_FROM and 126cdf0e10cSrcweir CONTENT_FLOWS_TO supported. 127cdf0e10cSrcweir </ul> 128cdf0e10cSrcweir 129cdf0e10cSrcweir */ 130cdf0e10cSrcweir interface ::com::sun::star::accessibility::XAccessibleContext; 131cdf0e10cSrcweir 132cdf0e10cSrcweir /** This interface describes the graphical representation of a 133cdf0e10cSrcweir text frame. 134cdf0e10cSrcweir */ 135cdf0e10cSrcweir interface ::com::sun::star::accessibility::XAccessibleComponent; 136cdf0e10cSrcweir 137cdf0e10cSrcweir /** This is the interface for listeners */ 138cdf0e10cSrcweir interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; 139cdf0e10cSrcweir}; 140cdf0e10cSrcweir 141cdf0e10cSrcweir//============================================================================= 142cdf0e10cSrcweir 143cdf0e10cSrcweir}; }; }; }; 144cdf0e10cSrcweir 145cdf0e10cSrcweir#endif 146