← Back to branch summary

~ubuntu-branches/ubuntu/natty/pygtk/natty-proposed

« back to all changes in this revision

Viewing changes to docs/html/class-atktext.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-06-22 16:49:42 UTC
  • mfrom: (1.2.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20090622164942-19zeltp4z0u5iw72
Tags: 2.15.2-0ubuntu1
* New upstream version:
  - Rename gtk.Statusbar.remove() to gtk.Statusbar.remove_message
  - Allow pango.Context creation 
  - Make gtk.gdk.Pixbuf.add_alpha accept integers, retaining backward
    compatibility accepting also chars 
  - Protect window obj from GC in gtk.window_get_toplevels 
  - Plug huge number of memory leaks in Pango wrappers 
  - Add gtk.gdk.WINDOWING constant 
  - Wrap gdk_pixbuf_apply_embedded_orientation 
  - Modernize constructors of seven more types 
  - Don't free a string we don't own 
  - Some docs tweaking 
* debian/control.in:
  - set vcs location
* debian/patches/02_fix_get_application_info_crash.patch:
  - the change is in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/class-atktext.html
1
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>atk.Text</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="atk-class-reference.html" title="The atk Class Reference"><link rel="prev" href="class-atktable.html" title="atk.Table"><link rel="next" href="class-atkvalue.html" title="atk.Value"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">atk.Text</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-atktable.html">Prev</a> </td><th width="60%" align="center">The atk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-atkvalue.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-atktext"></a><div class="titlepage"></div><div class="refnamediv"><h2>atk.Text</h2><p>atk.Text — the ATK interface implemented by components with text
2
 
      content.</p></div><div class="refsect1" lang="en"><a name="id2793650"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.Text</span></span>(<span class="ooclass"><span class="classname">gobject.GInterface</span></span>):
 
2
      content.</p></div><div class="refsect1" lang="en"><a name="id2994354"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.Text</span></span>(<span class="ooclass"><span class="classname">gobject.GInterface</span></span>):
3
3
<code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--get-text" title="atk.Text.get_text">get_text</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start_offset</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end_offset</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--get-character-at-offset" title="atk.Text.get_character_at_offset">get_character_at_offset</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>offset</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--get-text-after-offset" title="atk.Text.get_text_after_offset">get_text_after_offset</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>offset</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>boundary_type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--get-text-at-offset" title="atk.Text.get_text_at_offset">get_text_at_offset</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>offset</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>boundary_type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--get-text-before-offset" title="atk.Text.get_text_before_offset">get_text_before_offset</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>offset</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>boundary_type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--get-caret-offset" title="atk.Text.get_caret_offset">get_caret_offset</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--get-character-extents" title="atk.Text.get_character_extents">get_character_extents</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>offset</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coords</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--get-run-attributes" title="atk.Text.get_run_attributes">get_run_attributes</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>offset</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--get-default-attributes" title="atk.Text.get_default_attributes">get_default_attributes</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--get-character-count" title="atk.Text.get_character_count">get_character_count</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--get-offset-at-point" title="atk.Text.get_offset_at_point">get_offset_at_point</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coords</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--get-n-selections" title="atk.Text.get_n_selections">get_n_selections</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--get-selection" title="atk.Text.get_selection">get_selection</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>selection_num</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--add-selection" title="atk.Text.add_selection">add_selection</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start_offset</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end_offset</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--remove-selection" title="atk.Text.remove_selection">remove_selection</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>selection_num</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--set-selection" title="atk.Text.set_selection">set_selection</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>selection_num</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>start_offset</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end_offset</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--set-caret-offset" title="atk.Text.set_caret_offset">set_caret_offset</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>offset</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--get-range-extents" title="atk.Text.get_range_extents">get_range_extents</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start_offset</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end_offset</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#method-atktext--get-bounded-ranges" title="atk.Text.get_bounded_ranges">get_bounded_ranges</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>rect</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>coord_type</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>x_clip_type</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y_clip_type</code></strong></span></span>)</code><br></pre></td></tr></table><pre class="programlisting">
4
4
<span class="bold"><strong>Functions</strong></span>
5
5
 
6
 
<code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#function-atk--text-attribute-get-name" title="atk.text_attribute_get_name">atk.text_attribute_get_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>attr</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#function-atk--text-attribute-get-value" title="atk.text_attribute_get_value">atk.text_attribute_get_value</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>attr</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>index</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#function-atk--text-attribute-register" title="atk.text_attribute_register">atk.text_attribute_register</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#function-atk--text-attribute-for-name" title="atk.text_attribute_for_name">atk.text_attribute_for_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>)</code></pre></div><div class="refsect1" lang="en"><a name="signal-prototypes-atktext"></a><h2>atk.Text Signal Prototypes</h2><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-atktext.html#signal-atktext--text-attributes-changed" title='The "text-attributes-changed" atk.Text Signal'>text-attributes-changed</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atktext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-atktext.html#signal-atktext--text-caret-moved" title='The "text-caret-moved" atk.Text Signal'>text-caret-moved</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atktext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>position</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-atktext.html#signal-atktext--text-changed" title='The "text-changed" atk.Text Signal'>text-changed</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atktext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>position</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>length</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-atktext.html#signal-atktext--text-selection-changed" title='The "text-selection-changed" atk.Text Signal'>text-selection-changed</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atktext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id2763323"></a><h2>Description</h2><p><a class="link" href="class-atktext.html" title="atk.Text"><code class="classname">atk.Text</code></a> should be
 
6
<code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#function-atk--text-attribute-get-name" title="atk.text_attribute_get_name">atk.text_attribute_get_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>attr</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#function-atk--text-attribute-get-value" title="atk.text_attribute_get_value">atk.text_attribute_get_value</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>attr</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>index</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#function-atk--text-attribute-register" title="atk.text_attribute_register">atk.text_attribute_register</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-atktext.html#function-atk--text-attribute-for-name" title="atk.text_attribute_for_name">atk.text_attribute_for_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>)</code></pre></div><div class="refsect1" lang="en"><a name="signal-prototypes-atktext"></a><h2>atk.Text Signal Prototypes</h2><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-atktext.html#signal-atktext--text-attributes-changed" title='The "text-attributes-changed" atk.Text Signal'>text-attributes-changed</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atktext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-atktext.html#signal-atktext--text-caret-moved" title='The "text-caret-moved" atk.Text Signal'>text-caret-moved</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atktext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>position</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-atktext.html#signal-atktext--text-changed" title='The "text-changed" atk.Text Signal'>text-changed</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atktext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>position</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>length</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-atktext.html#signal-atktext--text-selection-changed" title='The "text-selection-changed" atk.Text Signal'>text-selection-changed</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atktext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id2964027"></a><h2>Description</h2><p><a class="link" href="class-atktext.html" title="atk.Text"><code class="classname">atk.Text</code></a> should be
7
7
    implemented by <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
8
8
    objects on behalf of widgets that have text content which is either
9
9
    attributed or otherwise non-trivial.  <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
21
21
    the text strings are exposed as UTF-8, and are therefore potentially
22
22
    multi-byte, and caret-to-byte offset mapping makes no assumptions about
23
23
    the character length; also bounding box glyph-to-offset mapping may be
24
 
    complex for languages which use ligatures.</p></div><div class="refsect1" lang="en"><a name="id2771301"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-atktext--get-text"></a><h3>atk.Text.get_text</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_text</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start_offset</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end_offset</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>start_offset</code></strong> :</span></p></td><td>start position</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>end_offset</code></strong> :</span></p></td><td>end position</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the text from
 
24
    complex for languages which use ligatures.</p></div><div class="refsect1" lang="en"><a name="id2972005"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-atktext--get-text"></a><h3>atk.Text.get_text</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_text</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start_offset</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end_offset</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>start_offset</code></strong> :</span></p></td><td>start position</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>end_offset</code></strong> :</span></p></td><td>end position</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the text from
25
25
          <em class="parameter"><code>start_offset</code></em> up to, but not including
26
26
          <em class="parameter"><code>end_offset</code></em>.</td></tr></tbody></table><p>Gets the specified text.</p></div><div class="refsect2" lang="en"><a name="method-atktext--get-character-at-offset"></a><h3>atk.Text.get_character_at_offset</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_character_at_offset</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>offset</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>offset</code></strong> :</span></p></td><td>position</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the character at
27
27
          <em class="parameter"><code>offset</code></em>.</td></tr></tbody></table><p>Gets the specified text.</p></div><div class="refsect2" lang="en"><a name="method-atktext--get-text-after-offset"></a><h3>atk.Text.get_text_after_offset</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_text_after_offset</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>offset</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>boundary_type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>offset</code></strong> :</span></p></td><td>position</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>boundary_type</code></strong> :</span></p></td><td>one of the <a class="xref" href="atk-constants.html#atk-text-boundary-constants" title="Atk Text Boundary Constants">Atk Text Boundary Constants</a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 3-tuple containing the text after
193
193
          <a class="xref" href="atk-constants.html#atk-text-clip-type-constants" title="Atk Text Clip Type Constants">Atk Text Clip Type Constants</a>.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a list of text ranges. The list contains a
194
194
          4-tuple for each text range. The 4-tuple contains a <a class="link" href="class-atkrectangle.html" title="atk.Rectangle"><code class="classname">atk.Rectangle</code></a>
195
195
          bounding the text range, the start and end offsets of the range
196
 
          and the text in the range.</td></tr></tbody></table><p>Get the ranges of text in the specified bounding box.</p></div></div><div class="refsect1" lang="en"><a name="id2822974"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-atk--text-attribute-get-name"></a><h3>atk.text_attribute_get_name</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">atk.text_attribute_get_name</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>attr</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>attr</code></strong> :</span></p></td><td>a text attribute (one of the <a class="xref" href="atk-constants.html#atk-text-attr-constants" title="Atk Text Attribute Constants">Atk Text Attribute Constants</a>) whose name is
 
196
          and the text in the range.</td></tr></tbody></table><p>Get the ranges of text in the specified bounding box.</p></div></div><div class="refsect1" lang="en"><a name="id3023678"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-atk--text-attribute-get-name"></a><h3>atk.text_attribute_get_name</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">atk.text_attribute_get_name</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>attr</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>attr</code></strong> :</span></p></td><td>a text attribute (one of the <a class="xref" href="atk-constants.html#atk-text-attr-constants" title="Atk Text Attribute Constants">Atk Text Attribute Constants</a>) whose name is
197
197
          required</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a string containing the name</td></tr></tbody></table><p>Gets the name corresponding to
198
198
      <em class="parameter"><code>attr</code></em>.</p></div><div class="refsect2" lang="en"><a name="function-atk--text-attribute-get-value"></a><h3>atk.text_attribute_get_value</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">atk.text_attribute_get_value</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>attr</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>index</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>attr</code></strong> :</span></p></td><td>a text attribute (one of the <a class="xref" href="atk-constants.html#atk-text-attr-constants" title="Atk Text Attribute Constants">Atk Text Attribute Constants</a>) whose name is
199
199
          required</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>index</code></strong> :</span></p></td><td>The index of the required
208
208
          the specified name, or
209
209
          <code class="literal">atk.TEXT_ATTRIBUTE_INVALID</code> if no matching text
210
210
          attribute is found.</td></tr></tbody></table><p>Get the text attribute type corresponding to a text attribute
211
 
      name specified by <em class="parameter"><code>name</code></em>.</p></div></div><div class="refsect1" lang="en"><a name="id2769611"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-atktext--text-attributes-changed"></a><h3>The "text-attributes-changed" atk.Text Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atktext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>atktext</code></em> :</span></p></td><td>the object which received the
 
211
      name specified by <em class="parameter"><code>name</code></em>.</p></div></div><div class="refsect1" lang="en"><a name="id2970315"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-atktext--text-attributes-changed"></a><h3>The "text-attributes-changed" atk.Text Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>atktext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>atktext</code></em> :</span></p></td><td>the object which received the
212
212
          signal.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
213
213
          with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
214
214
          method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if any)</td></tr></tbody></table><p>The "text-attributes-changed" signal is emitted when the text