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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gok-feedback</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<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-editor.html" title="gok-editor">
<link rel="next" href="gok-gok-gconf.html" title="gok-gconf">
<meta name="generator" content="GTK-Doc V1.6 (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-editor.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-gconf.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="#top_of_page" class="shortcut">Top</a>
 | 
<a href="#desc" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="gok-gok-feedback"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="top_of_page"></a>gok-feedback</span></h2>
<p>gok-feedback — </p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
GokFeedback* <a href="gok-gok-feedback.html#gok-feedback-new">gok_feedback_new</a> (void);
void <a href="gok-gok-feedback.html#gok-feedback-free">gok_feedback_free</a> (GokFeedback *pFeedback);
gboolean <a href="gok-gok-feedback.html#gok-feedback-open">gok_feedback_open</a> (void);
void <a href="gok-gok-feedback.html#gok-feedback-close">gok_feedback_close</a> (void);
GokFeedback* <a href="gok-gok-feedback.html#gok-feedback-get-first-feedback">gok_feedback_get_first_feedback</a>
(void);
GokFeedback* <a href="gok-gok-feedback.html#gok-feedback-find-feedback">gok_feedback_find_feedback</a> (gchar *NameFeedback,
gboolean bDisplayName);
void <a href="gok-gok-feedback.html#gok-feedback-add-feedback">gok_feedback_add_feedback</a> (GokFeedback *pFeedbackNew);
void <a href="gok-gok-feedback.html#gok-feedback-delete-feedback">gok_feedback_delete_feedback</a> (GokFeedback *pFeedbackDelete);
void <a href="gok-gok-feedback.html#gok-feedback-backup">gok_feedback_backup</a> (GokFeedback *pFeedback);
gboolean <a href="gok-gok-feedback.html#gok-feedback-revert">gok_feedback_revert</a> (GokFeedback *pFeedback);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="desc"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2584502"></a><h3>
<a name="gok-feedback-new"></a>gok_feedback_new ()</h3>
<a class="indexterm" name="id2584513"></a><pre class="programlisting">GokFeedback* gok_feedback_new (void);</pre>
<p>
Allocates memory for a new GokFeedback and initializes its attributes
to default values. Please free the returned GokFeedback using
gok_feedback_free.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A pointer to a new GokFeedback.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2584555"></a><h3>
<a name="gok-feedback-free"></a>gok_feedback_free ()</h3>
<a class="indexterm" name="id2584569"></a><pre class="programlisting">void gok_feedback_free (GokFeedback *pFeedback);</pre>
<p>
Frees a GokFeedback and associated resources.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>pFeedback</code></em> :</span></td>
<td> Pointer to the feedback that will be freed.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2584619"></a><h3>
<a name="gok-feedback-open"></a>gok_feedback_open ()</h3>
<a class="indexterm" name="id2584633"></a><pre class="programlisting">gboolean gok_feedback_open (void);</pre>
<p>
Initializes the gok feedbacks and reads them from GConf.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE if the feedbacks were initialized, FALSE if not.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2584673"></a><h3>
<a name="gok-feedback-close"></a>gok_feedback_close ()</h3>
<a class="indexterm" name="id2584687"></a><pre class="programlisting">void gok_feedback_close (void);</pre>
<p>
Closes the gok feedbacks and saves them in GConf.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2584712"></a><h3>
<a name="gok-feedback-get-first-feedback"></a>gok_feedback_get_first_feedback ()</h3>
<a class="indexterm" name="id2584725"></a><pre class="programlisting">GokFeedback* gok_feedback_get_first_feedback
(void);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A pointer to the first feedback in the list of feedbacks.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2584766"></a><h3>
<a name="gok-feedback-find-feedback"></a>gok_feedback_find_feedback ()</h3>
<a class="indexterm" name="id2584780"></a><pre class="programlisting">GokFeedback* gok_feedback_find_feedback (gchar *NameFeedback,
gboolean bDisplayName);</pre>
<p>
Finds the feedback from within our list of feedbacks.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>NameFeedback</code></em> :</span></td>
<td> Name of the feedback you're trying to find.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>bDisplayName</code></em> :</span></td>
<td> This should be set TRUE if you are passing in the display
name of the feedback. It should be set FALSE if passing in the actual
name of the feedback.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A pointer to the feedback, NULL if not found.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2584866"></a><h3>
<a name="gok-feedback-add-feedback"></a>gok_feedback_add_feedback ()</h3>
<a class="indexterm" name="id2584880"></a><pre class="programlisting">void gok_feedback_add_feedback (GokFeedback *pFeedbackNew);</pre>
<p>
Adds a new feedback to our list of feedbacks.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>pFeedbackNew</code></em> :</span></td>
<td> Pointer to an feedback that gets added to our list of feedbacks.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2584931"></a><h3>
<a name="gok-feedback-delete-feedback"></a>gok_feedback_delete_feedback ()</h3>
<a class="indexterm" name="id2584945"></a><pre class="programlisting">void gok_feedback_delete_feedback (GokFeedback *pFeedbackDelete);</pre>
<p>
Deletes the given feedback and unhooks it from our list of feedbacks.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>pFeedbackDelete</code></em> :</span></td>
<td> Pointer to the feedback that will be deleted.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2584996"></a><h3>
<a name="gok-feedback-backup"></a>gok_feedback_backup ()</h3>
<a class="indexterm" name="id2585009"></a><pre class="programlisting">void gok_feedback_backup (GokFeedback *pFeedback);</pre>
<p>
Creates a copy of all the data stored on the feedback.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>pFeedback</code></em> :</span></td>
<td> Pointer to the feedback that will be backed up.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2585060"></a><h3>
<a name="gok-feedback-revert"></a>gok_feedback_revert ()</h3>
<a class="indexterm" name="id2585073"></a><pre class="programlisting">gboolean gok_feedback_revert (GokFeedback *pFeedback);</pre>
<p>
Moves the backup data to the current data on the feedback.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>pFeedback</code></em> :</span></td>
<td> Pointer to the feedback that will be reverted.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE if any of the reverted settings are different from the
current settings. Returns FALSE if the reverted settings are the same
as the current settings.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|