1
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.IMContext</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="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkimagemenuitem.html" title="gtk.ImageMenuItem"><link rel="next" href="class-gtkimcontextsimple.html" title="gtk.IMContextSimple"></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">gtk.IMContext</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkimagemenuitem.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkimcontextsimple.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkimcontext"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">gtk.IMContext</span></h2><p>gtk.IMContext — an abstract base class defining a generic input method
2
interface</p></div><div class="refsect1" lang="en"><a name="id3527145"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.IMContext</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a></span></span>):
3
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--set-client-window" title="gtk.IMContext.set_client_window">set_client_window</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>window</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--get-preedit-string" title="gtk.IMContext.get_preedit_string">get_preedit_string</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--filter-keypress" title="gtk.IMContext.filter_keypress">filter_keypress</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--focus-in" title="gtk.IMContext.focus_in">focus_in</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--focus-out" title="gtk.IMContext.focus_out">focus_out</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--reset" title="gtk.IMContext.reset">reset</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--set-cursor-location" title="gtk.IMContext.set_cursor_location">set_cursor_location</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>area</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--set-use-preedit" title="gtk.IMContext.set_use_preedit">set_use_preedit</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>use_preedit</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--set-surrounding" title="gtk.IMContext.set_surrounding">set_surrounding</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>text</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>len</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>cursor_index</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--get-surrounding" title="gtk.IMContext.get_surrounding">get_surrounding</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--delete-surrounding" title="gtk.IMContext.delete_surrounding">delete_surrounding</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>n_chars</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3527483"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
2
interface</p></div><div class="refsect1" lang="en"><a name="id3727951"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.IMContext</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a></span></span>):
3
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--set-client-window" title="gtk.IMContext.set_client_window">set_client_window</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>window</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--get-preedit-string" title="gtk.IMContext.get_preedit_string">get_preedit_string</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--filter-keypress" title="gtk.IMContext.filter_keypress">filter_keypress</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>key</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--focus-in" title="gtk.IMContext.focus_in">focus_in</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--focus-out" title="gtk.IMContext.focus_out">focus_out</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--reset" title="gtk.IMContext.reset">reset</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--set-cursor-location" title="gtk.IMContext.set_cursor_location">set_cursor_location</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>area</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--set-use-preedit" title="gtk.IMContext.set_use_preedit">set_use_preedit</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>use_preedit</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--set-surrounding" title="gtk.IMContext.set_surrounding">set_surrounding</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>text</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>len</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>cursor_index</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--get-surrounding" title="gtk.IMContext.get_surrounding">get_surrounding</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkimcontext.html#method-gtkimcontext--delete-surrounding" title="gtk.IMContext.delete_surrounding">delete_surrounding</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>n_chars</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3728290"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
4
4
+-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
5
5
+-- <a class="link" href="class-gtkimcontext.html" title="gtk.IMContext">gtk.IMContext</a>
6
</pre></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkimcontext"></a><h2>gtk.IMContext 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-gtkimcontext.html#signal-gtkimcontext--commit" title='The "commit" gtk.IMContext Signal'>commit</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>imcontext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>string</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-gtkimcontext.html#signal-gtkimcontext--delete-surrounding" title='The "delete-surrounding" gtk.IMContext Signal'>delete-surrounding</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>imcontext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>offset</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>n_chars</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-gtkimcontext.html#signal-gtkimcontext--preedit-changed" title='The "preedit-changed" gtk.IMContext Signal'>preedit-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>imcontext</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-gtkimcontext.html#signal-gtkimcontext--preedit-end" title='The "preedit-end" gtk.IMContext Signal'>preedit-end</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>imcontext</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-gtkimcontext.html#signal-gtkimcontext--preedit-start" title='The "preedit-start" gtk.IMContext Signal'>preedit-start</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>imcontext</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-gtkimcontext.html#signal-gtkimcontext--retrieve-surrounding" title='The "retrieve-surrounding" gtk.IMContext Signal'>retrieve-surrounding</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>imcontext</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="id3527965"></a><h2>Description</h2><p>The <a class="link" href="class-gtkimcontext.html" title="gtk.IMContext"><code class="classname">gtk.IMContext</code></a> is
6
</pre></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkimcontext"></a><h2>gtk.IMContext 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-gtkimcontext.html#signal-gtkimcontext--commit" title='The "commit" gtk.IMContext Signal'>commit</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>imcontext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>string</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-gtkimcontext.html#signal-gtkimcontext--delete-surrounding" title='The "delete-surrounding" gtk.IMContext Signal'>delete-surrounding</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>imcontext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>offset</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>n_chars</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-gtkimcontext.html#signal-gtkimcontext--preedit-changed" title='The "preedit-changed" gtk.IMContext Signal'>preedit-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>imcontext</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-gtkimcontext.html#signal-gtkimcontext--preedit-end" title='The "preedit-end" gtk.IMContext Signal'>preedit-end</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>imcontext</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-gtkimcontext.html#signal-gtkimcontext--preedit-start" title='The "preedit-start" gtk.IMContext Signal'>preedit-start</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>imcontext</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-gtkimcontext.html#signal-gtkimcontext--retrieve-surrounding" title='The "retrieve-surrounding" gtk.IMContext Signal'>retrieve-surrounding</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>imcontext</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="id3728772"></a><h2>Description</h2><p>The <a class="link" href="class-gtkimcontext.html" title="gtk.IMContext"><code class="classname">gtk.IMContext</code></a> is
7
7
an abstract base class used to provide objects to manage the context for
8
8
input methods used to support text input in various natural languages. The
9
9
character input for some languages (e.g. Chinese, Japanese and Korean)
16
16
widgets.</p><p>The <a class="link" href="class-gtkimcontext.html" title="gtk.IMContext"><code class="classname">gtk.IMContext</code></a>
17
17
manages the context of the text surrounding the cursor and the preedit text
18
18
that provides feedback about the in-process multiple character
19
composition.</p></div><div class="refsect1" lang="en"><a name="id3528028"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkimcontext--set-client-window"></a><h3>gtk.IMContext.set_client_window</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_client_window</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>window</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>window</code></strong> :</span></p></td><td>the client window. This may be
19
composition.</p></div><div class="refsect1" lang="en"><a name="id3728835"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkimcontext--set-client-window"></a><h3>gtk.IMContext.set_client_window</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_client_window</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>window</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>window</code></strong> :</span></p></td><td>the client window. This may be
20
20
<code class="literal">None</code> to indicate that the previous client window no
21
21
longer exists.</td></tr></tbody></table><p>The <code class="methodname">set_client_window</code>() method set the
22
22
client window for the input context; this is the <a class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></a> in
86
86
the fact that even if the signal was handled, the input context might not
87
87
have deleted all the characters that were requested to be deleted.</p><p>This function is used by an input method that wants to make
88
88
substitutions in the existing text in response to new input. It is not useful
89
for applications.</p></div></div><div class="refsect1" lang="en"><a name="id3529006"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkimcontext--commit"></a><h3>The "commit" gtk.IMContext Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>imcontext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>string</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>imcontext</code></em> :</span></p></td><td>the imcontext that received the
89
for applications.</p></div></div><div class="refsect1" lang="en"><a name="id3729812"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkimcontext--commit"></a><h3>The "commit" gtk.IMContext Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>imcontext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>string</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>imcontext</code></em> :</span></p></td><td>the imcontext that received the
90
90
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td><td>the text to be committed</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
91
91
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
92
92
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if