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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gok-data</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GOK - Gnome Onscreen Keyboard">
<link rel="up" href="ch01.html" title="GOK Internal API">
<link rel="prev" href="gok-gok-control.html" title="gok-control">
<link rel="next" href="gok-gok-editor.html" title="gok-editor">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="GOK Internal API">
<link rel="chapter" href="ch02.html" title="Hardware Interfacing">
<link rel="chapter" href="ch03.html" title="Preferences GUI">
<link rel="chapter" href="ch04.html" title="Command Prediction">
</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="2">
<tr valign="middle">
<td><a accesskey="p" href="gok-gok-control.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GOK - Gnome Onscreen Keyboard</th>
<td><a accesskey="n" href="gok-gok-editor.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#gok-gok-data.synopsis" class="shortcut">Top</a>
|
<a href="#gok-gok-data.description" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="gok-gok-data"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gok-gok-data.top_of_page"></a>gok-data</span></h2>
<p>gok-data</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gok-gok-data.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#define <a class="link" href="gok-gok-data.html#GOK-SETTINGS-FILE:CAPS" title="GOK_SETTINGS_FILE">GOK_SETTINGS_FILE</a>
#define <a class="link" href="gok-gok-data.html#MAX-KEY-SPACING:CAPS" title="MAX_KEY_SPACING">MAX_KEY_SPACING</a>
#define <a class="link" href="gok-gok-data.html#MAX-KEY-WIDTH:CAPS" title="MAX_KEY_WIDTH">MAX_KEY_WIDTH</a>
#define <a class="link" href="gok-gok-data.html#MIN-KEY-WIDTH:CAPS" title="MIN_KEY_WIDTH">MIN_KEY_WIDTH</a>
#define <a class="link" href="gok-gok-data.html#MAX-KEY-HEIGHT:CAPS" title="MAX_KEY_HEIGHT">MAX_KEY_HEIGHT</a>
#define <a class="link" href="gok-gok-data.html#MIN-KEY-HEIGHT:CAPS" title="MIN_KEY_HEIGHT">MIN_KEY_HEIGHT</a>
void <a class="link" href="gok-gok-data.html#gok-data-initialize" title="gok_data_initialize ()">gok_data_initialize</a> (void);
GokSetting* <a class="link" href="gok-gok-data.html#gok-data-construct-setting" title="gok_data_construct_setting ()">gok_data_construct_setting</a> (void);
gboolean <a class="link" href="gok-gok-data.html#gok-data-read-settings" title="gok_data_read_settings ()">gok_data_read_settings</a> (void);
gboolean <a class="link" href="gok-gok-data.html#gok-data-write-settings" title="gok_data_write_settings ()">gok_data_write_settings</a> (void);
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,
gchar *NameSetting,
gint *Value,
gchar **ValueString);
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,
gchar *NameSetting,
gint Value,
gchar *pValueString);
void <a class="link" href="gok-gok-data.html#gok-data-close" title="gok_data_close ()">gok_data_close</a> (void);
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,
gchar *NameSetting,
gint Value,
gchar *ValueString);
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);
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);
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);
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);
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);
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);
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);
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);
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);
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);
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);
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);
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);
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);
gboolean <a class="link" href="gok-gok-data.html#gok-data-get-wordcomplete" title="gok_data_get_wordcomplete ()">gok_data_get_wordcomplete</a> (void);
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);
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);
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);
gboolean <a class="link" href="gok-gok-data.html#gok-data-restore-settings" title="gok_data_restore_settings ()">gok_data_restore_settings</a> (void);
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);
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);
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);
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);
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);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="gok-gok-data.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="gok-gok-data.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GOK-SETTINGS-FILE:CAPS"></a><h3>GOK_SETTINGS_FILE</h3>
<pre class="programlisting">#define GOK_SETTINGS_FILE "gok-settings.xml"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="MAX-KEY-SPACING:CAPS"></a><h3>MAX_KEY_SPACING</h3>
<pre class="programlisting">#define MAX_KEY_SPACING 100
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="MAX-KEY-WIDTH:CAPS"></a><h3>MAX_KEY_WIDTH</h3>
<pre class="programlisting">#define MAX_KEY_WIDTH 200
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="MIN-KEY-WIDTH:CAPS"></a><h3>MIN_KEY_WIDTH</h3>
<pre class="programlisting">#define MIN_KEY_WIDTH 5
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="MAX-KEY-HEIGHT:CAPS"></a><h3>MAX_KEY_HEIGHT</h3>
<pre class="programlisting">#define MAX_KEY_HEIGHT 100
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="MIN-KEY-HEIGHT:CAPS"></a><h3>MIN_KEY_HEIGHT</h3>
<pre class="programlisting">#define MIN_KEY_HEIGHT 5
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-initialize"></a><h3>gok_data_initialize ()</h3>
<pre class="programlisting">void gok_data_initialize (void);</pre>
<p>
Call this before using the Data. All data is initialized here.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-construct-setting"></a><h3>gok_data_construct_setting ()</h3>
<pre class="programlisting">GokSetting* gok_data_construct_setting (void);</pre>
<p>
Creates a new GokSetting structure.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A pointer to the new setting, NULL if setting was not created.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-read-settings"></a><h3>gok_data_read_settings ()</h3>
<pre class="programlisting">gboolean gok_data_read_settings (void);</pre>
<p>
Reads in the settings from disk. The settings are stored in a list
with the first item * in m_pSettingFirst.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the settings were read in correctly, FALSE if not.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-write-settings"></a><h3>gok_data_write_settings ()</h3>
<pre class="programlisting">gboolean gok_data_write_settings (void);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-get-setting"></a><h3>gok_data_get_setting ()</h3>
<pre class="programlisting">gboolean gok_data_get_setting (gchar *NameAccessMethod,
gchar *NameSetting,
gint *Value,
gchar **ValueString);</pre>
<p>
Gets a value for an access method setting.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>NameAccessMethod</code></em> :</span></p></td>
<td> Name of the access method that contains the setting.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>NameSetting</code></em> :</span></p></td>
<td> Name of the setting you want.
This string may specify more than
one setting with the various names seperated by '+'. In this case, only the
first name will be used.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>Value</code></em> :</span></p></td>
<td> Will contain the setting value if the function returns TRUE. This
may be NULL in which case it will not be filled in.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ValueString</code></em> :</span></p></td>
<td> Will contain a pointer to the value string. This name be NULL
in which case it will not be filled in.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the GokData has the setting, FALSE if not.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-create-setting"></a><h3>gok_data_create_setting ()</h3>
<pre class="programlisting">gboolean gok_data_create_setting (gchar *NameAccessMethod,
gchar *NameSetting,
gint Value,
gchar *pValueString);</pre>
<p>
Creates a new setting and stores it in GConf.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>NameAccessMethod</code></em> :</span></p></td>
<td> Name of the access method that uses the setting.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>NameSetting</code></em> :</span></p></td>
<td> Name of the setting.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>Value</code></em> :</span></p></td>
<td> Setting value.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pValueString</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the new setting was created, FALSE if not.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-close"></a><h3>gok_data_close ()</h3>
<pre class="programlisting">void gok_data_close (void);</pre>
<p>
Frees any memory used by the data.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-set-setting"></a><h3>gok_data_set_setting ()</h3>
<pre class="programlisting">gboolean gok_data_set_setting (gchar *NameAccessMethod,
gchar *NameSetting,
gint Value,
gchar *ValueString);</pre>
<p>
Sets a value for an access method.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>NameAccessMethod</code></em> :</span></p></td>
<td> Name of the access method that contains the setting.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>NameSetting</code></em> :</span></p></td>
<td> Name of the setting you want.
You may specify more than one setting by seperating
the setting names by "+".
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>Value</code></em> :</span></p></td>
<td> Will contain the setting value if the function returns TRUE.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ValueString</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the setting was changed, FALSE if not.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-get-key-width"></a><h3>gok_data_get_key_width ()</h3>
<pre class="programlisting">gint gok_data_get_key_width (void);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The key width.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-set-key-width"></a><h3>gok_data_set_key_width ()</h3>
<pre class="programlisting">void gok_data_set_key_width (gint Width);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>Width</code></em> :</span></p></td>
<td> The new key width
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-get-key-height"></a><h3>gok_data_get_key_height ()</h3>
<pre class="programlisting">gint gok_data_get_key_height (void);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The key height.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-set-key-height"></a><h3>gok_data_set_key_height ()</h3>
<pre class="programlisting">void gok_data_set_key_height (gint Height);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>Height</code></em> :</span></p></td>
<td> The new key height.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-get-key-spacing"></a><h3>gok_data_get_key_spacing ()</h3>
<pre class="programlisting">gint gok_data_get_key_spacing (void);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The key spacing.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-set-key-spacing"></a><h3>gok_data_set_key_spacing ()</h3>
<pre class="programlisting">void gok_data_set_key_spacing (gint Spacing);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>Spacing</code></em> :</span></p></td>
<td> The new key spacing.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-get-keyboard-x"></a><h3>gok_data_get_keyboard_x ()</h3>
<pre class="programlisting">gint gok_data_get_keyboard_x (void);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The horizontal location of the keyboard.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-set-keyboard-x"></a><h3>gok_data_set_keyboard_x ()</h3>
<pre class="programlisting">void gok_data_set_keyboard_x (gint X);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>X</code></em> :</span></p></td>
<td> Horizontal position of the keyboard.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-get-keyboard-y"></a><h3>gok_data_get_keyboard_y ()</h3>
<pre class="programlisting">gint gok_data_get_keyboard_y (void);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The vertical position of the keyboard.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-set-keyboard-y"></a><h3>gok_data_set_keyboard_y ()</h3>
<pre class="programlisting">void gok_data_set_keyboard_y (gint Y);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>Y</code></em> :</span></p></td>
<td> Vertical position of the keyboard.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-get-keysize-priority"></a><h3>gok_data_get_keysize_priority ()</h3>
<pre class="programlisting">gboolean gok_data_get_keysize_priority (void);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the keyboard should use the keysize to determine
the keyboard size, FALSE if not.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-set-keysize-priority"></a><h3>gok_data_set_keysize_priority ()</h3>
<pre class="programlisting">void gok_data_set_keysize_priority (gboolean bFlag);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>bFlag</code></em> :</span></p></td>
<td> TRUE if the keysize should be used to determine keyboard size.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-get-name-accessmethod"></a><h3>gok_data_get_name_accessmethod ()</h3>
<pre class="programlisting">char* gok_data_get_name_accessmethod (void);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Pointer to the name of the current access method.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-set-name-accessmethod"></a><h3>gok_data_set_name_accessmethod ()</h3>
<pre class="programlisting">void gok_data_set_name_accessmethod (const gchar *Name);</pre>
<p>
Records the new access method and stores it in GConf.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>Name</code></em> :</span></p></td>
<td> Name of the current access method.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-get-wordcomplete"></a><h3>gok_data_get_wordcomplete ()</h3>
<pre class="programlisting">gboolean gok_data_get_wordcomplete (void);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if word completion is turned on, FALSE if it's turned off.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-set-wordcomplete"></a><h3>gok_data_set_wordcomplete ()</h3>
<pre class="programlisting">void gok_data_set_wordcomplete (gboolean bTrueFalse);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>bTrueFalse</code></em> :</span></p></td>
<td> The flag setting the word completion state.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-get-num-predictions"></a><h3>gok_data_get_num_predictions ()</h3>
<pre class="programlisting">gint gok_data_get_num_predictions (void);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The maximum number of word predictions.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-set-num-predictions"></a><h3>gok_data_set_num_predictions ()</h3>
<pre class="programlisting">void gok_data_set_num_predictions (gint Number);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>Number</code></em> :</span></p></td>
<td> Maximum number of word predictions.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-restore-settings"></a><h3>gok_data_restore_settings ()</h3>
<pre class="programlisting">gboolean gok_data_restore_settings (void);</pre>
<p>
Restores the values for all the settings.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if any restored setting was different from the
current setting. Returns FALSE if all the restored settings are
the same as the current settings.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-backup-setting"></a><h3>gok_data_backup_setting ()</h3>
<pre class="programlisting">void gok_data_backup_setting (GokSetting *pSetting);</pre>
<p>
Backs up the values for the given setting.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>pSetting</code></em> :</span></p></td>
<td> Pointer to the setting that will be backed up.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-restore-setting"></a><h3>gok_data_restore_setting ()</h3>
<pre class="programlisting">gboolean gok_data_restore_setting (GokSetting *pSetting);</pre>
<p>
Restores the values for the given setting.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pSetting</code></em> :</span></p></td>
<td> Pointer to the setting that will be restored.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the backup setting is different from the current
setting. Returns FALSE if the backup setting is the same as the
current setting.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-get-control-values"></a><h3>gok_data_get_control_values ()</h3>
<pre class="programlisting">gboolean gok_data_get_control_values (GokControl *pControl);</pre>
<p>
Gets the values from the settings for the given control.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pControl</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the value was updated, FALSE if not.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-get-use-gtkplus-theme"></a><h3>gok_data_get_use_gtkplus_theme ()</h3>
<pre class="programlisting">gboolean gok_data_get_use_gtkplus_theme (void);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if we should use the Gtk+ theme, FALSE if we should not.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gok-data-set-use-gtkplus-theme"></a><h3>gok_data_set_use_gtkplus_theme ()</h3>
<pre class="programlisting">void gok_data_set_use_gtkplus_theme (gboolean bTrueFalse);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>bTrueFalse</code></em> :</span></p></td>
<td> The flag setting whether to use the Gtk+ theme or not.
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>
|