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 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_accessibility_XAccessibleMultiLineText_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_accessibility_XAccessibleMultiLineText_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_accessibility_XAccessibleText_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/accessibility/XAccessibleText.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_beans_PropertyValue_idl__ 34*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/PropertyValue.idl> 35*b1cdbd2cSJim Jagielski#endif 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module accessibility { 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski/** Implement this interface to give provide a mapping between text index 40*b1cdbd2cSJim Jagielski and line numbers. 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski <p>This interface is typically used in conjunction with the 43*b1cdbd2cSJim Jagielski <type>XAccessibleText</type> interface and extents it with a notion 44*b1cdbd2cSJim Jagielski of line numbers</p> 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski @since OpenOffice 3.0 47*b1cdbd2cSJim Jagielski*/ 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski/// not yet published 50*b1cdbd2cSJim Jagielskiinterface XAccessibleMultiLineText 51*b1cdbd2cSJim Jagielski : ::com::sun::star::accessibility::XAccessibleText 52*b1cdbd2cSJim Jagielski{ 53*b1cdbd2cSJim Jagielski /** Returns the line number at the specified index. 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski <p>For a text object that is spread over multiple lines, this method 56*b1cdbd2cSJim Jagielski provides a mapping from a text index to the corresponding line number. 57*b1cdbd2cSJim Jagielski </p> 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski @param nIndex 60*b1cdbd2cSJim Jagielski Index for which the line number should be returned. 61*b1cdbd2cSJim Jagielski The valid range is 0..length. 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski @return 64*b1cdbd2cSJim Jagielski Returns the line number of the specified text index. 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IndexOutOfBoundsException 67*b1cdbd2cSJim Jagielski if the index is invalid. 68*b1cdbd2cSJim Jagielski */ 69*b1cdbd2cSJim Jagielski long getLineNumberAtIndex([in] long nIndex) 70*b1cdbd2cSJim Jagielski raises (::com::sun::star::lang::IndexOutOfBoundsException); 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski /** Retuns the text of the specified line. 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski <p>Returns the substring of text that makes up the specified line 75*b1cdbd2cSJim Jagielski number.</p> 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski <p>The number of lines can be obtained by calling 78*b1cdbd2cSJim Jagielski <member>XAccessibleMultiLineText::getLineNumberAtIndex</member> 79*b1cdbd2cSJim Jagielski with the index of the last character. In a loop, the last line 80*b1cdbd2cSJim Jagielski has been reached when <member>TextSegment::SegmentEnd</member> 81*b1cdbd2cSJim Jagielski of the returned value is equal to the index of the last 82*b1cdbd2cSJim Jagielski character of the text.</p> 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski @param nLineNo 85*b1cdbd2cSJim Jagielski The number of the line to return the substring from. 86*b1cdbd2cSJim Jagielski The valid range is 0..getLineNumberAtIndex(getCharacterCount()). 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski @return 89*b1cdbd2cSJim Jagielski Returns the requested text portion. This portion may be empty 90*b1cdbd2cSJim Jagielski or invalid when no appropriate text portion is found. 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IndexOutOfBoundsException 93*b1cdbd2cSJim Jagielski if the line number is invalid 94*b1cdbd2cSJim Jagielski */ 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski TextSegment getTextAtLineNumber([in] long nLineNo) 97*b1cdbd2cSJim Jagielski raises (::com::sun::star::lang::IndexOutOfBoundsException); 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski /** Returns the text of the line in which the caret is located. 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski <p>The substring returned will most of the time be identical to 102*b1cdbd2cSJim Jagielski calling <member>XAccessibleText::getTextAtIndex</member> with 103*b1cdbd2cSJim Jagielski the index returned by <member>XAccessibleText::getCaretPosition</member> 104*b1cdbd2cSJim Jagielski and type <const scope="AccessibleTextType">LINE</type> beside the 105*b1cdbd2cSJim Jagielski following special case:</p> 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski <p>Some text implementations place the caret at the end of the current 108*b1cdbd2cSJim Jagielski line when the <b>End</b> key gets pressed. Since the index of this position 109*b1cdbd2cSJim Jagielski is identical to the one of the first character of the following line, 110*b1cdbd2cSJim Jagielski <member>XAccessibleMultiLineText::getLineNumberAtIndex</member> will 111*b1cdbd2cSJim Jagielski return the line following the current one in this case.</p> 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski @return 114*b1cdbd2cSJim Jagielski Returns the requested text portion. This portion may be empty 115*b1cdbd2cSJim Jagielski or invalid if the paragraph object does not have a valid caret 116*b1cdbd2cSJim Jagielski position. 117*b1cdbd2cSJim Jagielski */ 118*b1cdbd2cSJim Jagielski 119*b1cdbd2cSJim Jagielski TextSegment getTextAtLineWithCaret(); 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski /** Returns the number of the line in which the caret is located. 122*b1cdbd2cSJim Jagielski 123*b1cdbd2cSJim Jagielski <p>The line number returned will most of the time be identical to 124*b1cdbd2cSJim Jagielski calling <member>XAccessibleMultiLineText::getLineNumberAtIndex</member> 125*b1cdbd2cSJim Jagielski with the index returned by <member>XAccessibleText::getCaretPosition</member> 126*b1cdbd2cSJim Jagielski beside the following special case:</p> 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski <p>Some text implementations place the caret at the end of the current 129*b1cdbd2cSJim Jagielski line when the <b>End</b> key gets pressed. Since the index of this position 130*b1cdbd2cSJim Jagielski is identical to the one of the first character of the following line, 131*b1cdbd2cSJim Jagielski <member>XAccessibleMultiLineText::getLineNumberAtIndex</member> will 132*b1cdbd2cSJim Jagielski return the line following the current one in this case.</p> 133*b1cdbd2cSJim Jagielski 134*b1cdbd2cSJim Jagielski @return 135*b1cdbd2cSJim Jagielski Returns the index of the line in which the caret is located or -1 136*b1cdbd2cSJim Jagielski if the paragraph does not have a valid caret position. 137*b1cdbd2cSJim Jagielski */ 138*b1cdbd2cSJim Jagielski 139*b1cdbd2cSJim Jagielski long getNumberOfLineWithCaret(); 140*b1cdbd2cSJim Jagielski}; 141*b1cdbd2cSJim Jagielski 142*b1cdbd2cSJim Jagielski}; }; }; }; 143*b1cdbd2cSJim Jagielski 144*b1cdbd2cSJim Jagielski#endif 145