~ubuntu-branches/ubuntu/trusty/gtk+2.0/trusty

void <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> (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

<code><a href="http://library.gnome.org/devel/gdk3/gdk2-Windows.html#GdkWindow">GdkWindow</a> *window</code>);

<code><a href="../gdk2/gdk2-Windows.html#GdkWindow">GdkWindow</a> *window</code>);

void <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> (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> **str</code>,

<code>PangoAttrList **attrs</code>,

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> *cursor_pos</code>);

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GtkIMContext.html#gtk-im-context-filter-keypress" title="gtk_im_context_filter_keypress ()">gtk_im_context_filter_keypress</a> (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

<code><a href="http://library.gnome.org/devel/gdk3/gdk2-Event-Structures.html#GdkEventKey">GdkEventKey</a> *event</code>);

<code>gchar **str</code>,

<code><a href="/usr/share/gtk-doc/html/pango/pango-Text-Attributes.html#PangoAttrList">PangoAttrList</a> **attrs</code>,

<code>gint *cursor_pos</code>);

gboolean <a class="link" href="GtkIMContext.html#gtk-im-context-filter-keypress" title="gtk_im_context_filter_keypress ()">gtk_im_context_filter_keypress</a> (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

<code><a href="../gdk2/gdk2-Event-Structures.html#GdkEventKey">GdkEventKey</a> *event</code>);

void <a class="link" href="GtkIMContext.html#gtk-im-context-focus-in" title="gtk_im_context_focus_in ()">gtk_im_context_focus_in</a> (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>);

void <a class="link" href="GtkIMContext.html#gtk-im-context-focus-out" title="gtk_im_context_focus_out ()">gtk_im_context_focus_out</a> (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>);

void <a class="link" href="GtkIMContext.html#gtk-im-context-reset" title="gtk_im_context_reset ()">gtk_im_context_reset</a> (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>);

void <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> (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

<code>const <a href="http://library.gnome.org/devel/gdk3/gdk2-Points-Rectangles-and-Regions.html#GdkRectangle">GdkRectangle</a> *area</code>);

<code>const <a href="../gdk2/gdk2-Points-Rectangles-and-Regions.html#GdkRectangle">GdkRectangle</a> *area</code>);

void <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> (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> use_preedit</code>);

<code>gboolean use_preedit</code>);

void <a class="link" href="GtkIMContext.html#gtk-im-context-set-surrounding" title="gtk_im_context_set_surrounding ()">gtk_im_context_set_surrounding</a> (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *text</code>,

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> len</code>,

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> cursor_index</code>);

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GtkIMContext.html#gtk-im-context-get-surrounding" title="gtk_im_context_get_surrounding ()">gtk_im_context_get_surrounding</a> (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> **text</code>,

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> *cursor_index</code>);

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GtkIMContext.html#gtk-im-context-delete-surrounding" title="gtk_im_context_delete_surrounding ()">gtk_im_context_delete_surrounding</a> (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> offset</code>,

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> n_chars</code>);

<code>const gchar *text</code>,

<code>gint len</code>,

<code>gint cursor_index</code>);

gboolean <a class="link" href="GtkIMContext.html#gtk-im-context-get-surrounding" title="gtk_im_context_get_surrounding ()">gtk_im_context_get_surrounding</a> (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

<code>gchar **text</code>,

<code>gint *cursor_index</code>);

gboolean <a class="link" href="GtkIMContext.html#gtk-im-context-delete-surrounding" title="gtk_im_context_delete_surrounding ()">gtk_im_context_delete_surrounding</a> (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

<code>gint offset</code>,

<code>gint n_chars</code>);

</pre>

</div>

<a name="GtkIMContext.object-hierarchy"></a><h2>Object Hierarchy</h2>

<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>

GObject

+----GtkIMContext

+----<a class="link" href="GtkIMContextSimple.html" title="GtkIMContextSimple">GtkIMContextSimple</a>

+----<a class="link" href="GtkIMMulticontext.html" title="GtkIMMulticontext">GtkIMMulticontext</a>

<a name="GtkIMContext.signals"></a><h2>Signals</h2>

"<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>

"<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>

"<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>

"<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>

"<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>

"<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>

"<a class="link" href="GtkIMContext.html#GtkIMContext-commit" title='The "commit" signal'>commit</a>" : <code class="literal">Run Last</code>

"<a class="link" href="GtkIMContext.html#GtkIMContext-delete-surrounding" title='The "delete-surrounding" signal'>delete-surrounding</a>" : <code class="literal">Run Last</code>

"<a class="link" href="GtkIMContext.html#GtkIMContext-preedit-changed" title='The "preedit-changed" signal'>preedit-changed</a>" : <code class="literal">Run Last</code>

"<a class="link" href="GtkIMContext.html#GtkIMContext-preedit-end" title='The "preedit-end" signal'>preedit-end</a>" : <code class="literal">Run Last</code>

"<a class="link" href="GtkIMContext.html#GtkIMContext-preedit-start" title='The "preedit-start" signal'>preedit-start</a>" : <code class="literal">Run Last</code>

"<a class="link" href="GtkIMContext.html#GtkIMContext-retrieve-surrounding" title='The "retrieve-surrounding" signal'>retrieve-surrounding</a>" : <code class="literal">Run Last</code>

</pre>

</div>

147

</div>

148

149

150

This function should register the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType">GType</a> of the <a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</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 GType of the <a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</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

registered dynamically.

154

155

182

<td class="listing_code"><pre class="programlisting">void im_module_list(const <a class="link" href="GtkIMContext.html#GtkIMContextInfo" title="struct GtkIMContextInfo">GtkIMContextInfo</a> ***contexts, int *n_contexts)

183

{

184

*contexts = info_list;

185

*n_contexts = <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#G-N-ELEMENTS:CAPS">G_N_ELEMENTS</a> (info_list);

185

*n_contexts = G_N_ELEMENTS (info_list);

186

}</pre></td>

187

</tr>

188

</tbody>

320

<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

321

key press or release event. Every non-trivial input method needs to

322

override this in order to implement the mapping from key events to text.

323

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

323

A return value of <code class="literal">TRUE</code> indicates to the caller that the event was

324

consumed by the input method. In that case, the <a class="link" href="GtkIMContext.html#GtkIMContext-commit" title='The "commit" signal'>"commit"</a>

325

signal should be emitted upon completion of a key sequence to pass the

326

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

326

resulting text back to the input widget. Alternatively, <code class="literal">FALSE</code> may be

327

returned to indicate that the event wasn't handled by the input method.

328

If a builtin mapping exists for the key, it is used to produce a

329

character.</td>

399

</colgroup>

400

<tbody>

401

<tr>

402

<td>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *<code><a name="GtkIMContextInfo.context-id"></a>context_id</code>;</td>

402

<td>const gchar *<code><a name="GtkIMContextInfo.context-id"></a>context_id</code>;</td>

403

<td>The unique identification string of the input method.</td>

404

</tr>

405

<tr>

406

<td>const gchar *<code><a name="GtkIMContextInfo.context-name"></a>context_name</code>;</td>

407

<td>The human-readable name of the input method.</td>

408

</tr>

409

<tr>

410

<td>const gchar *<code><a name="GtkIMContextInfo.domain"></a>domain</code>;</td>

411

<td>Translation domain to be used with <code class="function">dgettext()</code>

412

</td>

413

</tr>

414

<tr>

415

<td>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *<code><a name="GtkIMContextInfo.domain-dirname"></a>domain_dirname</code>;</td>

415

<td>const gchar *<code><a name="GtkIMContextInfo.domain-dirname"></a>domain_dirname</code>;</td>

416

<td>Name of locale directory for use with <code class="function">bindtextdomain()</code>

417

</td>

418

</tr>

419

<tr>

420

<td>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *<code><a name="GtkIMContextInfo.default-locales"></a>default_locales</code>;</td>

420

<td>const gchar *<code><a name="GtkIMContextInfo.default-locales"></a>default_locales</code>;</td>

421

<td>A colon-separated list of locales where this input method

422

should be the default. The asterisk "*" sets the default for all locales.</td>

423

</tr>

428

429

<a name="gtk-im-context-set-client-window"></a><h3>gtk_im_context_set_client_window ()</h3>

430

<pre class="programlisting">void gtk_im_context_set_client_window (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

431

<code><a href="http://library.gnome.org/devel/gdk3/gdk2-Windows.html#GdkWindow">GdkWindow</a> *window</code>);</pre>

431

<code><a href="../gdk2/gdk2-Windows.html#GdkWindow">GdkWindow</a> *window</code>);</pre>

432

433

Set the client window for the input context; this is the

434

<a href="http://library.gnome.org/devel/gdk3/gdk2-Windows.html#GdkWindow">GdkWindow</a> in which the input appears. This window is

434

<a href="../gdk2/gdk2-Windows.html#GdkWindow">GdkWindow</a> in which the input appears. This window is

435

used in order to correctly position status windows, and may

436

also be used for purposes internal to the input method.

437

448

</tr>

449

<tr>

450

<td><code>window</code> :</td>

451

<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

451

<td>the client window. This may be <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> to indicate

452

that the previous client window no longer exists. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

453

</td>

454

</tr>

459

460

<a name="gtk-im-context-get-preedit-string"></a><h3>gtk_im_context_get_preedit_string ()</h3>

461

<pre class="programlisting">void gtk_im_context_get_preedit_string (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

462

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> **str</code>,

463

<code>PangoAttrList **attrs</code>,

464

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> *cursor_pos</code>);</pre>

462

<code>gchar **str</code>,

463

<code><a href="/usr/share/gtk-doc/html/pango/pango-Text-Attributes.html#PangoAttrList">PangoAttrList</a> **attrs</code>,

464

<code>gint *cursor_pos</code>);</pre>

465

466

Retrieve the current preedit string for the input context,

467

and a list of attributes to apply to the string.

482

<tr>

483

484

<td>location to store the retrieved

485

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>. [<acronym title="Parameter for returning results. Default is transfer full.">out</acronym>][<acronym title="Free data after the code is done.">transfer full</acronym>]

485

string. The string retrieved must be freed with <code class="function">g_free()</code>. [<acronym title="Parameter for returning results. Default is transfer full.">out</acronym>][<acronym title="Free data after the code is done.">transfer full</acronym>]

486

</td>

487

</tr>

488

<tr>

489

<td><code>attrs</code> :</td>

490

<td>location to store the retrieved

491

attribute list. When you are done with this list, you

492

must unreference it with <code class="function">pango_attr_list_unref()</code>. [<acronym title="Parameter for returning results. Default is transfer full.">out</acronym>][<acronym title="Free data after the code is done.">transfer full</acronym>]

492

must unreference it with <a href="/usr/share/gtk-doc/html/pango/pango-Text-Attributes.html#pango-attr-list-unref"><code class="function">pango_attr_list_unref()</code></a>. [<acronym title="Parameter for returning results. Default is transfer full.">out</acronym>][<acronym title="Free data after the code is done.">transfer full</acronym>]

493

</td>

494

</tr>

495

<tr>

504

<hr>

505

506

<a name="gtk-im-context-filter-keypress"></a><h3>gtk_im_context_filter_keypress ()</h3>

507

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> gtk_im_context_filter_keypress (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

508

<code><a href="http://library.gnome.org/devel/gdk3/gdk2-Event-Structures.html#GdkEventKey">GdkEventKey</a> *event</code>);</pre>

507

<pre class="programlisting">gboolean gtk_im_context_filter_keypress (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

508

<code><a href="../gdk2/gdk2-Event-Structures.html#GdkEventKey">GdkEventKey</a> *event</code>);</pre>

509

510

Allow an input method to internally handle key press and release

511

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

511

events. If this function returns <code class="literal">TRUE</code>, then no further processing

512

should be done for this key event.

513

514

529

<tr>

530

<td>Returns :</td>

531

<td>

532

<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>

532

<code class="literal">TRUE</code> if the input method handled the key event.</td>

533

</tr>

534

</tbody>

535

</table></div>

603

604

<a name="gtk-im-context-set-cursor-location"></a><h3>gtk_im_context_set_cursor_location ()</h3>

605

<pre class="programlisting">void gtk_im_context_set_cursor_location (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

606

<code>const <a href="http://library.gnome.org/devel/gdk3/gdk2-Points-Rectangles-and-Regions.html#GdkRectangle">GdkRectangle</a> *area</code>);</pre>

606

<code>const <a href="../gdk2/gdk2-Points-Rectangles-and-Regions.html#GdkRectangle">GdkRectangle</a> *area</code>);</pre>

607

608

Notify the input method that a change in cursor

609

position has been made. The location is relative to the client

631

632

<a name="gtk-im-context-set-use-preedit"></a><h3>gtk_im_context_set_use_preedit ()</h3>

633

<pre class="programlisting">void gtk_im_context_set_use_preedit (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

634

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> use_preedit</code>);</pre>

634

<code>gboolean use_preedit</code>);</pre>

635

636

Sets whether the IM context should use the preedit string

637

to display feedback. If <code>use_preedit</code> is FALSE (default

660

661

<a name="gtk-im-context-set-surrounding"></a><h3>gtk_im_context_set_surrounding ()</h3>

662

<pre class="programlisting">void gtk_im_context_set_surrounding (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

663

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *text</code>,

664

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> len</code>,

665

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> cursor_index</code>);</pre>

663

<code>const gchar *text</code>,

664

<code>gint len</code>,

665

<code>gint cursor_index</code>);</pre>

666

667

Sets surrounding context around the insertion point and preedit

668

string. This function is expected to be called in response to the

700

<hr>

701

702

<a name="gtk-im-context-get-surrounding"></a><h3>gtk_im_context_get_surrounding ()</h3>

703

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> gtk_im_context_get_surrounding (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

704

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> **text</code>,

705

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> *cursor_index</code>);</pre>

703

<pre class="programlisting">gboolean gtk_im_context_get_surrounding (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

704

<code>gchar **text</code>,

705

<code>gint *cursor_index</code>);</pre>

706

707

Retrieves context around the insertion point. Input methods

708

typically want context in order to constrain input text based on

733

734

<td>location to store a UTF-8 encoded

735

string of text holding context around the insertion point.

736

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

737

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>. [<acronym title="Parameter for returning results. Default is transfer full.">out</acronym>][<acronym title="Free data after the code is done.">transfer full</acronym>]

736

If the function returns <code class="literal">TRUE</code>, then you must free the result

737

stored in this location with <code class="function">g_free()</code>. [<acronym title="Parameter for returning results. Default is transfer full.">out</acronym>][<acronym title="Free data after the code is done.">transfer full</acronym>]

738

</td>

739

</tr>

740

<tr>

745

<tr>

746

<td>Returns :</td>

747

<td>

748

<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

748

<code class="literal">TRUE</code> if surrounding text was provided; in this case

749

you must free the result stored in *text.</td>

750

</tr>

751

</tbody>

754

<hr>

755

756

<a name="gtk-im-context-delete-surrounding"></a><h3>gtk_im_context_delete_surrounding ()</h3>

757

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> gtk_im_context_delete_surrounding (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

758

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> offset</code>,

759

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> n_chars</code>);</pre>

757

<pre class="programlisting">gboolean gtk_im_context_delete_surrounding (<code><a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context</code>,

758

<code>gint offset</code>,

759

<code>gint n_chars</code>);</pre>

760

761

Asks the widget that the input context is attached to to delete

762

characters around the cursor position by emitting the

800

<tr>

801

<td>Returns :</td>

802

<td>

803

<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>

803

<code class="literal">TRUE</code> if the signal was handled.</td>

804

</tr>

805

</tbody>

806

</table></div>

811

812

<a name="GtkIMContext-commit"></a><h3>The <code class="literal">"commit"</code> signal</h3>

813

<pre class="programlisting">void user_function (<a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context,

814

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *str,

815

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</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>

814

gchar *str,

815

gpointer user_data) : <code class="literal">Run Last</code></pre>

816

817

The ::commit signal is emitted when a complete input sequence

818

has been entered by the user. This can be a single character

842

<hr>

843

844

<a name="GtkIMContext-delete-surrounding"></a><h3>The <code class="literal">"delete-surrounding"</code> signal</h3>

845

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> user_function (<a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context,

846

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> offset,

847

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint">gint</a> n_chars,

848

845

<pre class="programlisting">gboolean user_function (<a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context,

846

gint offset,

847

gint n_chars,

848

gpointer user_data) : <code class="literal">Run Last</code></pre>

849

850

The ::delete-surrounding signal is emitted when the input method

851

needs to delete all or part of the context surrounding the cursor.

877

<tr>

878

<td>Returns :</td>

879

<td>

880

<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>

880

<code class="literal">TRUE</code> if the signal was handled.</td>

881

</tr>

882

</tbody>

883

</table></div>

886

887

<a name="GtkIMContext-preedit-changed"></a><h3>The <code class="literal">"preedit-changed"</code> signal</h3>

888

<pre class="programlisting">void user_function (<a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context,

889

gpointer user_data) : <code class="literal">Run Last</code></pre>

890

891

The ::preedit-changed signal is emitted whenever the preedit sequence

892

currently being entered has changed. It is also emitted at the end of

914

915

<a name="GtkIMContext-preedit-end"></a><h3>The <code class="literal">"preedit-end"</code> signal</h3>

916

<pre class="programlisting">void user_function (<a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context,

917

gpointer user_data) : <code class="literal">Run Last</code></pre>

918

919

The ::preedit-end signal is emitted when a preediting sequence

920

has been completed or canceled.

940

941

<a name="GtkIMContext-preedit-start"></a><h3>The <code class="literal">"preedit-start"</code> signal</h3>

942

<pre class="programlisting">void user_function (<a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context,

943

gpointer user_data) : <code class="literal">Run Last</code></pre>

944

945

The ::preedit-start signal is emitted when a new preediting sequence

946

starts.

965

<hr>

966

967

<a name="GtkIMContext-retrieve-surrounding"></a><h3>The <code class="literal">"retrieve-surrounding"</code> signal</h3>

968

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> user_function (<a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context,

969

968

<pre class="programlisting">gboolean user_function (<a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a> *context,

969

gpointer user_data) : <code class="literal">Run Last</code></pre>

970

971

The ::retrieve-surrounding signal is emitted when the input method

972

requires the context surrounding the cursor. The callback should set

990

<tr>

991

<td>Returns :</td>

992

<td>

993

<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>

993

<code class="literal">TRUE</code> if the signal was handled.</td>

994

</tr>

995

</tbody>

996

</table></div>

Older »