<html> <head> <title>Interface XAccessibleEditableText</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="XAccessibleEditableText-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleEditableText" class="navimain">Devguide</a></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">interface XAccessibleEditableText</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XAccessibleEditableText</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>Description</b></dt> <dd>Implement this interface to give read and write access to a text representation. </dd> <dd><p>This interface is typically used in conjunction with the <a href="XAccessibleText.html">XAccessibleText</a> interface and extents it about the ability to modify the text represented by that interface.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleEditableText">Accessibility - XAccessibleEditableText</a></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="#cutText">cutText</a></td> <td class="imsum_right">Copies the text range into the clipboard. </td> </tr> <tr> <td class="imsum_left"><a href="#pasteText">pasteText</a></td> <td class="imsum_right">Pastes text from the clipboard. </td> </tr> <tr> <td class="imsum_left"><a href="#deleteText">deleteText</a></td> <td class="imsum_right">Deletes a range of text. </td> </tr> <tr> <td class="imsum_left"><a href="#insertText">insertText</a></td> <td class="imsum_right">Inserts text at the specified position. </td> </tr> <tr> <td class="imsum_left"><a href="#replaceText">replaceText</a></td> <td class="imsum_right">Replaces text. </td> </tr> <tr> <td class="imsum_left"><a href="#setAttributes">setAttributes</a></td> <td class="imsum_right">Replaces the attributes of a text range by the given set of attributes. </td> </tr> <tr> <td class="imsum_left"><a href="#setText">setText</a></td> <td class="imsum_right">Replaces the whole text with the given text. </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="cutText" class="membertitle">cutText</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">boolean</td> </tr> <tr> <td valign="top"><b>cutText</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nStartIndex,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nEndIndex )</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>Copies the text range into the clipboard. </dd> <dd><p>The specified text between and including the two given indices is copied into the system clipboard and is deleted afterwards from the text represented by this object. This is equivalent to calling first <a href="XAccessibleText.html">XAccessibleText</a>::<a href="XAccessibleText.html#copyText">copyText</a> and then <a href="XAccessibleEditableText.html">XAccessibleEditableText</a>::<a href="XAccessibleEditableText.html#deleteText">deleteText</a> with the given start and end indices.</p> <p>The text indices are interpreted like those in the <a href="XAccessibleText.html">XAccessibleText</a>::<a href="XAccessibleText.html#getTextRange">getTextRange</a> method. </p> </dd> <dt><b>Parameter nStartIndex</b></dt> <dd>Start index of the text to moved into the clipboard. The valid range is 0..length. </dd> <dt><b>Parameter nEndIndex</b></dt> <dd>End index of the text to moved into the clipboard. The valid range is 0..length. </dd> <dt><b>Returns</b></dt> <dd>Returns a flag that indicates whether the operation has been executed successfully. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the indices are invalid </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="pasteText" class="membertitle">pasteText</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">boolean</td> </tr> <tr> <td valign="top"><b>pasteText</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>Pastes text from the clipboard. </dd> <dd><p>The text in the system clipboard is pasted into the text represented by this object at the given index. This method is similar to the <a href="XAccessibleEditableText.html">XAccessibleEditableText</a>::<a href="XAccessibleEditableText.html#insertText">insertText</a> method. If the index is not valid then the system clipboard text is not inserted.</p> </dd> <dt><b>Parameter nIndex</b></dt> <dd>Index at which to insert the text from the system clipboard into the text represented by this object. The valid range is 0..length. </dd> <dt><b>Returns</b></dt> <dd>Returns a flag that indicates whether the operation has been executed successfully. </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="deleteText" class="membertitle">deleteText</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">boolean</td> </tr> <tr> <td valign="top"><b>deleteText</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nStartIndex,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nEndIndex )</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>Deletes a range of text. </dd> <dd><p>The text between and including the two given indices is deleted from the text represented by this object.</p> <p>The text indices are interpreted like those in the <a href="XAccessibleText.html">XAccessibleText</a>::<a href="XAccessibleText.html#getTextRange">getTextRange</a> method. </p> </dd> <dt><b>Parameter nStartIndex</b></dt> <dd>Start index of the text to be deleted. The valid range is 0..length. </dd> <dt><b>Parameter nEndIndex</b></dt> <dd>End index of the text to be deleted. The valid range is 0..length. </dd> <dt><b>Returns</b></dt> <dd>Returns a flag that indicates whether the operation has been executed successfully. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the indices are invalid </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="insertText" class="membertitle">insertText</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">boolean</td> </tr> <tr> <td valign="top"><b>insertText</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sText,</td> </tr> <tr> <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>Inserts text at the specified position. </dd> <dd><p>The specified string is inserted at the given index into the text represented by this object.</p> </dd> <dt><b>Parameter sText</b></dt> <dd>Text that is inserted. </dd> <dt><b>Parameter nIndex</b></dt> <dd>Index at which to insert the text. The valid range is 0..length. </dd> <dt><b>Returns</b></dt> <dd>Returns a flag that indicates whether the operation has been executed successfully. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the indices are invalid </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="replaceText" class="membertitle">replaceText</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">boolean</td> </tr> <tr> <td valign="top"><b>replaceText</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nStartIndex,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nEndIndex,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> sReplacement )</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>Replaces text. </dd> <dd><p>The text between the two given indices is replaced by the specified replacement string. This method is equivalent to calling first <a href="XAccessibleEditableText.html">XAccessibleEditableText</a>::<a href="XAccessibleEditableText.html#deleteText">deleteText</a> with the two indices and afterwards calling <a href="XAccessibleEditableText.html">XAccessibleEditableText</a>::<a href="XAccessibleEditableText.html#insertText">insertText</a> with the replacement text and the start index.</p> <p>The text indices are interpreted like those in the <a href="XAccessibleText.html">XAccessibleText</a>::<a href="XAccessibleText.html#getTextRange">getTextRange</a> method. </p> </dd> <dt><b>Parameter nStartIndex</b></dt> <dd>Start index of the text to be replaced. The valid range is 0..length. </dd> <dt><b>Parameter nEndIndex</b></dt> <dd>Start index of the text to be replaced. The valid range is 0..length. </dd> <dt><b>Parameter sReplacement</b></dt> <dd>The Text that replaces the text between the given indices. </dd> <dt><b>Returns</b></dt> <dd>Returns a flag that indicates whether the operation has been executed successfully. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the indices are invalid </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setAttributes" class="membertitle">setAttributes</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">boolean</td> </tr> <tr> <td valign="top"><b>setAttributes</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nStartIndex,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nEndIndex,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> aAttributeSet )</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>Replaces the attributes of a text range by the given set of attributes. </dd> <dd><p>Sets the attributes for the text between and including the two given indices to those given. The old attributes of this text portion are replaced by the new list of attributes.</p> <p>The text indices are interpreted like those in the <a href="XAccessibleText.html">XAccessibleText</a>::<a href="XAccessibleText.html#getTextRange">getTextRange</a> method. </p> </dd> <dt><b>Parameter nStartIndex</b></dt> <dd>Start index of the text whose attributes are modified. The valid range is 0..length. </dd> <dt><b>Parameter nEndIndex</b></dt> <dd>Start index of the text whose attributes are modified. The valid range is 0..length. </dd> <dt><b>Parameter aAttributeSet</b></dt> <dd>Set of attributes that replaces the old list of attributes of the specified text portion. </dd> <dt><b>Returns</b></dt> <dd>Returns a flag that indicates whether the operation has been executed successfully. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the indices are invalid </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setText" class="membertitle">setText</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">boolean</td> </tr> <tr> <td valign="top"><b>setText</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sText );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Replaces the whole text with the given text. </dd> <dd><p>The text content of this object is set to the given string.</p> </dd> <dt><b>Parameter sText</b></dt> <dd>The new text that replaces the old text. </dd> <dt><b>Returns</b></dt> <dd>Returns a flag that indicates whether the operation has been executed successfully. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
611
