1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>WebKitInputMethodContext: WebKitGTK Reference Manual</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7
<link rel="home" href="index.html" title="WebKitGTK Reference Manual">
8
<link rel="up" href="ch01.html" title="Class Overview">
9
<link rel="prev" href="WebKitPointerLockPermissionRequest.html" title="WebKitPointerLockPermissionRequest">
10
<link rel="next" href="ch02.html" title="Web Extensions">
11
<meta name="generator" content="GTK-Doc V1.32.1 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16
<td width="100%" align="left" class="shortcuts">
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
18
<a href="#WebKitInputMethodContext.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
19
<a href="#WebKitInputMethodContext.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
20
<a href="#WebKitInputMethodContext.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
21
<a href="#WebKitInputMethodContext.signals" class="shortcut">Signals</a></span>
23
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
24
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
25
<td><a accesskey="p" href="WebKitPointerLockPermissionRequest.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
26
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
28
<div class="refentry">
29
<a name="WebKitInputMethodContext"></a><div class="titlepage"></div>
30
<div class="refnamediv"><table width="100%"><tr>
32
<h2><span class="refentrytitle"><a name="WebKitInputMethodContext.top_of_page"></a>WebKitInputMethodContext</span></h2>
33
<p>WebKitInputMethodContext — Base class for input method contexts</p>
35
<td class="gallery_image" valign="top" align="right"></td>
37
<div class="refsect1">
38
<a name="WebKitInputMethodContext.functions"></a><h2>Functions</h2>
39
<div class="informaltable"><table class="informaltable" width="100%" border="0">
41
<col width="150px" class="functions_proto_type">
42
<col class="functions_proto_name">
46
<td class="function_type">
47
<span class="returnvalue">void</span>
49
<td class="function_name">
50
<a class="link" href="WebKitInputMethodContext.html#webkit-input-method-context-set-enable-preedit" title="webkit_input_method_context_set_enable_preedit ()">webkit_input_method_context_set_enable_preedit</a> <span class="c_punctuation">()</span>
54
<td class="function_type">
55
<span class="returnvalue">void</span>
57
<td class="function_name">
58
<a class="link" href="WebKitInputMethodContext.html#webkit-input-method-context-get-preedit" title="webkit_input_method_context_get_preedit ()">webkit_input_method_context_get_preedit</a> <span class="c_punctuation">()</span>
62
<td class="function_type">
63
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
65
<td class="function_name">
66
<a class="link" href="WebKitInputMethodContext.html#webkit-input-method-context-filter-key-event" title="webkit_input_method_context_filter_key_event ()">webkit_input_method_context_filter_key_event</a> <span class="c_punctuation">()</span>
70
<td class="function_type">
71
<span class="returnvalue">void</span>
73
<td class="function_name">
74
<a class="link" href="WebKitInputMethodContext.html#webkit-input-method-context-notify-focus-in" title="webkit_input_method_context_notify_focus_in ()">webkit_input_method_context_notify_focus_in</a> <span class="c_punctuation">()</span>
78
<td class="function_type">
79
<span class="returnvalue">void</span>
81
<td class="function_name">
82
<a class="link" href="WebKitInputMethodContext.html#webkit-input-method-context-notify-focus-out" title="webkit_input_method_context_notify_focus_out ()">webkit_input_method_context_notify_focus_out</a> <span class="c_punctuation">()</span>
86
<td class="function_type">
87
<span class="returnvalue">void</span>
89
<td class="function_name">
90
<a class="link" href="WebKitInputMethodContext.html#webkit-input-method-context-notify-cursor-area" title="webkit_input_method_context_notify_cursor_area ()">webkit_input_method_context_notify_cursor_area</a> <span class="c_punctuation">()</span>
94
<td class="function_type">
95
<span class="returnvalue">void</span>
97
<td class="function_name">
98
<a class="link" href="WebKitInputMethodContext.html#webkit-input-method-context-notify-surrounding" title="webkit_input_method_context_notify_surrounding ()">webkit_input_method_context_notify_surrounding</a> <span class="c_punctuation">()</span>
102
<td class="function_type">
103
<span class="returnvalue">void</span>
105
<td class="function_name">
106
<a class="link" href="WebKitInputMethodContext.html#webkit-input-method-context-reset" title="webkit_input_method_context_reset ()">webkit_input_method_context_reset</a> <span class="c_punctuation">()</span>
110
<td class="function_type">
111
<a class="link" href="WebKitInputMethodContext.html#WebKitInputPurpose" title="enum WebKitInputPurpose"><span class="returnvalue">WebKitInputPurpose</span></a>
113
<td class="function_name">
114
<a class="link" href="WebKitInputMethodContext.html#webkit-input-method-context-get-input-purpose" title="webkit_input_method_context_get_input_purpose ()">webkit_input_method_context_get_input_purpose</a> <span class="c_punctuation">()</span>
118
<td class="function_type">
119
<span class="returnvalue">void</span>
121
<td class="function_name">
122
<a class="link" href="WebKitInputMethodContext.html#webkit-input-method-context-set-input-purpose" title="webkit_input_method_context_set_input_purpose ()">webkit_input_method_context_set_input_purpose</a> <span class="c_punctuation">()</span>
126
<td class="function_type">
127
<a class="link" href="WebKitInputMethodContext.html#WebKitInputHints" title="enum WebKitInputHints"><span class="returnvalue">WebKitInputHints</span></a>
129
<td class="function_name">
130
<a class="link" href="WebKitInputMethodContext.html#webkit-input-method-context-get-input-hints" title="webkit_input_method_context_get_input_hints ()">webkit_input_method_context_get_input_hints</a> <span class="c_punctuation">()</span>
134
<td class="function_type">
135
<span class="returnvalue">void</span>
137
<td class="function_name">
138
<a class="link" href="WebKitInputMethodContext.html#webkit-input-method-context-set-input-hints" title="webkit_input_method_context_set_input_hints ()">webkit_input_method_context_set_input_hints</a> <span class="c_punctuation">()</span>
142
<td class="function_type">
143
<a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodUnderline"><span class="returnvalue">WebKitInputMethodUnderline</span></a> *
145
<td class="function_name">
146
<a class="link" href="WebKitInputMethodContext.html#webkit-input-method-underline-new" title="webkit_input_method_underline_new ()">webkit_input_method_underline_new</a> <span class="c_punctuation">()</span>
150
<td class="function_type">
151
<a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodUnderline"><span class="returnvalue">WebKitInputMethodUnderline</span></a> *
153
<td class="function_name">
154
<a class="link" href="WebKitInputMethodContext.html#webkit-input-method-underline-copy" title="webkit_input_method_underline_copy ()">webkit_input_method_underline_copy</a> <span class="c_punctuation">()</span>
158
<td class="function_type">
159
<span class="returnvalue">void</span>
161
<td class="function_name">
162
<a class="link" href="WebKitInputMethodContext.html#webkit-input-method-underline-free" title="webkit_input_method_underline_free ()">webkit_input_method_underline_free</a> <span class="c_punctuation">()</span>
166
<td class="function_type">
167
<span class="returnvalue">void</span>
169
<td class="function_name">
170
<a class="link" href="WebKitInputMethodContext.html#webkit-input-method-underline-set-color" title="webkit_input_method_underline_set_color ()">webkit_input_method_underline_set_color</a> <span class="c_punctuation">()</span>
176
<div class="refsect1">
177
<a name="WebKitInputMethodContext.properties"></a><h2>Properties</h2>
178
<div class="informaltable"><table class="informaltable" border="0">
180
<col width="150px" class="properties_type">
181
<col width="300px" class="properties_name">
182
<col width="200px" class="properties_flags">
186
<td class="property_type"><a class="link" href="WebKitInputMethodContext.html#WebKitInputHints" title="enum WebKitInputHints"><span class="type">WebKitInputHints</span></a></td>
187
<td class="property_name"><a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodContext--input-hints" title="The “input-hints” property">input-hints</a></td>
188
<td class="property_flags">Read / Write</td>
191
<td class="property_type"><a class="link" href="WebKitInputMethodContext.html#WebKitInputPurpose" title="enum WebKitInputPurpose"><span class="type">WebKitInputPurpose</span></a></td>
192
<td class="property_name"><a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodContext--input-purpose" title="The “input-purpose” property">input-purpose</a></td>
193
<td class="property_flags">Read / Write</td>
198
<div class="refsect1">
199
<a name="WebKitInputMethodContext.signals"></a><h2>Signals</h2>
200
<div class="informaltable"><table class="informaltable" border="0">
202
<col width="150px" class="signal_proto_type">
203
<col width="300px" class="signal_proto_name">
204
<col width="200px" class="signal_proto_flags">
208
<td class="signal_type"><span class="returnvalue">void</span></td>
209
<td class="signal_name"><a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodContext-committed" title="The “committed” signal">committed</a></td>
210
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
213
<td class="signal_type"><span class="returnvalue">void</span></td>
214
<td class="signal_name"><a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodContext-delete-surrounding" title="The “delete-surrounding” signal">delete-surrounding</a></td>
215
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
218
<td class="signal_type"><span class="returnvalue">void</span></td>
219
<td class="signal_name"><a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodContext-preedit-changed" title="The “preedit-changed” signal">preedit-changed</a></td>
220
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
223
<td class="signal_type"><span class="returnvalue">void</span></td>
224
<td class="signal_name"><a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodContext-preedit-finished" title="The “preedit-finished” signal">preedit-finished</a></td>
225
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
228
<td class="signal_type"><span class="returnvalue">void</span></td>
229
<td class="signal_name"><a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodContext-preedit-started" title="The “preedit-started” signal">preedit-started</a></td>
230
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
235
<a name="WebKitInputMethodUnderline"></a><div class="refsect1">
236
<a name="WebKitInputMethodContext.other"></a><h2>Types and Values</h2>
237
<div class="informaltable"><table class="informaltable" width="100%" border="0">
239
<col width="150px" class="other_proto_type">
240
<col class="other_proto_name">
244
<td class="datatype_keyword">struct</td>
245
<td class="function_name"><a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodContext-struct" title="struct WebKitInputMethodContext">WebKitInputMethodContext</a></td>
248
<td class="datatype_keyword">enum</td>
249
<td class="function_name"><a class="link" href="WebKitInputMethodContext.html#WebKitInputPurpose" title="enum WebKitInputPurpose">WebKitInputPurpose</a></td>
252
<td class="datatype_keyword">enum</td>
253
<td class="function_name"><a class="link" href="WebKitInputMethodContext.html#WebKitInputHints" title="enum WebKitInputHints">WebKitInputHints</a></td>
256
<td class="datatype_keyword"> </td>
257
<td class="function_name"><a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodUnderline-struct" title="WebKitInputMethodUnderline">WebKitInputMethodUnderline</a></td>
262
<div class="refsect1">
263
<a name="WebKitInputMethodContext.object-hierarchy"></a><h2>Object Hierarchy</h2>
264
<pre class="screen"> <a href="../gobject/gobject-Boxed-Types.html">GBoxed</a>
265
<span class="lineart">╰──</span> WebKitInputMethodUnderline
266
<a href="../gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
267
<span class="lineart">╰──</span> WebKitInputPurpose
268
<a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
269
<span class="lineart">╰──</span> WebKitInputMethodContext
272
<div class="refsect1">
273
<a name="WebKitInputMethodContext.description"></a><h2>Description</h2>
274
<p>WebKitInputMethodContext defines the interface to implement WebKit input methods.
275
The input methods are used by WebKit, when editable content is focused, to map from
276
key events to Unicode character strings.</p>
277
<p>An input method may consume multiple key events in sequence and finally
278
output the composed result. This is called preediting, and an input method
279
may provide feedback about this process by displaying the intermediate
280
composition states as preedit text.</p>
282
<div class="refsect1">
283
<a name="WebKitInputMethodContext.functions_details"></a><h2>Functions</h2>
284
<div class="refsect2">
285
<a name="webkit-input-method-context-set-enable-preedit"></a><h3>webkit_input_method_context_set_enable_preedit ()</h3>
286
<pre class="programlisting"><span class="returnvalue">void</span>
287
webkit_input_method_context_set_enable_preedit
288
(<em class="parameter"><code><a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> *context</code></em>,
289
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enabled</code></em>);</pre>
290
<p>Set whether <em class="parameter"><code>context</code></em>
291
should enable preedit to display feedback.</p>
292
<div class="refsect3">
293
<a name="webkit-input-method-context-set-enable-preedit.parameters"></a><h4>Parameters</h4>
294
<div class="informaltable"><table class="informaltable" width="100%" border="0">
296
<col width="150px" class="parameters_name">
297
<col class="parameters_description">
298
<col width="200px" class="parameters_annotations">
302
<td class="parameter_name"><p>context</p></td>
303
<td class="parameter_description"><p>a <a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a></p></td>
304
<td class="parameter_annotations"> </td>
307
<td class="parameter_name"><p>enabled</p></td>
308
<td class="parameter_description"><p>whether to enable preedit</p></td>
309
<td class="parameter_annotations"> </td>
314
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
317
<div class="refsect2">
318
<a name="webkit-input-method-context-get-preedit"></a><h3>webkit_input_method_context_get_preedit ()</h3>
319
<pre class="programlisting"><span class="returnvalue">void</span>
320
webkit_input_method_context_get_preedit
321
(<em class="parameter"><code><a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> *context</code></em>,
322
<em class="parameter"><code><span class="type">char</span> **text</code></em>,
323
<em class="parameter"><code><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> **underlines</code></em>,
324
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *cursor_offset</code></em>);</pre>
325
<p>Get the current preedit string for the <em class="parameter"><code>context</code></em>
326
, and a list of WebKitInputMethodUnderline to apply to the string.
327
The string will be displayed inserted at <em class="parameter"><code>cursor_offset</code></em>
329
<div class="refsect3">
330
<a name="webkit-input-method-context-get-preedit.parameters"></a><h4>Parameters</h4>
331
<div class="informaltable"><table class="informaltable" width="100%" border="0">
333
<col width="150px" class="parameters_name">
334
<col class="parameters_description">
335
<col width="200px" class="parameters_annotations">
339
<td class="parameter_name"><p>context</p></td>
340
<td class="parameter_description"><p>a <a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a></p></td>
341
<td class="parameter_annotations"> </td>
344
<td class="parameter_name"><p>text</p></td>
345
<td class="parameter_description"><p>location to store the preedit string. </p></td>
346
<td class="parameter_annotations"><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>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
349
<td class="parameter_name"><p>underlines</p></td>
350
<td class="parameter_description"><p>location to store the underlines as a <a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of <a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodUnderline"><span class="type">WebKitInputMethodUnderline</span></a>. </p></td>
351
<td class="parameter_annotations"><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>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> WebKit2.InputMethodUnderline]</span></td>
354
<td class="parameter_name"><p>cursor_offset</p></td>
355
<td class="parameter_description"><p>location to store the position of cursor in preedit string. </p></td>
356
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
361
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
364
<div class="refsect2">
365
<a name="webkit-input-method-context-filter-key-event"></a><h3>webkit_input_method_context_filter_key_event ()</h3>
366
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
367
webkit_input_method_context_filter_key_event
368
(<em class="parameter"><code><a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> *context</code></em>,
369
<em class="parameter"><code><a href="../gdk3/gdk3-Event-Structures.html#GdkEventKey"><span class="type">GdkEventKey</span></a> *key_event</code></em>);</pre>
370
<p>Allow <em class="parameter"><code>key_event</code></em>
371
to be handled by the input method. If <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is returned, then no further processing should be
372
done for the key event.</p>
373
<div class="refsect3">
374
<a name="webkit-input-method-context-filter-key-event.parameters"></a><h4>Parameters</h4>
375
<div class="informaltable"><table class="informaltable" width="100%" border="0">
377
<col width="150px" class="parameters_name">
378
<col class="parameters_description">
379
<col width="200px" class="parameters_annotations">
383
<td class="parameter_name"><p>context</p></td>
384
<td class="parameter_description"><p>a <a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a></p></td>
385
<td class="parameter_annotations"> </td>
388
<td class="parameter_name"><p>key_event</p></td>
389
<td class="parameter_description"><p>the key event to filter</p></td>
390
<td class="parameter_annotations"> </td>
395
<div class="refsect3">
396
<a name="webkit-input-method-context-filter-key-event.returns"></a><h4>Returns</h4>
397
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the key event was handled, or <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
399
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
402
<div class="refsect2">
403
<a name="webkit-input-method-context-notify-focus-in"></a><h3>webkit_input_method_context_notify_focus_in ()</h3>
404
<pre class="programlisting"><span class="returnvalue">void</span>
405
webkit_input_method_context_notify_focus_in
406
(<em class="parameter"><code><a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> *context</code></em>);</pre>
407
<p>Notify <em class="parameter"><code>context</code></em>
408
that input associated has gained focus.</p>
409
<div class="refsect3">
410
<a name="webkit-input-method-context-notify-focus-in.parameters"></a><h4>Parameters</h4>
411
<div class="informaltable"><table class="informaltable" width="100%" border="0">
413
<col width="150px" class="parameters_name">
414
<col class="parameters_description">
415
<col width="200px" class="parameters_annotations">
418
<td class="parameter_name"><p>context</p></td>
419
<td class="parameter_description"><p>a <a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a></p></td>
420
<td class="parameter_annotations"> </td>
424
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
427
<div class="refsect2">
428
<a name="webkit-input-method-context-notify-focus-out"></a><h3>webkit_input_method_context_notify_focus_out ()</h3>
429
<pre class="programlisting"><span class="returnvalue">void</span>
430
webkit_input_method_context_notify_focus_out
431
(<em class="parameter"><code><a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> *context</code></em>);</pre>
432
<p>Notify <em class="parameter"><code>context</code></em>
433
that input associated has lost focus.</p>
434
<div class="refsect3">
435
<a name="webkit-input-method-context-notify-focus-out.parameters"></a><h4>Parameters</h4>
436
<div class="informaltable"><table class="informaltable" width="100%" border="0">
438
<col width="150px" class="parameters_name">
439
<col class="parameters_description">
440
<col width="200px" class="parameters_annotations">
443
<td class="parameter_name"><p>context</p></td>
444
<td class="parameter_description"><p>a <a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a></p></td>
445
<td class="parameter_annotations"> </td>
449
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
452
<div class="refsect2">
453
<a name="webkit-input-method-context-notify-cursor-area"></a><h3>webkit_input_method_context_notify_cursor_area ()</h3>
454
<pre class="programlisting"><span class="returnvalue">void</span>
455
webkit_input_method_context_notify_cursor_area
456
(<em class="parameter"><code><a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> *context</code></em>,
457
<em class="parameter"><code><span class="type">int</span> x</code></em>,
458
<em class="parameter"><code><span class="type">int</span> y</code></em>,
459
<em class="parameter"><code><span class="type">int</span> width</code></em>,
460
<em class="parameter"><code><span class="type">int</span> height</code></em>);</pre>
461
<p>Notify <em class="parameter"><code>context</code></em>
462
that cursor area changed in input associated.</p>
463
<div class="refsect3">
464
<a name="webkit-input-method-context-notify-cursor-area.parameters"></a><h4>Parameters</h4>
465
<div class="informaltable"><table class="informaltable" width="100%" border="0">
467
<col width="150px" class="parameters_name">
468
<col class="parameters_description">
469
<col width="200px" class="parameters_annotations">
473
<td class="parameter_name"><p>context</p></td>
474
<td class="parameter_description"><p>a <a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a></p></td>
475
<td class="parameter_annotations"> </td>
478
<td class="parameter_name"><p>x</p></td>
479
<td class="parameter_description"><p>the x coordinate of cursor location</p></td>
480
<td class="parameter_annotations"> </td>
483
<td class="parameter_name"><p>y</p></td>
484
<td class="parameter_description"><p>the y coordinate of cursor location</p></td>
485
<td class="parameter_annotations"> </td>
488
<td class="parameter_name"><p>width</p></td>
489
<td class="parameter_description"><p>the width of cursor area</p></td>
490
<td class="parameter_annotations"> </td>
493
<td class="parameter_name"><p>height</p></td>
494
<td class="parameter_description"><p>the height of cursor area</p></td>
495
<td class="parameter_annotations"> </td>
500
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
503
<div class="refsect2">
504
<a name="webkit-input-method-context-notify-surrounding"></a><h3>webkit_input_method_context_notify_surrounding ()</h3>
505
<pre class="programlisting"><span class="returnvalue">void</span>
506
webkit_input_method_context_notify_surrounding
507
(<em class="parameter"><code><a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> *context</code></em>,
508
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>,
509
<em class="parameter"><code><span class="type">int</span> length</code></em>,
510
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> cursor_index</code></em>,
511
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> selection_index</code></em>);</pre>
512
<p>Notify <em class="parameter"><code>context</code></em>
513
that the context surrounding the cursor has changed.
514
If there's no selection <em class="parameter"><code>selection_index</code></em>
515
is the same as <em class="parameter"><code>cursor_index</code></em>
517
<div class="refsect3">
518
<a name="webkit-input-method-context-notify-surrounding.parameters"></a><h4>Parameters</h4>
519
<div class="informaltable"><table class="informaltable" width="100%" border="0">
521
<col width="150px" class="parameters_name">
522
<col class="parameters_description">
523
<col width="200px" class="parameters_annotations">
527
<td class="parameter_name"><p>context</p></td>
528
<td class="parameter_description"><p>a <a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a></p></td>
529
<td class="parameter_annotations"> </td>
532
<td class="parameter_name"><p>text</p></td>
533
<td class="parameter_description"><p>text surrounding the insertion point</p></td>
534
<td class="parameter_annotations"> </td>
537
<td class="parameter_name"><p>length</p></td>
538
<td class="parameter_description"><p>the length of <em class="parameter"><code>text</code></em>
539
, or -1 if <em class="parameter"><code>text</code></em>
540
is nul-terminated</p></td>
541
<td class="parameter_annotations"> </td>
544
<td class="parameter_name"><p>cursor_index</p></td>
545
<td class="parameter_description"><p>the byte index of the insertion cursor within <em class="parameter"><code>text</code></em>
547
<td class="parameter_annotations"> </td>
550
<td class="parameter_name"><p>selection_index</p></td>
551
<td class="parameter_description"><p>the byte index of the selection cursor within <em class="parameter"><code>text</code></em>
553
<td class="parameter_annotations"> </td>
558
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
561
<div class="refsect2">
562
<a name="webkit-input-method-context-reset"></a><h3>webkit_input_method_context_reset ()</h3>
563
<pre class="programlisting"><span class="returnvalue">void</span>
564
webkit_input_method_context_reset (<em class="parameter"><code><a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> *context</code></em>);</pre>
565
<p>Reset the <em class="parameter"><code>context</code></em>
566
. This will typically cause the input to clear the preedit state.</p>
567
<div class="refsect3">
568
<a name="webkit-input-method-context-reset.parameters"></a><h4>Parameters</h4>
569
<div class="informaltable"><table class="informaltable" width="100%" border="0">
571
<col width="150px" class="parameters_name">
572
<col class="parameters_description">
573
<col width="200px" class="parameters_annotations">
576
<td class="parameter_name"><p>context</p></td>
577
<td class="parameter_description"><p>a <a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a></p></td>
578
<td class="parameter_annotations"> </td>
582
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
585
<div class="refsect2">
586
<a name="webkit-input-method-context-get-input-purpose"></a><h3>webkit_input_method_context_get_input_purpose ()</h3>
587
<pre class="programlisting"><a class="link" href="WebKitInputMethodContext.html#WebKitInputPurpose" title="enum WebKitInputPurpose"><span class="returnvalue">WebKitInputPurpose</span></a>
588
webkit_input_method_context_get_input_purpose
589
(<em class="parameter"><code><a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> *context</code></em>);</pre>
590
<p>Get the value of the <a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodContext--input-purpose" title="The “input-purpose” property"><span class="type">“input-purpose”</span></a> property.</p>
591
<div class="refsect3">
592
<a name="webkit-input-method-context-get-input-purpose.parameters"></a><h4>Parameters</h4>
593
<div class="informaltable"><table class="informaltable" width="100%" border="0">
595
<col width="150px" class="parameters_name">
596
<col class="parameters_description">
597
<col width="200px" class="parameters_annotations">
600
<td class="parameter_name"><p>context</p></td>
601
<td class="parameter_description"><p>a <a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a></p></td>
602
<td class="parameter_annotations"> </td>
606
<div class="refsect3">
607
<a name="webkit-input-method-context-get-input-purpose.returns"></a><h4>Returns</h4>
608
<p> the <a class="link" href="WebKitInputMethodContext.html#WebKitInputPurpose" title="enum WebKitInputPurpose"><span class="type">WebKitInputPurpose</span></a> of the input associated with <em class="parameter"><code>context</code></em>
611
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
614
<div class="refsect2">
615
<a name="webkit-input-method-context-set-input-purpose"></a><h3>webkit_input_method_context_set_input_purpose ()</h3>
616
<pre class="programlisting"><span class="returnvalue">void</span>
617
webkit_input_method_context_set_input_purpose
618
(<em class="parameter"><code><a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> *context</code></em>,
619
<em class="parameter"><code><a class="link" href="WebKitInputMethodContext.html#WebKitInputPurpose" title="enum WebKitInputPurpose"><span class="type">WebKitInputPurpose</span></a> purpose</code></em>);</pre>
620
<p>Set the value of the <a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodContext--input-purpose" title="The “input-purpose” property"><span class="type">“input-purpose”</span></a> property.</p>
621
<div class="refsect3">
622
<a name="webkit-input-method-context-set-input-purpose.parameters"></a><h4>Parameters</h4>
623
<div class="informaltable"><table class="informaltable" width="100%" border="0">
625
<col width="150px" class="parameters_name">
626
<col class="parameters_description">
627
<col width="200px" class="parameters_annotations">
631
<td class="parameter_name"><p>context</p></td>
632
<td class="parameter_description"><p>a <a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a></p></td>
633
<td class="parameter_annotations"> </td>
636
<td class="parameter_name"><p>purpose</p></td>
637
<td class="parameter_description"><p>a <a class="link" href="WebKitInputMethodContext.html#WebKitInputPurpose" title="enum WebKitInputPurpose"><span class="type">WebKitInputPurpose</span></a></p></td>
638
<td class="parameter_annotations"> </td>
643
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
646
<div class="refsect2">
647
<a name="webkit-input-method-context-get-input-hints"></a><h3>webkit_input_method_context_get_input_hints ()</h3>
648
<pre class="programlisting"><a class="link" href="WebKitInputMethodContext.html#WebKitInputHints" title="enum WebKitInputHints"><span class="returnvalue">WebKitInputHints</span></a>
649
webkit_input_method_context_get_input_hints
650
(<em class="parameter"><code><a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> *context</code></em>);</pre>
651
<p>Get the value of the <a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodContext--input-hints" title="The “input-hints” property"><span class="type">“input-hints”</span></a> property.</p>
652
<div class="refsect3">
653
<a name="webkit-input-method-context-get-input-hints.parameters"></a><h4>Parameters</h4>
654
<div class="informaltable"><table class="informaltable" width="100%" border="0">
656
<col width="150px" class="parameters_name">
657
<col class="parameters_description">
658
<col width="200px" class="parameters_annotations">
661
<td class="parameter_name"><p>context</p></td>
662
<td class="parameter_description"><p>a <a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a></p></td>
663
<td class="parameter_annotations"> </td>
667
<div class="refsect3">
668
<a name="webkit-input-method-context-get-input-hints.returns"></a><h4>Returns</h4>
669
<p> the <a class="link" href="WebKitInputMethodContext.html#WebKitInputHints" title="enum WebKitInputHints"><span class="type">WebKitInputHints</span></a> of the input associated with <em class="parameter"><code>context</code></em>
672
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
675
<div class="refsect2">
676
<a name="webkit-input-method-context-set-input-hints"></a><h3>webkit_input_method_context_set_input_hints ()</h3>
677
<pre class="programlisting"><span class="returnvalue">void</span>
678
webkit_input_method_context_set_input_hints
679
(<em class="parameter"><code><a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> *context</code></em>,
680
<em class="parameter"><code><a class="link" href="WebKitInputMethodContext.html#WebKitInputHints" title="enum WebKitInputHints"><span class="type">WebKitInputHints</span></a> hints</code></em>);</pre>
683
<div class="refsect2">
684
<a name="webkit-input-method-underline-new"></a><h3>webkit_input_method_underline_new ()</h3>
685
<pre class="programlisting"><a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodUnderline"><span class="returnvalue">WebKitInputMethodUnderline</span></a> *
686
webkit_input_method_underline_new (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> start_offset</code></em>,
687
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> end_offset</code></em>);</pre>
688
<p>Create a new <a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodUnderline"><span class="type">WebKitInputMethodUnderline</span></a> for the given range in preedit string</p>
689
<div class="refsect3">
690
<a name="webkit-input-method-underline-new.parameters"></a><h4>Parameters</h4>
691
<div class="informaltable"><table class="informaltable" width="100%" border="0">
693
<col width="150px" class="parameters_name">
694
<col class="parameters_description">
695
<col width="200px" class="parameters_annotations">
699
<td class="parameter_name"><p>start_offset</p></td>
700
<td class="parameter_description"><p>the start offset in preedit string</p></td>
701
<td class="parameter_annotations"> </td>
704
<td class="parameter_name"><p>end_offset</p></td>
705
<td class="parameter_description"><p>the end offset in preedit string</p></td>
706
<td class="parameter_annotations"> </td>
711
<div class="refsect3">
712
<a name="webkit-input-method-underline-new.returns"></a><h4>Returns</h4>
713
<p>A newly created <a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodUnderline"><span class="type">WebKitInputMethodUnderline</span></a>. </p>
714
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
716
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
719
<div class="refsect2">
720
<a name="webkit-input-method-underline-copy"></a><h3>webkit_input_method_underline_copy ()</h3>
721
<pre class="programlisting"><a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodUnderline"><span class="returnvalue">WebKitInputMethodUnderline</span></a> *
722
webkit_input_method_underline_copy (<em class="parameter"><code><a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodUnderline"><span class="type">WebKitInputMethodUnderline</span></a> *underline</code></em>);</pre>
723
<p>Make a copy of the <a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodUnderline"><span class="type">WebKitInputMethodUnderline</span></a>.</p>
724
<div class="refsect3">
725
<a name="webkit-input-method-underline-copy.parameters"></a><h4>Parameters</h4>
726
<div class="informaltable"><table class="informaltable" width="100%" border="0">
728
<col width="150px" class="parameters_name">
729
<col class="parameters_description">
730
<col width="200px" class="parameters_annotations">
733
<td class="parameter_name"><p>underline</p></td>
734
<td class="parameter_description"><p>a <a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodUnderline"><span class="type">WebKitInputMethodUnderline</span></a></p></td>
735
<td class="parameter_annotations"> </td>
739
<div class="refsect3">
740
<a name="webkit-input-method-underline-copy.returns"></a><h4>Returns</h4>
741
<p>A copy of passed in <a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodUnderline"><span class="type">WebKitInputMethodUnderline</span></a>. </p>
742
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
744
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
747
<div class="refsect2">
748
<a name="webkit-input-method-underline-free"></a><h3>webkit_input_method_underline_free ()</h3>
749
<pre class="programlisting"><span class="returnvalue">void</span>
750
webkit_input_method_underline_free (<em class="parameter"><code><a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodUnderline"><span class="type">WebKitInputMethodUnderline</span></a> *underline</code></em>);</pre>
751
<p>Free the <a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodUnderline"><span class="type">WebKitInputMethodUnderline</span></a>.</p>
752
<div class="refsect3">
753
<a name="webkit-input-method-underline-free.parameters"></a><h4>Parameters</h4>
754
<div class="informaltable"><table class="informaltable" width="100%" border="0">
756
<col width="150px" class="parameters_name">
757
<col class="parameters_description">
758
<col width="200px" class="parameters_annotations">
761
<td class="parameter_name"><p>underline</p></td>
762
<td class="parameter_description"><p>A <a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodUnderline"><span class="type">WebKitInputMethodUnderline</span></a></p></td>
763
<td class="parameter_annotations"> </td>
767
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
770
<div class="refsect2">
771
<a name="webkit-input-method-underline-set-color"></a><h3>webkit_input_method_underline_set_color ()</h3>
772
<pre class="programlisting"><span class="returnvalue">void</span>
773
webkit_input_method_underline_set_color
774
(<em class="parameter"><code><a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodUnderline"><span class="type">WebKitInputMethodUnderline</span></a> *underline</code></em>,
775
<em class="parameter"><code>const <a href="../gdk3/gdk3-RGBA-Colors.html#GdkRGBA"><span class="type">GdkRGBA</span></a> *rgba</code></em>);</pre>
776
<p>Set the color of the underline. If <em class="parameter"><code>rgba</code></em>
777
is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> the foreground text color will be used
778
for the underline too.</p>
779
<div class="refsect3">
780
<a name="webkit-input-method-underline-set-color.parameters"></a><h4>Parameters</h4>
781
<div class="informaltable"><table class="informaltable" width="100%" border="0">
783
<col width="150px" class="parameters_name">
784
<col class="parameters_description">
785
<col width="200px" class="parameters_annotations">
789
<td class="parameter_name"><p>underline</p></td>
790
<td class="parameter_description"><p>a <a class="link" href="WebKitInputMethodContext.html#WebKitInputMethodUnderline"><span class="type">WebKitInputMethodUnderline</span></a></p></td>
791
<td class="parameter_annotations"> </td>
794
<td class="parameter_name"><p>rgba</p></td>
795
<td class="parameter_description"><p>a <a href="../gdk3/gdk3-RGBA-Colors.html#GdkRGBA"><span class="type">GdkRGBA</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
796
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
801
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
804
<div class="refsect1">
805
<a name="WebKitInputMethodContext.other_details"></a><h2>Types and Values</h2>
806
<div class="refsect2">
807
<a name="WebKitInputMethodContext-struct"></a><h3>struct WebKitInputMethodContext</h3>
808
<pre class="programlisting">struct WebKitInputMethodContext;</pre>
811
<div class="refsect2">
812
<a name="WebKitInputPurpose"></a><h3>enum WebKitInputPurpose</h3>
813
<p>Enum values used to describe the primary purpose of the active editable element.</p>
814
<div class="refsect3">
815
<a name="WebKitInputPurpose.members"></a><h4>Members</h4>
816
<div class="informaltable"><table class="informaltable" width="100%" border="0">
818
<col width="300px" class="enum_members_name">
819
<col class="enum_members_description">
820
<col width="200px" class="enum_members_annotations">
824
<td class="enum_member_name"><p><a name="WEBKIT-INPUT-PURPOSE-FREE-FORM:CAPS"></a>WEBKIT_INPUT_PURPOSE_FREE_FORM</p></td>
825
<td class="enum_member_description">
826
<p>Editable element expects any characters</p>
828
<td class="enum_member_annotations"> </td>
831
<td class="enum_member_name"><p><a name="WEBKIT-INPUT-PURPOSE-DIGITS:CAPS"></a>WEBKIT_INPUT_PURPOSE_DIGITS</p></td>
832
<td class="enum_member_description">
833
<p>Editable element expects digits</p>
835
<td class="enum_member_annotations"> </td>
838
<td class="enum_member_name"><p><a name="WEBKIT-INPUT-PURPOSE-NUMBER:CAPS"></a>WEBKIT_INPUT_PURPOSE_NUMBER</p></td>
839
<td class="enum_member_description">
840
<p>Editable element expects a number</p>
842
<td class="enum_member_annotations"> </td>
845
<td class="enum_member_name"><p><a name="WEBKIT-INPUT-PURPOSE-PHONE:CAPS"></a>WEBKIT_INPUT_PURPOSE_PHONE</p></td>
846
<td class="enum_member_description">
847
<p>Editable element expects a telephone</p>
849
<td class="enum_member_annotations"> </td>
852
<td class="enum_member_name"><p><a name="WEBKIT-INPUT-PURPOSE-URL:CAPS"></a>WEBKIT_INPUT_PURPOSE_URL</p></td>
853
<td class="enum_member_description">
854
<p>Editable element expects a URL</p>
856
<td class="enum_member_annotations"> </td>
859
<td class="enum_member_name"><p><a name="WEBKIT-INPUT-PURPOSE-EMAIL:CAPS"></a>WEBKIT_INPUT_PURPOSE_EMAIL</p></td>
860
<td class="enum_member_description">
861
<p>Editable element expects an email</p>
863
<td class="enum_member_annotations"> </td>
866
<td class="enum_member_name"><p><a name="WEBKIT-INPUT-PURPOSE-PASSWORD:CAPS"></a>WEBKIT_INPUT_PURPOSE_PASSWORD</p></td>
867
<td class="enum_member_description">
868
<p>Editable element expects a password</p>
870
<td class="enum_member_annotations"> </td>
875
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
878
<div class="refsect2">
879
<a name="WebKitInputHints"></a><h3>enum WebKitInputHints</h3>
880
<p>Enum values used to describe hints that might be taken into account by input methods.</p>
881
<div class="refsect3">
882
<a name="WebKitInputHints.members"></a><h4>Members</h4>
883
<div class="informaltable"><table class="informaltable" width="100%" border="0">
885
<col width="300px" class="enum_members_name">
886
<col class="enum_members_description">
887
<col width="200px" class="enum_members_annotations">
891
<td class="enum_member_name"><p><a name="WEBKIT-INPUT-HINT-NONE:CAPS"></a>WEBKIT_INPUT_HINT_NONE</p></td>
892
<td class="enum_member_description">
893
<p>No special behavior suggested</p>
895
<td class="enum_member_annotations"> </td>
898
<td class="enum_member_name"><p><a name="WEBKIT-INPUT-HINT-SPELLCHECK:CAPS"></a>WEBKIT_INPUT_HINT_SPELLCHECK</p></td>
899
<td class="enum_member_description">
900
<p>Suggest spell checking</p>
902
<td class="enum_member_annotations"> </td>
905
<td class="enum_member_name"><p><a name="WEBKIT-INPUT-HINT-LOWERCASE:CAPS"></a>WEBKIT_INPUT_HINT_LOWERCASE</p></td>
906
<td class="enum_member_description">
907
<p>Suggest to not autocapitlize</p>
909
<td class="enum_member_annotations"> </td>
912
<td class="enum_member_name"><p><a name="WEBKIT-INPUT-HINT-UPPERCASE-CHARS:CAPS"></a>WEBKIT_INPUT_HINT_UPPERCASE_CHARS</p></td>
913
<td class="enum_member_description">
914
<p>Suggest to capitalize all text</p>
916
<td class="enum_member_annotations"> </td>
919
<td class="enum_member_name"><p><a name="WEBKIT-INPUT-HINT-UPPERCASE-WORDS:CAPS"></a>WEBKIT_INPUT_HINT_UPPERCASE_WORDS</p></td>
920
<td class="enum_member_description">
921
<p>Suggest to capitalize the first character of each word</p>
923
<td class="enum_member_annotations"> </td>
926
<td class="enum_member_name"><p><a name="WEBKIT-INPUT-HINT-UPPERCASE-SENTENCES:CAPS"></a>WEBKIT_INPUT_HINT_UPPERCASE_SENTENCES</p></td>
927
<td class="enum_member_description">
928
<p>Suggest to capitalize the first word of each sentence</p>
930
<td class="enum_member_annotations"> </td>
933
<td class="enum_member_name"><p><a name="WEBKIT-INPUT-HINT-INHIBIT-OSK:CAPS"></a>WEBKIT_INPUT_HINT_INHIBIT_OSK</p></td>
934
<td class="enum_member_description">
935
<p>Suggest to not show an onscreen keyboard</p>
937
<td class="enum_member_annotations"> </td>
942
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
945
<div class="refsect2">
946
<a name="WebKitInputMethodUnderline-struct"></a><h3>WebKitInputMethodUnderline</h3>
947
<pre class="programlisting">typedef struct _WebKitInputMethodUnderline WebKitInputMethodUnderline;</pre>
950
<div class="refsect1">
951
<a name="WebKitInputMethodContext.property-details"></a><h2>Property Details</h2>
952
<div class="refsect2">
953
<a name="WebKitInputMethodContext--input-hints"></a><h3>The <code class="literal">“input-hints”</code> property</h3>
954
<pre class="programlisting"> “input-hints” <a class="link" href="WebKitInputMethodContext.html#WebKitInputHints" title="enum WebKitInputHints"><span class="type">WebKitInputHints</span></a></pre>
955
<p>The hints of the input associated.</p>
956
<p>Owner: WebKitInputMethodContext</p>
957
<p>Flags: Read / Write</p>
960
<div class="refsect2">
961
<a name="WebKitInputMethodContext--input-purpose"></a><h3>The <code class="literal">“input-purpose”</code> property</h3>
962
<pre class="programlisting"> “input-purpose” <a class="link" href="WebKitInputMethodContext.html#WebKitInputPurpose" title="enum WebKitInputPurpose"><span class="type">WebKitInputPurpose</span></a></pre>
963
<p>The purpose of the input associated.</p>
964
<p>Owner: WebKitInputMethodContext</p>
965
<p>Flags: Read / Write</p>
966
<p>Default value: WEBKIT_INPUT_PURPOSE_FREE_FORM</p>
969
<div class="refsect1">
970
<a name="WebKitInputMethodContext.signal-details"></a><h2>Signal Details</h2>
971
<div class="refsect2">
972
<a name="WebKitInputMethodContext-committed"></a><h3>The <code class="literal">“committed”</code> signal</h3>
973
<pre class="programlisting"><span class="returnvalue">void</span>
974
user_function (<a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> *context,
975
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text,
976
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
977
<p>Emitted when a complete input sequence has been entered by the user.
978
This can be a single character immediately after a key press or the
979
final result of preediting.</p>
980
<div class="refsect3">
981
<a name="WebKitInputMethodContext-committed.parameters"></a><h4>Parameters</h4>
982
<div class="informaltable"><table class="informaltable" width="100%" border="0">
984
<col width="150px" class="parameters_name">
985
<col class="parameters_description">
986
<col width="200px" class="parameters_annotations">
990
<td class="parameter_name"><p>context</p></td>
991
<td class="parameter_description"><p>the <a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> on which the signal is emitted</p></td>
992
<td class="parameter_annotations"> </td>
995
<td class="parameter_name"><p>text</p></td>
996
<td class="parameter_description"><p>the string result</p></td>
997
<td class="parameter_annotations"> </td>
1000
<td class="parameter_name"><p>user_data</p></td>
1001
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
1002
<td class="parameter_annotations"> </td>
1007
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
1008
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
1011
<div class="refsect2">
1012
<a name="WebKitInputMethodContext-delete-surrounding"></a><h3>The <code class="literal">“delete-surrounding”</code> signal</h3>
1013
<pre class="programlisting"><span class="returnvalue">void</span>
1014
user_function (<a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> *context,
1015
<a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset,
1016
<a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n_chars,
1017
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
1018
<p>Emitted when the input method wants to delete the context surrounding the cursor.
1019
If <em class="parameter"><code>offset</code></em>
1020
is a negative value, it means a position before the cursor.</p>
1021
<div class="refsect3">
1022
<a name="WebKitInputMethodContext-delete-surrounding.parameters"></a><h4>Parameters</h4>
1023
<div class="informaltable"><table class="informaltable" width="100%" border="0">
1025
<col width="150px" class="parameters_name">
1026
<col class="parameters_description">
1027
<col width="200px" class="parameters_annotations">
1031
<td class="parameter_name"><p>context</p></td>
1032
<td class="parameter_description"><p>the <a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> on which the signal is emitted</p></td>
1033
<td class="parameter_annotations"> </td>
1036
<td class="parameter_name"><p>offset</p></td>
1037
<td class="parameter_description"><p>the character offset from the cursor position of the text to be deleted.</p></td>
1038
<td class="parameter_annotations"> </td>
1041
<td class="parameter_name"><p>n_chars</p></td>
1042
<td class="parameter_description"><p>the number of characters to be deleted</p></td>
1043
<td class="parameter_annotations"> </td>
1046
<td class="parameter_name"><p>user_data</p></td>
1047
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
1048
<td class="parameter_annotations"> </td>
1053
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
1054
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
1057
<div class="refsect2">
1058
<a name="WebKitInputMethodContext-preedit-changed"></a><h3>The <code class="literal">“preedit-changed”</code> signal</h3>
1059
<pre class="programlisting"><span class="returnvalue">void</span>
1060
user_function (<a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> *context,
1061
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
1062
<p>Emitted whenever the preedit sequence currently being entered has changed.
1063
It is also emitted at the end of a preedit sequence, in which case
1064
<a class="link" href="WebKitInputMethodContext.html#webkit-input-method-context-get-preedit" title="webkit_input_method_context_get_preedit ()"><code class="function">webkit_input_method_context_get_preedit()</code></a> returns the empty string.</p>
1065
<div class="refsect3">
1066
<a name="WebKitInputMethodContext-preedit-changed.parameters"></a><h4>Parameters</h4>
1067
<div class="informaltable"><table class="informaltable" width="100%" border="0">
1069
<col width="150px" class="parameters_name">
1070
<col class="parameters_description">
1071
<col width="200px" class="parameters_annotations">
1075
<td class="parameter_name"><p>context</p></td>
1076
<td class="parameter_description"><p>the <a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> on which the signal is emitted</p></td>
1077
<td class="parameter_annotations"> </td>
1080
<td class="parameter_name"><p>user_data</p></td>
1081
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
1082
<td class="parameter_annotations"> </td>
1087
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
1088
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
1091
<div class="refsect2">
1092
<a name="WebKitInputMethodContext-preedit-finished"></a><h3>The <code class="literal">“preedit-finished”</code> signal</h3>
1093
<pre class="programlisting"><span class="returnvalue">void</span>
1094
user_function (<a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> *context,
1095
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
1096
<p>Emitted when a preediting sequence has been completed or canceled.</p>
1097
<div class="refsect3">
1098
<a name="WebKitInputMethodContext-preedit-finished.parameters"></a><h4>Parameters</h4>
1099
<div class="informaltable"><table class="informaltable" width="100%" border="0">
1101
<col width="150px" class="parameters_name">
1102
<col class="parameters_description">
1103
<col width="200px" class="parameters_annotations">
1107
<td class="parameter_name"><p>context</p></td>
1108
<td class="parameter_description"><p>the <a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> on which the signal is emitted</p></td>
1109
<td class="parameter_annotations"> </td>
1112
<td class="parameter_name"><p>user_data</p></td>
1113
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
1114
<td class="parameter_annotations"> </td>
1119
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
1120
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
1123
<div class="refsect2">
1124
<a name="WebKitInputMethodContext-preedit-started"></a><h3>The <code class="literal">“preedit-started”</code> signal</h3>
1125
<pre class="programlisting"><span class="returnvalue">void</span>
1126
user_function (<a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> *context,
1127
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
1128
<p>Emitted when a new preediting sequence starts.</p>
1129
<div class="refsect3">
1130
<a name="WebKitInputMethodContext-preedit-started.parameters"></a><h4>Parameters</h4>
1131
<div class="informaltable"><table class="informaltable" width="100%" border="0">
1133
<col width="150px" class="parameters_name">
1134
<col class="parameters_description">
1135
<col width="200px" class="parameters_annotations">
1139
<td class="parameter_name"><p>context</p></td>
1140
<td class="parameter_description"><p>the <a class="link" href="WebKitInputMethodContext.html" title="WebKitInputMethodContext"><span class="type">WebKitInputMethodContext</span></a> on which the signal is emitted</p></td>
1141
<td class="parameter_annotations"> </td>
1144
<td class="parameter_name"><p>user_data</p></td>
1145
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
1146
<td class="parameter_annotations"> </td>
1151
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
1152
<p class="since">Since: <a class="link" href="api-index-2-28.html#api-index-2.28">2.28</a></p>
1155
<div class="refsect1">
1156
<a name="WebKitInputMethodContext.see-also"></a><h2>See Also</h2>
1157
<p><a class="link" href="WebKitWebView.html" title="The main frame document title of this #WebKitWebView. If the title has not been received yet, it will be %NULL."><span class="type">WebKitWebView</span></a></p>
1160
<div class="footer">
1161
<hr>Generated by GTK-Doc V1.32.1</div>
b'\\ No newline at end of file'
added
removed
Documentation/webkit2gtk-4.0/html/WebKitInputMethodContext.html
