← Back to branch summary

~ubuntu-branches/debian/wheezy/avant-window-navigator/wheezy

« back to all changes in this revision

Viewing changes to doc/reference/html/AwnApplet.html

  • Committer: Bazaar Package Importer
  • Author(s): Julien Lavergne
  • Date: 2008-05-24 14:42:01 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080524144201-r3v8e4g2hv2q1i9x
Tags: 0.2.6-6
http://bugs.debian.org/482030
* debian/patches/04-fix-colormap.patch
 - Fix crash in awn-manager if colormap == None. Thanks Emme for the 
   patch. (Closes: #482030) 

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/AwnApplet.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
5
<title>AwnApplet</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
 
7
<link rel="start" href="index.html" title="libawn Reference Manual">
 
8
<link rel="up" href="ch01.html" title="Table of Contents">
 
9
<link rel="prev" href="AwnTitle.html" title="AwnTitle">
 
10
<link rel="next" href="libawn-awn-vfs.html" title="awn-vfs">
 
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
<link rel="chapter" href="ch01.html" title="Table of Contents">
 
14
</head>
 
15
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
16
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
17
<tr valign="middle">
 
18
<td><a accesskey="p" href="AwnTitle.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
19
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
20
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
21
<th width="100%" align="center">libawn Reference Manual</th>
 
22
<td><a accesskey="n" href="libawn-awn-vfs.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
23
</tr>
 
24
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2577460" class="shortcut">Top</a>
 
25
                  &#160;|&#160;
 
26
                  <a href="#id2594686" class="shortcut">Description</a>
 
27
                  &#160;|&#160;
 
28
                  <a href="#id2583767" class="shortcut">Object Hierarchy</a>
 
29
                  &#160;|&#160;
 
30
                  <a href="#id2597500" class="shortcut">Implemented Interfaces</a>
 
31
                  &#160;|&#160;
 
32
                  <a href="#id2597528" class="shortcut">Properties</a>
 
33
                  &#160;|&#160;
 
34
                  <a href="#id2597583" class="shortcut">Signals</a></nobr></td></tr>
 
35
</table>
 
36
<div class="refentry" lang="en">
 
37
<a name="AwnApplet"></a><div class="titlepage"></div>
 
38
<div class="refnamediv"><table width="100%"><tr>
 
39
<td valign="top">
 
40
<h2>
 
41
<a name="id2577460"></a><span class="refentrytitle">AwnApplet</span>
 
42
</h2>
 
43
<p>AwnApplet</p>
 
44
</td>
 
45
<td valign="top" align="right"></td>
 
46
</tr></table></div>
 
47
<div class="refsynopsisdiv">
 
48
<h2>Synopsis</h2>
 
49
<pre class="synopsis">
 
50
 
 
51
 
 
52
 
 
53
                    <a href="AwnApplet.html#AwnAppletPrivate">AwnAppletPrivate</a>;
 
54
                    <a href="AwnApplet.html#AwnApplet-struct">AwnApplet</a>;
 
55
gboolean            (<a href="AwnApplet.html#AwnAppletInitFunc">*AwnAppletInitFunc</a>)                (<a href="AwnApplet.html" title="AwnApplet">AwnApplet</a> *applet);
 
56
<a href="AwnApplet.html" title="AwnApplet">AwnApplet</a>*          (<a href="AwnApplet.html#AwnAppletInitPFunc">*AwnAppletInitPFunc</a>)               (const gchar *uid,
 
57
                                                         gint orient,
 
58
                                                         gint height);
 
59
<a href="AwnApplet.html" title="AwnApplet">AwnApplet</a>*          <a href="AwnApplet.html#awn-applet-new">awn_applet_new</a>                      (const gchar *uid,
 
60
                                                         gint orient,
 
61
                                                         gint height);
 
62
<a href="libawn-awn-defines.html#AwnOrientation">AwnOrientation</a>      <a href="AwnApplet.html#awn-applet-get-orientation">awn_applet_get_orientation</a>          (<a href="AwnApplet.html" title="AwnApplet">AwnApplet</a> *applet);
 
63
guint               <a href="AwnApplet.html#awn-applet-get-height">awn_applet_get_height</a>               (<a href="AwnApplet.html" title="AwnApplet">AwnApplet</a> *applet);
 
64
GtkWidget*          <a href="AwnApplet.html#awn-applet-create-default-menu">awn_applet_create_default_menu</a>      (<a href="AwnApplet.html" title="AwnApplet">AwnApplet</a> *applet);
 
65
 
 
66
</pre>
 
67
</div>
 
68
<div class="refsect1" lang="en">
 
69
<a name="id2583767"></a><h2>Object Hierarchy</h2>
 
70
<pre class="synopsis">
 
71
 
 
72
  GObject
 
73
   +----GInitiallyUnowned
 
74
         +----GtkObject
 
75
               +----GtkWidget
 
76
                     +----GtkContainer
 
77
                           +----GtkBin
 
78
                                 +----GtkEventBox
 
79
                                       +----AwnApplet
 
80
                                             +----<a href="AwnAppletSimple.html" title="AwnAppletSimple">AwnAppletSimple</a>
 
81
</pre>
 
82
</div>
 
83
<div class="refsect1" lang="en">
 
84
<a name="id2597500"></a><h2>Implemented Interfaces</h2>
 
85
<p>
 
86
AwnApplet implements
 
87
 AtkImplementorIface and  GtkBuildable.</p>
 
88
</div>
 
89
<div class="refsect1" lang="en">
 
90
<a name="id2597528"></a><h2>Properties</h2>
 
91
<pre class="synopsis">
 
92
 
 
93
  "<a href="AwnApplet.html#AwnApplet--height">height</a>"                   gint                  : Read / Write / Construct
 
94
  "<a href="AwnApplet.html#AwnApplet--orient">orient</a>"                   gint                  : Read / Write / Construct
 
95
  "<a href="AwnApplet.html#AwnApplet--uid">uid</a>"                      gchararray            : Read / Write / Construct
 
96
</pre>
 
97
</div>
 
98
<div class="refsect1" lang="en">
 
99
<a name="id2597583"></a><h2>Signals</h2>
 
100
<pre class="synopsis">
 
101
 
 
102
  "<a href="AwnApplet.html#AwnApplet-applet-deleted">applet-deleted</a>"                                 : Run First
 
103
  "<a href="AwnApplet.html#AwnApplet-height-changed">height-changed</a>"                                 : Run First
 
104
  "<a href="AwnApplet.html#AwnApplet-orientation-changed">orientation-changed</a>"                            : Run First
 
105
</pre>
 
106
</div>
 
107
<div class="refsect1" lang="en">
 
108
<a name="id2594686"></a><h2>Description</h2>
 
109
<p>
 
110
 
 
111
</p>
 
112
</div>
 
113
<div class="refsect1" lang="en">
 
114
<a name="id2594702"></a><h2>Details</h2>
 
115
<div class="refsect2" lang="en">
 
116
<a name="id2594712"></a><h3>
 
117
<a name="AwnAppletPrivate"></a>AwnAppletPrivate</h3>
 
118
<a class="indexterm" name="id2594725"></a><pre class="programlisting">typedef struct _AwnAppletPrivate AwnAppletPrivate;</pre>
 
119
<p>
 
120
 
 
121
</p>
 
122
</div>
 
123
<hr>
 
124
<div class="refsect2" lang="en">
 
125
<a name="id2594741"></a><h3>
 
126
<a name="AwnApplet-struct"></a>AwnApplet</h3>
 
127
<a class="indexterm" name="id2594754"></a><pre class="programlisting">typedef struct _AwnApplet AwnApplet;</pre>
 
128
<p>
 
129
 
 
130
</p>
 
131
</div>
 
132
<hr>
 
133
<div class="refsect2" lang="en">
 
134
<a name="id2594769"></a><h3>
 
135
<a name="AwnAppletInitFunc"></a>AwnAppletInitFunc ()</h3>
 
136
<a class="indexterm" name="id2594781"></a><pre class="programlisting">gboolean            (*AwnAppletInitFunc)                (<a href="AwnApplet.html" title="AwnApplet">AwnApplet</a> *applet);</pre>
 
137
<p>
 
138
 
 
139
</p>
 
140
<div class="variablelist"><table border="0">
 
141
<col align="left" valign="top">
 
142
<tbody>
 
143
<tr>
 
144
<td><span class="term"><em class="parameter"><code>applet</code></em>&#160;:</span></td>
 
145
<td>
 
146
</td>
 
147
</tr>
 
148
<tr>
 
149
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
150
<td>
 
151
 
 
152
 
 
153
</td>
 
154
</tr>
 
155
</tbody>
 
156
</table></div>
 
157
</div>
 
158
<hr>
 
159
<div class="refsect2" lang="en">
 
160
<a name="id2594838"></a><h3>
 
161
<a name="AwnAppletInitPFunc"></a>AwnAppletInitPFunc ()</h3>
 
162
<a class="indexterm" name="id2594850"></a><pre class="programlisting"><a href="AwnApplet.html" title="AwnApplet">AwnApplet</a>*          (*AwnAppletInitPFunc)               (const gchar *uid,
 
163
                                                         gint orient,
 
164
                                                         gint height);</pre>
 
165
<p>
 
166
 
 
167
</p>
 
168
<div class="variablelist"><table border="0">
 
169
<col align="left" valign="top">
 
170
<tbody>
 
171
<tr>
 
172
<td><span class="term"><em class="parameter"><code>uid</code></em>&#160;:</span></td>
 
173
<td>
 
174
</td>
 
175
</tr>
 
176
<tr>
 
177
<td><span class="term"><em class="parameter"><code>orient</code></em>&#160;:</span></td>
 
178
<td>
 
179
</td>
 
180
</tr>
 
181
<tr>
 
182
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
 
183
<td>
 
184
</td>
 
185
</tr>
 
186
<tr>
 
187
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
188
<td>
 
189
 
 
190
 
 
191
</td>
 
192
</tr>
 
193
</tbody>
 
194
</table></div>
 
195
</div>
 
196
<hr>
 
197
<div class="refsect2" lang="en">
 
198
<a name="id2586991"></a><h3>
 
199
<a name="awn-applet-new"></a>awn_applet_new ()</h3>
 
200
<a class="indexterm" name="id2587003"></a><pre class="programlisting"><a href="AwnApplet.html" title="AwnApplet">AwnApplet</a>*          awn_applet_new                      (const gchar *uid,
 
201
                                                         gint orient,
 
202
                                                         gint height);</pre>
 
203
<p>
 
204
 
 
205
</p>
 
206
<div class="variablelist"><table border="0">
 
207
<col align="left" valign="top">
 
208
<tbody>
 
209
<tr>
 
210
<td><span class="term"><em class="parameter"><code>uid</code></em>&#160;:</span></td>
 
211
<td>
 
212
</td>
 
213
</tr>
 
214
<tr>
 
215
<td><span class="term"><em class="parameter"><code>orient</code></em>&#160;:</span></td>
 
216
<td>
 
217
</td>
 
218
</tr>
 
219
<tr>
 
220
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
 
221
<td>
 
222
</td>
 
223
</tr>
 
224
<tr>
 
225
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
226
<td>
 
227
 
 
228
 
 
229
</td>
 
230
</tr>
 
231
</tbody>
 
232
</table></div>
 
233
</div>
 
234
<hr>
 
235
<div class="refsect2" lang="en">
 
236
<a name="id2587102"></a><h3>
 
237
<a name="awn-applet-get-orientation"></a>awn_applet_get_orientation ()</h3>
 
238
<a class="indexterm" name="id2587114"></a><pre class="programlisting"><a href="libawn-awn-defines.html#AwnOrientation">AwnOrientation</a>      awn_applet_get_orientation          (<a href="AwnApplet.html" title="AwnApplet">AwnApplet</a> *applet);</pre>
 
239
<p>
 
240
 
 
241
</p>
 
242
<div class="variablelist"><table border="0">
 
243
<col align="left" valign="top">
 
244
<tbody>
 
245
<tr>
 
246
<td><span class="term"><em class="parameter"><code>applet</code></em>&#160;:</span></td>
 
247
<td>
 
248
</td>
 
249
</tr>
 
250
<tr>
 
251
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
252
<td>
 
253
 
 
254
 
 
255
</td>
 
256
</tr>
 
257
</tbody>
 
258
</table></div>
 
259
</div>
 
260
<hr>
 
261
<div class="refsect2" lang="en">
 
262
<a name="id2587170"></a><h3>
 
263
<a name="awn-applet-get-height"></a>awn_applet_get_height ()</h3>
 
264
<a class="indexterm" name="id2587181"></a><pre class="programlisting">guint               awn_applet_get_height               (<a href="AwnApplet.html" title="AwnApplet">AwnApplet</a> *applet);</pre>
 
265
<p>
 
266
 
 
267
</p>
 
268
<div class="variablelist"><table border="0">
 
269
<col align="left" valign="top">
 
270
<tbody>
 
271
<tr>
 
272
<td><span class="term"><em class="parameter"><code>applet</code></em>&#160;:</span></td>
 
273
<td>
 
274
</td>
 
275
</tr>
 
276
<tr>
 
277
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
278
<td>
 
279
 
 
280
 
 
281
</td>
 
282
</tr>
 
283
</tbody>
 
284
</table></div>
 
285
</div>
 
286
<hr>
 
287
<div class="refsect2" lang="en">
 
288
<a name="id2587238"></a><h3>
 
289
<a name="awn-applet-create-default-menu"></a>awn_applet_create_default_menu ()</h3>
 
290
<a class="indexterm" name="id2587249"></a><pre class="programlisting">GtkWidget*          awn_applet_create_default_menu      (<a href="AwnApplet.html" title="AwnApplet">AwnApplet</a> *applet);</pre>
 
291
<p>
 
292
 
 
293
</p>
 
294
<div class="variablelist"><table border="0">
 
295
<col align="left" valign="top">
 
296
<tbody>
 
297
<tr>
 
298
<td><span class="term"><em class="parameter"><code>applet</code></em>&#160;:</span></td>
 
299
<td>
 
300
</td>
 
301
</tr>
 
302
<tr>
 
303
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
304
<td>
 
305
 
 
306
 
 
307
</td>
 
308
</tr>
 
309
</tbody>
 
310
</table></div>
 
311
</div>
 
312
</div>
 
313
<div class="refsect1" lang="en">
 
314
<a name="id2600464"></a><h2>Property Details</h2>
 
315
<div class="refsect2" lang="en">
 
316
<a name="id2600473"></a><h3>
 
317
<a name="AwnApplet--height"></a>The "<code class="literal">height</code>" property</h3>
 
318
<a class="indexterm" name="id2600486"></a><pre class="programlisting">  "height"                   gint                  : Read / Write / Construct</pre>
 
319
<p>The current visible height of the bar.</p>
 
320
<p>Allowed values: [12,100]</p>
 
321
<p>Default value: 48</p>
 
322
</div>
 
323
<hr>
 
324
<div class="refsect2" lang="en">
 
325
<a name="id2600513"></a><h3>
 
326
<a name="AwnApplet--orient"></a>The "<code class="literal">orient</code>" property</h3>
 
327
<a class="indexterm" name="id2600528"></a><pre class="programlisting">  "orient"                   gint                  : Read / Write / Construct</pre>
 
328
<p>The current bar orientation.</p>
 
329
<p>Allowed values: [0,10]</p>
 
330
<p>Default value: 0</p>
 
331
</div>
 
332
<hr>
 
333
<div class="refsect2" lang="en">
 
334
<a name="id2600558"></a><h3>
 
335
<a name="AwnApplet--uid"></a>The "<code class="literal">uid</code>" property</h3>
 
336
<a class="indexterm" name="id2600573"></a><pre class="programlisting">  "uid"                      gchararray            : Read / Write / Construct</pre>
 
337
<p>Awn's Unique ID for this applet instance (used for gconf).</p>
 
338
<p>Default value: NULL</p>
 
339
</div>
 
340
</div>
 
341
<div class="refsect1" lang="en">
 
342
<a name="id2600601"></a><h2>Signal Details</h2>
 
343
<div class="refsect2" lang="en">
 
344
<a name="id2600612"></a><h3>
 
345
<a name="AwnApplet-applet-deleted"></a>The "applet-deleted" signal</h3>
 
346
<a class="indexterm" name="id2600620"></a><pre class="programlisting">void                user_function                      (<a href="AwnApplet.html" title="AwnApplet">AwnApplet</a> *awnapplet,
 
347
                                                        gchar     *arg1,
 
348
                                                        gpointer   user_data)      : Run First</pre>
 
349
<p>
 
350
 
 
351
</p>
 
352
<div class="variablelist"><table border="0">
 
353
<col align="left" valign="top">
 
354
<tbody>
 
355
<tr>
 
356
<td><span class="term"><em class="parameter"><code>awnapplet</code></em>&#160;:</span></td>
 
357
<td>the object which received the signal.
 
358
</td>
 
359
</tr>
 
360
<tr>
 
361
<td><span class="term"><em class="parameter"><code>arg1</code></em>&#160;:</span></td>
 
362
<td>
 
363
 
 
364
</td>
 
365
</tr>
 
366
<tr>
 
367
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
 
368
<td>user data set when the signal handler was connected.</td>
 
369
</tr>
 
370
</tbody>
 
371
</table></div>
 
372
</div>
 
373
<hr>
 
374
<div class="refsect2" lang="en">
 
375
<a name="id2600709"></a><h3>
 
376
<a name="AwnApplet-height-changed"></a>The "height-changed" signal</h3>
 
377
<a class="indexterm" name="id2600716"></a><pre class="programlisting">void                user_function                      (<a href="AwnApplet.html" title="AwnApplet">AwnApplet</a> *awnapplet,
 
378
                                                        gint       arg1,
 
379
                                                        gpointer   user_data)      : Run First</pre>
 
380
<p>
 
381
 
 
382
</p>
 
383
<div class="variablelist"><table border="0">
 
384
<col align="left" valign="top">
 
385
<tbody>
 
386
<tr>
 
387
<td><span class="term"><em class="parameter"><code>awnapplet</code></em>&#160;:</span></td>
 
388
<td>the object which received the signal.
 
389
</td>
 
390
</tr>
 
391
<tr>
 
392
<td><span class="term"><em class="parameter"><code>arg1</code></em>&#160;:</span></td>
 
393
<td>
 
394
 
 
395
</td>
 
396
</tr>
 
397
<tr>
 
398
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
 
399
<td>user data set when the signal handler was connected.</td>
 
400
</tr>
 
401
</tbody>
 
402
</table></div>
 
403
</div>
 
404
<hr>
 
405
<div class="refsect2" lang="en">
 
406
<a name="id2600805"></a><h3>
 
407
<a name="AwnApplet-orientation-changed"></a>The "orientation-changed" signal</h3>
 
408
<a class="indexterm" name="id2600815"></a><pre class="programlisting">void                user_function                      (<a href="AwnApplet.html" title="AwnApplet">AwnApplet</a> *awnapplet,
 
409
                                                        gint       arg1,
 
410
                                                        gpointer   user_data)      : Run First</pre>
 
411
<p>
 
412
 
 
413
</p>
 
414
<div class="variablelist"><table border="0">
 
415
<col align="left" valign="top">
 
416
<tbody>
 
417
<tr>
 
418
<td><span class="term"><em class="parameter"><code>awnapplet</code></em>&#160;:</span></td>
 
419
<td>the object which received the signal.
 
420
</td>
 
421
</tr>
 
422
<tr>
 
423
<td><span class="term"><em class="parameter"><code>arg1</code></em>&#160;:</span></td>
 
424
<td>
 
425
 
 
426
</td>
 
427
</tr>
 
428
<tr>
 
429
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
 
430
<td>user data set when the signal handler was connected.</td>
 
431
</tr>
 
432
</tbody>
 
433
</table></div>
 
434
</div>
 
435
</div>
 
436
</div>
 
437
</body>
 
438
</html>