<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>at-spi-idl: Accessibility::EditableText Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<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="tabs2">
<ul class="tablist">
<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="navpath">
<ul>
<li><a class="el" href="namespaceAccessibility.html">Accessibility</a> </li>
<li><a class="el" href="interfaceAccessibility_1_1EditableText.html">Accessibility::EditableText</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>Accessibility::EditableText Interface Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Accessibility::EditableText" --><!-- doxytag: inherits="Accessibility::Text" -->
<p><code>import "<a class="el" href="Accessibility__EditableText_8idl_source.html">Accessibility_EditableText.idl</a>";</code></p>
<div class="dynheader">
Inheritance diagram for Accessibility::EditableText:</div>
<div class="dyncontent">
<div class="center">
<img src="interfaceAccessibility_1_1EditableText.png" usemap="#Accessibility::EditableText_map" alt=""/>
<map id="Accessibility::EditableText_map" name="Accessibility::EditableText_map">
<area href="interfaceAccessibility_1_1Text.html" alt="Accessibility::Text" shape="rect" coords="0,0,157,24"/>
</map>
</div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#ac88a6706ce03bf00de3c61374c194c65">setTextContents</a> (in string newContents)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#ae6aa2770b3f4e584987b3efd215f76fe">insertText</a> (in long position, in string text, in long length)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#a2c9d080695ee20707f6e519797443de6">setAttributes</a> (in string attributes, in long startPos, in long endPos)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#aac9b23b9c1b64222f30fe22cf4237782">copyText</a> (in long startPos, in long endPos)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#a123e3190efdbe61b4a7cf064acc68c1f">cutText</a> (in long startPos, in long endPos)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#aef4ca6897ba0c1d971bc6151311b0a9a">deleteText</a> (in long startPos, in long endPos)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#af561a56b670a94472e1baa9c8ec2987e">pasteText</a> (in long position)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#ae2d072e324621c971752ca453b9b3aa9">unImplemented5</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#a1e783f82f29eaa1be8b09074d07a0c9f">unImplemented6</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#a4e31d84f8e9dabe46de8e41b45e7d582">unImplemented9</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#abd4b5100fd50196615ae9f56ac7a0783">unImplemented10</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#a9ca7a940ce2201881a055b630b2afa2e">unImplemented11</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1EditableText.html#a36238a66040b958ad95c7616f1633824">unImplemented12</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>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"><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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aac9b23b9c1b64222f30fe22cf4237782"></a><!-- doxytag: member="Accessibility::EditableText::copyText" ref="aac9b23b9c1b64222f30fe22cf4237782" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy a range of text into the system clipboard. </p>
<dl><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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a123e3190efdbe61b4a7cf064acc68c1f"></a><!-- doxytag: member="Accessibility::EditableText::cutText" ref="a123e3190efdbe61b4a7cf064acc68c1f" 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></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. </p>
<dl><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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the text was successfully cut, <code>False</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="aef4ca6897ba0c1d971bc6151311b0a9a"></a><!-- doxytag: member="Accessibility::EditableText::deleteText" ref="aef4ca6897ba0c1d971bc6151311b0a9a" 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></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. </p>
<dl><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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the text was successfully deleted, <code>False</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="ae6aa2770b3f4e584987b3efd215f76fe"></a><!-- doxytag: member="Accessibility::EditableText::insertText" ref="ae6aa2770b3f4e584987b3efd215f76fe" 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></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. </p>
<dl><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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the text content was successfully inserted, <code>False</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="af561a56b670a94472e1baa9c8ec2987e"></a><!-- doxytag: member="Accessibility::EditableText::pasteText" ref="af561a56b670a94472e1baa9c8ec2987e" 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></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><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>
</dd>
</dl>
<dl class="return"><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>
<a class="anchor" id="a2c9d080695ee20707f6e519797443de6"></a><!-- doxytag: member="Accessibility::EditableText::setAttributes" ref="a2c9d080695ee20707f6e519797443de6" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Apply a particular set of attributes to a range of text.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the text attributes were successfully modified, <code>False</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="ac88a6706ce03bf00de3c61374c194c65"></a><!-- doxytag: member="Accessibility::EditableText::setTextContents" ref="ac88a6706ce03bf00de3c61374c194c65" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Replace the text contents with a new string, discarding the old contents.</p>
<dl><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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the text content was successfully changed, <code>False</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="abd4b5100fd50196615ae9f56ac7a0783"></a><!-- doxytag: member="Accessibility::EditableText::unImplemented10" ref="abd4b5100fd50196615ae9f56ac7a0783" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a9ca7a940ce2201881a055b630b2afa2e"></a><!-- doxytag: member="Accessibility::EditableText::unImplemented11" ref="a9ca7a940ce2201881a055b630b2afa2e" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a36238a66040b958ad95c7616f1633824"></a><!-- doxytag: member="Accessibility::EditableText::unImplemented12" ref="a36238a66040b958ad95c7616f1633824" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae2d072e324621c971752ca453b9b3aa9"></a><!-- doxytag: member="Accessibility::EditableText::unImplemented5" ref="ae2d072e324621c971752ca453b9b3aa9" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>unImplemented:</p>
<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>. </p>
</div>
</div>
<a class="anchor" id="a1e783f82f29eaa1be8b09074d07a0c9f"></a><!-- doxytag: member="Accessibility::EditableText::unImplemented6" ref="a1e783f82f29eaa1be8b09074d07a0c9f" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a4e31d84f8e9dabe46de8e41b45e7d582"></a><!-- doxytag: member="Accessibility::EditableText::unImplemented9" ref="a4e31d84f8e9dabe46de8e41b45e7d582" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<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></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Sep 27 2010 16:50:43 for at-spi-idl by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
