1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_text_AccessibleTextFrameView_idl__ 28#define __com_sun_star_text_AccessibleTextFrameView_idl__ 29 30#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__ 31#include <com/sun/star/accessibility/XAccessibleContext.idl> 32#endif 33 34#ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__ 35#include <com/sun/star/accessibility/XAccessibleComponent.idl> 36#endif 37 38 39#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__ 40#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl> 41#endif 42 43//============================================================================= 44 45module com { module sun { module star { module text { 46 47//============================================================================= 48 49/** The accessible view of text frames. 50 51 @since OOo 1.1.2 52 */ 53published service AccessibleTextFrameView 54{ 55 /** This interface gives access to any paragraph fragment and table 56 fragment that is contained in a text frame and at least 57 partially visible on the screen. 58 59 <ul> 60 <li>The parent returned by 61 <method scope="::com::sun::star::accessibility" 62 >XAccessibleContext::getAccessibleParent</type> is the 63 accessible view of a paragraph if the text frame is bound as 64 character, and the accessible view (or of a page in the page 65 preview) of the document in any other case. 66 <li>The children returned by 67 <method scope="::com::sun::star::accessibility" 68 >XAccessibleContext::getAccessibleChild</type> all support the 69 interface XAccessible. Calling 70 <method scope="::com::sun::star::accessibility" 71 >XAccessible::getAccessibleContext</type> for these children 72 returns an object that supports one of the following 73 services. 74 <ul> 75 <li><type scope="::com::sun::star::text" 76 >AccessibleParagraphView</type>: A child of this 77 kind is returned for every paragraph fragment that 78 is contained in the document body and is at least 79 partially visible. A paragraph fragment is the part 80 of a paragraph that is displayed on a certain page 81 or a certain column. 82 <li><type scope="::com::sun::star::table" 83 >AccessibleTableView</type>: A child of this kind is 84 returned for every table fragment that is contained 85 in the document body and is at least partially 86 visible. A table fragment is the part of a table 87 that is displayed on a certain page or a certain 88 column. 89 </ul> 90 <p>The logical order of paragraph and table fragments is never 91 changed. 92 <li>The role is <const scope="::com::sun::star::accessibility" 93 >AccessibleRole::TEXT_FRAME</const> 94 <li>The name is the one assigned to the text frame in the text 95 document. This means that it is not internationalized. 96 <li>The description is the one assigned to the text frame in the 97 text document. This means that it is not internationalized. If 98 no description has been set, the description equals the name. 99 <li>There are no relations. 100 <li>The following states might be contained in the state set 101 returned by <method scope="::com::sun::star::accessibility" 102 >XAccessibleContext::getAccessibleStateSet</method>: 103 <ul> 104 <li><const scope="::com::sun::star::accessibility" 105 >AccessibleStateType::DEFUNC</const> (indicates that 106 the document window has been closed or the graphic 107 is not existing any longer) 108 <li><const scope="::com::sun::star::accessibility" 109 >AccessibleStateType::EDITABLE</const> 110 <li><const scope="::com::sun::star::accessibility" 111 >AccessibleStateType::ENABLED</const> (always 112 contained) 113 <li><const scope="::com::sun::star::accessibility" 114 >AccessibleStateType::OPAQUE</const> 115 <li><const scope="::com::sun::star::accessibility" 116 >AccessibleStateType::SELECTABLE</const> 117 <li><const scope="::com::sun::star::accessibility" 118 >AccessibleStateType::SELECTED</const> 119 <li><const scope="::com::sun::star::accessibility" 120 >AccessibleStateType::FOCUSABLE</const> 121 <li><const scope="::com::sun::star::accessibility" 122 >AccessibleStateType::FOCUSED</const> 123 <li><const scope="::com::sun::star::accessibility" 124 >AccessibleStateType::SHOWING</const> 125 <li><const scope="::com::sun::star::accessibility" 126 >AccessibleStateType::VISIBLE</const> 127 </ul> 128 <li>The locale is the one the text document itself. 129 <li>There are the two relations CONTENT_FLOWS_FROM and 130 CONTENT_FLOWS_TO supported. 131 </ul> 132 133 */ 134 interface ::com::sun::star::accessibility::XAccessibleContext; 135 136 /** This interface describes the graphical representation of a 137 text frame. 138 */ 139 interface ::com::sun::star::accessibility::XAccessibleComponent; 140 141 /** This is the interface for listeners */ 142 interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; 143}; 144 145//============================================================================= 146 147}; }; }; }; 148 149#endif 150