<!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>atkmm: Atk::Text Class 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.2 -->
<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="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespaceAtk.html">Atk</a> </li>
<li><a class="el" href="classAtk_1_1Text.html">Text</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#related">Related Functions</a> </div>
<div class="headertitle">
<h1>Atk::Text Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Atk::Text" --><!-- doxytag: inherits="Glib::Interface" -->
<p>The ATK interface implemented by components with text content. <a href="#_details">More...</a></p>
<p><code>#include <atkmm/text.h></code></p>
<!-- startSectionHeader --><div class="dynheader">
Inheritance diagram for Atk::Text:<!-- endSectionHeader --></div>
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
<div class="center"><img src="classAtk_1_1Text__inherit__graph.png" border="0" usemap="#Atk_1_1Text_inherit__map" alt="Inheritance graph"/></div>
<map name="Atk_1_1Text_inherit__map" id="Atk_1_1Text_inherit__map">
<area shape="rect" id="node9" href="classAtk_1_1NoOpObject.html" title="An Atk::NoOpObject is an Atk::Object which purports to implement all ATK interfaces." alt="" coords="5,315,133,344"/><area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="15,160,124,189"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="7,83,132,112"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,5,127,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
<p><a href="classAtk_1_1Text-members.html">List of all members.</a></p>
<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"><a class="anchor" id="a89fa4c5f3fdc6b59a811da1609571bdf"></a><!-- doxytag: member="Atk::Text::gobj" ref="a89fa4c5f3fdc6b59a811da1609571bdf" args="()" -->
AtkText* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#a89fa4c5f3fdc6b59a811da1609571bdf">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f3329b4e844483278abd627a141142d"></a><!-- doxytag: member="Atk::Text::gobj" ref="a2f3329b4e844483278abd627a141142d" args="() const " -->
const AtkText* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#a2f3329b4e844483278abd627a141142d">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#a8f749c1f6dc15ffef4e27766ea66655f">get_text</a> (int start_offset, int end_offset) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the specified text. <a href="#a8f749c1f6dc15ffef4e27766ea66655f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">gunichar </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#a061b8607e273fb85e84162a0a0e5b47b">get_character_at_offset</a> (int offset) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the specified text. <a href="#a061b8607e273fb85e84162a0a0e5b47b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#a3850bea8df6900731de05add95c3dc36">get_text_after_offset</a> (int offset, TextBoundary boundary_type, int& start_offset, int& end_offset) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the specified text. <a href="#a3850bea8df6900731de05add95c3dc36"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#af4a06a65abef1a65af82cc11e54adf3f">get_text_at_offset</a> (int offset, TextBoundary boundary_type, int& start_offset, int& end_offset) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the specified text. <a href="#af4a06a65abef1a65af82cc11e54adf3f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#a8472685388551749d87a43ce62982644">get_text_before_offset</a> (int offset, TextBoundary boundary_type, int& start_offset, int& end_offset) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the specified text. <a href="#a8472685388551749d87a43ce62982644"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#a10e19ea8a7bb6d5576ef69eb64db8e94">get_caret_offset</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the offset position of the caret (cursor). <a href="#a10e19ea8a7bb6d5576ef69eb64db8e94"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#abfce57bc598c220bc3de0ea9a26f11a4">get_character_extents</a> (int offset, int& x, int& y, int& width, int& height, CoordType coords) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the bounding box containing the glyph representing the character at a particular text offset. <a href="#abfce57bc598c220bc3de0ea9a26f11a4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SListHandle.html">AttributeSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#a134728ff97897f45014d383502d9cd0e">get_run_attributes</a> (int offset, int& start_offset, int& end_offset) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates an Atk::AttributeSet which consists of the attributes explicitly set at the position <em>offset</em> in the text. <a href="#a134728ff97897f45014d383502d9cd0e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SListHandle.html">AttributeSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#a48b27d8ac35f7e21a9910fe84c84cdb0">get_default_attributes</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates an Atk::AttributeSet which consists of the default values of attributes for the text. <a href="#a48b27d8ac35f7e21a9910fe84c84cdb0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#af0097531b66f229867b7b8b2b49d4ddb">get_character_count</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the character count. <a href="#af0097531b66f229867b7b8b2b49d4ddb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#a933eb7fc0a5a77d1b4393d711bc1719f">get_offset_at_point</a> (int x, int y, CoordType coords) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the offset of the character located at coordinates <em>x</em> and <em>y</em>. <a href="#a933eb7fc0a5a77d1b4393d711bc1719f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#a7027005265ad0212f25c50b53ff775e1">get_n_selections</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of selected regions. <a href="#a7027005265ad0212f25c50b53ff775e1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#aeee0be1f96d9368c68934e66a23921da">get_selection</a> (int selection_num, int& start_offset, int& end_offset) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the text from the specified selection. <a href="#aeee0be1f96d9368c68934e66a23921da"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#af6cb6584fa1bd0a3541a3d566a356d03">add_selection</a> (int start_offset, int end_offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a selection bounded by the specified offsets. <a href="#af6cb6584fa1bd0a3541a3d566a356d03"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#ac0d02f671ae48bd11f6a1c451c399ef9">remove_selection</a> (int selection_num)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes the specified selection. <a href="#ac0d02f671ae48bd11f6a1c451c399ef9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#a7e24f7bc27300fa7312fb8742192ac65">set_selection</a> (int selection_num, int start_offset, int end_offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Changes the start and end offset of the specified selection. <a href="#a7e24f7bc27300fa7312fb8742192ac65"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#acbd9dd3ed20867c7665f97e4f9d521d4">set_caret_offset</a> (int offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the caret (cursor) position to the specified <em>offset</em>. <a href="#acbd9dd3ed20867c7665f97e4f9d521d4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#aa58bbce3c64f2c60a92c70703d310495">get_range_extents</a> (int start_offset, int end_offset, CoordType coord_type, Rectangle& rect)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the bounding box for text within the specified range. <a href="#aa58bbce3c64f2c60a92c70703d310495"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">AtkTextRange** </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#a0d547bd9d5c17d52d16addd236e7b8a2">get_bounded_ranges</a> (const Rectangle& rect, CoordType coord_type, TextClipType x_clip_type, TextClipType y_clip_type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the ranges of text in the specified bounding box. <a href="#a0d547bd9d5c17d52d16addd236e7b8a2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy2.html">Glib::SignalProxy2</a>< void, int, <br class="typebreak"/>
int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#a6bf23ccafb0f5fdc2eb0f0e0a1853f16">signal_text_changed</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy1.html">Glib::SignalProxy1</a>< void, int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#a880162a200f019a13c82ec2621d41674">signal_text_caret_moved</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#a37f85345fddbfd3c3ce311667bdec059">signal_text_selection_changed</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#a620cbefacaa02153ab697e2b846e8bae">signal_text_attributes_changed</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1Text.html">Atk::Text</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Text.html#a112fb37843d9647af0ca48654c59b3c4">wrap</a> (AtkText* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a112fb37843d9647af0ca48654c59b3c4"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The ATK interface implemented by components with text content. </p>
<p>This should be implemented by Atk::Objects on behalf of widgets that have text content which is either attributed or otherwise non-trivial. Atk::Objects whose text content is simple, unattributed, and very brief may expose that content via <a class="el" href="classAtk_1_1Object.html#a13a68f38ef69b789c2007e11d284c9bf" title="Gets the accessible name of the accessible.">Atk::Object::get_name()</a> instead; however if the text is editable, multi-line, typically longer than three or four words, attributed, selectable, or if the object already uses the 'name' ATK property for other information, this <a class="el" href="classAtk_1_1Text.html" title="The ATK interface implemented by components with text content.">Text</a> interface should be used to expose the text content. In the case of editable text content, Atk::EditableText (a subtype of the <a class="el" href="classAtk_1_1Text.html" title="The ATK interface implemented by components with text content.">Atk::Text</a> interface) should be implemented instead.</p>
<p><a class="el" href="classAtk_1_1Text.html" title="The ATK interface implemented by components with text content.">Atk::Text</a> provides not only traversal facilities and change notification for text content, but also caret tracking and glyph bounding box calculations. Note that the text strings are exposed as UTF-8, and are therefore potentially multi-byte, and caret-to-byte offset mapping makes no assumptions about the character length; also bounding box glyph-to-offset mapping may be complex for languages which use ligatures. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af6cb6584fa1bd0a3541a3d566a356d03"></a><!-- doxytag: member="Atk::Text::add_selection" ref="af6cb6584fa1bd0a3541a3d566a356d03" args="(int start_offset, int end_offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Atk::Text::add_selection </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>start_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>end_offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a selection bounded by the specified offsets. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">start_offset</td><td>The start position of the selected region. </td></tr>
<tr><td class="paramname">end_offset</td><td>The offset of the first character after the selected region. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a0d547bd9d5c17d52d16addd236e7b8a2"></a><!-- doxytag: member="Atk::Text::get_bounded_ranges" ref="a0d547bd9d5c17d52d16addd236e7b8a2" args="(const Rectangle &rect, CoordType coord_type, TextClipType x_clip_type, TextClipType y_clip_type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AtkTextRange** Atk::Text::get_bounded_ranges </td>
<td>(</td>
<td class="paramtype">const Rectangle & </td>
<td class="paramname"> <em>rect</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">CoordType </td>
<td class="paramname"> <em>coord_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TextClipType </td>
<td class="paramname"> <em>x_clip_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TextClipType </td>
<td class="paramname"> <em>y_clip_type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the ranges of text in the specified bounding box. </p>
<dl class="since_1_3"><dt><b><a class="el" href="since_1_3.html#_since_1_3000002">Since atkmm 1.3:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">rect</td><td>An AtkTextRectagle giving the dimensions of the bounding box. </td></tr>
<tr><td class="paramname">coord_type</td><td>Specify whether coordinates are relative to the screen or widget window. </td></tr>
<tr><td class="paramname">x_clip_type</td><td>Specify the horizontal clip type. </td></tr>
<tr><td class="paramname">y_clip_type</td><td>Specify the vertical clip type. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Array of AtkTextRange. The last element of the array returned by this function will be <code>0</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="a10e19ea8a7bb6d5576ef69eb64db8e94"></a><!-- doxytag: member="Atk::Text::get_caret_offset" ref="a10e19ea8a7bb6d5576ef69eb64db8e94" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Atk::Text::get_caret_offset </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the offset position of the caret (cursor). </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The offset position of the caret (cursor). </dd></dl>
</div>
</div>
<a class="anchor" id="a061b8607e273fb85e84162a0a0e5b47b"></a><!-- doxytag: member="Atk::Text::get_character_at_offset" ref="a061b8607e273fb85e84162a0a0e5b47b" args="(int offset) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gunichar Atk::Text::get_character_at_offset </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>offset</em> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the specified text. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>Position. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The character at <em>offset</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="af0097531b66f229867b7b8b2b49d4ddb"></a><!-- doxytag: member="Atk::Text::get_character_count" ref="af0097531b66f229867b7b8b2b49d4ddb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Atk::Text::get_character_count </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the character count. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of characters. </dd></dl>
</div>
</div>
<a class="anchor" id="abfce57bc598c220bc3de0ea9a26f11a4"></a><!-- doxytag: member="Atk::Text::get_character_extents" ref="abfce57bc598c220bc3de0ea9a26f11a4" args="(int offset, int &x, int &y, int &width, int &height, CoordType coords) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Atk::Text::get_character_extents </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">CoordType </td>
<td class="paramname"> <em>coords</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the bounding box containing the glyph representing the character at a particular text offset. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>The offset of the text character for which bounding information is required. </td></tr>
<tr><td class="paramname">x</td><td>Pointer for the x cordinate of the bounding box. </td></tr>
<tr><td class="paramname">y</td><td>Pointer for the y cordinate of the bounding box. </td></tr>
<tr><td class="paramname">width</td><td>Pointer for the width of the bounding box. </td></tr>
<tr><td class="paramname">height</td><td>Pointer for the height of the bounding box. </td></tr>
<tr><td class="paramname">coords</td><td>Specify whether coordinates are relative to the screen or widget window. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a48b27d8ac35f7e21a9910fe84c84cdb0"></a><!-- doxytag: member="Atk::Text::get_default_attributes" ref="a48b27d8ac35f7e21a9910fe84c84cdb0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SListHandle.html">AttributeSet</a> Atk::Text::get_default_attributes </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates an Atk::AttributeSet which consists of the default values of attributes for the text. </p>
<p>See the enum AtkTextAttribute for types of text attributes that can be returned. Note that other attributes may also be returned. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>An Atk::AttributeSet which contains the default values of attributes. at <em>offset</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="a7027005265ad0212f25c50b53ff775e1"></a><!-- doxytag: member="Atk::Text::get_n_selections" ref="a7027005265ad0212f25c50b53ff775e1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Atk::Text::get_n_selections </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the number of selected regions. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of selected regions, or -1 if a failure occurred. </dd></dl>
</div>
</div>
<a class="anchor" id="a933eb7fc0a5a77d1b4393d711bc1719f"></a><!-- doxytag: member="Atk::Text::get_offset_at_point" ref="a933eb7fc0a5a77d1b4393d711bc1719f" args="(int x, int y, CoordType coords) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Atk::Text::get_offset_at_point </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">CoordType </td>
<td class="paramname"> <em>coords</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the offset of the character located at coordinates <em>x</em> and <em>y</em>. </p>
<p><em>x</em> and <em>y</em> are interpreted as being relative to the screen or this widget's window depending on <em>coords</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>Screen x-position of character. </td></tr>
<tr><td class="paramname">y</td><td>Screen y-position of character. </td></tr>
<tr><td class="paramname">coords</td><td>Specify whether coordinates are relative to the screen or widget window. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The offset to the character which is located at the specified <em>x</em> and <em>y</em> coordinates. </dd></dl>
</div>
</div>
<a class="anchor" id="aa58bbce3c64f2c60a92c70703d310495"></a><!-- doxytag: member="Atk::Text::get_range_extents" ref="aa58bbce3c64f2c60a92c70703d310495" args="(int start_offset, int end_offset, CoordType coord_type, Rectangle &rect)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Atk::Text::get_range_extents </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>start_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>end_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">CoordType </td>
<td class="paramname"> <em>coord_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Rectangle & </td>
<td class="paramname"> <em>rect</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the bounding box for text within the specified range. </p>
<dl class="since_1_3"><dt><b><a class="el" href="since_1_3.html#_since_1_3000001">Since atkmm 1.3:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">start_offset</td><td>The offset of the first text character for which boundary information is required. </td></tr>
<tr><td class="paramname">end_offset</td><td>The offset of the text character after the last character for which boundary information is required. </td></tr>
<tr><td class="paramname">coord_type</td><td>Specify whether coordinates are relative to the screen or widget window. </td></tr>
<tr><td class="paramname">rect</td><td>A pointer to a AtkTextRectangle which is filled in by this function. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a134728ff97897f45014d383502d9cd0e"></a><!-- doxytag: member="Atk::Text::get_run_attributes" ref="a134728ff97897f45014d383502d9cd0e" args="(int offset, int &start_offset, int &end_offset) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SListHandle.html">AttributeSet</a> Atk::Text::get_run_attributes </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>start_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>end_offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates an Atk::AttributeSet which consists of the attributes explicitly set at the position <em>offset</em> in the text. </p>
<p><em>start_offset</em> and <em>end_offset</em> are set to the start and end of the range around <em>offset</em> where the attributes are invariant. See the enum AtkTextAttribute for types of text attributes that can be returned. Note that other attributes may also be returned. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>The offset at which to get the attributes. </td></tr>
<tr><td class="paramname">start_offset</td><td>The address to put the start offset of the range. </td></tr>
<tr><td class="paramname">end_offset</td><td>The address to put the end offset of the range. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>An Atk::AttributeSet which contains the attributes explicitly set at <em>offset</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="aeee0be1f96d9368c68934e66a23921da"></a><!-- doxytag: member="Atk::Text::get_selection" ref="aeee0be1f96d9368c68934e66a23921da" args="(int selection_num, int &start_offset, int &end_offset) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Atk::Text::get_selection </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>selection_num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>start_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>end_offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the text from the specified selection. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">selection_num</td><td>The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. </td></tr>
<tr><td class="paramname">start_offset</td><td>Passes back the start position of the selected region. </td></tr>
<tr><td class="paramname">end_offset</td><td>Passes back the end position of (e.g. offset immediately past) the selected region. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The selected text. </dd></dl>
</div>
</div>
<a class="anchor" id="a8f749c1f6dc15ffef4e27766ea66655f"></a><!-- doxytag: member="Atk::Text::get_text" ref="a8f749c1f6dc15ffef4e27766ea66655f" args="(int start_offset, int end_offset) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Atk::Text::get_text </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>start_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>end_offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the specified text. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">start_offset</td><td>Start position. </td></tr>
<tr><td class="paramname">end_offset</td><td>End position. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The text from <em>start_offset</em> up to, but not including <em>end_offset</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="a3850bea8df6900731de05add95c3dc36"></a><!-- doxytag: member="Atk::Text::get_text_after_offset" ref="a3850bea8df6900731de05add95c3dc36" args="(int offset, TextBoundary boundary_type, int &start_offset, int &end_offset) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Atk::Text::get_text_after_offset </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TextBoundary </td>
<td class="paramname"> <em>boundary_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>start_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>end_offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the specified text. </p>
<p>If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character after the offset is returned.</p>
<p>If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string is from the word start after the offset to the next word start.</p>
<p>The returned string will contain the word after the offset if the offset is inside a word or if the offset is not inside a word.</p>
<p>If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string is from the word end at or after the offset to the next work end.</p>
<p>The returned string will contain the word after the offset if the offset is inside a word and will contain the word after the word after the offset if the offset is not inside a word.</p>
<p>If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned string is from the sentence start after the offset to the next sentence start.</p>
<p>The returned string will contain the sentence after the offset if the offset is inside a sentence or if the offset is not inside a sentence.</p>
<p>If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string is from the sentence end at or after the offset to the next sentence end.</p>
<p>The returned string will contain the sentence after the offset if the offset is inside a sentence and will contain the sentence after the sentence after the offset if the offset is not inside a sentence.</p>
<p>If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned string is from the line start after the offset to the next line start.</p>
<p>If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string is from the line end at or after the offset to the next line start. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>Position. </td></tr>
<tr><td class="paramname">boundary_type</td><td>An Atk::TextBoundary. </td></tr>
<tr><td class="paramname">start_offset</td><td>The start offset of the returned string. </td></tr>
<tr><td class="paramname">end_offset</td><td>The offset of the first character after the returned substring. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The text after <em>offset</em> bounded by the specified <em>boundary_type</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="af4a06a65abef1a65af82cc11e54adf3f"></a><!-- doxytag: member="Atk::Text::get_text_at_offset" ref="af4a06a65abef1a65af82cc11e54adf3f" args="(int offset, TextBoundary boundary_type, int &start_offset, int &end_offset) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Atk::Text::get_text_at_offset </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TextBoundary </td>
<td class="paramname"> <em>boundary_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>start_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>end_offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the specified text. </p>
<p>If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the offset is returned.</p>
<p>If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string is from the word start at or before the offset to the word start after the offset.</p>
<p>The returned string will contain the word at the offset if the offset is inside a word and will contain the word before the offset if the offset is not inside a word.</p>
<p>If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string is from the word end before the offset to the word end at or after the offset.</p>
<p>The returned string will contain the word at the offset if the offset is inside a word and will contain the word after to the offset if the offset is not inside a word.</p>
<p>If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned string is from the sentence start at or before the offset to the sentence start after the offset.</p>
<p>The returned string will contain the sentence at the offset if the offset is inside a sentence and will contain the sentence before the offset if the offset is not inside a sentence.</p>
<p>If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string is from the sentence end before the offset to the sentence end at or after the offset.</p>
<p>The returned string will contain the sentence at the offset if the offset is inside a sentence and will contain the sentence after the offset if the offset is not inside a sentence.</p>
<p>If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned string is from the line start at or before the offset to the line start after the offset.</p>
<p>If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string is from the line end before the offset to the line end at or after the offset. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>Position. </td></tr>
<tr><td class="paramname">boundary_type</td><td>An Atk::TextBoundary. </td></tr>
<tr><td class="paramname">start_offset</td><td>The start offset of the returned string. </td></tr>
<tr><td class="paramname">end_offset</td><td>The offset of the first character after the returned substring. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The text at <em>offset</em> bounded by the specified <em>boundary_type</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="a8472685388551749d87a43ce62982644"></a><!-- doxytag: member="Atk::Text::get_text_before_offset" ref="a8472685388551749d87a43ce62982644" args="(int offset, TextBoundary boundary_type, int &start_offset, int &end_offset) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Atk::Text::get_text_before_offset </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TextBoundary </td>
<td class="paramname"> <em>boundary_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>start_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>end_offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the specified text. </p>
<p>If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character before the offset is returned.</p>
<p>If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string is from the word start before the word start before the offset to the word start before the offset.</p>
<p>The returned string will contain the word before the offset if the offset is inside a word and will contain the word before the word before the offset if the offset is not inside a word.</p>
<p>If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string is from the word end before the word end at or before the offset to the word end at or before the offset.</p>
<p>The returned string will contain the word before the offset if the offset is inside a word or if the offset is not inside a word.</p>
<p>If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned string is from the sentence start before the sentence start before the offset to the sentence start before the offset.</p>
<p>The returned string will contain the sentence before the offset if the offset is inside a sentence and will contain the sentence before the sentence before the offset if the offset is not inside a sentence.</p>
<p>If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string is from the sentence end before the sentence end at or before the offset to the sentence end at or before the offset.</p>
<p>The returned string will contain the sentence before the offset if the offset is inside a sentence or if the offset is not inside a sentence.</p>
<p>If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned string is from the line start before the line start ar or before the offset to the line start ar or before the offset.</p>
<p>If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string is from the line end before the line end before the offset to the line end before the offset. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>Position. </td></tr>
<tr><td class="paramname">boundary_type</td><td>An Atk::TextBoundary. </td></tr>
<tr><td class="paramname">start_offset</td><td>The start offset of the returned string. </td></tr>
<tr><td class="paramname">end_offset</td><td>The offset of the first character after the returned substring. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The text before <em>offset</em> bounded by the specified <em>boundary_type</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="ac0d02f671ae48bd11f6a1c451c399ef9"></a><!-- doxytag: member="Atk::Text::remove_selection" ref="ac0d02f671ae48bd11f6a1c451c399ef9" args="(int selection_num)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Atk::Text::remove_selection </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>selection_num</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes the specified selection. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">selection_num</td><td>The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="acbd9dd3ed20867c7665f97e4f9d521d4"></a><!-- doxytag: member="Atk::Text::set_caret_offset" ref="acbd9dd3ed20867c7665f97e4f9d521d4" args="(int offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Atk::Text::set_caret_offset </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>offset</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the caret (cursor) position to the specified <em>offset</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>Position. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a7e24f7bc27300fa7312fb8742192ac65"></a><!-- doxytag: member="Atk::Text::set_selection" ref="a7e24f7bc27300fa7312fb8742192ac65" args="(int selection_num, int start_offset, int end_offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Atk::Text::set_selection </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>selection_num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>start_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>end_offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Changes the start and end offset of the specified selection. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">selection_num</td><td>The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. </td></tr>
<tr><td class="paramname">start_offset</td><td>The new start position of the selection. </td></tr>
<tr><td class="paramname">end_offset</td><td>The new end position of (e.g. offset immediately past) the selection. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if success, <code>false</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a620cbefacaa02153ab697e2b846e8bae"></a><!-- doxytag: member="Atk::Text::signal_text_attributes_changed" ref="a620cbefacaa02153ab697e2b846e8bae" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > Atk::Text::signal_text_attributes_changed </td>
<td>(</td>
<td class="paramname"> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_text_attributes_changed()</code> </dd></dl>
</div>
</div>
<a class="anchor" id="a880162a200f019a13c82ec2621d41674"></a><!-- doxytag: member="Atk::Text::signal_text_caret_moved" ref="a880162a200f019a13c82ec2621d41674" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy1.html">Glib::SignalProxy1</a>< void,int > Atk::Text::signal_text_caret_moved </td>
<td>(</td>
<td class="paramname"> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_text_caret_moved(int location)</code> </dd></dl>
</div>
</div>
<a class="anchor" id="a6bf23ccafb0f5fdc2eb0f0e0a1853f16"></a><!-- doxytag: member="Atk::Text::signal_text_changed" ref="a6bf23ccafb0f5fdc2eb0f0e0a1853f16" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy2.html">Glib::SignalProxy2</a>< void,int,int > Atk::Text::signal_text_changed </td>
<td>(</td>
<td class="paramname"> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_text_changed(int position, int length)</code> </dd></dl>
</div>
</div>
<a class="anchor" id="a37f85345fddbfd3c3ce311667bdec059"></a><!-- doxytag: member="Atk::Text::signal_text_selection_changed" ref="a37f85345fddbfd3c3ce311667bdec059" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > Atk::Text::signal_text_selection_changed </td>
<td>(</td>
<td class="paramname"> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_text_selection_changed()</code> </dd></dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a112fb37843d9647af0ca48654c59b3c4"></a><!-- doxytag: member="Atk::Text::wrap" ref="a112fb37843d9647af0ca48654c59b3c4" args="(AtkText *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1Text.html">Atk::Text</a> > wrap </td>
<td>(</td>
<td class="paramtype">AtkText * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
<tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Mar 30 2011 09:27:41 for atkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
</body>
</html>
