gtk3/docs/reference/gtk/html/GtkIMMulticontext.html
2021-04-15 09:52:10 +01:00

231 lines
11 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkIMMulticontext: GTK+ 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="MiscObjects.html" title="Miscellaneous">
<link rel="prev" href="GtkIMContextSimple.html" title="GtkIMContextSimple">
<link rel="next" href="GtkSizeGroup.html" title="GtkSizeGroup">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#GtkIMMulticontext.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
<a href="#GtkIMMulticontext.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="MiscObjects.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkIMContextSimple.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkSizeGroup.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkIMMulticontext"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkIMMulticontext.top_of_page"></a>GtkIMMulticontext</span></h2>
<p>GtkIMMulticontext — An input method context supporting multiple, loadable input methods</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkIMMulticontext.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="returnvalue">GtkIMContext</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkIMMulticontext.html#gtk-im-multicontext-new" title="gtk_im_multicontext_new ()">gtk_im_multicontext_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkIMMulticontext.html#gtk-im-multicontext-append-menuitems" title="gtk_im_multicontext_append_menuitems ()">gtk_im_multicontext_append_menuitems</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="GtkIMMulticontext.html#gtk-im-multicontext-get-context-id" title="gtk_im_multicontext_get_context_id ()">gtk_im_multicontext_get_context_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkIMMulticontext.html#gtk-im-multicontext-set-context-id" title="gtk_im_multicontext_set_context_id ()">gtk_im_multicontext_set_context_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkIMMulticontext.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkIMMulticontext.html#GtkIMMulticontext-struct" title="struct GtkIMMulticontext">GtkIMMulticontext</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkIMMulticontext.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> <a class="link" href="GtkIMContext.html" title="GtkIMContext">GtkIMContext</a>
<span class="lineart">╰──</span> GtkIMMulticontext
</pre>
</div>
<div class="refsect1">
<a name="GtkIMMulticontext.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtk/gtk.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GtkIMMulticontext.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GtkIMMulticontext.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-im-multicontext-new"></a><h3>gtk_im_multicontext_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkIMContext.html" title="GtkIMContext"><span class="returnvalue">GtkIMContext</span></a> *
gtk_im_multicontext_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="GtkIMMulticontext.html" title="GtkIMMulticontext"><span class="type">GtkIMMulticontext</span></a>.</p>
<div class="refsect3">
<a name="gtk-im-multicontext-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkIMMulticontext.html" title="GtkIMMulticontext"><span class="type">GtkIMMulticontext</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-im-multicontext-append-menuitems"></a><h3>gtk_im_multicontext_append_menuitems ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_im_multicontext_append_menuitems (<em class="parameter"><code><a class="link" href="GtkIMMulticontext.html" title="GtkIMMulticontext"><span class="type">GtkIMMulticontext</span></a> *context</code></em>,
<em class="parameter"><code><a class="link" href="GtkMenuShell.html" title="GtkMenuShell"><span class="type">GtkMenuShell</span></a> *menushell</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_im_multicontext_append_menuitems</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p>
<p>It is better to use the system-wide input
method framework for changing input methods. Modern
desktop shells offer on-screen displays for this that
can triggered with a keyboard shortcut, e.g. Super-Space.</p>
</div>
<p>Add menuitems for various available input methods to a menu;
the menuitems, when selected, will switch the input method
for the context and the global default input method.</p>
<div class="refsect3">
<a name="gtk-im-multicontext-append-menuitems.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkIMMulticontext.html" title="GtkIMMulticontext"><span class="type">GtkIMMulticontext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>menushell</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkMenuShell.html" title="GtkMenuShell"><span class="type">GtkMenuShell</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-im-multicontext-get-context-id"></a><h3>gtk_im_multicontext_get_context_id ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
gtk_im_multicontext_get_context_id (<em class="parameter"><code><a class="link" href="GtkIMMulticontext.html" title="GtkIMMulticontext"><span class="type">GtkIMMulticontext</span></a> *context</code></em>);</pre>
<p>Gets the id of the currently active slave of the <em class="parameter"><code>context</code></em>
.</p>
<div class="refsect3">
<a name="gtk-im-multicontext-get-context-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkIMMulticontext.html" title="GtkIMMulticontext"><span class="type">GtkIMMulticontext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-im-multicontext-get-context-id.returns"></a><h4>Returns</h4>
<p> the id of the currently active slave</p>
</div>
<p class="since">Since: 2.16</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-im-multicontext-set-context-id"></a><h3>gtk_im_multicontext_set_context_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_im_multicontext_set_context_id (<em class="parameter"><code><a class="link" href="GtkIMMulticontext.html" title="GtkIMMulticontext"><span class="type">GtkIMMulticontext</span></a> *context</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *context_id</code></em>);</pre>
<p>Sets the context id for <em class="parameter"><code>context</code></em>
.</p>
<p>This causes the currently active slave of <em class="parameter"><code>context</code></em>
to be
replaced by the slave corresponding to the new context id.</p>
<div class="refsect3">
<a name="gtk-im-multicontext-set-context-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkIMMulticontext.html" title="GtkIMMulticontext"><span class="type">GtkIMMulticontext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>context_id</p></td>
<td class="parameter_description"><p>the id to use </p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.16</p>
</div>
</div>
<div class="refsect1">
<a name="GtkIMMulticontext.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkIMMulticontext-struct"></a><h3>struct GtkIMMulticontext</h3>
<pre class="programlisting">struct GtkIMMulticontext;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>