<html> <head> <title>Interface XAccessibleMultiLineText</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XAccessibleMultiLineText-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">accessibility</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XAccessibleMultiLineText</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XAccessibleMultiLineText</strong> ┗ <a href="XAccessibleText.html">XAccessibleText</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XAccessibleText.html">XAccessibleText</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>Implement this interface to give read-only access to a text. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>not yet published</dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getLineNumberAtIndex">getLineNumberAtIndex</a></td> <td class="imsum_right">Returns the line number at the specified index. </td> </tr> <tr> <td class="imsum_left"><a href="#getTextAtLineNumber">getTextAtLineNumber</a></td> <td class="imsum_right">Returns the text of the specified line. </td> </tr> <tr> <td class="imsum_left"><a href="#getTextAtLineWithCaret">getTextAtLineWithCaret</a></td> <td class="imsum_right">Returns the text of the line in which the caret is located. </td> </tr> <tr> <td class="imsum_left"><a href="#getNumberOfLineWithCaret">getNumberOfLineWithCaret</a></td> <td class="imsum_right">Returns the number of the line in which the caret is located. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getLineNumberAtIndex" class="membertitle">getLineNumberAtIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getLineNumberAtIndex</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the line number at the specified index. </dd> <dd><p>For a text object that is spread over multiple lines, this method provides a mapping from a text index to the corresponding line number. </p> </dd> <dt><b>Parameter nIndex</b></dt> <dd>Index for which the line number should be returned. The valid range is 0..length. </dd> <dt><b>Returns</b></dt> <dd>Returns the line number of the specified text index. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the index is invalid. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getTextAtLineNumber" class="membertitle">getTextAtLineNumber</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="TextSegment.html">TextSegment</a></td> </tr> <tr> <td valign="top"><b>getTextAtLineNumber</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nLineNo )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the text of the specified line. </dd> <dd><p>Returns the substring of text that makes up the specified line number.</p> <p>The number of lines can be obtained by calling <a href="XAccessibleMultiLineText.html">XAccessibleMultiLineText</a>::<a href="XAccessibleMultiLineText.html#getLineNumberAtIndex">getLineNumberAtIndex</a> with the index of the last character. In a loop, the last line has been reached when <a href="TextSegment.html">TextSegment</a>::<a href="TextSegment.html#SegmentEnd">SegmentEnd</a> of the returned value is equal to the index of the last character of the text.</p> </dd> <dt><b>Parameter nLineNo</b></dt> <dd>The number of the line to return the substring from. The valid range is 0..getLineNumberAtIndex(getCharacterCount()). </dd> <dt><b>Returns</b></dt> <dd>Returns the requested text portion. This portion may be empty or invalid when no appropriate text portion is found. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the line number is invalid </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getTextAtLineWithCaret" class="membertitle">getTextAtLineWithCaret</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="TextSegment.html">TextSegment</a></td> </tr> <tr> <td valign="top"><b>getTextAtLineWithCaret</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the text of the line in which the caret is located. </dd> <dd><p>The substring returned will most of the time be identical to calling <a href="XAccessibleText.html">XAccessibleText</a>::<a href="XAccessibleText.html#getTextAtIndex">getTextAtIndex</a> with the index returned by <a href="XAccessibleText.html">XAccessibleText</a>::<a href="XAccessibleText.html#getCaretPosition">getCaretPosition</a> and type <b>LINE beside the following special case:</p> <p>Some text implementations place the caret at the end of the current line when the <b>End</b> key gets pressed. Since the index of this position is identical to the one of the first character of the following line, <a href="XAccessibleMultiLineText.html">XAccessibleMultiLineText</a>::<a href="XAccessibleMultiLineText.html#getLineNumberAtIndex">getLineNumberAtIndex</a> will return the line following the current one in this case.</p> </dd> <dt><b>Returns</b></dt> <dd>Returns the requested text portion. This portion may be empty or invalid if the paragraph object does not have a valid caret position. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getNumberOfLineWithCaret" class="membertitle">getNumberOfLineWithCaret</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getNumberOfLineWithCaret</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the number of the line in which the caret is located. </dd> <dd><p>The line number returned will most of the time be identical to calling <a href="XAccessibleMultiLineText.html">XAccessibleMultiLineText</a>::<a href="XAccessibleMultiLineText.html#getLineNumberAtIndex">getLineNumberAtIndex</a> with the index returned by <a href="XAccessibleText.html">XAccessibleText</a>::<a href="XAccessibleText.html#getCaretPosition">getCaretPosition</a> beside the following special case:</p> <p>Some text implementations place the caret at the end of the current line when the <b>End</b> key gets pressed. Since the index of this position is identical to the one of the first character of the following line, <a href="XAccessibleMultiLineText.html">XAccessibleMultiLineText</a>::<a href="XAccessibleMultiLineText.html#getLineNumberAtIndex">getLineNumberAtIndex</a> will return the line following the current one in this case.</p> </dd> <dt><b>Returns</b></dt> <dd>Returns the index of the line in which the caret is located or -1 if the paragraph does not have a valid caret position. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
