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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdictDatabaseChooser</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GNOME Dictionary Library Reference Manual">
<link rel="up" href="ch06.html" title="Advanced widgets">
<link rel="prev" href="ch06.html" title="Advanced widgets">
<link rel="next" href="GdictStrategyChooser.html" title="GdictStrategyChooser">
<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch06.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch06.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">GNOME Dictionary Library Reference Manual</th>
<td><a accesskey="n" href="GdictStrategyChooser.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GdictDatabaseChooser.synopsis" class="shortcut">Top</a>
|
<a href="#GdictDatabaseChooser.description" class="shortcut">Description</a>
|
<a href="#GdictDatabaseChooser.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GdictDatabaseChooser.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#GdictDatabaseChooser.properties" class="shortcut">Properties</a>
|
<a href="#GdictDatabaseChooser.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="GdictDatabaseChooser">
<a name="GdictDatabaseChooser"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdictDatabaseChooser.top_of_page"></a>GdictDatabaseChooser</span></h2>
<p>GdictDatabaseChooser — Display the list of available databases</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="GdictDatabaseChooser.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="GdictDatabaseChooser.html#GdictDatabaseChooser-struct" title="GdictDatabaseChooser">GdictDatabaseChooser</a>;
<a class="link" href="GdictDatabaseChooser.html#GdictDatabaseChooserClass" title="GdictDatabaseChooserClass">GdictDatabaseChooserClass</a>;
<span class="returnvalue">GtkWidget</span> * <a class="link" href="GdictDatabaseChooser.html#gdict-database-chooser-new" title="gdict_database_chooser_new ()">gdict_database_chooser_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">GtkWidget</span> * <a class="link" href="GdictDatabaseChooser.html#gdict-database-chooser-new-with-context" title="gdict_database_chooser_new_with_context ()">gdict_database_chooser_new_with_context</a>
(<em class="parameter"><code><span class="type">GdictContext</span> *context</code></em>);
<span class="returnvalue">GdictContext</span> * <a class="link" href="GdictDatabaseChooser.html#gdict-database-chooser-get-context" title="gdict_database_chooser_get_context ()">gdict_database_chooser_get_context</a> (<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdictDatabaseChooser.html#gdict-database-chooser-set-context" title="gdict_database_chooser_set_context ()">gdict_database_chooser_set_context</a> (<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>,
<em class="parameter"><code><span class="type">GdictContext</span> *context</code></em>);
<span class="returnvalue">gchar</span> ** <a class="link" href="GdictDatabaseChooser.html#gdict-database-chooser-get-databases" title="gdict_database_chooser_get_databases ()">gdict_database_chooser_get_databases</a>
(<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>,
<em class="parameter"><code><span class="type">gsize</span> *length</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="GdictDatabaseChooser.html#gdict-database-chooser-count-databases" title="gdict_database_chooser_count_databases ()">gdict_database_chooser_count_databases</a>
(<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="GdictDatabaseChooser.html#gdict-database-chooser-has-database" title="gdict_database_chooser_has_database ()">gdict_database_chooser_has_database</a> (<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *database</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdictDatabaseChooser.html#gdict-database-chooser-refresh" title="gdict_database_chooser_refresh ()">gdict_database_chooser_refresh</a> (<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdictDatabaseChooser.html#gdict-database-chooser-clear" title="gdict_database_chooser_clear ()">gdict_database_chooser_clear</a> (<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>);
<span class="returnvalue">GtkWidget</span> * <a class="link" href="GdictDatabaseChooser.html#gdict-database-chooser-add-button" title="gdict_database_chooser_add_button ()">gdict_database_chooser_add_button</a> (<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *button_text</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="GdictDatabaseChooser.html#gdict-database-chooser-get-current-database" title="gdict_database_chooser_get_current_database ()">gdict_database_chooser_get_current_database</a>
(<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="GdictDatabaseChooser.html#gdict-database-chooser-select-database" title="gdict_database_chooser_select_database ()">gdict_database_chooser_select_database</a>
(<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *db_name</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="GdictDatabaseChooser.html#gdict-database-chooser-set-current-database" title="gdict_database_chooser_set_current_database ()">gdict_database_chooser_set_current_database</a>
(<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *db_name</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="GdictDatabaseChooser.html#gdict-database-chooser-unselect-database" title="gdict_database_chooser_unselect_database ()">gdict_database_chooser_unselect_database</a>
(<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *db_name</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="GdictDatabaseChooser.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkBox
+----GtkVBox
+----GdictDatabaseChooser
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="GdictDatabaseChooser.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GdictDatabaseChooser implements
AtkImplementorIface, GtkBuildable and GtkOrientable.</p>
</div>
<div class="refsect1" title="Properties">
<a name="GdictDatabaseChooser.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GdictDatabaseChooser.html#GdictDatabaseChooser--context" title='The "context" property'>context</a>" <span class="type">GdictContext</span>* : Read / Write / Construct
"<a class="link" href="GdictDatabaseChooser.html#GdictDatabaseChooser--count" title='The "count" property'>count</a>" <span class="type">gint</span> : Read
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="GdictDatabaseChooser.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GdictDatabaseChooser.html#GdictDatabaseChooser-database-activated" title='The "database-activated" signal'>database-activated</a>" : Run Last
"<a class="link" href="GdictDatabaseChooser.html#GdictDatabaseChooser-selection-changed" title='The "selection-changed" signal'>selection-changed</a>" : Run Last
</pre>
</div>
<div class="refsect1" title="Description">
<a name="GdictDatabaseChooser.description"></a><h2>Description</h2>
<p>
Each <span class="type">GdictContext</span> has a list of databases, that is dictionaries that
can be queried. <a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> is a widget that queries a given
<span class="type">GdictContext</span> and displays the list of available databases.
</p>
<p>
<a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> is available since Gdict 0.10
</p>
</div>
<div class="refsect1" title="Details">
<a name="GdictDatabaseChooser.details"></a><h2>Details</h2>
<div class="refsect2" title="GdictDatabaseChooser">
<a name="GdictDatabaseChooser-struct"></a><h3>GdictDatabaseChooser</h3>
<pre class="programlisting">typedef struct _GdictDatabaseChooser GdictDatabaseChooser;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="GdictDatabaseChooserClass">
<a name="GdictDatabaseChooserClass"></a><h3>GdictDatabaseChooserClass</h3>
<pre class="programlisting">typedef struct {
void (*database_activated) (GdictDatabaseChooser *chooser,
const gchar *name,
const gchar *description);
void (*selection_changed) (GdictDatabaseChooser *chooser);
} GdictDatabaseChooserClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="gdict_database_chooser_new ()">
<a name="gdict-database-chooser-new"></a><h3>gdict_database_chooser_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * gdict_database_chooser_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new <a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> widget. A Database chooser widget
can be used to display the list of available databases on a dictionary
source using the <span class="type">GdictContext</span> representing it. After creation, the
<span class="type">GdictContext</span> can be set using <a class="link" href="GdictDatabaseChooser.html#gdict-database-chooser-set-context" title="gdict_database_chooser_set_context ()"><code class="function">gdict_database_chooser_set_context()</code></a>.
</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 newly created <a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> widget.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title="gdict_database_chooser_new_with_context ()">
<a name="gdict-database-chooser-new-with-context"></a><h3>gdict_database_chooser_new_with_context ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * gdict_database_chooser_new_with_context
(<em class="parameter"><code><span class="type">GdictContext</span> *context</code></em>);</pre>
<p>
Creates a new <a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a>, using <em class="parameter"><code>context</code></em> as the representation
of the dictionary source to query for the list of available databases.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>a <span class="type">GdictContext</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the newly created <a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> widget.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title="gdict_database_chooser_get_context ()">
<a name="gdict-database-chooser-get-context"></a><h3>gdict_database_chooser_get_context ()</h3>
<pre class="programlisting"><span class="returnvalue">GdictContext</span> * gdict_database_chooser_get_context (<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>);</pre>
<p>
Retrieves the <span class="type">GdictContext</span> used by <em class="parameter"><code>chooser</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>a <a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <span class="type">GdictContext</span> or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title="gdict_database_chooser_set_context ()">
<a name="gdict-database-chooser-set-context"></a><h3>gdict_database_chooser_set_context ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdict_database_chooser_set_context (<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>,
<em class="parameter"><code><span class="type">GdictContext</span> *context</code></em>);</pre>
<p>
Sets the <span class="type">GdictContext</span> to be used to query a dictionary source
for the list of available databases.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>a <a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>a <span class="type">GdictContext</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title="gdict_database_chooser_get_databases ()">
<a name="gdict-database-chooser-get-databases"></a><h3>gdict_database_chooser_get_databases ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> ** gdict_database_chooser_get_databases
(<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>,
<em class="parameter"><code><span class="type">gsize</span> *length</code></em>);</pre>
<p>
Gets the list of available database names.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>a <a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td>return location for the length of the returned vector
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly allocated, <code class="literal">NULL</code> terminated string vector
containing database names. Use <code class="function">g_strfreev()</code> to deallocate it.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title="gdict_database_chooser_count_databases ()">
<a name="gdict-database-chooser-count-databases"></a><h3>gdict_database_chooser_count_databases ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> gdict_database_chooser_count_databases
(<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>);</pre>
<p>
Returns the number of databases found.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>a <a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the number of databases or -1 if no context is set
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title="gdict_database_chooser_has_database ()">
<a name="gdict-database-chooser-has-database"></a><h3>gdict_database_chooser_has_database ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gdict_database_chooser_has_database (<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *database</code></em>);</pre>
<p>
Checks whether the <em class="parameter"><code>chooser</code></em> displays <em class="parameter"><code>database</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>a <a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>database</code></em> :</span></p></td>
<td>the name of a database
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if the search database name is present
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title="gdict_database_chooser_refresh ()">
<a name="gdict-database-chooser-refresh"></a><h3>gdict_database_chooser_refresh ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdict_database_chooser_refresh (<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>);</pre>
<p>
Reloads the list of available databases.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>a <a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title="gdict_database_chooser_clear ()">
<a name="gdict-database-chooser-clear"></a><h3>gdict_database_chooser_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdict_database_chooser_clear (<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>);</pre>
<p>
Clears <em class="parameter"><code>chooser</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>a <a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title="gdict_database_chooser_add_button ()">
<a name="gdict-database-chooser-add-button"></a><h3>gdict_database_chooser_add_button ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * gdict_database_chooser_add_button (<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *button_text</code></em>);</pre>
<p>
Adds a <span class="type">GtkButton</span> with <em class="parameter"><code>button_text</code></em> to the button area on
the bottom of <em class="parameter"><code>chooser</code></em>. The <em class="parameter"><code>button_text</code></em> can also be a
stock ID.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>a <a class="link" href="gdict-GdictContext.html#GdictDatabase" title="GdictDatabase"><span class="type">GdictDatabase</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>button_text</code></em> :</span></p></td>
<td>text of the button
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the newly packed button.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title="gdict_database_chooser_get_current_database ()">
<a name="gdict-database-chooser-get-current-database"></a><h3>gdict_database_chooser_get_current_database ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * gdict_database_chooser_get_current_database
(<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>);</pre>
<p>
Retrieves the name of the currently selected database inside <em class="parameter"><code>chooser</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>a <a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the name of the selected database. Use <code class="function">g_free()</code> on the
returned string when done using it
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title="gdict_database_chooser_select_database ()">
<a name="gdict-database-chooser-select-database"></a><h3>gdict_database_chooser_select_database ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gdict_database_chooser_select_database
(<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *db_name</code></em>);</pre>
<p>
Selects the database with <em class="parameter"><code>db_name</code></em> inside the <em class="parameter"><code>chooser</code></em> widget.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>a <a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>db_name</code></em> :</span></p></td>
<td>name of the database to select
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if the database was found and selected
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title="gdict_database_chooser_set_current_database ()">
<a name="gdict-database-chooser-set-current-database"></a><h3>gdict_database_chooser_set_current_database ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gdict_database_chooser_set_current_database
(<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *db_name</code></em>);</pre>
<p>
Sets <em class="parameter"><code>db_name</code></em> as the current database. This function will select
and activate the corresponding row, if the database is found.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>a <a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>db_name</code></em> :</span></p></td>
<td>the name of the database
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if the database was found and set
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title="gdict_database_chooser_unselect_database ()">
<a name="gdict-database-chooser-unselect-database"></a><h3>gdict_database_chooser_unselect_database ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gdict_database_chooser_unselect_database
(<em class="parameter"><code><a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *db_name</code></em>);</pre>
<p>
Unselects the database <em class="parameter"><code>db_name</code></em> inside the <em class="parameter"><code>chooser</code></em> widget
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>a <a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>db_name</code></em> :</span></p></td>
<td>name of the database to unselect
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if the database was found and unselected
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="GdictDatabaseChooser.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "context" property'>
<a name="GdictDatabaseChooser--context"></a><h3>The <code class="literal">"context"</code> property</h3>
<pre class="programlisting"> "context" <span class="type">GdictContext</span>* : Read / Write / Construct</pre>
<p>
The <span class="type">GdictContext</span> used to retrieve the list of available databases.
</p>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title='The "count" property'>
<a name="GdictDatabaseChooser--count"></a><h3>The <code class="literal">"count"</code> property</h3>
<pre class="programlisting"> "count" <span class="type">gint</span> : Read</pre>
<p>
The number of displayed databases or, if no <span class="type">GdictContext</span> is set, -1.
</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
<p class="since">Since 0.12</p>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="GdictDatabaseChooser.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "database-activated" signal'>
<a name="GdictDatabaseChooser-database-activated"></a><h3>The <code class="literal">"database-activated"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser,
<span class="type">gchar</span> *name,
<span class="type">gchar</span> *description,
<span class="type">gpointer</span> user_data) : Run Last</pre>
<p>
The ::database-activated signal is emitted each time the user
activated a row in the database chooser widget, either by double
clicking on it or by a keyboard event.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>the database chooser that received the signal
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the name of the activated database
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td>
<td>the description of the activated database
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.10</p>
</div>
<hr>
<div class="refsect2" title='The "selection-changed" signal'>
<a name="GdictDatabaseChooser-selection-changed"></a><h3>The <code class="literal">"selection-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GdictDatabaseChooser.html" title="GdictDatabaseChooser"><span class="type">GdictDatabaseChooser</span></a> *chooser,
<span class="type">gpointer</span> user_data) : Run Last</pre>
<p>
The ::selection-changed signal is emitted each time the selection
inside the database chooser has been changed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>the database chooser that received the signal
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.12</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.15.1</div>
</body>
</html>
|