summaryrefslogtreecommitdiff
path: root/docs/reference/pygtk-gtkimcontextsimple.xml
blob: b39671b6e3891551d8d8217de42d6cc30f11d71d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-gtkimcontextsimple">
  <refnamediv>
    <refname>gtk.IMContextSimple</refname>
    <refpurpose>an input method context object that supports "simple" input
methods</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.IMContextSimple</classname></ooclass>
      <ooclass><classname><link
linkend="class-gtkimcontext">gtk.IMContext</link></classname></ooclass>
      <constructorsynopsis language="python">
	<methodname><link
linkend="constructor-gtkimcontextsimple">gtk.IMContextSimple</link></methodname>
	<methodparam></methodparam>  </constructorsynopsis>

<!-- NOT IMPLEMENTED
<methodsynopsis language="python">
    <methodname><link linkend="method-gtkimcontextsimple- -add-table">add_table</link></methodname>
    <methodparam><parameter role="keyword">data</parameter></methodparam>
    <methodparam><parameter role="keyword">max_seq_len</parameter></methodparam>
    <methodparam><parameter role="keyword">n_seqs</parameter></methodparam>
  </methodsynopsis>
END NOT IMPLEMENTED -->

    </classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtkobject">gtk.Object</link>
    +-- <link linkend="class-gtkimcontext">gtk.IMContext</link>
      +-- <link linkend="class-gtkimcontextsimple">gtk.IMContextSimple</link>
</synopsis>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkimcontextsimple">
    <title>gtk.IMContextSimple Signal Prototypes</title>

    <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkimcontext">gtk.IMContext Signal Prototypes</link></para>
  </refsect1>

  <refsect1>
    <title>Description</title>

    <para>The <link
linkend="class-gtkimcontextsimple"><classname>gtk.IMContextSimple</classname></link> 
class is a subclass of <link
linkend="class-gtkimcontext"><classname>gtk.IMContext</classname></link>
that provides context support for "simple" input methods. <link
linkend="class-gtkimcontextsimple"><classname>gtk.IMContextSimple</classname></link> 
does direct keysym to unicode translation and table-driven
composition.</para>

  </refsect1>

  <refsect1 id="constructor-gtkimcontextsimple">
    <title>Constructor</title>

    <programlisting><constructorsynopsis language="python">
	<methodname>gtk.IMContextSimple</methodname>
	<methodparam></methodparam>  </constructorsynopsis></programlisting>
    <variablelist>
      <varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	<listitem><simpara>a new <link
linkend="class-gtkimcontextsimple"><classname>gtk.IMContextSimple</classname></link>.</simpara></listitem>
      </varlistentry>
    </variablelist>

    <para>Creates a new <link
linkend="class-gtkimcontextsimple"><classname>gtk.IMContextSimple</classname></link> 
object.</para>

  </refsect1>

  <refsect1>
    <title>Methods</title>

<!-- NOT IMPLEMENTED
  <refsect2 id="method-gtkimcontextsimple- -add-table">
    <title>gtk.IMContextSimple.add_table</title>

<programlisting><methodsynopsis language="python">
    <methodname>add_table</methodname>
    <methodparam><parameter role="keyword">data</parameter></methodparam>
    <methodparam><parameter role="keyword">max_seq_len</parameter></methodparam>
    <methodparam><parameter role="keyword">n_seqs</parameter></methodparam>
  </methodsynopsis></programlisting>
  <variablelist>
    <varlistentry>
      <term><parameter role="keyword">data</parameter>&nbsp;:</term>
      <listitem><simpara>the table</simpara></listitem>
    </varlistentry>
    <varlistentry>
      <term><parameter role="keyword">max_seq_len</parameter>&nbsp;:</term>
      <listitem><simpara>Maximum length of a sequence in the table
(cannot be greater than <literal>GTK_MAX_COMPOSE_LEN</literal>)</simpara></listitem>
    </varlistentry>
    <varlistentry>
      <term><parameter role="keyword">n_seqs</parameter>&nbsp;:</term>
      <listitem><simpara>number of sequences in the table</simpara></listitem>
    </varlistentry>
  </variablelist>
<para>
Adds an additional table to search to the input context.
Each row of the table consists of <parameter>max_seq_len</parameter> key symbols
followed by two <literal>guint16</literal> interpreted as the high and low
words of a <literal>gunicode</literal> value. Tables are searched starting
from the last added.
</para>
<para>
The table must be sorted in dictionary order on the
numeric value of the key symbol fields. (Values beyond
the length of the sequence should be zero.)
</para>  </refsect2>
END NOT IMPLEMENTED -->

  </refsect1>

</refentry>