« back to all changes in this revision
Viewing changes to docs/reference/html/gok-gok-data.html
- browse files at revision 28
- compare with another revision
- download diff
- download tarball
- view history from revision 28
- Committer: Bazaar Package Importer
- Author(s): Luke Yelavich
- Date: 2008-07-15 10:17:46 UTC
- mfrom: (1.1.16 upstream)
- Revision ID: james.westby@ubuntu.com-20080715101746-3fie18s3rcgb5hb5
Tags: 1.4.0-0ubuntu1
New upstream release.
- files added:
- po/as.po
- files removed:
- intltool-extract.in
- files modified:
- ChangeLog
added
removed
docs/reference/html/gok-gok-data.html
1
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
2
<html>
3
3
<head>
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>gok-data</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.71.0">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
7
<link rel="start" href="index.html" title="GOK - Gnome Onscreen Keyboard">
8
8
<link rel="up" href="ch01.html" title="GOK Internal API">
9
9
<link rel="prev" href="gok-gok-control.html" title="gok-control">
10
10
<link rel="next" href="gok-gok-editor.html" title="gok-editor">
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="ch01.html" title="GOK Internal API">
14
14
<link rel="chapter" href="ch02.html" title="Hardware Interfacing">
24
24
<th width="100%" align="center">GOK - Gnome Onscreen Keyboard</th>
25
25
<td><a accesskey="n" href="gok-gok-editor.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
26
26
</tr>
27
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2602680" class="shortcut">Top</a>
28
 | 
29
<a href="#id2603438" class="shortcut">Description</a></nobr></td></tr>
27
<tr><td colspan="5" class="shortcuts"><nobr><a href="#gok-gok-data.synopsis" class="shortcut">Top</a>
28
|
29
<a href="#gok-gok-data.description" class="shortcut">Description</a></nobr></td></tr>
30
30
</table>
31
31
<div class="refentry" lang="en">
32
32
<a name="gok-gok-data"></a><div class="titlepage"></div>
33
33
<div class="refnamediv"><table width="100%"><tr>
34
34
<td valign="top">
35
<h2>
36
<a name="id2602680"></a><span class="refentrytitle">gok-data</span>
37
</h2>
35
<h2><span class="refentrytitle"><a name="gok-gok-data.top_of_page"></a>gok-data</span></h2>
38
36
<p>gok-data</p>
39
37
</td>
40
38
<td valign="top" align="right"></td>
41
39
</tr></table></div>
42
40
<div class="refsynopsisdiv">
43
<h2>Synopsis</h2>
41
<a name="gok-gok-data.synopsis"></a><h2>Synopsis</h2>
44
42
<pre class="synopsis">
45
46
47
48
#define <a href="gok-gok-data.html#GOK-SETTINGS-FILE:CAPS">GOK_SETTINGS_FILE</a>
49
#define <a href="gok-gok-data.html#MAX-KEY-SPACING:CAPS">MAX_KEY_SPACING</a>
50
#define <a href="gok-gok-data.html#MAX-KEY-WIDTH:CAPS">MAX_KEY_WIDTH</a>
51
#define <a href="gok-gok-data.html#MIN-KEY-WIDTH:CAPS">MIN_KEY_WIDTH</a>
52
#define <a href="gok-gok-data.html#MAX-KEY-HEIGHT:CAPS">MAX_KEY_HEIGHT</a>
53
#define <a href="gok-gok-data.html#MIN-KEY-HEIGHT:CAPS">MIN_KEY_HEIGHT</a>
54
void <a href="gok-gok-data.html#gok-data-initialize">gok_data_initialize</a> (void);
55
GokSetting* <a href="gok-gok-data.html#gok-data-construct-setting">gok_data_construct_setting</a> (void);
56
gboolean <a href="gok-gok-data.html#gok-data-read-settings">gok_data_read_settings</a> (void);
57
gboolean <a href="gok-gok-data.html#gok-data-write-settings">gok_data_write_settings</a> (void);
58
gboolean <a href="gok-gok-data.html#gok-data-get-setting">gok_data_get_setting</a> (gchar *NameAccessMethod,
43
#define <a class="link" href="gok-gok-data.html#GOK-SETTINGS-FILE:CAPS" title="GOK_SETTINGS_FILE">GOK_SETTINGS_FILE</a>
44
#define <a class="link" href="gok-gok-data.html#MAX-KEY-SPACING:CAPS" title="MAX_KEY_SPACING">MAX_KEY_SPACING</a>
45
#define <a class="link" href="gok-gok-data.html#MAX-KEY-WIDTH:CAPS" title="MAX_KEY_WIDTH">MAX_KEY_WIDTH</a>
46
#define <a class="link" href="gok-gok-data.html#MIN-KEY-WIDTH:CAPS" title="MIN_KEY_WIDTH">MIN_KEY_WIDTH</a>
47
#define <a class="link" href="gok-gok-data.html#MAX-KEY-HEIGHT:CAPS" title="MAX_KEY_HEIGHT">MAX_KEY_HEIGHT</a>
48
#define <a class="link" href="gok-gok-data.html#MIN-KEY-HEIGHT:CAPS" title="MIN_KEY_HEIGHT">MIN_KEY_HEIGHT</a>
49
void <a class="link" href="gok-gok-data.html#gok-data-initialize" title="gok_data_initialize ()">gok_data_initialize</a> (void);
50
GokSetting* <a class="link" href="gok-gok-data.html#gok-data-construct-setting" title="gok_data_construct_setting ()">gok_data_construct_setting</a> (void);
51
gboolean <a class="link" href="gok-gok-data.html#gok-data-read-settings" title="gok_data_read_settings ()">gok_data_read_settings</a> (void);
52
gboolean <a class="link" href="gok-gok-data.html#gok-data-write-settings" title="gok_data_write_settings ()">gok_data_write_settings</a> (void);
53
gboolean <a class="link" href="gok-gok-data.html#gok-data-get-setting" title="gok_data_get_setting ()">gok_data_get_setting</a> (gchar *NameAccessMethod,
59
54
gchar *NameSetting,
60
55
gint *Value,
61
56
gchar **ValueString);
62
gboolean <a href="gok-gok-data.html#gok-data-create-setting">gok_data_create_setting</a> (gchar *NameAccessMethod,
57
gboolean <a class="link" href="gok-gok-data.html#gok-data-create-setting" title="gok_data_create_setting ()">gok_data_create_setting</a> (gchar *NameAccessMethod,
63
58
gchar *NameSetting,
64
59
gint Value,
65
60
gchar *pValueString);
66
void <a href="gok-gok-data.html#gok-data-close">gok_data_close</a> (void);
67
gboolean <a href="gok-gok-data.html#gok-data-set-setting">gok_data_set_setting</a> (gchar *NameAccessMethod,
61
void <a class="link" href="gok-gok-data.html#gok-data-close" title="gok_data_close ()">gok_data_close</a> (void);
62
gboolean <a class="link" href="gok-gok-data.html#gok-data-set-setting" title="gok_data_set_setting ()">gok_data_set_setting</a> (gchar *NameAccessMethod,
68
63
gchar *NameSetting,
69
64
gint Value,
70
65
gchar *ValueString);
71
gint <a href="gok-gok-data.html#gok-data-get-key-width">gok_data_get_key_width</a> (void);
72
void <a href="gok-gok-data.html#gok-data-set-key-width">gok_data_set_key_width</a> (gint Width);
73
gint <a href="gok-gok-data.html#gok-data-get-key-height">gok_data_get_key_height</a> (void);
74
void <a href="gok-gok-data.html#gok-data-set-key-height">gok_data_set_key_height</a> (gint Height);
75
gint <a href="gok-gok-data.html#gok-data-get-key-spacing">gok_data_get_key_spacing</a> (void);
76
void <a href="gok-gok-data.html#gok-data-set-key-spacing">gok_data_set_key_spacing</a> (gint Spacing);
77
gint <a href="gok-gok-data.html#gok-data-get-keyboard-x">gok_data_get_keyboard_x</a> (void);
78
void <a href="gok-gok-data.html#gok-data-set-keyboard-x">gok_data_set_keyboard_x</a> (gint X);
79
gint <a href="gok-gok-data.html#gok-data-get-keyboard-y">gok_data_get_keyboard_y</a> (void);
80
void <a href="gok-gok-data.html#gok-data-set-keyboard-y">gok_data_set_keyboard_y</a> (gint Y);
81
gboolean <a href="gok-gok-data.html#gok-data-get-keysize-priority">gok_data_get_keysize_priority</a> (void);
82
void <a href="gok-gok-data.html#gok-data-set-keysize-priority">gok_data_set_keysize_priority</a> (gboolean bFlag);
83
char* <a href="gok-gok-data.html#gok-data-get-name-accessmethod">gok_data_get_name_accessmethod</a> (void);
84
void <a href="gok-gok-data.html#gok-data-set-name-accessmethod">gok_data_set_name_accessmethod</a> (const gchar *Name);
85
gboolean <a href="gok-gok-data.html#gok-data-get-wordcomplete">gok_data_get_wordcomplete</a> (void);
86
void <a href="gok-gok-data.html#gok-data-set-wordcomplete">gok_data_set_wordcomplete</a> (gboolean bTrueFalse);
87
gint <a href="gok-gok-data.html#gok-data-get-num-predictions">gok_data_get_num_predictions</a> (void);
88
void <a href="gok-gok-data.html#gok-data-set-num-predictions">gok_data_set_num_predictions</a> (gint Number);
89
gboolean <a href="gok-gok-data.html#gok-data-restore-settings">gok_data_restore_settings</a> (void);
90
void <a href="gok-gok-data.html#gok-data-backup-setting">gok_data_backup_setting</a> (GokSetting *pSetting);
91
gboolean <a href="gok-gok-data.html#gok-data-restore-setting">gok_data_restore_setting</a> (GokSetting *pSetting);
92
gboolean <a href="gok-gok-data.html#gok-data-get-control-values">gok_data_get_control_values</a> (GokControl *pControl);
93
gboolean <a href="gok-gok-data.html#gok-data-get-use-gtkplus-theme">gok_data_get_use_gtkplus_theme</a> (void);
94
void <a href="gok-gok-data.html#gok-data-set-use-gtkplus-theme">gok_data_set_use_gtkplus_theme</a> (gboolean bTrueFalse);
95
</pre>
96
</div>
97
<div class="refsect1" lang="en">
98
<a name="id2603438"></a><h2>Description</h2>
99
<p>
100
101
</p>
102
</div>
103
<div class="refsect1" lang="en">
104
<a name="id2603453"></a><h2>Details</h2>
105
<div class="refsect2" lang="en">
106
<a name="id2603463"></a><h3>
107
<a name="GOK-SETTINGS-FILE:CAPS"></a>GOK_SETTINGS_FILE</h3>
108
<a class="indexterm" name="id2603477"></a><pre class="programlisting">#define GOK_SETTINGS_FILE "gok-settings.xml"
109
</pre>
110
<p>
111
112
</p>
113
</div>
114
<hr>
115
<div class="refsect2" lang="en">
116
<a name="id2603492"></a><h3>
117
<a name="MAX-KEY-SPACING:CAPS"></a>MAX_KEY_SPACING</h3>
118
<a class="indexterm" name="id2603505"></a><pre class="programlisting">#define MAX_KEY_SPACING 100
119
</pre>
120
<p>
121
122
</p>
123
</div>
124
<hr>
125
<div class="refsect2" lang="en">
126
<a name="id2603520"></a><h3>
127
<a name="MAX-KEY-WIDTH:CAPS"></a>MAX_KEY_WIDTH</h3>
128
<a class="indexterm" name="id2603532"></a><pre class="programlisting">#define MAX_KEY_WIDTH 200
129
</pre>
130
<p>
131
132
</p>
133
</div>
134
<hr>
135
<div class="refsect2" lang="en">
136
<a name="id2603547"></a><h3>
137
<a name="MIN-KEY-WIDTH:CAPS"></a>MIN_KEY_WIDTH</h3>
138
<a class="indexterm" name="id2603560"></a><pre class="programlisting">#define MIN_KEY_WIDTH 5
139
</pre>
140
<p>
141
142
</p>
143
</div>
144
<hr>
145
<div class="refsect2" lang="en">
146
<a name="id2603575"></a><h3>
147
<a name="MAX-KEY-HEIGHT:CAPS"></a>MAX_KEY_HEIGHT</h3>
148
<a class="indexterm" name="id2603588"></a><pre class="programlisting">#define MAX_KEY_HEIGHT 100
149
</pre>
150
<p>
151
152
</p>
153
</div>
154
<hr>
155
<div class="refsect2" lang="en">
156
<a name="id2603603"></a><h3>
157
<a name="MIN-KEY-HEIGHT:CAPS"></a>MIN_KEY_HEIGHT</h3>
158
<a class="indexterm" name="id2603616"></a><pre class="programlisting">#define MIN_KEY_HEIGHT 5
159
</pre>
160
<p>
161
162
</p>
163
</div>
164
<hr>
165
<div class="refsect2" lang="en">
166
<a name="id2603631"></a><h3>
167
<a name="gok-data-initialize"></a>gok_data_initialize ()</h3>
168
<a class="indexterm" name="id2603645"></a><pre class="programlisting">void gok_data_initialize (void);</pre>
66
gint <a class="link" href="gok-gok-data.html#gok-data-get-key-width" title="gok_data_get_key_width ()">gok_data_get_key_width</a> (void);
67
void <a class="link" href="gok-gok-data.html#gok-data-set-key-width" title="gok_data_set_key_width ()">gok_data_set_key_width</a> (gint Width);
68
gint <a class="link" href="gok-gok-data.html#gok-data-get-key-height" title="gok_data_get_key_height ()">gok_data_get_key_height</a> (void);
69
void <a class="link" href="gok-gok-data.html#gok-data-set-key-height" title="gok_data_set_key_height ()">gok_data_set_key_height</a> (gint Height);
70
gint <a class="link" href="gok-gok-data.html#gok-data-get-key-spacing" title="gok_data_get_key_spacing ()">gok_data_get_key_spacing</a> (void);
71
void <a class="link" href="gok-gok-data.html#gok-data-set-key-spacing" title="gok_data_set_key_spacing ()">gok_data_set_key_spacing</a> (gint Spacing);
72
gint <a class="link" href="gok-gok-data.html#gok-data-get-keyboard-x" title="gok_data_get_keyboard_x ()">gok_data_get_keyboard_x</a> (void);
73
void <a class="link" href="gok-gok-data.html#gok-data-set-keyboard-x" title="gok_data_set_keyboard_x ()">gok_data_set_keyboard_x</a> (gint X);
74
gint <a class="link" href="gok-gok-data.html#gok-data-get-keyboard-y" title="gok_data_get_keyboard_y ()">gok_data_get_keyboard_y</a> (void);
75
void <a class="link" href="gok-gok-data.html#gok-data-set-keyboard-y" title="gok_data_set_keyboard_y ()">gok_data_set_keyboard_y</a> (gint Y);
76
gboolean <a class="link" href="gok-gok-data.html#gok-data-get-keysize-priority" title="gok_data_get_keysize_priority ()">gok_data_get_keysize_priority</a> (void);
77
void <a class="link" href="gok-gok-data.html#gok-data-set-keysize-priority" title="gok_data_set_keysize_priority ()">gok_data_set_keysize_priority</a> (gboolean bFlag);
78
char* <a class="link" href="gok-gok-data.html#gok-data-get-name-accessmethod" title="gok_data_get_name_accessmethod ()">gok_data_get_name_accessmethod</a> (void);
79
void <a class="link" href="gok-gok-data.html#gok-data-set-name-accessmethod" title="gok_data_set_name_accessmethod ()">gok_data_set_name_accessmethod</a> (const gchar *Name);
80
gboolean <a class="link" href="gok-gok-data.html#gok-data-get-wordcomplete" title="gok_data_get_wordcomplete ()">gok_data_get_wordcomplete</a> (void);
81
void <a class="link" href="gok-gok-data.html#gok-data-set-wordcomplete" title="gok_data_set_wordcomplete ()">gok_data_set_wordcomplete</a> (gboolean bTrueFalse);
82
gint <a class="link" href="gok-gok-data.html#gok-data-get-num-predictions" title="gok_data_get_num_predictions ()">gok_data_get_num_predictions</a> (void);
83
void <a class="link" href="gok-gok-data.html#gok-data-set-num-predictions" title="gok_data_set_num_predictions ()">gok_data_set_num_predictions</a> (gint Number);
84
gboolean <a class="link" href="gok-gok-data.html#gok-data-restore-settings" title="gok_data_restore_settings ()">gok_data_restore_settings</a> (void);
85
void <a class="link" href="gok-gok-data.html#gok-data-backup-setting" title="gok_data_backup_setting ()">gok_data_backup_setting</a> (GokSetting *pSetting);
86
gboolean <a class="link" href="gok-gok-data.html#gok-data-restore-setting" title="gok_data_restore_setting ()">gok_data_restore_setting</a> (GokSetting *pSetting);
87
gboolean <a class="link" href="gok-gok-data.html#gok-data-get-control-values" title="gok_data_get_control_values ()">gok_data_get_control_values</a> (GokControl *pControl);
88
gboolean <a class="link" href="gok-gok-data.html#gok-data-get-use-gtkplus-theme" title="gok_data_get_use_gtkplus_theme ()">gok_data_get_use_gtkplus_theme</a> (void);
89
void <a class="link" href="gok-gok-data.html#gok-data-set-use-gtkplus-theme" title="gok_data_set_use_gtkplus_theme ()">gok_data_set_use_gtkplus_theme</a> (gboolean bTrueFalse);
90
</pre>
91
</div>
92
<div class="refsect1" lang="en">
93
<a name="gok-gok-data.description"></a><h2>Description</h2>
94
<p>
95
96
</p>
97
</div>
98
<div class="refsect1" lang="en">
99
<a name="gok-gok-data.details"></a><h2>Details</h2>
100
<div class="refsect2" lang="en">
101
<a name="GOK-SETTINGS-FILE:CAPS"></a><h3>GOK_SETTINGS_FILE</h3>
102
<pre class="programlisting">#define GOK_SETTINGS_FILE "gok-settings.xml"
103
</pre>
104
<p>
105
106
</p>
107
</div>
108
<hr>
109
<div class="refsect2" lang="en">
110
<a name="MAX-KEY-SPACING:CAPS"></a><h3>MAX_KEY_SPACING</h3>
111
<pre class="programlisting">#define MAX_KEY_SPACING 100
112
</pre>
113
<p>
114
115
</p>
116
</div>
117
<hr>
118
<div class="refsect2" lang="en">
119
<a name="MAX-KEY-WIDTH:CAPS"></a><h3>MAX_KEY_WIDTH</h3>
120
<pre class="programlisting">#define MAX_KEY_WIDTH 200
121
</pre>
122
<p>
123
124
</p>
125
</div>
126
<hr>
127
<div class="refsect2" lang="en">
128
<a name="MIN-KEY-WIDTH:CAPS"></a><h3>MIN_KEY_WIDTH</h3>
129
<pre class="programlisting">#define MIN_KEY_WIDTH 5
130
</pre>
131
<p>
132
133
</p>
134
</div>
135
<hr>
136
<div class="refsect2" lang="en">
137
<a name="MAX-KEY-HEIGHT:CAPS"></a><h3>MAX_KEY_HEIGHT</h3>
138
<pre class="programlisting">#define MAX_KEY_HEIGHT 100
139
</pre>
140
<p>
141
142
</p>
143
</div>
144
<hr>
145
<div class="refsect2" lang="en">
146
<a name="MIN-KEY-HEIGHT:CAPS"></a><h3>MIN_KEY_HEIGHT</h3>
147
<pre class="programlisting">#define MIN_KEY_HEIGHT 5
148
</pre>
149
<p>
150
151
</p>
152
</div>
153
<hr>
154
<div class="refsect2" lang="en">
155
<a name="gok-data-initialize"></a><h3>gok_data_initialize ()</h3>
156
<pre class="programlisting">void gok_data_initialize (void);</pre>
169
157
<p>
170
158
Call this before using the Data. All data is initialized here.</p>
171
159
<p>
174
162
</div>
175
163
<hr>
176
164
<div class="refsect2" lang="en">
177
<a name="id2603670"></a><h3>
178
<a name="gok-data-construct-setting"></a>gok_data_construct_setting ()</h3>
179
<a class="indexterm" name="id2603684"></a><pre class="programlisting">GokSetting* gok_data_construct_setting (void);</pre>
165
<a name="gok-data-construct-setting"></a><h3>gok_data_construct_setting ()</h3>
166
<pre class="programlisting">GokSetting* gok_data_construct_setting (void);</pre>
180
167
<p>
181
168
Creates a new GokSetting structure.</p>
182
169
<p>
185
172
<div class="variablelist"><table border="0">
186
173
<col align="left" valign="top">
187
174
<tbody><tr>
188
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
175
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
189
176
<td> A pointer to the new setting, NULL if setting was not created.
190
177
</td>
191
178
</tr></tbody>
193
180
</div>
194
181
<hr>
195
182
<div class="refsect2" lang="en">
196
<a name="id2603725"></a><h3>
197
<a name="gok-data-read-settings"></a>gok_data_read_settings ()</h3>
198
<a class="indexterm" name="id2603738"></a><pre class="programlisting">gboolean gok_data_read_settings (void);</pre>
183
<a name="gok-data-read-settings"></a><h3>gok_data_read_settings ()</h3>
184
<pre class="programlisting">gboolean gok_data_read_settings (void);</pre>
199
185
<p>
200
186
Reads in the settings from disk. The settings are stored in a list
201
187
with the first item * in m_pSettingFirst.</p>
205
191
<div class="variablelist"><table border="0">
206
192
<col align="left" valign="top">
207
193
<tbody><tr>
208
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
194
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
209
195
<td> TRUE if the settings were read in correctly, FALSE if not.
210
196
</td>
211
197
</tr></tbody>
213
199
</div>
214
200
<hr>
215
201
<div class="refsect2" lang="en">
216
<a name="id2603780"></a><h3>
217
<a name="gok-data-write-settings"></a>gok_data_write_settings ()</h3>
218
<a class="indexterm" name="id2603793"></a><pre class="programlisting">gboolean gok_data_write_settings (void);</pre>
202
<a name="gok-data-write-settings"></a><h3>gok_data_write_settings ()</h3>
203
<pre class="programlisting">gboolean gok_data_write_settings (void);</pre>
219
204
<p>
220
205
221
206
</p>
222
207
<div class="variablelist"><table border="0">
223
208
<col align="left" valign="top">
224
209
<tbody><tr>
225
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
210
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
226
211
<td>
227
212
228
213
232
217
</div>
233
218
<hr>
234
219
<div class="refsect2" lang="en">
235
<a name="id2603829"></a><h3>
236
<a name="gok-data-get-setting"></a>gok_data_get_setting ()</h3>
237
<a class="indexterm" name="id2603842"></a><pre class="programlisting">gboolean gok_data_get_setting (gchar *NameAccessMethod,
220
<a name="gok-data-get-setting"></a><h3>gok_data_get_setting ()</h3>
221
<pre class="programlisting">gboolean gok_data_get_setting (gchar *NameAccessMethod,
238
222
gchar *NameSetting,
239
223
gint *Value,
240
224
gchar **ValueString);</pre>
247
231
<col align="left" valign="top">
248
232
<tbody>
249
233
<tr>
250
<td><span class="term"><em class="parameter"><code>NameAccessMethod</code></em> :</span></td>
234
<td><p><span class="term"><em class="parameter"><code>NameAccessMethod</code></em> :</span></p></td>
251
235
<td> Name of the access method that contains the setting.
252
236
</td>
253
237
</tr>
254
238
<tr>
255
<td><span class="term"><em class="parameter"><code>NameSetting</code></em> :</span></td>
239
<td><p><span class="term"><em class="parameter"><code>NameSetting</code></em> :</span></p></td>
256
240
<td> Name of the setting you want.
257
241
This string may specify more than
258
242
one setting with the various names seperated by '+'. In this case, only the
260
244
</td>
261
245
</tr>
262
246
<tr>
263
<td><span class="term"><em class="parameter"><code>Value</code></em> :</span></td>
247
<td><p><span class="term"><em class="parameter"><code>Value</code></em> :</span></p></td>
264
248
<td> Will contain the setting value if the function returns TRUE. This
265
249
may be NULL in which case it will not be filled in.
266
250
</td>
267
251
</tr>
268
252
<tr>
269
<td><span class="term"><em class="parameter"><code>ValueString</code></em> :</span></td>
253
<td><p><span class="term"><em class="parameter"><code>ValueString</code></em> :</span></p></td>
270
254
<td> Will contain a pointer to the value string. This name be NULL
271
255
in which case it will not be filled in.
272
256
</td>
273
257
</tr>
274
258
<tr>
275
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
259
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
276
260
<td> TRUE if the GokData has the setting, FALSE if not.
277
261
</td>
278
262
</tr>
281
265
</div>
282
266
<hr>
283
267
<div class="refsect2" lang="en">
284
<a name="id2603976"></a><h3>
285
<a name="gok-data-create-setting"></a>gok_data_create_setting ()</h3>
286
<a class="indexterm" name="id2603989"></a><pre class="programlisting">gboolean gok_data_create_setting (gchar *NameAccessMethod,
268
<a name="gok-data-create-setting"></a><h3>gok_data_create_setting ()</h3>
269
<pre class="programlisting">gboolean gok_data_create_setting (gchar *NameAccessMethod,
287
270
gchar *NameSetting,
288
271
gint Value,
289
272
gchar *pValueString);</pre>
296
279
<col align="left" valign="top">
297
280
<tbody>
298
281
<tr>
299
<td><span class="term"><em class="parameter"><code>NameAccessMethod</code></em> :</span></td>
282
<td><p><span class="term"><em class="parameter"><code>NameAccessMethod</code></em> :</span></p></td>
300
283
<td> Name of the access method that uses the setting.
301
284
</td>
302
285
</tr>
303
286
<tr>
304
<td><span class="term"><em class="parameter"><code>NameSetting</code></em> :</span></td>
287
<td><p><span class="term"><em class="parameter"><code>NameSetting</code></em> :</span></p></td>
305
288
<td> Name of the setting.
306
289
</td>
307
290
</tr>
308
291
<tr>
309
<td><span class="term"><em class="parameter"><code>Value</code></em> :</span></td>
292
<td><p><span class="term"><em class="parameter"><code>Value</code></em> :</span></p></td>
310
293
<td> Setting value.
311
294
</td>
312
295
</tr>
313
296
<tr>
314
<td><span class="term"><em class="parameter"><code>pValueString</code></em> :</span></td>
297
<td><p><span class="term"><em class="parameter"><code>pValueString</code></em> :</span></p></td>
315
298
<td>
316
299
</td>
317
300
</tr>
318
301
<tr>
319
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
302
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
320
303
<td> TRUE if the new setting was created, FALSE if not.
321
304
</td>
322
305
</tr>
325
308
</div>
326
309
<hr>
327
310
<div class="refsect2" lang="en">
328
<a name="id2604117"></a><h3>
329
<a name="gok-data-close"></a>gok_data_close ()</h3>
330
<a class="indexterm" name="id2604130"></a><pre class="programlisting">void gok_data_close (void);</pre>
311
<a name="gok-data-close"></a><h3>gok_data_close ()</h3>
312
<pre class="programlisting">void gok_data_close (void);</pre>
331
313
<p>
332
314
Frees any memory used by the data.</p>
333
315
<p>
336
318
</div>
337
319
<hr>
338
320
<div class="refsect2" lang="en">
339
<a name="id2604156"></a><h3>
340
<a name="gok-data-set-setting"></a>gok_data_set_setting ()</h3>
341
<a class="indexterm" name="id2604169"></a><pre class="programlisting">gboolean gok_data_set_setting (gchar *NameAccessMethod,
321
<a name="gok-data-set-setting"></a><h3>gok_data_set_setting ()</h3>
322
<pre class="programlisting">gboolean gok_data_set_setting (gchar *NameAccessMethod,
342
323
gchar *NameSetting,
343
324
gint Value,
344
325
gchar *ValueString);</pre>
351
332
<col align="left" valign="top">
352
333
<tbody>
353
334
<tr>
354
<td><span class="term"><em class="parameter"><code>NameAccessMethod</code></em> :</span></td>
335
<td><p><span class="term"><em class="parameter"><code>NameAccessMethod</code></em> :</span></p></td>
355
336
<td> Name of the access method that contains the setting.
356
337
</td>
357
338
</tr>
358
339
<tr>
359
<td><span class="term"><em class="parameter"><code>NameSetting</code></em> :</span></td>
340
<td><p><span class="term"><em class="parameter"><code>NameSetting</code></em> :</span></p></td>
360
341
<td> Name of the setting you want.
361
342
You may specify more than one setting by seperating
362
343
the setting names by "+".
363
344
</td>
364
345
</tr>
365
346
<tr>
366
<td><span class="term"><em class="parameter"><code>Value</code></em> :</span></td>
347
<td><p><span class="term"><em class="parameter"><code>Value</code></em> :</span></p></td>
367
348
<td> Will contain the setting value if the function returns TRUE.
368
349
</td>
369
350
</tr>
370
351
<tr>
371
<td><span class="term"><em class="parameter"><code>ValueString</code></em> :</span></td>
352
<td><p><span class="term"><em class="parameter"><code>ValueString</code></em> :</span></p></td>
372
353
<td>
373
354
</td>
374
355
</tr>
375
356
<tr>
376
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
357
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
377
358
<td> TRUE if the setting was changed, FALSE if not.
378
359
</td>
379
360
</tr>
382
363
</div>
383
364
<hr>
384
365
<div class="refsect2" lang="en">
385
<a name="id2604299"></a><h3>
386
<a name="gok-data-get-key-width"></a>gok_data_get_key_width ()</h3>
387
<a class="indexterm" name="id2604312"></a><pre class="programlisting">gint gok_data_get_key_width (void);</pre>
366
<a name="gok-data-get-key-width"></a><h3>gok_data_get_key_width ()</h3>
367
<pre class="programlisting">gint gok_data_get_key_width (void);</pre>
388
368
<p>
389
369
</p>
390
370
<p>
393
373
<div class="variablelist"><table border="0">
394
374
<col align="left" valign="top">
395
375
<tbody><tr>
396
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
376
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
397
377
<td> The key width.
398
378
</td>
399
379
</tr></tbody>
401
381
</div>
402
382
<hr>
403
383
<div class="refsect2" lang="en">
404
<a name="id2604351"></a><h3>
405
<a name="gok-data-set-key-width"></a>gok_data_set_key_width ()</h3>
406
<a class="indexterm" name="id2604364"></a><pre class="programlisting">void gok_data_set_key_width (gint Width);</pre>
384
<a name="gok-data-set-key-width"></a><h3>gok_data_set_key_width ()</h3>
385
<pre class="programlisting">void gok_data_set_key_width (gint Width);</pre>
407
386
<p>
408
387
</p>
409
388
<p>
412
391
<div class="variablelist"><table border="0">
413
392
<col align="left" valign="top">
414
393
<tbody><tr>
415
<td><span class="term"><em class="parameter"><code>Width</code></em> :</span></td>
394
<td><p><span class="term"><em class="parameter"><code>Width</code></em> :</span></p></td>
416
395
<td> The new key width
417
396
</td>
418
397
</tr></tbody>
420
399
</div>
421
400
<hr>
422
401
<div class="refsect2" lang="en">
423
<a name="id2604414"></a><h3>
424
<a name="gok-data-get-key-height"></a>gok_data_get_key_height ()</h3>
425
<a class="indexterm" name="id2604427"></a><pre class="programlisting">gint gok_data_get_key_height (void);</pre>
402
<a name="gok-data-get-key-height"></a><h3>gok_data_get_key_height ()</h3>
403
<pre class="programlisting">gint gok_data_get_key_height (void);</pre>
426
404
<p>
427
405
</p>
428
406
<p>
431
409
<div class="variablelist"><table border="0">
432
410
<col align="left" valign="top">
433
411
<tbody><tr>
434
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
412
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
435
413
<td> The key height.
436
414
</td>
437
415
</tr></tbody>
439
417
</div>
440
418
<hr>
441
419
<div class="refsect2" lang="en">
442
<a name="id2604467"></a><h3>
443
<a name="gok-data-set-key-height"></a>gok_data_set_key_height ()</h3>
444
<a class="indexterm" name="id2604480"></a><pre class="programlisting">void gok_data_set_key_height (gint Height);</pre>
420
<a name="gok-data-set-key-height"></a><h3>gok_data_set_key_height ()</h3>
421
<pre class="programlisting">void gok_data_set_key_height (gint Height);</pre>
445
422
<p>
446
423
</p>
447
424
<p>
450
427
<div class="variablelist"><table border="0">
451
428
<col align="left" valign="top">
452
429
<tbody><tr>
453
<td><span class="term"><em class="parameter"><code>Height</code></em> :</span></td>
430
<td><p><span class="term"><em class="parameter"><code>Height</code></em> :</span></p></td>
454
431
<td> The new key height.
455
432
</td>
456
433
</tr></tbody>
458
435
</div>
459
436
<hr>
460
437
<div class="refsect2" lang="en">
461
<a name="id2604530"></a><h3>
462
<a name="gok-data-get-key-spacing"></a>gok_data_get_key_spacing ()</h3>
463
<a class="indexterm" name="id2604542"></a><pre class="programlisting">gint gok_data_get_key_spacing (void);</pre>
438
<a name="gok-data-get-key-spacing"></a><h3>gok_data_get_key_spacing ()</h3>
439
<pre class="programlisting">gint gok_data_get_key_spacing (void);</pre>
464
440
<p>
465
441
</p>
466
442
<p>
469
445
<div class="variablelist"><table border="0">
470
446
<col align="left" valign="top">
471
447
<tbody><tr>
472
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
448
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
473
449
<td> The key spacing.
474
450
</td>
475
451
</tr></tbody>
477
453
</div>
478
454
<hr>
479
455
<div class="refsect2" lang="en">
480
<a name="id2604582"></a><h3>
481
<a name="gok-data-set-key-spacing"></a>gok_data_set_key_spacing ()</h3>
482
<a class="indexterm" name="id2604595"></a><pre class="programlisting">void gok_data_set_key_spacing (gint Spacing);</pre>
456
<a name="gok-data-set-key-spacing"></a><h3>gok_data_set_key_spacing ()</h3>
457
<pre class="programlisting">void gok_data_set_key_spacing (gint Spacing);</pre>
483
458
<p>
484
459
</p>
485
460
<p>
488
463
<div class="variablelist"><table border="0">
489
464
<col align="left" valign="top">
490
465
<tbody><tr>
491
<td><span class="term"><em class="parameter"><code>Spacing</code></em> :</span></td>
466
<td><p><span class="term"><em class="parameter"><code>Spacing</code></em> :</span></p></td>
492
467
<td> The new key spacing.
493
468
</td>
494
469
</tr></tbody>
496
471
</div>
497
472
<hr>
498
473
<div class="refsect2" lang="en">
499
<a name="id2604645"></a><h3>
500
<a name="gok-data-get-keyboard-x"></a>gok_data_get_keyboard_x ()</h3>
501
<a class="indexterm" name="id2604659"></a><pre class="programlisting">gint gok_data_get_keyboard_x (void);</pre>
474
<a name="gok-data-get-keyboard-x"></a><h3>gok_data_get_keyboard_x ()</h3>
475
<pre class="programlisting">gint gok_data_get_keyboard_x (void);</pre>
502
476
<p>
503
477
</p>
504
478
<p>
507
481
<div class="variablelist"><table border="0">
508
482
<col align="left" valign="top">
509
483
<tbody><tr>
510
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
484
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
511
485
<td> The horizontal location of the keyboard.
512
486
</td>
513
487
</tr></tbody>
515
489
</div>
516
490
<hr>
517
491
<div class="refsect2" lang="en">
518
<a name="id2604699"></a><h3>
519
<a name="gok-data-set-keyboard-x"></a>gok_data_set_keyboard_x ()</h3>
520
<a class="indexterm" name="id2604712"></a><pre class="programlisting">void gok_data_set_keyboard_x (gint X);</pre>
492
<a name="gok-data-set-keyboard-x"></a><h3>gok_data_set_keyboard_x ()</h3>
493
<pre class="programlisting">void gok_data_set_keyboard_x (gint X);</pre>
521
494
<p>
522
495
</p>
523
496
<p>
526
499
<div class="variablelist"><table border="0">
527
500
<col align="left" valign="top">
528
501
<tbody><tr>
529
<td><span class="term"><em class="parameter"><code>X</code></em> :</span></td>
502
<td><p><span class="term"><em class="parameter"><code>X</code></em> :</span></p></td>
530
503
<td> Horizontal position of the keyboard.
531
504
</td>
532
505
</tr></tbody>
534
507
</div>
535
508
<hr>
536
509
<div class="refsect2" lang="en">
537
<a name="id2604762"></a><h3>
538
<a name="gok-data-get-keyboard-y"></a>gok_data_get_keyboard_y ()</h3>
539
<a class="indexterm" name="id2604775"></a><pre class="programlisting">gint gok_data_get_keyboard_y (void);</pre>
510
<a name="gok-data-get-keyboard-y"></a><h3>gok_data_get_keyboard_y ()</h3>
511
<pre class="programlisting">gint gok_data_get_keyboard_y (void);</pre>
540
512
<p>
541
513
</p>
542
514
<p>
545
517
<div class="variablelist"><table border="0">
546
518
<col align="left" valign="top">
547
519
<tbody><tr>
548
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
520
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
549
521
<td> The vertical position of the keyboard.
550
522
</td>
551
523
</tr></tbody>
553
525
</div>
554
526
<hr>
555
527
<div class="refsect2" lang="en">
556
<a name="id2604815"></a><h3>
557
<a name="gok-data-set-keyboard-y"></a>gok_data_set_keyboard_y ()</h3>
558
<a class="indexterm" name="id2604829"></a><pre class="programlisting">void gok_data_set_keyboard_y (gint Y);</pre>
528
<a name="gok-data-set-keyboard-y"></a><h3>gok_data_set_keyboard_y ()</h3>
529
<pre class="programlisting">void gok_data_set_keyboard_y (gint Y);</pre>
559
530
<p>
560
531
</p>
561
532
<p>
564
535
<div class="variablelist"><table border="0">
565
536
<col align="left" valign="top">
566
537
<tbody><tr>
567
<td><span class="term"><em class="parameter"><code>Y</code></em> :</span></td>
538
<td><p><span class="term"><em class="parameter"><code>Y</code></em> :</span></p></td>
568
539
<td> Vertical position of the keyboard.
569
540
</td>
570
541
</tr></tbody>
572
543
</div>
573
544
<hr>
574
545
<div class="refsect2" lang="en">
575
<a name="id2604879"></a><h3>
576
<a name="gok-data-get-keysize-priority"></a>gok_data_get_keysize_priority ()</h3>
577
<a class="indexterm" name="id2604892"></a><pre class="programlisting">gboolean gok_data_get_keysize_priority (void);</pre>
546
<a name="gok-data-get-keysize-priority"></a><h3>gok_data_get_keysize_priority ()</h3>
547
<pre class="programlisting">gboolean gok_data_get_keysize_priority (void);</pre>
578
548
<p>
579
549
</p>
580
550
<p>
583
553
<div class="variablelist"><table border="0">
584
554
<col align="left" valign="top">
585
555
<tbody><tr>
586
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
556
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
587
557
<td> TRUE if the keyboard should use the keysize to determine
588
558
the keyboard size, FALSE if not.
589
559
</td>
592
562
</div>
593
563
<hr>
594
564
<div class="refsect2" lang="en">
595
<a name="id2604933"></a><h3>
596
<a name="gok-data-set-keysize-priority"></a>gok_data_set_keysize_priority ()</h3>
597
<a class="indexterm" name="id2604947"></a><pre class="programlisting">void gok_data_set_keysize_priority (gboolean bFlag);</pre>
565
<a name="gok-data-set-keysize-priority"></a><h3>gok_data_set_keysize_priority ()</h3>
566
<pre class="programlisting">void gok_data_set_keysize_priority (gboolean bFlag);</pre>
598
567
<p>
599
568
</p>
600
569
<p>
603
572
<div class="variablelist"><table border="0">
604
573
<col align="left" valign="top">
605
574
<tbody><tr>
606
<td><span class="term"><em class="parameter"><code>bFlag</code></em> :</span></td>
575
<td><p><span class="term"><em class="parameter"><code>bFlag</code></em> :</span></p></td>
607
576
<td> TRUE if the keysize should be used to determine keyboard size.
608
577
</td>
609
578
</tr></tbody>
611
580
</div>
612
581
<hr>
613
582
<div class="refsect2" lang="en">
614
<a name="id2604997"></a><h3>
615
<a name="gok-data-get-name-accessmethod"></a>gok_data_get_name_accessmethod ()</h3>
616
<a class="indexterm" name="id2605011"></a><pre class="programlisting">char* gok_data_get_name_accessmethod (void);</pre>
583
<a name="gok-data-get-name-accessmethod"></a><h3>gok_data_get_name_accessmethod ()</h3>
584
<pre class="programlisting">char* gok_data_get_name_accessmethod (void);</pre>
617
585
<p>
618
586
</p>
619
587
<p>
622
590
<div class="variablelist"><table border="0">
623
591
<col align="left" valign="top">
624
592
<tbody><tr>
625
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
593
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
626
594
<td> Pointer to the name of the current access method.
627
595
</td>
628
596
</tr></tbody>
630
598
</div>
631
599
<hr>
632
600
<div class="refsect2" lang="en">
633
<a name="id2605051"></a><h3>
634
<a name="gok-data-set-name-accessmethod"></a>gok_data_set_name_accessmethod ()</h3>
635
<a class="indexterm" name="id2605065"></a><pre class="programlisting">void gok_data_set_name_accessmethod (const gchar *Name);</pre>
601
<a name="gok-data-set-name-accessmethod"></a><h3>gok_data_set_name_accessmethod ()</h3>
602
<pre class="programlisting">void gok_data_set_name_accessmethod (const gchar *Name);</pre>
636
603
<p>
637
604
Records the new access method and stores it in GConf.</p>
638
605
<p>
641
608
<div class="variablelist"><table border="0">
642
609
<col align="left" valign="top">
643
610
<tbody><tr>
644
<td><span class="term"><em class="parameter"><code>Name</code></em> :</span></td>
611
<td><p><span class="term"><em class="parameter"><code>Name</code></em> :</span></p></td>
645
612
<td> Name of the current access method.
646
613
</td>
647
614
</tr></tbody>
649
616
</div>
650
617
<hr>
651
618
<div class="refsect2" lang="en">
652
<a name="id2605117"></a><h3>
653
<a name="gok-data-get-wordcomplete"></a>gok_data_get_wordcomplete ()</h3>
654
<a class="indexterm" name="id2605131"></a><pre class="programlisting">gboolean gok_data_get_wordcomplete (void);</pre>
619
<a name="gok-data-get-wordcomplete"></a><h3>gok_data_get_wordcomplete ()</h3>
620
<pre class="programlisting">gboolean gok_data_get_wordcomplete (void);</pre>
655
621
<p>
656
622
</p>
657
623
<p>
660
626
<div class="variablelist"><table border="0">
661
627
<col align="left" valign="top">
662
628
<tbody><tr>
663
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
629
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
664
630
<td> TRUE if word completion is turned on, FALSE if it's turned off.
665
631
</td>
666
632
</tr></tbody>
668
634
</div>
669
635
<hr>
670
636
<div class="refsect2" lang="en">
671
<a name="id2605170"></a><h3>
672
<a name="gok-data-set-wordcomplete"></a>gok_data_set_wordcomplete ()</h3>
673
<a class="indexterm" name="id2605184"></a><pre class="programlisting">void gok_data_set_wordcomplete (gboolean bTrueFalse);</pre>
637
<a name="gok-data-set-wordcomplete"></a><h3>gok_data_set_wordcomplete ()</h3>
638
<pre class="programlisting">void gok_data_set_wordcomplete (gboolean bTrueFalse);</pre>
674
639
<p>
675
640
</p>
676
641
<p>
679
644
<div class="variablelist"><table border="0">
680
645
<col align="left" valign="top">
681
646
<tbody><tr>
682
<td><span class="term"><em class="parameter"><code>bTrueFalse</code></em> :</span></td>
647
<td><p><span class="term"><em class="parameter"><code>bTrueFalse</code></em> :</span></p></td>
683
648
<td> The flag setting the word completion state.
684
649
</td>
685
650
</tr></tbody>
687
652
</div>
688
653
<hr>
689
654
<div class="refsect2" lang="en">
690
<a name="id2605234"></a><h3>
691
<a name="gok-data-get-num-predictions"></a>gok_data_get_num_predictions ()</h3>
692
<a class="indexterm" name="id2605248"></a><pre class="programlisting">gint gok_data_get_num_predictions (void);</pre>
655
<a name="gok-data-get-num-predictions"></a><h3>gok_data_get_num_predictions ()</h3>
656
<pre class="programlisting">gint gok_data_get_num_predictions (void);</pre>
693
657
<p>
694
658
</p>
695
659
<p>
698
662
<div class="variablelist"><table border="0">
699
663
<col align="left" valign="top">
700
664
<tbody><tr>
701
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
665
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
702
666
<td> The maximum number of word predictions.
703
667
</td>
704
668
</tr></tbody>
706
670
</div>
707
671
<hr>
708
672
<div class="refsect2" lang="en">
709
<a name="id2605288"></a><h3>
710
<a name="gok-data-set-num-predictions"></a>gok_data_set_num_predictions ()</h3>
711
<a class="indexterm" name="id2605302"></a><pre class="programlisting">void gok_data_set_num_predictions (gint Number);</pre>
673
<a name="gok-data-set-num-predictions"></a><h3>gok_data_set_num_predictions ()</h3>
674
<pre class="programlisting">void gok_data_set_num_predictions (gint Number);</pre>
712
675
<p>
713
676
</p>
714
677
<p>
717
680
<div class="variablelist"><table border="0">
718
681
<col align="left" valign="top">
719
682
<tbody><tr>
720
<td><span class="term"><em class="parameter"><code>Number</code></em> :</span></td>
683
<td><p><span class="term"><em class="parameter"><code>Number</code></em> :</span></p></td>
721
684
<td> Maximum number of word predictions.
722
685
</td>
723
686
</tr></tbody>
725
688
</div>
726
689
<hr>
727
690
<div class="refsect2" lang="en">
728
<a name="id2605352"></a><h3>
729
<a name="gok-data-restore-settings"></a>gok_data_restore_settings ()</h3>
730
<a class="indexterm" name="id2605366"></a><pre class="programlisting">gboolean gok_data_restore_settings (void);</pre>
691
<a name="gok-data-restore-settings"></a><h3>gok_data_restore_settings ()</h3>
692
<pre class="programlisting">gboolean gok_data_restore_settings (void);</pre>
731
693
<p>
732
694
Restores the values for all the settings.</p>
733
695
<p>
736
698
<div class="variablelist"><table border="0">
737
699
<col align="left" valign="top">
738
700
<tbody><tr>
739
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
701
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
740
702
<td> TRUE if any restored setting was different from the
741
703
current setting. Returns FALSE if all the restored settings are
742
704
the same as the current settings.
746
708
</div>
747
709
<hr>
748
710
<div class="refsect2" lang="en">
749
<a name="id2605409"></a><h3>
750
<a name="gok-data-backup-setting"></a>gok_data_backup_setting ()</h3>
751
<a class="indexterm" name="id2605422"></a><pre class="programlisting">void gok_data_backup_setting (GokSetting *pSetting);</pre>
711
<a name="gok-data-backup-setting"></a><h3>gok_data_backup_setting ()</h3>
712
<pre class="programlisting">void gok_data_backup_setting (GokSetting *pSetting);</pre>
752
713
<p>
753
714
Backs up the values for the given setting.</p>
754
715
<p>
757
718
<div class="variablelist"><table border="0">
758
719
<col align="left" valign="top">
759
720
<tbody><tr>
760
<td><span class="term"><em class="parameter"><code>pSetting</code></em> :</span></td>
721
<td><p><span class="term"><em class="parameter"><code>pSetting</code></em> :</span></p></td>
761
722
<td> Pointer to the setting that will be backed up.
762
723
</td>
763
724
</tr></tbody>
765
726
</div>
766
727
<hr>
767
728
<div class="refsect2" lang="en">
768
<a name="id2605473"></a><h3>
769
<a name="gok-data-restore-setting"></a>gok_data_restore_setting ()</h3>
770
<a class="indexterm" name="id2605487"></a><pre class="programlisting">gboolean gok_data_restore_setting (GokSetting *pSetting);</pre>
729
<a name="gok-data-restore-setting"></a><h3>gok_data_restore_setting ()</h3>
730
<pre class="programlisting">gboolean gok_data_restore_setting (GokSetting *pSetting);</pre>
771
731
<p>
772
732
Restores the values for the given setting.</p>
773
733
<p>
777
737
<col align="left" valign="top">
778
738
<tbody>
779
739
<tr>
780
<td><span class="term"><em class="parameter"><code>pSetting</code></em> :</span></td>
740
<td><p><span class="term"><em class="parameter"><code>pSetting</code></em> :</span></p></td>
781
741
<td> Pointer to the setting that will be restored.
782
742
</td>
783
743
</tr>
784
744
<tr>
785
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
745
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
786
746
<td> TRUE if the backup setting is different from the current
787
747
setting. Returns FALSE if the backup setting is the same as the
788
748
current setting.
793
753
</div>
794
754
<hr>
795
755
<div class="refsect2" lang="en">
796
<a name="id2605550"></a><h3>
797
<a name="gok-data-get-control-values"></a>gok_data_get_control_values ()</h3>
798
<a class="indexterm" name="id2605564"></a><pre class="programlisting">gboolean gok_data_get_control_values (GokControl *pControl);</pre>
756
<a name="gok-data-get-control-values"></a><h3>gok_data_get_control_values ()</h3>
757
<pre class="programlisting">gboolean gok_data_get_control_values (GokControl *pControl);</pre>
799
758
<p>
800
759
Gets the values from the settings for the given control.</p>
801
760
<p>
805
764
<col align="left" valign="top">
806
765
<tbody>
807
766
<tr>
808
<td><span class="term"><em class="parameter"><code>pControl</code></em> :</span></td>
767
<td><p><span class="term"><em class="parameter"><code>pControl</code></em> :</span></p></td>
809
768
<td>
810
769
</td>
811
770
</tr>
812
771
<tr>
813
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
772
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
814
773
<td> TRUE if the value was updated, FALSE if not.
815
774
</td>
816
775
</tr>
819
778
</div>
820
779
<hr>
821
780
<div class="refsect2" lang="en">
822
<a name="id2605626"></a><h3>
823
<a name="gok-data-get-use-gtkplus-theme"></a>gok_data_get_use_gtkplus_theme ()</h3>
824
<a class="indexterm" name="id2605639"></a><pre class="programlisting">gboolean gok_data_get_use_gtkplus_theme (void);</pre>
781
<a name="gok-data-get-use-gtkplus-theme"></a><h3>gok_data_get_use_gtkplus_theme ()</h3>
782
<pre class="programlisting">gboolean gok_data_get_use_gtkplus_theme (void);</pre>
825
783
<p>
826
784
</p>
827
785
<p>
830
788
<div class="variablelist"><table border="0">
831
789
<col align="left" valign="top">
832
790
<tbody><tr>
833
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
791
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
834
792
<td> TRUE if we should use the Gtk+ theme, FALSE if we should not.
835
793
</td>
836
794
</tr></tbody>
838
796
</div>
839
797
<hr>
840
798
<div class="refsect2" lang="en">
841
<a name="id2605680"></a><h3>
842
<a name="gok-data-set-use-gtkplus-theme"></a>gok_data_set_use_gtkplus_theme ()</h3>
843
<a class="indexterm" name="id2605694"></a><pre class="programlisting">void gok_data_set_use_gtkplus_theme (gboolean bTrueFalse);</pre>
799
<a name="gok-data-set-use-gtkplus-theme"></a><h3>gok_data_set_use_gtkplus_theme ()</h3>
800
<pre class="programlisting">void gok_data_set_use_gtkplus_theme (gboolean bTrueFalse);</pre>
844
801
<p>
845
802
</p>
846
803
<p>
849
806
<div class="variablelist"><table border="0">
850
807
<col align="left" valign="top">
851
808
<tbody><tr>
852
<td><span class="term"><em class="parameter"><code>bTrueFalse</code></em> :</span></td>
809
<td><p><span class="term"><em class="parameter"><code>bTrueFalse</code></em> :</span></p></td>
853
810
<td> The flag setting whether to use the Gtk+ theme or not.
854
811
</td>
855
812
</tr></tbody>
857
814
</div>
858
815
</div>
859
816
</div>
817
<div class="footer">
818
<hr>
819
Generated by GTK-Doc V1.10</div>
860
820
</body>
861
821
</html>
Loggerhead is a web-based interface for Breezy
Version: 2.0.1