libgdict-1.0-dev 3.10.0-1ubuntu1 / usr / share / gtk-doc / html / gdict / GdictClientContext.html

This file is indexed.

/usr/share/gtk-doc/html/gdict/GdictClientContext.html is in libgdict-1.0-dev 3.10.0-1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdictClientContext</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GNOME Dictionary Library Reference Manual">
<link rel="up" href="context-types.html" title="Context Implementations">
<link rel="prev" href="context-types.html" title="Context Implementations">
<link rel="next" href="sources.html" title="Dictionary Source">
<meta name="generator" content="GTK-Doc V1.19 (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="context-types.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="context-types.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="sources.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GdictClientContext.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GdictClientContext.description" class="shortcut">Description</a>
                   | 
                  <a href="#GdictClientContext.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GdictClientContext.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#GdictClientContext.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#GdictClientContext.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GdictClientContext"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdictClientContext.top_of_page"></a>GdictClientContext</span></h2>
<p>GdictClientContext — DICT client transport</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GdictClientContext.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="GdictClientContext.html#GdictClientContext-struct" title="struct GdictClientContext">GdictClientContext</a>;
struct              <a class="link" href="GdictClientContext.html#GdictClientContextClass" title="struct GdictClientContextClass">GdictClientContextClass</a>;
enum                <a class="link" href="GdictClientContext.html#GdictClientContextError" title="enum GdictClientContextError">GdictClientContextError</a>;
<span class="returnvalue">GdictContext</span> *      <a class="link" href="GdictClientContext.html#gdict-client-context-new" title="gdict_client_context_new ()">gdict_client_context_new</a>            (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *hostname</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> port</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GdictClientContext.html#gdict-client-context-set-hostname" title="gdict_client_context_set_hostname ()">gdict_client_context_set_hostname</a>   (<em class="parameter"><code><a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> *context</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *hostname</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="GdictClientContext.html#gdict-client-context-get-hostname" title="gdict_client_context_get_hostname ()">gdict_client_context_get_hostname</a>   (<em class="parameter"><code><a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> *context</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GdictClientContext.html#gdict-client-context-set-port" title="gdict_client_context_set_port ()">gdict_client_context_set_port</a>       (<em class="parameter"><code><a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> *context</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> port</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="GdictClientContext.html#gdict-client-context-get-port" title="gdict_client_context_get_port ()">gdict_client_context_get_port</a>       (<em class="parameter"><code><a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> *context</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GdictClientContext.html#gdict-client-context-set-client" title="gdict_client_context_set_client ()">gdict_client_context_set_client</a>     (<em class="parameter"><code><a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> *context</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *client</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="GdictClientContext.html#gdict-client-context-get-client" title="gdict_client_context_get_client ()">gdict_client_context_get_client</a>     (<em class="parameter"><code><a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> *context</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GdictClientContext.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----GdictClientContext
</pre>
</div>
<div class="refsect1">
<a name="GdictClientContext.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GdictClientContext implements
</p>
</div>
<div class="refsect1">
<a name="GdictClientContext.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="GdictClientContext.html#GdictClientContext--client-name" title='The "client-name" property'>client-name</a>"              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  "<a class="link" href="GdictClientContext.html#GdictClientContext--hostname" title='The "hostname" property'>hostname</a>"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  "<a class="link" href="GdictClientContext.html#GdictClientContext--port" title='The "port" property'>port</a>"                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
  "<a class="link" href="GdictClientContext.html#GdictClientContext--status" title='The "status" property'>status</a>"                   <a class="link" href="gdict-Gdict-Utilities.html#GdictStatusCode" title="enum GdictStatusCode"><span class="type">GdictStatusCode</span></a>       : Read
</pre>
</div>
<div class="refsect1">
<a name="GdictClientContext.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="GdictClientContext.html#GdictClientContext-connected" title='The "connected" signal'>connected</a>"                                      : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
  "<a class="link" href="GdictClientContext.html#GdictClientContext-disconnected" title='The "disconnected" signal'>disconnected</a>"                                   : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="GdictClientContext.description"></a><h2>Description</h2>
<p>
<a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> is an implementation of the <span class="type">GdictContext</span> interface.
It implements the Dictionary Protocol as defined by the RFC 2229 in order
to connect to a dictionary server.
</p>
<p>
You should rarely instantiate this object directely: use an appropriate
<a class="link" href="GdictSource.html" title="GdictSource"><span class="type">GdictSource</span></a> instead.
</p>
</div>
<div class="refsect1">
<a name="GdictClientContext.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GdictClientContext-struct"></a><h3>struct GdictClientContext</h3>
<pre class="programlisting">struct GdictClientContext;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GdictClientContextClass"></a><h3>struct GdictClientContextClass</h3>
<pre class="programlisting">struct GdictClientContextClass {
  /* signals monitoring the lifetime of the connection with
   * the dictionary server
   */
  void (*connected)    (GdictClientContext *context);
  void (*disconnected) (GdictClientContext *context);
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GdictClientContextError"></a><h3>enum GdictClientContextError</h3>
<pre class="programlisting">typedef enum {
  GDICT_CLIENT_CONTEXT_ERROR_SOCKET,
  GDICT_CLIENT_CONTEXT_ERROR_LOOKUP,
  GDICT_CLIENT_CONTEXT_ERROR_NO_CONNECTION,
  GDICT_CLIENT_CONTEXT_ERROR_SERVER_DOWN
} GdictClientContextError;
</pre>
<p>
<a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> error enumeration
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GDICT-CLIENT-CONTEXT-ERROR-SOCKET:CAPS"></a><span class="term"><code class="literal">GDICT_CLIENT_CONTEXT_ERROR_SOCKET</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="GDICT-CLIENT-CONTEXT-ERROR-LOOKUP:CAPS"></a><span class="term"><code class="literal">GDICT_CLIENT_CONTEXT_ERROR_LOOKUP</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="GDICT-CLIENT-CONTEXT-ERROR-NO-CONNECTION:CAPS"></a><span class="term"><code class="literal">GDICT_CLIENT_CONTEXT_ERROR_NO_CONNECTION</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="GDICT-CLIENT-CONTEXT-ERROR-SERVER-DOWN:CAPS"></a><span class="term"><code class="literal">GDICT_CLIENT_CONTEXT_ERROR_SERVER_DOWN</code></span></p></td>
<td></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdict-client-context-new"></a><h3>gdict_client_context_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GdictContext</span> *      gdict_client_context_new            (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *hostname</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> port</code></em>);</pre>
<p>
Creates a new <a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> object for <em class="parameter"><code>hostname</code></em>. Use this
object to connect and query the dictionary server using the Dictionary
Protocol as defined by RFC 2229.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hostname</code></em> :</span></p></td>
<td>the hostname of a dictionary server, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the
default server</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>port</code></em> :</span></p></td>
<td>port to be used when connecting to the dictionary server,
or -1 for the default port</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="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> object.  You should
free it using <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdict-client-context-set-hostname"></a><h3>gdict_client_context_set_hostname ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gdict_client_context_set_hostname   (<em class="parameter"><code><a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> *context</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *hostname</code></em>);</pre>
<p>
Sets <em class="parameter"><code>hostname</code></em> as the hostname of the dictionary server to be used.
If <em class="parameter"><code>hostname</code></em> is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the default dictionary server will be used.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>a <a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>hostname</code></em> :</span></p></td>
<td>the hostname of a Dictionary server, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdict-client-context-get-hostname"></a><h3>gdict_client_context_get_hostname ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gdict_client_context_get_hostname   (<em class="parameter"><code><a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> *context</code></em>);</pre>
<p>
Gets the hostname of the dictionary server used by <em class="parameter"><code>context</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>a <a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the hostname of a dictionary server. The returned string is
owned by the <a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> object and should never be modified or
freed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdict-client-context-set-port"></a><h3>gdict_client_context_set_port ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gdict_client_context_set_port       (<em class="parameter"><code><a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> *context</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> port</code></em>);</pre>
<p>
Sets the port of the dictionary server to be used when connecting.
</p>
<p>
If <em class="parameter"><code>port</code></em> is -1, the default port will be used.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>a <a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>port</code></em> :</span></p></td>
<td>port of the dictionary server to be used, or -1</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdict-client-context-get-port"></a><h3>gdict_client_context_get_port ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gdict_client_context_get_port       (<em class="parameter"><code><a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> *context</code></em>);</pre>
<p>
Gets the port of the dictionary server used by <em class="parameter"><code>context</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>a <a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the number of the port.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdict-client-context-set-client"></a><h3>gdict_client_context_set_client ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gdict_client_context_set_client     (<em class="parameter"><code><a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> *context</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *client</code></em>);</pre>
<p>
Sets <em class="parameter"><code>client</code></em> as the client name to be used when advertising ourselves when
a connection the the dictionary server has been established.
If <em class="parameter"><code>client</code></em> is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the default client name will be used.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>a <a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
<td>the client name to use, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdict-client-context-get-client"></a><h3>gdict_client_context_get_client ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gdict_client_context_get_client     (<em class="parameter"><code><a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> *context</code></em>);</pre>
<p>
Gets the client name used by <em class="parameter"><code>context</code></em>. See <a class="link" href="GdictClientContext.html#gdict-client-context-set-client" title="gdict_client_context_set_client ()"><code class="function">gdict_client_context_set_client()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>a <a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the client name. The returned string is owned by the
<a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> object and should never be modified or freed.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GdictClientContext.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdictClientContext--client-name"></a><h3>The <code class="literal">"client-name"</code> property</h3>
<pre class="programlisting">  "client-name"              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
<p>
The name of the client using this context; it will be advertised when
connecting to the dictionary server.
</p>
<p>Default value: NULL</p>
<p class="since">Since 1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GdictClientContext--hostname"></a><h3>The <code class="literal">"hostname"</code> property</h3>
<pre class="programlisting">  "hostname"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
<p>
The hostname of the dictionary server to connect to.
</p>
<p>Default value: NULL</p>
<p class="since">Since 1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GdictClientContext--port"></a><h3>The <code class="literal">"port"</code> property</h3>
<pre class="programlisting">  "port"                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
<p>
The port of the dictionary server to connect to.
</p>
<p>Allowed values: &lt;= 65535</p>
<p>Default value: 2628</p>
<p class="since">Since 1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GdictClientContext--status"></a><h3>The <code class="literal">"status"</code> property</h3>
<pre class="programlisting">  "status"                   <a class="link" href="gdict-Gdict-Utilities.html#GdictStatusCode" title="enum GdictStatusCode"><span class="type">GdictStatusCode</span></a>       : Read</pre>
<p>
The status code as returned by the dictionary server.
</p>
<p>Default value: GDICT_STATUS_INVALID</p>
<p class="since">Since 1.0</p>
</div>
</div>
<div class="refsect1">
<a name="GdictClientContext.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GdictClientContext-connected"></a><h3>The <code class="literal">"connected"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> *client,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>            user_data)      : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Emitted when a <a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> has successfully established a
connection with a dictionary server.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
<td>the object which 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 1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GdictClientContext-disconnected"></a><h3>The <code class="literal">"disconnected"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> *client,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>            user_data)      : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Emitted when a <a class="link" href="GdictClientContext.html" title="GdictClientContext"><span class="type">GdictClientContext</span></a> has disconnected from a dictionary
server.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
<td>the object which 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 1.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.