~ubuntu-branches/debian/experimental/gtk+2.0/experimental

« back to all changes in this revision

Viewing changes to docs/reference/gtk/html/GtkIMContext.html

  • Committer: Package Import Robot
  • Author(s): Josselin Mouette
  • Date: 2011-09-02 17:17:47 UTC
  • mto: (72.4.15 sid)
  • mto: This revision was merged to the branch mainline in revision 102.
  • Revision ID: package-import@ubuntu.com-20110902171747-i8dr3czswn2sk7tu
Tags: upstream-2.24.6
Import upstream version 2.24.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
49
49
struct              <a class="link" href="GtkIMContext.html#GtkIMContextClass" title="struct GtkIMContextClass">GtkIMContextClass</a>;
50
50
struct              <a class="link" href="GtkIMContext.html#GtkIMContextInfo" title="struct GtkIMContextInfo">GtkIMContextInfo</a>;
51
51
<span class="returnvalue">void</span>                <a class="link" href="GtkIMContext.html#gtk-im-context-set-client-window" title="gtk_im_context_set_client_window ()">gtk_im_context_set_client_window</a>    (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
52
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> *window</code></em>);
 
52
                                                         <em class="parameter"><code><a href="../gdk/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> *window</code></em>);
53
53
<span class="returnvalue">void</span>                <a class="link" href="GtkIMContext.html#gtk-im-context-get-preedit-string" title="gtk_im_context_get_preedit_string ()">gtk_im_context_get_preedit_string</a>   (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
54
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **str</code></em>,
 
54
                                                         <em class="parameter"><code><span class="type">gchar</span> **str</code></em>,
55
55
                                                         <em class="parameter"><code><span class="type">PangoAttrList</span> **attrs</code></em>,
56
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *cursor_pos</code></em>);
57
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GtkIMContext.html#gtk-im-context-filter-keypress" title="gtk_im_context_filter_keypress ()">gtk_im_context_filter_keypress</a>      (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
58
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkEventKey"><span class="type">GdkEventKey</span></a> *event</code></em>);
 
56
                                                         <em class="parameter"><code><span class="type">gint</span> *cursor_pos</code></em>);
 
57
<span class="returnvalue">gboolean</span>            <a class="link" href="GtkIMContext.html#gtk-im-context-filter-keypress" title="gtk_im_context_filter_keypress ()">gtk_im_context_filter_keypress</a>      (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
 
58
                                                         <em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkEventKey"><span class="type">GdkEventKey</span></a> *event</code></em>);
59
59
<span class="returnvalue">void</span>                <a class="link" href="GtkIMContext.html#gtk-im-context-focus-in" title="gtk_im_context_focus_in ()">gtk_im_context_focus_in</a>             (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>);
60
60
<span class="returnvalue">void</span>                <a class="link" href="GtkIMContext.html#gtk-im-context-focus-out" title="gtk_im_context_focus_out ()">gtk_im_context_focus_out</a>            (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>);
61
61
<span class="returnvalue">void</span>                <a class="link" href="GtkIMContext.html#gtk-im-context-reset" title="gtk_im_context_reset ()">gtk_im_context_reset</a>                (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>);
62
62
<span class="returnvalue">void</span>                <a class="link" href="GtkIMContext.html#gtk-im-context-set-cursor-location" title="gtk_im_context_set_cursor_location ()">gtk_im_context_set_cursor_location</a>  (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
63
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gdk3/gdk-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *area</code></em>);
 
63
                                                         <em class="parameter"><code>const <a href="../gdk/gdk-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *area</code></em>);
64
64
<span class="returnvalue">void</span>                <a class="link" href="GtkIMContext.html#gtk-im-context-set-use-preedit" title="gtk_im_context_set_use_preedit ()">gtk_im_context_set_use_preedit</a>      (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
65
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> use_preedit</code></em>);
 
65
                                                         <em class="parameter"><code><span class="type">gboolean</span> use_preedit</code></em>);
66
66
<span class="returnvalue">void</span>                <a class="link" href="GtkIMContext.html#gtk-im-context-set-surrounding" title="gtk_im_context_set_surrounding ()">gtk_im_context_set_surrounding</a>      (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
67
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>,
68
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> len</code></em>,
69
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> cursor_index</code></em>);
70
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GtkIMContext.html#gtk-im-context-get-surrounding" title="gtk_im_context_get_surrounding ()">gtk_im_context_get_surrounding</a>      (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
71
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **text</code></em>,
72
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *cursor_index</code></em>);
73
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GtkIMContext.html#gtk-im-context-delete-surrounding" title="gtk_im_context_delete_surrounding ()">gtk_im_context_delete_surrounding</a>   (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
74
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
75
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_chars</code></em>);
 
67
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
 
68
                                                         <em class="parameter"><code><span class="type">gint</span> len</code></em>,
 
69
                                                         <em class="parameter"><code><span class="type">gint</span> cursor_index</code></em>);
 
70
<span class="returnvalue">gboolean</span>            <a class="link" href="GtkIMContext.html#gtk-im-context-get-surrounding" title="gtk_im_context_get_surrounding ()">gtk_im_context_get_surrounding</a>      (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
 
71
                                                         <em class="parameter"><code><span class="type">gchar</span> **text</code></em>,
 
72
                                                         <em class="parameter"><code><span class="type">gint</span> *cursor_index</code></em>);
 
73
<span class="returnvalue">gboolean</span>            <a class="link" href="GtkIMContext.html#gtk-im-context-delete-surrounding" title="gtk_im_context_delete_surrounding ()">gtk_im_context_delete_surrounding</a>   (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
 
74
                                                         <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
 
75
                                                         <em class="parameter"><code><span class="type">gint</span> n_chars</code></em>);
76
76
</pre>
77
77
</div>
78
78
<div class="refsect1">
79
79
<a name="GtkIMContext.object-hierarchy"></a><h2>Object Hierarchy</h2>
80
80
<pre class="synopsis">
81
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
81
  GObject
82
82
   +----GtkIMContext
83
83
         +----<a class="link" href="GtkIMContextSimple.html" title="GtkIMContextSimple">GtkIMContextSimple</a>
84
84
         +----<a class="link" href="GtkIMMulticontext.html" title="GtkIMMulticontext">GtkIMMulticontext</a>
87
87
<div class="refsect1">
88
88
<a name="GtkIMContext.signals"></a><h2>Signals</h2>
89
89
<pre class="synopsis">
90
 
  "<a class="link" href="GtkIMContext.html#GtkIMContext-commit" title='The "commit" signal'>commit</a>"                                         : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
91
 
  "<a class="link" href="GtkIMContext.html#GtkIMContext-delete-surrounding" title='The "delete-surrounding" signal'>delete-surrounding</a>"                             : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
92
 
  "<a class="link" href="GtkIMContext.html#GtkIMContext-preedit-changed" title='The "preedit-changed" signal'>preedit-changed</a>"                                : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
93
 
  "<a class="link" href="GtkIMContext.html#GtkIMContext-preedit-end" title='The "preedit-end" signal'>preedit-end</a>"                                    : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
94
 
  "<a class="link" href="GtkIMContext.html#GtkIMContext-preedit-start" title='The "preedit-start" signal'>preedit-start</a>"                                  : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
95
 
  "<a class="link" href="GtkIMContext.html#GtkIMContext-retrieve-surrounding" title='The "retrieve-surrounding" signal'>retrieve-surrounding</a>"                           : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
90
  "<a class="link" href="GtkIMContext.html#GtkIMContext-commit" title='The "commit" signal'>commit</a>"                                         : <code class="literal">Run Last</code>
 
91
  "<a class="link" href="GtkIMContext.html#GtkIMContext-delete-surrounding" title='The "delete-surrounding" signal'>delete-surrounding</a>"                             : <code class="literal">Run Last</code>
 
92
  "<a class="link" href="GtkIMContext.html#GtkIMContext-preedit-changed" title='The "preedit-changed" signal'>preedit-changed</a>"                                : <code class="literal">Run Last</code>
 
93
  "<a class="link" href="GtkIMContext.html#GtkIMContext-preedit-end" title='The "preedit-end" signal'>preedit-end</a>"                                    : <code class="literal">Run Last</code>
 
94
  "<a class="link" href="GtkIMContext.html#GtkIMContext-preedit-start" title='The "preedit-start" signal'>preedit-start</a>"                                  : <code class="literal">Run Last</code>
 
95
  "<a class="link" href="GtkIMContext.html#GtkIMContext-retrieve-surrounding" title='The "retrieve-surrounding" signal'>retrieve-surrounding</a>"                           : <code class="literal">Run Last</code>
96
96
</pre>
97
97
</div>
98
98
<div class="refsect1">
147
147
</div>
148
148
 
149
149
<p>
150
 
This function should register the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the <a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> subclass which
151
 
implements the input method by means of <a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html#g-type-module-register-type"><code class="function">g_type_module_register_type()</code></a>. Note
152
 
that <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#g-type-register-static"><code class="function">g_type_register_static()</code></a> cannot be used as the type needs to be
 
150
This function should register the <span class="type">GType</span> of the <a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> subclass which
 
151
implements the input method by means of <code class="function">g_type_module_register_type()</code>. Note
 
152
that <code class="function">g_type_register_static()</code> cannot be used as the type needs to be
153
153
registered dynamically.
154
154
</p>
155
155
<p>
182
182
        <td class="listing_code"><pre class="programlisting"><span class="type">void</span><span class="normal"> </span><span class="function">im_module_list</span><span class="symbol">(</span><span class="keyword">const</span><span class="normal"> </span><span class="symbol">&lt;</span><span class="usertype">a</span><span class="normal"> class</span><span class="symbol">=</span><span class="string">"link"</span><span class="normal"> href</span><span class="symbol">=</span><span class="string">"GtkIMContext.html#GtkIMContextInfo"</span><span class="normal"> title</span><span class="symbol">=</span><span class="string">"struct GtkIMContextInfo"</span><span class="symbol">&gt;</span><span class="usertype">GtkIMContextInfo&lt;/a&gt;</span><span class="normal"> </span><span class="symbol">***</span><span class="normal">contexts</span><span class="symbol">,</span><span class="normal"> </span><span class="type">int</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">n_contexts</span><span class="symbol">)</span>
183
183
<span class="cbracket">{</span>
184
184
<span class="normal">  </span><span class="symbol">*</span><span class="normal">contexts </span><span class="symbol">=</span><span class="normal"> info_list</span><span class="symbol">;</span>
185
 
<span class="normal">  </span><span class="symbol">*</span><span class="normal">n_contexts </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Miscellaneous-Macros.html#G-N-ELEMENTS:CAPS">G_N_ELEMENTS</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">info_list</span><span class="symbol">);</span>
 
185
<span class="normal">  </span><span class="symbol">*</span><span class="normal">n_contexts </span><span class="symbol">=</span><span class="normal"> </span><span class="function">G_N_ELEMENTS</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">info_list</span><span class="symbol">);</span>
186
186
<span class="cbracket">}</span></pre></td>
187
187
      </tr>
188
188
    </tbody>
317
317
<td>Called via <a class="link" href="GtkIMContext.html#gtk-im-context-filter-keypress" title="gtk_im_context_filter_keypress ()"><code class="function">gtk_im_context_filter_keypress()</code></a> on every
318
318
key press or release event. Every non-trivial input method needs to
319
319
override this in order to implement the mapping from key events to text.
320
 
A return value of <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> indicates to the caller that the event was
 
320
A return value of <code class="literal">TRUE</code> indicates to the caller that the event was
321
321
consumed by the input method. In that case, the <a class="link" href="GtkIMContext.html#GtkIMContext-commit" title='The "commit" signal'><span class="type">"commit"</span></a>
322
322
signal should be emitted upon completion of a key sequence to pass the
323
 
resulting text back to the input widget. Alternatively, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> may be
 
323
resulting text back to the input widget. Alternatively, <code class="literal">FALSE</code> may be
324
324
returned to indicate that the event wasn't handled by the input method.
325
325
If a builtin mapping exists for the key, it is used to produce a
326
326
character.</td>
393
393
<col align="left" valign="top">
394
394
<tbody>
395
395
<tr>
396
 
<td><p><span class="term">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GtkIMContextInfo.context-id"></a>context_id</code></em>;</span></p></td>
 
396
<td><p><span class="term">const <span class="type">gchar</span> *<em class="structfield"><code><a name="GtkIMContextInfo.context-id"></a>context_id</code></em>;</span></p></td>
397
397
<td>The unique identification string of the input method.</td>
398
398
</tr>
399
399
<tr>
400
 
<td><p><span class="term">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GtkIMContextInfo.context-name"></a>context_name</code></em>;</span></p></td>
 
400
<td><p><span class="term">const <span class="type">gchar</span> *<em class="structfield"><code><a name="GtkIMContextInfo.context-name"></a>context_name</code></em>;</span></p></td>
401
401
<td>The human-readable name of the input method.</td>
402
402
</tr>
403
403
<tr>
404
 
<td><p><span class="term">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GtkIMContextInfo.domain"></a>domain</code></em>;</span></p></td>
 
404
<td><p><span class="term">const <span class="type">gchar</span> *<em class="structfield"><code><a name="GtkIMContextInfo.domain"></a>domain</code></em>;</span></p></td>
405
405
<td>Translation domain to be used with <code class="function">dgettext()</code>
406
406
</td>
407
407
</tr>
408
408
<tr>
409
 
<td><p><span class="term">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GtkIMContextInfo.domain-dirname"></a>domain_dirname</code></em>;</span></p></td>
 
409
<td><p><span class="term">const <span class="type">gchar</span> *<em class="structfield"><code><a name="GtkIMContextInfo.domain-dirname"></a>domain_dirname</code></em>;</span></p></td>
410
410
<td>Name of locale directory for use with <code class="function">bindtextdomain()</code>
411
411
</td>
412
412
</tr>
413
413
<tr>
414
 
<td><p><span class="term">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GtkIMContextInfo.default-locales"></a>default_locales</code></em>;</span></p></td>
 
414
<td><p><span class="term">const <span class="type">gchar</span> *<em class="structfield"><code><a name="GtkIMContextInfo.default-locales"></a>default_locales</code></em>;</span></p></td>
415
415
<td>A colon-separated list of locales where this input method
416
416
should be the default. The asterisk "*" sets the default for all locales.</td>
417
417
</tr>
422
422
<div class="refsect2">
423
423
<a name="gtk-im-context-set-client-window"></a><h3>gtk_im_context_set_client_window ()</h3>
424
424
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_im_context_set_client_window    (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
425
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> *window</code></em>);</pre>
 
425
                                                         <em class="parameter"><code><a href="../gdk/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> *window</code></em>);</pre>
426
426
<p>
427
427
Set the client window for the input context; this is the
428
 
<a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> in which the input appears. This window is
 
428
<a href="../gdk/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> in which the input appears. This window is
429
429
used in order to correctly position status windows, and may
430
430
also be used for purposes internal to the input method.
431
431
</p>
439
439
</tr>
440
440
<tr>
441
441
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
442
 
<td>the client window. This may be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to indicate
 
442
<td>the client window. This may be <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to indicate
443
443
that the previous client window no longer exists. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
444
444
</td>
445
445
</tr>
450
450
<div class="refsect2">
451
451
<a name="gtk-im-context-get-preedit-string"></a><h3>gtk_im_context_get_preedit_string ()</h3>
452
452
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_im_context_get_preedit_string   (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
453
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **str</code></em>,
 
453
                                                         <em class="parameter"><code><span class="type">gchar</span> **str</code></em>,
454
454
                                                         <em class="parameter"><code><span class="type">PangoAttrList</span> **attrs</code></em>,
455
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *cursor_pos</code></em>);</pre>
 
455
                                                         <em class="parameter"><code><span class="type">gint</span> *cursor_pos</code></em>);</pre>
456
456
<p>
457
457
Retrieve the current preedit string for the input context,
458
458
and a list of attributes to apply to the string.
470
470
<tr>
471
471
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
472
472
<td>location to store the retrieved
473
 
string. The string retrieved must be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
473
string. The string retrieved must be freed with <code class="function">g_free()</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
474
474
</td>
475
475
</tr>
476
476
<tr>
492
492
<hr>
493
493
<div class="refsect2">
494
494
<a name="gtk-im-context-filter-keypress"></a><h3>gtk_im_context_filter_keypress ()</h3>
495
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_im_context_filter_keypress      (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
496
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkEventKey"><span class="type">GdkEventKey</span></a> *event</code></em>);</pre>
 
495
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_im_context_filter_keypress      (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
 
496
                                                         <em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkEventKey"><span class="type">GdkEventKey</span></a> *event</code></em>);</pre>
497
497
<p>
498
498
Allow an input method to internally handle key press and release 
499
 
events. If this function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, then no further processing
 
499
events. If this function returns <code class="literal">TRUE</code>, then no further processing
500
500
should be done for this key event.
501
501
</p>
502
502
<div class="variablelist"><table border="0">
514
514
<tr>
515
515
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
516
516
<td>
517
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the input method handled the key event.</td>
 
517
<code class="literal">TRUE</code> if the input method handled the key event.</td>
518
518
</tr>
519
519
</tbody>
520
520
</table></div>
579
579
<div class="refsect2">
580
580
<a name="gtk-im-context-set-cursor-location"></a><h3>gtk_im_context_set_cursor_location ()</h3>
581
581
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_im_context_set_cursor_location  (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
582
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gdk3/gdk-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *area</code></em>);</pre>
 
582
                                                         <em class="parameter"><code>const <a href="../gdk/gdk-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *area</code></em>);</pre>
583
583
<p>
584
584
Notify the input method that a change in cursor 
585
585
position has been made. The location is relative to the client
604
604
<div class="refsect2">
605
605
<a name="gtk-im-context-set-use-preedit"></a><h3>gtk_im_context_set_use_preedit ()</h3>
606
606
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_im_context_set_use_preedit      (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
607
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> use_preedit</code></em>);</pre>
 
607
                                                         <em class="parameter"><code><span class="type">gboolean</span> use_preedit</code></em>);</pre>
608
608
<p>
609
609
Sets whether the IM context should use the preedit string
610
610
to display feedback. If <em class="parameter"><code>use_preedit</code></em> is FALSE (default
630
630
<div class="refsect2">
631
631
<a name="gtk-im-context-set-surrounding"></a><h3>gtk_im_context_set_surrounding ()</h3>
632
632
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_im_context_set_surrounding      (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
633
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>,
634
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> len</code></em>,
635
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> cursor_index</code></em>);</pre>
 
633
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
 
634
                                                         <em class="parameter"><code><span class="type">gint</span> len</code></em>,
 
635
                                                         <em class="parameter"><code><span class="type">gint</span> cursor_index</code></em>);</pre>
636
636
<p>
637
637
Sets surrounding context around the insertion point and preedit
638
638
string. This function is expected to be called in response to the
667
667
<hr>
668
668
<div class="refsect2">
669
669
<a name="gtk-im-context-get-surrounding"></a><h3>gtk_im_context_get_surrounding ()</h3>
670
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_im_context_get_surrounding      (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
671
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **text</code></em>,
672
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *cursor_index</code></em>);</pre>
 
670
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_im_context_get_surrounding      (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
 
671
                                                         <em class="parameter"><code><span class="type">gchar</span> **text</code></em>,
 
672
                                                         <em class="parameter"><code><span class="type">gint</span> *cursor_index</code></em>);</pre>
673
673
<p>
674
674
Retrieves context around the insertion point. Input methods
675
675
typically want context in order to constrain input text based on
697
697
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
698
698
<td>location to store a UTF-8 encoded
699
699
string of text holding context around the insertion point.
700
 
If the function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, then you must free the result
701
 
stored in this location with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
700
If the function returns <code class="literal">TRUE</code>, then you must free the result
 
701
stored in this location with <code class="function">g_free()</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
702
702
</td>
703
703
</tr>
704
704
<tr>
709
709
<tr>
710
710
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
711
711
<td>
712
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if surrounding text was provided; in this case
 
712
<code class="literal">TRUE</code> if surrounding text was provided; in this case
713
713
you must free the result stored in *text.</td>
714
714
</tr>
715
715
</tbody>
718
718
<hr>
719
719
<div class="refsect2">
720
720
<a name="gtk-im-context-delete-surrounding"></a><h3>gtk_im_context_delete_surrounding ()</h3>
721
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_im_context_delete_surrounding   (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
722
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset</code></em>,
723
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_chars</code></em>);</pre>
 
721
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_im_context_delete_surrounding   (<em class="parameter"><code><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context</code></em>,
 
722
                                                         <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
 
723
                                                         <em class="parameter"><code><span class="type">gint</span> n_chars</code></em>);</pre>
724
724
<p>
725
725
Asks the widget that the input context is attached to to delete
726
726
characters around the cursor position by emitting the
761
761
<tr>
762
762
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
763
763
<td>
764
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the signal was handled.</td>
 
764
<code class="literal">TRUE</code> if the signal was handled.</td>
765
765
</tr>
766
766
</tbody>
767
767
</table></div>
772
772
<div class="refsect2">
773
773
<a name="GtkIMContext-commit"></a><h3>The <code class="literal">"commit"</code> signal</h3>
774
774
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context,
775
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>        *str,
776
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
775
                                                        <span class="type">gchar</span>        *str,
 
776
                                                        <span class="type">gpointer</span>      user_data)      : <code class="literal">Run Last</code></pre>
777
777
<p>
778
778
The ::commit signal is emitted when a complete input sequence
779
779
has been entered by the user. This can be a single character
800
800
<hr>
801
801
<div class="refsect2">
802
802
<a name="GtkIMContext-delete-surrounding"></a><h3>The <code class="literal">"delete-surrounding"</code> signal</h3>
803
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context,
804
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>          offset,
805
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>          n_chars,
806
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
803
<pre class="programlisting"><span class="returnvalue">gboolean</span>            user_function                      (<a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context,
 
804
                                                        <span class="type">gint</span>          offset,
 
805
                                                        <span class="type">gint</span>          n_chars,
 
806
                                                        <span class="type">gpointer</span>      user_data)      : <code class="literal">Run Last</code></pre>
807
807
<p>
808
808
The ::delete-surrounding signal is emitted when the input method
809
809
needs to delete all or part of the context surrounding the cursor.
832
832
<tr>
833
833
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
834
834
<td>
835
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the signal was handled.</td>
 
835
<code class="literal">TRUE</code> if the signal was handled.</td>
836
836
</tr>
837
837
</tbody>
838
838
</table></div>
841
841
<div class="refsect2">
842
842
<a name="GtkIMContext-preedit-changed"></a><h3>The <code class="literal">"preedit-changed"</code> signal</h3>
843
843
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context,
844
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
844
                                                        <span class="type">gpointer</span>      user_data)      : <code class="literal">Run Last</code></pre>
845
845
<p>
846
846
The ::preedit-changed signal is emitted whenever the preedit sequence
847
847
currently being entered has changed.  It is also emitted at the end of
866
866
<div class="refsect2">
867
867
<a name="GtkIMContext-preedit-end"></a><h3>The <code class="literal">"preedit-end"</code> signal</h3>
868
868
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context,
869
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
869
                                                        <span class="type">gpointer</span>      user_data)      : <code class="literal">Run Last</code></pre>
870
870
<p>
871
871
The ::preedit-end signal is emitted when a preediting sequence
872
872
has been completed or canceled.
889
889
<div class="refsect2">
890
890
<a name="GtkIMContext-preedit-start"></a><h3>The <code class="literal">"preedit-start"</code> signal</h3>
891
891
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context,
892
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
892
                                                        <span class="type">gpointer</span>      user_data)      : <code class="literal">Run Last</code></pre>
893
893
<p>
894
894
The ::preedit-start signal is emitted when a new preediting sequence
895
895
starts.
911
911
<hr>
912
912
<div class="refsect2">
913
913
<a name="GtkIMContext-retrieve-surrounding"></a><h3>The <code class="literal">"retrieve-surrounding"</code> signal</h3>
914
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context,
915
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
914
<pre class="programlisting"><span class="returnvalue">gboolean</span>            user_function                      (<a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="type">GtkIMContext</span></a> *context,
 
915
                                                        <span class="type">gpointer</span>      user_data)      : <code class="literal">Run Last</code></pre>
916
916
<p>
917
917
The ::retrieve-surrounding signal is emitted when the input method
918
918
requires the context surrounding the cursor.  The callback should set
933
933
<tr>
934
934
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
935
935
<td>
936
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the signal was handled.</td>
 
936
<code class="literal">TRUE</code> if the signal was handled.</td>
937
937
</tr>
938
938
</tbody>
939
939
</table></div>