<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>at-spi-idl: Accessibility::EditableText Interface Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="nav">
<a class="el" href="namespaceAccessibility.html">Accessibility</a>::<a class="el" href="interfaceAccessibility_1_1EditableText.html">EditableText</a></div>
<h1>Accessibility::EditableText Interface Reference</h1><!-- doxytag: class="Accessibility::EditableText" --><!-- doxytag: inherits="Accessibility::Text" --><code>import "<a class="el" href="Accessibility__EditableText_8idl-source.html">Accessibility_EditableText.idl</a>";</code>
<p>
<p>Inheritance diagram for Accessibility::EditableText:
<p><center><img src="interfaceAccessibility_1_1EditableText.png" usemap="#Accessibility::EditableText_map" border="0" alt=""></center>
<map name="Accessibility::EditableText_map">
<area href="interfaceAccessibility_1_1Text.html" alt="Accessibility::Text" shape="rect" coords="0,0,157,24">
</map>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#81d08f323fe9c76206fd275d50ef408d">setTextContents</a> (in string newContents)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#57cf7dae7f9646d5cece68fe56b320ce">insertText</a> (in long position, in string text, in long length)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#6f301017737bcf9dfd3e44a650600925">setAttributes</a> (in string attributes, in long startPos, in long endPos)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#e44d2cbe1bd5023b47ea943698da8dbc">copyText</a> (in long startPos, in long endPos)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#6125236f3ee22cae2a0043993fe0c9d4">cutText</a> (in long startPos, in long endPos)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#9dd3d1070233c184ec71f96fa25c350c">deleteText</a> (in long startPos, in long endPos)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#a496fc0c7de1b04b7306ce9e02908662">pasteText</a> (in long position)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#bb6fb15d5a481c21d98b61b0164b83d2">unImplemented5</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#22e4c766ce3b3feebdd3b6f434ed3db6">unImplemented6</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#11dee0793bf3252c7db5dd15e1a215e2">unImplemented9</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#42a7ca1b506d9ffcfcc744a9c0cc5827">unImplemented10</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#1d431107cab5f415b83ab9206bd53adf">unImplemented11</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#e0a2485ee0261dfbef35a1f813512de4">unImplemented12</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Derived from interface <a class="el" href="interfaceAccessibility_1_1Text.html">Text</a>, <a class="el" href="interfaceAccessibility_1_1EditableText.html">EditableText</a> provides methods for modifying textual content of components which support editing. <a class="el" href="interfaceAccessibility_1_1EditableText.html">EditableText</a> also interacts with the system clipboard via copyText, cutText, and pasteText.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>read-only instances of <a class="el" href="interfaceAccessibility_1_1EditableText.html">EditableText</a> are possible; These may be instances of a general-purpose component type which are sometimes, but not always, user-editable, or may be components which are temporarily or circumstantially in a non-editable state. </dd></dl>
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="81d08f323fe9c76206fd275d50ef408d"></a><!-- doxytag: member="Accessibility::EditableText::setTextContents" ref="81d08f323fe9c76206fd275d50ef408d" args="(in string newContents)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::EditableText::setTextContents </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"> <em>newContents</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Replace the text contents with a new string, discarding the old contents.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>newContents</em> </td><td>a UTF-8 string with which the text object's contents will be replaced. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>True</code> if the text content was successfully changed, <code>False</code> otherwise. </dd></dl>
</div>
</div><p>
<a class="anchor" name="57cf7dae7f9646d5cece68fe56b320ce"></a><!-- doxytag: member="Accessibility::EditableText::insertText" ref="57cf7dae7f9646d5cece68fe56b320ce" args="(in long position, in string text, in long length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::EditableText::insertText </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in string </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>length</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Insert new text contents into an existing text object at a given location, while retaining the old contents. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>position</em> </td><td>the character offset into the <a class="el" href="interfaceAccessibility_1_1Text.html">Text</a> implementor's content at which the new content will be inserted. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>a UTF-8 string of which <code>length</code> characters will be inserted into the text object's text buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the number of characters of <code>text</code> to insert. If the character count of <code>text</code> is less than or equal to <code>length</code>, the entire contents of <code>text</code> will be inserted.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>True</code> if the text content was successfully inserted, <code>False</code> otherwise. </dd></dl>
</div>
</div><p>
<a class="anchor" name="6f301017737bcf9dfd3e44a650600925"></a><!-- doxytag: member="Accessibility::EditableText::setAttributes" ref="6f301017737bcf9dfd3e44a650600925" args="(in string attributes, in long startPos, in long endPos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::EditableText::setAttributes </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"> <em>attributes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>startPos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>endPos</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Apply a particular set of attributes to a range of text.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>True</code> if the text attributes were successfully modified, <code>False</code> otherwise. </dd></dl>
</div>
</div><p>
<a class="anchor" name="e44d2cbe1bd5023b47ea943698da8dbc"></a><!-- doxytag: member="Accessibility::EditableText::copyText" ref="e44d2cbe1bd5023b47ea943698da8dbc" args="(in long startPos, in long endPos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::EditableText::copyText </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>startPos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>endPos</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy a range of text into the system clipboard. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>startPos</em> </td><td>the character offset of the first character in the range of text being copied. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>endPos</em> </td><td>the offset of the first character past the end of the range of text being copied. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="6125236f3ee22cae2a0043993fe0c9d4"></a><!-- doxytag: member="Accessibility::EditableText::cutText" ref="6125236f3ee22cae2a0043993fe0c9d4" args="(in long startPos, in long endPos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::EditableText::cutText </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>startPos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>endPos</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Excise a range of text from a <a class="el" href="interfaceAccessibility_1_1Text.html">Text</a> object, copying it into the system clipboard. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>startPos</em> </td><td>the character offset of the first character in the range of text being cut. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>endPos</em> </td><td>the offset of the first character past the end of the range of text being cut. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>True</code> if the text was successfully cut, <code>False</code> otherwise. </dd></dl>
</div>
</div><p>
<a class="anchor" name="9dd3d1070233c184ec71f96fa25c350c"></a><!-- doxytag: member="Accessibility::EditableText::deleteText" ref="9dd3d1070233c184ec71f96fa25c350c" args="(in long startPos, in long endPos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::EditableText::deleteText </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>startPos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>endPos</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Excise a range of text from a <a class="el" href="interfaceAccessibility_1_1Text.html">Text</a> object without copying it into the system clipboard. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>startPos</em> </td><td>the character offset of the first character in the range of text being deleted. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>endPos</em> </td><td>the offset of the first character past the end of the range of text being deleted. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>True</code> if the text was successfully deleted, <code>False</code> otherwise. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a496fc0c7de1b04b7306ce9e02908662"></a><!-- doxytag: member="Accessibility::EditableText::pasteText" ref="a496fc0c7de1b04b7306ce9e02908662" args="(in long position)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::EditableText::pasteText </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>position</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy the text contents of the system clipboard, if any, into a <a class="el" href="interfaceAccessibility_1_1Text.html">Text</a> object, inserting it at a particular character offset.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>position</em> </td><td>the character offset before which the text will be inserted. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>True</code> if the text was successfully pasted into the <a class="el" href="interfaceAccessibility_1_1Text.html">Text</a> object, <code>False</code> otherwise. </dd></dl>
</div>
</div><p>
<a class="anchor" name="bb6fb15d5a481c21d98b61b0164b83d2"></a><!-- doxytag: member="Accessibility::EditableText::unImplemented5" ref="bb6fb15d5a481c21d98b61b0164b83d2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::EditableText::unImplemented5 </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
unImplemented:<p>
placeholders for future expansion. Note that these are named 'unimplemented5 and unimplemented6' to avoid conflict with placeholders from <a class="el" href="interfaceAccessibility_1_1Text.html">Accessibility::Text</a>.
</div>
</div><p>
<a class="anchor" name="22e4c766ce3b3feebdd3b6f434ed3db6"></a><!-- doxytag: member="Accessibility::EditableText::unImplemented6" ref="22e4c766ce3b3feebdd3b6f434ed3db6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::EditableText::unImplemented6 </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="11dee0793bf3252c7db5dd15e1a215e2"></a><!-- doxytag: member="Accessibility::EditableText::unImplemented9" ref="11dee0793bf3252c7db5dd15e1a215e2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::EditableText::unImplemented9 </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="42a7ca1b506d9ffcfcc744a9c0cc5827"></a><!-- doxytag: member="Accessibility::EditableText::unImplemented10" ref="42a7ca1b506d9ffcfcc744a9c0cc5827" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::EditableText::unImplemented10 </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="1d431107cab5f415b83ab9206bd53adf"></a><!-- doxytag: member="Accessibility::EditableText::unImplemented11" ref="1d431107cab5f415b83ab9206bd53adf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::EditableText::unImplemented11 </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="e0a2485ee0261dfbef35a1f813512de4"></a><!-- doxytag: member="Accessibility::EditableText::unImplemented12" ref="e0a2485ee0261dfbef35a1f813512de4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::EditableText::unImplemented12 </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this interface was generated from the following file:<ul>
<li>/home/liyuan/src/at-spi/idl/<a class="el" href="Accessibility__EditableText_8idl-source.html">Accessibility_EditableText.idl</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jul 10 10:46:52 2007 for at-spi-idl by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>
