1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>PanelApplet</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
<link rel="home" href="index.html" title="Panel Applet Library Reference Manual">
8
<link rel="up" href="panel-applet.html" title="The Panel Applet Library">
9
<link rel="prev" href="panel-applet.html" title="The Panel Applet Library">
10
<link rel="next" href="panel-applet-Panel-Applet-GConf-Utilities.html" title="Panel Applet GConf Utilities">
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="chapter" href="applet-writing.html" title="Writing Applets">
14
<link rel="chapter" href="applet-porting.html" title="Porting Applets from the GNOME 1.x interfaces">
15
<link rel="chapter" href="panel-applet.html" title="The Panel Applet Library">
17
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
18
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
20
<td><a accesskey="p" href="panel-applet.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
21
<td><a accesskey="u" href="panel-applet.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
22
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
23
<th width="100%" align="center">Panel Applet Library Reference Manual</th>
24
<td><a accesskey="n" href="panel-applet-Panel-Applet-GConf-Utilities.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
26
<tr><td colspan="5" class="shortcuts">
27
<a href="#PanelApplet.synopsis" class="shortcut">Top</a>
29
<a href="#PanelApplet.description" class="shortcut">Description</a>
31
<a href="#PanelApplet.object-hierarchy" class="shortcut">Object Hierarchy</a>
33
<a href="#PanelApplet.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
35
<a href="#PanelApplet.signals" class="shortcut">Signals</a>
38
<div class="refentry" title="PanelApplet">
39
<a name="PanelApplet"></a><div class="titlepage"></div>
40
<div class="refnamediv"><table width="100%"><tr>
42
<h2><span class="refentrytitle"><a name="PanelApplet.top_of_page"></a>PanelApplet</span></h2>
43
<p>PanelApplet — The PanelApplet object.</p>
45
<td valign="top" align="right"></td>
47
<div class="refsynopsisdiv" title="Synopsis">
48
<a name="PanelApplet.synopsis"></a><h2>Synopsis</h2>
49
<pre class="synopsis">
50
#include <panel-applet.h>
52
<a class="link" href="PanelApplet.html#PanelApplet-struct" title="PanelApplet">PanelApplet</a>;
53
typedef <a class="link" href="PanelApplet.html#PanelAppletOrient" title="PanelAppletOrient">PanelAppletOrient</a>;
54
#define <a class="link" href="PanelApplet.html#PANEL-APPLET-ORIENT-UP:CAPS" title="PANEL_APPLET_ORIENT_UP">PANEL_APPLET_ORIENT_UP</a>
55
#define <a class="link" href="PanelApplet.html#PANEL-APPLET-ORIENT-DOWN:CAPS" title="PANEL_APPLET_ORIENT_DOWN">PANEL_APPLET_ORIENT_DOWN</a>
56
#define <a class="link" href="PanelApplet.html#PANEL-APPLET-ORIENT-LEFT:CAPS" title="PANEL_APPLET_ORIENT_LEFT">PANEL_APPLET_ORIENT_LEFT</a>
57
#define <a class="link" href="PanelApplet.html#PANEL-APPLET-ORIENT-RIGHT:CAPS" title="PANEL_APPLET_ORIENT_RIGHT">PANEL_APPLET_ORIENT_RIGHT</a>
58
enum <a class="link" href="PanelApplet.html#PanelAppletBackgroundType" title="enum PanelAppletBackgroundType">PanelAppletBackgroundType</a>;
59
enum <a class="link" href="PanelApplet.html#PanelAppletFlags" title="enum PanelAppletFlags">PanelAppletFlags</a>;
60
<span class="returnvalue">gboolean</span> (<a class="link" href="PanelApplet.html#PanelAppletFactoryCallback" title="PanelAppletFactoryCallback ()">*PanelAppletFactoryCallback</a>) (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,
61
const <span class="returnvalue">gchar</span> *iid,
62
<span class="returnvalue">gpointer</span> user_data);
63
<span class="returnvalue">GtkWidget</span> * <a class="link" href="PanelApplet.html#panel-applet-new" title="panel_applet_new ()">panel_applet_new</a> (void);
64
<a class="link" href="PanelApplet.html#PanelAppletOrient" title="PanelAppletOrient"><span class="returnvalue">PanelAppletOrient</span></a> <a class="link" href="PanelApplet.html#panel-applet-get-orient" title="panel_applet_get_orient ()">panel_applet_get_orient</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);
65
<span class="returnvalue">guint</span> <a class="link" href="PanelApplet.html#panel-applet-get-size" title="panel_applet_get_size ()">panel_applet_get_size</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);
66
<a class="link" href="PanelApplet.html#PanelAppletBackgroundType" title="enum PanelAppletBackgroundType"><span class="returnvalue">PanelAppletBackgroundType</span></a> <a class="link" href="PanelApplet.html#panel-applet-get-background" title="panel_applet_get_background ()">panel_applet_get_background</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,
67
<span class="returnvalue">GdkColor</span> *color,
68
<span class="returnvalue">GdkPixmap</span> **pixmap);
69
<span class="returnvalue">gchar</span> * <a class="link" href="PanelApplet.html#panel-applet-get-preferences-key" title="panel_applet_get_preferences_key ()">panel_applet_get_preferences_key</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);
70
<span class="returnvalue">void</span> <a class="link" href="PanelApplet.html#panel-applet-add-preferences" title="panel_applet_add_preferences ()">panel_applet_add_preferences</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,
71
const <span class="returnvalue">gchar</span> *schema_dir,
72
<span class="returnvalue">GError</span> **opt_error);
73
<a class="link" href="PanelApplet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="returnvalue">PanelAppletFlags</span></a> <a class="link" href="PanelApplet.html#panel-applet-get-flags" title="panel_applet_get_flags ()">panel_applet_get_flags</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);
74
<span class="returnvalue">void</span> <a class="link" href="PanelApplet.html#panel-applet-set-flags" title="panel_applet_set_flags ()">panel_applet_set_flags</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,
75
<a class="link" href="PanelApplet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="returnvalue">PanelAppletFlags</span></a> flags);
76
<span class="returnvalue">void</span> <a class="link" href="PanelApplet.html#panel-applet-set-size-hints" title="panel_applet_set_size_hints ()">panel_applet_set_size_hints</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,
77
const <span class="returnvalue">int</span> *size_hints,
78
<span class="returnvalue">int</span> n_elements,
79
<span class="returnvalue">int</span> base_size);
80
<span class="returnvalue">gboolean</span> <a class="link" href="PanelApplet.html#panel-applet-get-locked-down" title="panel_applet_get_locked_down ()">panel_applet_get_locked_down</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);
81
<span class="returnvalue">void</span> <a class="link" href="PanelApplet.html#panel-applet-request-focus" title="panel_applet_request_focus ()">panel_applet_request_focus</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,
82
<span class="returnvalue">guint32</span> timestamp);
83
<span class="returnvalue">BonoboControl</span> * <a class="link" href="PanelApplet.html#panel-applet-get-control" title="panel_applet_get_control ()">panel_applet_get_control</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);
84
<span class="returnvalue">BonoboUIComponent</span> * <a class="link" href="PanelApplet.html#panel-applet-get-popup-component" title="panel_applet_get_popup_component ()">panel_applet_get_popup_component</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);
85
<span class="returnvalue">void</span> <a class="link" href="PanelApplet.html#panel-applet-setup-menu" title="panel_applet_setup_menu ()">panel_applet_setup_menu</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,
86
const <span class="returnvalue">gchar</span> *xml,
87
const <span class="returnvalue">BonoboUIVerb</span> *verb_list,
88
<span class="returnvalue">gpointer</span> user_data);
89
<span class="returnvalue">void</span> <a class="link" href="PanelApplet.html#panel-applet-setup-menu-from-file" title="panel_applet_setup_menu_from_file ()">panel_applet_setup_menu_from_file</a> (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,
90
const <span class="returnvalue">gchar</span> *opt_datadir,
91
const <span class="returnvalue">gchar</span> *file,
92
const <span class="returnvalue">gchar</span> *opt_app_name,
93
const <span class="returnvalue">BonoboUIVerb</span> *verb_list,
94
<span class="returnvalue">gpointer</span> user_data);
95
<span class="returnvalue">int</span> <a class="link" href="PanelApplet.html#panel-applet-factory-main" title="panel_applet_factory_main ()">panel_applet_factory_main</a> (const <span class="returnvalue">gchar</span> *iid,
96
<span class="returnvalue">GType</span> applet_type,
97
<a class="link" href="PanelApplet.html#PanelAppletFactoryCallback" title="PanelAppletFactoryCallback ()"><span class="returnvalue">PanelAppletFactoryCallback</span></a> callback,
98
<span class="returnvalue">gpointer</span> data);
99
<span class="returnvalue">int</span> <a class="link" href="PanelApplet.html#panel-applet-factory-main-closure" title="panel_applet_factory_main_closure ()">panel_applet_factory_main_closure</a> (const <span class="returnvalue">gchar</span> *iid,
100
<span class="returnvalue">GType</span> applet_type,
101
<span class="returnvalue">GClosure</span> *closure);
102
#define <a class="link" href="PanelApplet.html#PANEL-APPLET-BONOBO-FACTORY:CAPS" title="PANEL_APPLET_BONOBO_FACTORY()">PANEL_APPLET_BONOBO_FACTORY</a> (iid, type, name, version, callback, data)
103
<span class="returnvalue">Bonobo_Unknown</span> <a class="link" href="PanelApplet.html#panel-applet-shlib-factory" title="panel_applet_shlib_factory ()">panel_applet_shlib_factory</a> (const <span class="returnvalue">char</span> *iid,
104
<span class="returnvalue">GType</span> applet_type,
105
<span class="returnvalue">PortableServer_POA</span> poa,
106
<span class="returnvalue">gpointer</span> impl_ptr,
107
<a class="link" href="PanelApplet.html#PanelAppletFactoryCallback" title="PanelAppletFactoryCallback ()"><span class="returnvalue">PanelAppletFactoryCallback</span></a> callback,
108
<span class="returnvalue">gpointer</span> user_data,
109
<span class="returnvalue">CORBA_Environment</span> *ev);
110
<span class="returnvalue">Bonobo_Unknown</span> <a class="link" href="PanelApplet.html#panel-applet-shlib-factory-closure" title="panel_applet_shlib_factory_closure ()">panel_applet_shlib_factory_closure</a> (const <span class="returnvalue">char</span> *iid,
111
<span class="returnvalue">GType</span> applet_type,
112
<span class="returnvalue">PortableServer_POA</span> poa,
113
<span class="returnvalue">gpointer</span> impl_ptr,
114
<span class="returnvalue">GClosure</span> *closure,
115
<span class="returnvalue">CORBA_Environment</span> *ev);
116
#define <a class="link" href="PanelApplet.html#PANEL-APPLET-BONOBO-SHLIB-FACTORY:CAPS" title="PANEL_APPLET_BONOBO_SHLIB_FACTORY()">PANEL_APPLET_BONOBO_SHLIB_FACTORY</a> (iid, type, descr, callback, data)
119
<div class="refsect1" title="Object Hierarchy">
120
<a name="PanelApplet.object-hierarchy"></a><h2>Object Hierarchy</h2>
121
<pre class="synopsis">
123
+----GInitiallyUnowned
132
<div class="refsect1" title="Implemented Interfaces">
133
<a name="PanelApplet.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
135
PanelApplet implements
136
AtkImplementorIface and GtkBuildable.</p>
138
<div class="refsect1" title="Signals">
139
<a name="PanelApplet.signals"></a><h2>Signals</h2>
140
<pre class="synopsis">
141
"<a class="link" href="PanelApplet.html#PanelApplet-change-background" title='The "change-background" signal'>change-background</a>" : Run Last
142
"<a class="link" href="PanelApplet.html#PanelApplet-change-orient" title='The "change-orient" signal'>change-orient</a>" : Run Last
143
"<a class="link" href="PanelApplet.html#PanelApplet-change-size" title='The "change-size" signal'>change-size</a>" : Run Last
144
"<a class="link" href="PanelApplet.html#PanelApplet-move-focus-out-of-applet" title='The "move-focus-out-of-applet" signal'>move-focus-out-of-applet</a>" : Run Last / Action
147
<div class="refsect1" title="Description">
148
<a name="PanelApplet.description"></a><h2>Description</h2>
150
The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a> object is an object which encapsulates an applet. It
151
is a <span class="type">GtkContainer</span> which may contain a single widget. This widget, in
152
turn, should contain all widgets exposed by the applet.
155
A <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a> is associated with a <span class="type">BonoboControl</span>. The control makes
156
the cross process UI emmbedding required by applets possible.
159
<div class="refsect1" title="Details">
160
<a name="PanelApplet.details"></a><h2>Details</h2>
161
<div class="refsect2" title="PanelApplet">
162
<a name="PanelApplet-struct"></a><h3>PanelApplet</h3>
163
<pre class="programlisting">typedef struct _PanelApplet PanelApplet;</pre>
165
The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a> struct contains private data only.
169
<div class="refsect2" title="PanelAppletOrient">
170
<a name="PanelAppletOrient"></a><h3>PanelAppletOrient</h3>
171
<pre class="programlisting">typedef GNOME_Vertigo_PanelOrient PanelAppletOrient;
174
The <a class="link" href="PanelApplet.html#PanelAppletOrient" title="PanelAppletOrient"><span class="type">PanelAppletOrient</span></a> type specifies the orientation of the applet. The
175
values may seem backward (e.g. <a class="link" href="PanelApplet.html#PANEL-APPLET-ORIENT-LEFT:CAPS" title="PANEL_APPLET_ORIENT_LEFT"><code class="literal">PANEL_APPLET_ORIENT_LEFT</code></a> means the panel
176
is on the right hand side), but this is because the value is representative
177
of the applet's <span class="emphasis"><em>orientation</em></span>, not the panel's position.
181
<div class="refsect2" title="PANEL_APPLET_ORIENT_UP">
182
<a name="PANEL-APPLET-ORIENT-UP:CAPS"></a><h3>PANEL_APPLET_ORIENT_UP</h3>
183
<pre class="programlisting">#define PANEL_APPLET_ORIENT_UP GNOME_Vertigo_PANEL_ORIENT_UP
186
The applet is orientated up (i.e. the panel is at the bottom of the screen).
190
<div class="refsect2" title="PANEL_APPLET_ORIENT_DOWN">
191
<a name="PANEL-APPLET-ORIENT-DOWN:CAPS"></a><h3>PANEL_APPLET_ORIENT_DOWN</h3>
192
<pre class="programlisting">#define PANEL_APPLET_ORIENT_DOWN GNOME_Vertigo_PANEL_ORIENT_DOWN
195
The applet is orientated down (i.e. the panel is at the top of the screen).
199
<div class="refsect2" title="PANEL_APPLET_ORIENT_LEFT">
200
<a name="PANEL-APPLET-ORIENT-LEFT:CAPS"></a><h3>PANEL_APPLET_ORIENT_LEFT</h3>
201
<pre class="programlisting">#define PANEL_APPLET_ORIENT_LEFT GNOME_Vertigo_PANEL_ORIENT_LEFT
204
The applet is orientated left (i.e. the panel is at the right hand side of the screen).
208
<div class="refsect2" title="PANEL_APPLET_ORIENT_RIGHT">
209
<a name="PANEL-APPLET-ORIENT-RIGHT:CAPS"></a><h3>PANEL_APPLET_ORIENT_RIGHT</h3>
210
<pre class="programlisting">#define PANEL_APPLET_ORIENT_RIGHT GNOME_Vertigo_PANEL_ORIENT_RIGHT
213
The applet is orientated right (i.e. the panel is at the left hand side of the screen).
217
<div class="refsect2" title="enum PanelAppletBackgroundType">
218
<a name="PanelAppletBackgroundType"></a><h3>enum PanelAppletBackgroundType</h3>
219
<pre class="programlisting">typedef enum {
221
PANEL_COLOR_BACKGROUND,
222
PANEL_PIXMAP_BACKGROUND
223
} PanelAppletBackgroundType;
226
The <a class="link" href="PanelApplet.html#PanelAppletBackgroundType" title="enum PanelAppletBackgroundType"><span class="type">PanelAppletBackgroundType</span></a> enumerated type specifies the type of
227
background of a panel.
229
<div class="variablelist"><table border="0">
230
<col align="left" valign="top">
233
<td><p><a name="PANEL-NO-BACKGROUND:CAPS"></a><span class="term"><code class="literal">PANEL_NO_BACKGROUND</code></span></p></td>
234
<td>The panel has no background, the default is used.
238
<td><p><a name="PANEL-COLOR-BACKGROUND:CAPS"></a><span class="term"><code class="literal">PANEL_COLOR_BACKGROUND</code></span></p></td>
239
<td>The panel has a color, i.e rgb value,
244
<td><p><a name="PANEL-PIXMAP-BACKGROUND:CAPS"></a><span class="term"><code class="literal">PANEL_PIXMAP_BACKGROUND</code></span></p></td>
245
<td> The panel has either an image background
253
<div class="refsect2" title="enum PanelAppletFlags">
254
<a name="PanelAppletFlags"></a><h3>enum PanelAppletFlags</h3>
255
<pre class="programlisting">typedef enum {
256
PANEL_APPLET_FLAGS_NONE = 0,
257
PANEL_APPLET_EXPAND_MAJOR = 1 << 0,
258
PANEL_APPLET_EXPAND_MINOR = 1 << 1,
259
PANEL_APPLET_HAS_HANDLE = 1 << 2
263
The <a class="link" href="PanelApplet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a> associated with the applet are boolean flags which
264
the panel may read in order to figure out how to handle the applet.
266
<div class="variablelist"><table border="0">
267
<col align="left" valign="top">
270
<td><p><a name="PANEL-APPLET-FLAGS-NONE:CAPS"></a><span class="term"><code class="literal">PANEL_APPLET_FLAGS_NONE</code></span></p></td>
271
<td>No flags are to be associated with the applet.
275
<td><p><a name="PANEL-APPLET-EXPAND-MAJOR:CAPS"></a><span class="term"><code class="literal">PANEL_APPLET_EXPAND_MAJOR</code></span></p></td>
276
<td>The applet should expand horizontally on an
277
horizontal panel and vertically on a vertical panel - e.g. the behaviour
278
of the Window List applet.
282
<td><p><a name="PANEL-APPLET-EXPAND-MINOR:CAPS"></a><span class="term"><code class="literal">PANEL_APPLET_EXPAND_MINOR</code></span></p></td>
283
<td>The applet should expand vertically on an
284
horizontal panel and horizontally on a vertical panel. Most applets should
285
set this flag in order to utilise the full panel width and allow the applet
286
to be Fitt's Law compliant.
290
<td><p><a name="PANEL-APPLET-HAS-HANDLE:CAPS"></a><span class="term"><code class="literal">PANEL_APPLET_HAS_HANDLE</code></span></p></td>
291
<td>The panel should draw a grab handle around the
292
applet - e.g. the Window List and Notification Area applets both set this
300
<div class="refsect2" title="PanelAppletFactoryCallback ()">
301
<a name="PanelAppletFactoryCallback"></a><h3>PanelAppletFactoryCallback ()</h3>
302
<pre class="programlisting"><span class="returnvalue">gboolean</span> (*PanelAppletFactoryCallback) (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,
303
const <span class="returnvalue">gchar</span> *iid,
304
<span class="returnvalue">gpointer</span> user_data);</pre>
306
This callback is invoked when the applet is loaded onto the panel. Typically
307
the callback will check that <em class="parameter"><code>iid</code></em> matches and fill the <em class="parameter"><code>applet</code></em> with the
308
widgets which make up the applet.
311
Prior to the callback being invoked the <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a> (or an instance of the
312
sub-class specified by the <span class="type">GType</span> passed to the factory macros) is instantiated
315
<div class="variablelist"><table border="0">
316
<col align="left" valign="top">
319
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
320
<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.
324
<td><p><span class="term"><em class="parameter"><code>iid</code></em> :</span></p></td>
325
<td>The Bonobo IID of the applet requested.
329
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
330
<td>The data passed to the factory macros.
334
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
336
<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure.
343
<div class="refsect2" title="panel_applet_new ()">
344
<a name="panel-applet-new"></a><h3>panel_applet_new ()</h3>
345
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * panel_applet_new (void);</pre>
347
Creates a new <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>. This function is typically not
348
useful as the applet is created before the <a class="link" href="PanelApplet.html#PanelAppletFactoryCallback" title="PanelAppletFactoryCallback ()"><span class="type">PanelAppletFactoryCallback</span></a>
351
<div class="variablelist"><table border="0">
352
<col align="left" valign="top">
354
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
355
<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.
361
<div class="refsect2" title="panel_applet_get_orient ()">
362
<a name="panel-applet-get-orient"></a><h3>panel_applet_get_orient ()</h3>
363
<pre class="programlisting"><a class="link" href="PanelApplet.html#PanelAppletOrient" title="PanelAppletOrient"><span class="returnvalue">PanelAppletOrient</span></a> panel_applet_get_orient (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);</pre>
365
Get the current orientation of the applet.
367
<div class="variablelist"><table border="0">
368
<col align="left" valign="top">
371
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
372
<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.
376
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
377
<td>The orientation of the applet.
384
<div class="refsect2" title="panel_applet_get_size ()">
385
<a name="panel-applet-get-size"></a><h3>panel_applet_get_size ()</h3>
386
<pre class="programlisting"><span class="returnvalue">guint</span> panel_applet_get_size (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);</pre>
388
Get the current size hint for the panel. The size hint is
389
not useful for most applets.
392
Note: The return value is <span class="emphasis"><em>not an integer value
393
specifying the pixel size of the panel.</em></span> Do not
394
use this value to calculate the size of the applet. Use it
395
only as a hint by which to decide the applet's layout.
397
<div class="variablelist"><table border="0">
398
<col align="left" valign="top">
401
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
402
<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.
406
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
407
<td>The panel's size hint.
414
<div class="refsect2" title="panel_applet_get_background ()">
415
<a name="panel-applet-get-background"></a><h3>panel_applet_get_background ()</h3>
416
<pre class="programlisting"><a class="link" href="PanelApplet.html#PanelAppletBackgroundType" title="enum PanelAppletBackgroundType"><span class="returnvalue">PanelAppletBackgroundType</span></a> panel_applet_get_background (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,
417
<span class="returnvalue">GdkColor</span> *color,
418
<span class="returnvalue">GdkPixmap</span> **pixmap);</pre>
420
Returns the current background type. If the background
421
type is <a class="link" href="PanelApplet.html#PANEL-NO-BACKGROUND:CAPS"><code class="literal">PANEL_NO_BACKGROUND</code></a> both <em class="parameter"><code>color</code></em> and <em class="parameter"><code>pixmap</code></em> will
422
be unaffected. If the background type is <a class="link" href="PanelApplet.html#PANEL-COLOR-BACKGROUND:CAPS"><code class="literal">PANEL_COLOR_BACKGROUND</code></a>
423
then <em class="parameter"><code>color</code></em> will contain the current panel background colour.
424
If the background type is <a class="link" href="PanelApplet.html#PANEL-PIXMAP-BACKGROUND:CAPS"><code class="literal">PANEL_PIXMAP_BACKGROUND</code></a>, <em class="parameter"><code>pixmap</code></em> will
425
contain a pointer to a <span class="type">GdkPixmap</span> which is a copy of the applet's
426
portion of the panel's background pixmap.
428
<div class="variablelist"><table border="0">
429
<col align="left" valign="top">
432
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
433
<td>A <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.
437
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
438
<td>A <span class="type">GdkColor</span> to be filled in.
442
<td><p><span class="term"><em class="parameter"><code>pixmap</code></em> :</span></p></td>
443
<td>Returned <span class="type">GdkPixmap</span>.
447
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
448
<td>The background type.
455
<div class="refsect2" title="panel_applet_get_preferences_key ()">
456
<a name="panel-applet-get-preferences-key"></a><h3>panel_applet_get_preferences_key ()</h3>
457
<pre class="programlisting"><span class="returnvalue">gchar</span> * panel_applet_get_preferences_key (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);</pre>
459
Returns the GConf path to the directory containing the applet's
460
per-instance preference keys. Using this you may construct the
461
full path for the applet's preference keys. See
462
<a class="xref" href="panel-applet-Panel-Applet-GConf-Utilities.html" title="Panel Applet GConf Utilities"><span class="refentrytitle"><a name="panel-applet-Panel-Applet-GConf-Utilities.top_of_page"></a>Panel Applet GConf Utilities</span>(3)</a> for
465
<div class="variablelist"><table border="0">
466
<col align="left" valign="top">
469
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
470
<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.
474
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
482
<div class="refsect2" title="panel_applet_add_preferences ()">
483
<a name="panel-applet-add-preferences"></a><h3>panel_applet_add_preferences ()</h3>
484
<pre class="programlisting"><span class="returnvalue">void</span> panel_applet_add_preferences (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,
485
const <span class="returnvalue">gchar</span> *schema_dir,
486
<span class="returnvalue">GError</span> **opt_error);</pre>
488
Associates each schema in <em class="parameter"><code>schema_dir</code></em> with a key in the applet's
489
preferences directory (i.e. the directory returned by
490
<a class="link" href="PanelApplet.html#panel-applet-get-preferences-key" title="panel_applet_get_preferences_key ()"><code class="function">panel_applet_get_preferences_key()</code></a>). Each applet preference
491
should have an associated schema to ensure that the key has
492
a defined type, sane default and documentation.
495
If you pass <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>opt_error</code></em>, this function will print
496
a warning message from any <span class="type">GError</span> which GConf may return.
498
<div class="variablelist"><table border="0">
499
<col align="left" valign="top">
502
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
503
<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.
507
<td><p><span class="term"><em class="parameter"><code>schema_dir</code></em> :</span></p></td>
508
<td>The GConf path where the applet's schemas are installed
509
e.g. /schemas/apps/my_applet
513
<td><p><span class="term"><em class="parameter"><code>opt_error</code></em> :</span></p></td>
514
<td>Optional <span class="type">GError</span>.
521
<div class="refsect2" title="panel_applet_get_flags ()">
522
<a name="panel-applet-get-flags"></a><h3>panel_applet_get_flags ()</h3>
523
<pre class="programlisting"><a class="link" href="PanelApplet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="returnvalue">PanelAppletFlags</span></a> panel_applet_get_flags (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);</pre>
525
Retrieve the <a class="link" href="PanelApplet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a> associated with the applet.
527
<div class="variablelist"><table border="0">
528
<col align="left" valign="top">
531
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
532
<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.
536
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
537
<td>The <a class="link" href="PanelApplet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a>.
544
<div class="refsect2" title="panel_applet_set_flags ()">
545
<a name="panel-applet-set-flags"></a><h3>panel_applet_set_flags ()</h3>
546
<pre class="programlisting"><span class="returnvalue">void</span> panel_applet_set_flags (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,
547
<a class="link" href="PanelApplet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="returnvalue">PanelAppletFlags</span></a> flags);</pre>
549
Set the <a class="link" href="PanelApplet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a> associated with the applet. See
550
<a class="link" href="PanelApplet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a> for more details on the possible uses of
553
<div class="variablelist"><table border="0">
554
<col align="left" valign="top">
557
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
558
<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.
562
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
563
<td>The <a class="link" href="PanelApplet.html#PanelAppletFlags" title="enum PanelAppletFlags"><span class="type">PanelAppletFlags</span></a> to associate.
570
<div class="refsect2" title="panel_applet_set_size_hints ()">
571
<a name="panel-applet-set-size-hints"></a><h3>panel_applet_set_size_hints ()</h3>
572
<pre class="programlisting"><span class="returnvalue">void</span> panel_applet_set_size_hints (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,
573
const <span class="returnvalue">int</span> *size_hints,
574
<span class="returnvalue">int</span> n_elements,
575
<span class="returnvalue">int</span> base_size);</pre>
577
Set a list of desired size ranges for an applet with the
578
<a class="link" href="PanelApplet.html#PANEL-APPLET-EXPAND-MAJOR:CAPS"><span class="type">PANEL_APPLET_EXPAND_MAJOR</span></a> flags set. <em class="parameter"><code>size_hints</code></em> is an
579
array of (max, min) pairs where min(i) > max(i + 1).
582
The panel will endeavour to allocate the applet a size
583
in one of the (<em class="parameter"><code>base</code></em> + max, <em class="parameter"><code>base</code></em> + min) ranges.
585
<div class="variablelist"><table border="0">
586
<col align="left" valign="top">
589
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
590
<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.
594
<td><p><span class="term"><em class="parameter"><code>size_hints</code></em> :</span></p></td>
595
<td>Array of size_hints.
599
<td><p><span class="term"><em class="parameter"><code>n_elements</code></em> :</span></p></td>
600
<td>Number of elements in the array. <span class="emphasis"><em>
601
Not</em></span> the number of pairs.
605
<td><p><span class="term"><em class="parameter"><code>base_size</code></em> :</span></p></td>
606
<td>The base size of the applet.
613
<div class="refsect2" title="panel_applet_get_locked_down ()">
614
<a name="panel-applet-get-locked-down"></a><h3>panel_applet_get_locked_down ()</h3>
615
<pre class="programlisting"><span class="returnvalue">gboolean</span> panel_applet_get_locked_down (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);</pre>
617
Check if the <em class="parameter"><code>applet</code></em> is locked down. A locked down applet should not allow any change to its configuration.
619
<div class="variablelist"><table border="0">
620
<col align="left" valign="top">
623
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
624
<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.
628
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
630
<code class="literal">TRUE</code> if the <em class="parameter"><code>applet</code></em> is locked down, <code class="literal">FALSE</code> otherwise.
637
<div class="refsect2" title="panel_applet_request_focus ()">
638
<a name="panel-applet-request-focus"></a><h3>panel_applet_request_focus ()</h3>
639
<pre class="programlisting"><span class="returnvalue">void</span> panel_applet_request_focus (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,
640
<span class="returnvalue">guint32</span> timestamp);</pre>
642
Set keyboard focus to <em class="parameter"><code>applet</code></em>.
644
<div class="variablelist"><table border="0">
645
<col align="left" valign="top">
648
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
649
<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.
653
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
654
<td>timestamp of the event triggering the window focus
661
<div class="refsect2" title="panel_applet_get_control ()">
662
<a name="panel-applet-get-control"></a><h3>panel_applet_get_control ()</h3>
663
<pre class="programlisting"><span class="returnvalue">BonoboControl</span> * panel_applet_get_control (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);</pre>
665
Retrieves the <span class="type">BonoboControl</span> associated with <em class="parameter"><code>applet</code></em>.
667
<div class="variablelist"><table border="0">
668
<col align="left" valign="top">
671
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
672
<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.
676
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
677
<td>A <span class="type">BonoboControl</span>.
684
<div class="refsect2" title="panel_applet_get_popup_component ()">
685
<a name="panel-applet-get-popup-component"></a><h3>panel_applet_get_popup_component ()</h3>
686
<pre class="programlisting"><span class="returnvalue">BonoboUIComponent</span> * panel_applet_get_popup_component (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet);</pre>
688
Retrieves the <span class="type">BonoboUIComponent</span> used for popup menus associated
689
with <em class="parameter"><code>applet</code></em>.
691
<div class="variablelist"><table border="0">
692
<col align="left" valign="top">
695
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
696
<td>The <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.
700
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
701
<td>A <span class="type">BonoboUIComponent</span>.
708
<div class="refsect2" title="panel_applet_setup_menu ()">
709
<a name="panel-applet-setup-menu"></a><h3>panel_applet_setup_menu ()</h3>
710
<pre class="programlisting"><span class="returnvalue">void</span> panel_applet_setup_menu (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,
711
const <span class="returnvalue">gchar</span> *xml,
712
const <span class="returnvalue">BonoboUIVerb</span> *verb_list,
713
<span class="returnvalue">gpointer</span> user_data);</pre>
715
Sets up a popup menu for <em class="parameter"><code>applet</code></em> described by the xml
716
string, <em class="parameter"><code>xml</code></em>. See <a class="xref" href="applet-writing.html" title="Writing Applets"><i>Writing Applets</i></a> section
717
for a description of the format of the xml.
719
<div class="variablelist"><table border="0">
720
<col align="left" valign="top">
723
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
724
<td>A <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.
728
<td><p><span class="term"><em class="parameter"><code>xml</code></em> :</span></p></td>
729
<td>The xml character string describing the popup menu.
733
<td><p><span class="term"><em class="parameter"><code>verb_list</code></em> :</span></p></td>
734
<td>The list of <span class="type">BonoboUIVerbs</span> for the menu.
738
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
739
<td>The user data pointer for the menu.
746
<div class="refsect2" title="panel_applet_setup_menu_from_file ()">
747
<a name="panel-applet-setup-menu-from-file"></a><h3>panel_applet_setup_menu_from_file ()</h3>
748
<pre class="programlisting"><span class="returnvalue">void</span> panel_applet_setup_menu_from_file (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="returnvalue">PanelApplet</span></a> *applet,
749
const <span class="returnvalue">gchar</span> *opt_datadir,
750
const <span class="returnvalue">gchar</span> *file,
751
const <span class="returnvalue">gchar</span> *opt_app_name,
752
const <span class="returnvalue">BonoboUIVerb</span> *verb_list,
753
<span class="returnvalue">gpointer</span> user_data);</pre>
755
Sets up a popup menu for <em class="parameter"><code>applet</code></em> described by the xml
756
file, <em class="parameter"><code>file</code></em>. See <a class="xref" href="applet-writing.html" title="Writing Applets"><i>Writing Applets</i></a> for a description of
757
the format of the xml.
759
<div class="variablelist"><table border="0">
760
<col align="left" valign="top">
763
<td><p><span class="term"><em class="parameter"><code>applet</code></em> :</span></p></td>
764
<td>A <a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a>.
768
<td><p><span class="term"><em class="parameter"><code>opt_datadir</code></em> :</span></p></td>
769
<td>The data directory - i.e. ${prefix}/share (optional).
773
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
778
<td><p><span class="term"><em class="parameter"><code>opt_app_name</code></em> :</span></p></td>
779
<td>The application's name (optional).
783
<td><p><span class="term"><em class="parameter"><code>verb_list</code></em> :</span></p></td>
784
<td>The list of <span class="type">BonoboUIVerbs</span> for the menu.
788
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
789
<td>The user data pointer for the menu.
796
<div class="refsect2" title="panel_applet_factory_main ()">
797
<a name="panel-applet-factory-main"></a><h3>panel_applet_factory_main ()</h3>
798
<pre class="programlisting"><span class="returnvalue">int</span> panel_applet_factory_main (const <span class="returnvalue">gchar</span> *iid,
799
<span class="returnvalue">GType</span> applet_type,
800
<a class="link" href="PanelApplet.html#PanelAppletFactoryCallback" title="PanelAppletFactoryCallback ()"><span class="returnvalue">PanelAppletFactoryCallback</span></a> callback,
801
<span class="returnvalue">gpointer</span> data);</pre>
803
A generic 'main' routine for applets. This should not normally be
804
used directly because it is invoked by <a class="link" href="PanelApplet.html#PANEL-APPLET-BONOBO-FACTORY:CAPS" title="PANEL_APPLET_BONOBO_FACTORY()"><span class="type">PANEL_APPLET_BONOBO_FACTORY</span></a>.
806
<div class="variablelist"><table border="0">
807
<col align="left" valign="top">
810
<td><p><span class="term"><em class="parameter"><code>iid</code></em> :</span></p></td>
811
<td>The bonobo-activation iid of the factory.
815
<td><p><span class="term"><em class="parameter"><code>applet_type</code></em> :</span></p></td>
816
<td>The <span class="type">GType</span> to instantiate.
820
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
821
<td>The factory callback.
825
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
826
<td>The factory user data pointer.
830
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
831
<td>0 on success, 1 on failure.
838
<div class="refsect2" title="panel_applet_factory_main_closure ()">
839
<a name="panel-applet-factory-main-closure"></a><h3>panel_applet_factory_main_closure ()</h3>
840
<pre class="programlisting"><span class="returnvalue">int</span> panel_applet_factory_main_closure (const <span class="returnvalue">gchar</span> *iid,
841
<span class="returnvalue">GType</span> applet_type,
842
<span class="returnvalue">GClosure</span> *closure);</pre>
844
A generic 'main' routine for applets. This should not normally be
845
used directly because it is invoked by <a class="link" href="PanelApplet.html#PANEL-APPLET-BONOBO-FACTORY:CAPS" title="PANEL_APPLET_BONOBO_FACTORY()"><span class="type">PANEL_APPLET_BONOBO_FACTORY</span></a>.
847
<div class="variablelist"><table border="0">
848
<col align="left" valign="top">
851
<td><p><span class="term"><em class="parameter"><code>iid</code></em> :</span></p></td>
852
<td>The bonobo-activation iid of the factory.
856
<td><p><span class="term"><em class="parameter"><code>applet_type</code></em> :</span></p></td>
857
<td>The <span class="type">GType</span> to instantiate.
861
<td><p><span class="term"><em class="parameter"><code>closure</code></em> :</span></p></td>
862
<td>The factory callback closure.
866
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
867
<td>0 on success, 1 on failure.
874
<div class="refsect2" title="PANEL_APPLET_BONOBO_FACTORY()">
875
<a name="PANEL-APPLET-BONOBO-FACTORY:CAPS"></a><h3>PANEL_APPLET_BONOBO_FACTORY()</h3>
876
<pre class="programlisting">#define PANEL_APPLET_BONOBO_FACTORY(iid, type, name, version, callback, data)</pre>
878
Defines a 'main' routine for the applet factory.
880
<div class="variablelist"><table border="0">
881
<col align="left" valign="top">
884
<td><p><span class="term"><em class="parameter"><code>iid</code></em> :</span></p></td>
885
<td>The bonobo-activation iid of the factory.
889
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
890
<td>The <span class="type">GType</span> to instantiate.
894
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
895
<td>The applet ID string.
899
<td><p><span class="term"><em class="parameter"><code>version</code></em> :</span></p></td>
900
<td>The applet version string.
904
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
905
<td>The factory callback.
909
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
910
<td>The factory user data pointer.
917
<div class="refsect2" title="panel_applet_shlib_factory ()">
918
<a name="panel-applet-shlib-factory"></a><h3>panel_applet_shlib_factory ()</h3>
919
<pre class="programlisting"><span class="returnvalue">Bonobo_Unknown</span> panel_applet_shlib_factory (const <span class="returnvalue">char</span> *iid,
920
<span class="returnvalue">GType</span> applet_type,
921
<span class="returnvalue">PortableServer_POA</span> poa,
922
<span class="returnvalue">gpointer</span> impl_ptr,
923
<a class="link" href="PanelApplet.html#PanelAppletFactoryCallback" title="PanelAppletFactoryCallback ()"><span class="returnvalue">PanelAppletFactoryCallback</span></a> callback,
924
<span class="returnvalue">gpointer</span> user_data,
925
<span class="returnvalue">CORBA_Environment</span> *ev);</pre>
927
A generic shared library factory routine for applets. This should not
928
normally be used directly as it is invoked by <a class="link" href="PanelApplet.html#PANEL-APPLET-BONOBO-SHLIB-FACTORY:CAPS" title="PANEL_APPLET_BONOBO_SHLIB_FACTORY()"><span class="type">PANEL_APPLET_BONOBO_SHLIB_FACTORY</span></a>.
930
<div class="variablelist"><table border="0">
931
<col align="left" valign="top">
934
<td><p><span class="term"><em class="parameter"><code>iid</code></em> :</span></p></td>
935
<td>The bonobo-activation iid of the factory.
939
<td><p><span class="term"><em class="parameter"><code>applet_type</code></em> :</span></p></td>
940
<td>The <span class="type">GType</span> to instantiate.
944
<td><p><span class="term"><em class="parameter"><code>poa</code></em> :</span></p></td>
945
<td>The <span class="type">PortableServer_POA</span> passed to the shlib factory
950
<td><p><span class="term"><em class="parameter"><code>impl_ptr</code></em> :</span></p></td>
951
<td>The <span class="type">gpointer</span> passed to the shlib factory callback.
955
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
956
<td>The applet factory callback.
960
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
961
<td>The factory user data pointer.
965
<td><p><span class="term"><em class="parameter"><code>ev</code></em> :</span></p></td>
966
<td>The $CORBA_Environment passed to the shlib factory callback.
970
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
971
<td>A <span class="type">Bonobo_Unknown</span> to return from the shlib factory
979
<div class="refsect2" title="panel_applet_shlib_factory_closure ()">
980
<a name="panel-applet-shlib-factory-closure"></a><h3>panel_applet_shlib_factory_closure ()</h3>
981
<pre class="programlisting"><span class="returnvalue">Bonobo_Unknown</span> panel_applet_shlib_factory_closure (const <span class="returnvalue">char</span> *iid,
982
<span class="returnvalue">GType</span> applet_type,
983
<span class="returnvalue">PortableServer_POA</span> poa,
984
<span class="returnvalue">gpointer</span> impl_ptr,
985
<span class="returnvalue">GClosure</span> *closure,
986
<span class="returnvalue">CORBA_Environment</span> *ev);</pre>
988
A generic shared library factory routine for applets. This should not
989
normally be used directly as it is invoked by <a class="link" href="PanelApplet.html#PANEL-APPLET-BONOBO-SHLIB-FACTORY:CAPS" title="PANEL_APPLET_BONOBO_SHLIB_FACTORY()"><span class="type">PANEL_APPLET_BONOBO_SHLIB_FACTORY</span></a>.
991
<div class="variablelist"><table border="0">
992
<col align="left" valign="top">
995
<td><p><span class="term"><em class="parameter"><code>iid</code></em> :</span></p></td>
996
<td>The bonobo-activation iid of the factory.
1000
<td><p><span class="term"><em class="parameter"><code>applet_type</code></em> :</span></p></td>
1001
<td>The <span class="type">GType</span> to instantiate.
1005
<td><p><span class="term"><em class="parameter"><code>poa</code></em> :</span></p></td>
1006
<td>The <span class="type">PortableServer_POA</span> passed to the shlib factory
1011
<td><p><span class="term"><em class="parameter"><code>impl_ptr</code></em> :</span></p></td>
1012
<td>The <span class="type">gpointer</span> passed to the shlib factory callback.
1016
<td><p><span class="term"><em class="parameter"><code>closure</code></em> :</span></p></td>
1017
<td>The applet factory closure.
1021
<td><p><span class="term"><em class="parameter"><code>ev</code></em> :</span></p></td>
1022
<td>The $CORBA_Environment passed to the shlib factory callback.
1026
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1027
<td>A <span class="type">Bonobo_Unknown</span> to return from the shlib factory
1035
<div class="refsect2" title="PANEL_APPLET_BONOBO_SHLIB_FACTORY()">
1036
<a name="PANEL-APPLET-BONOBO-SHLIB-FACTORY:CAPS"></a><h3>PANEL_APPLET_BONOBO_SHLIB_FACTORY()</h3>
1037
<pre class="programlisting">#define PANEL_APPLET_BONOBO_SHLIB_FACTORY(iid, type, descr, callback, data)</pre>
1039
Defines a Bonobo Activation shared library plugin and associated
1042
<div class="variablelist"><table border="0">
1043
<col align="left" valign="top">
1046
<td><p><span class="term"><em class="parameter"><code>iid</code></em> :</span></p></td>
1047
<td>The bonobo-activation iid of the factory.
1051
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
1052
<td>The <span class="type">GType</span> to instantiate.
1056
<td><p><span class="term"><em class="parameter"><code>descr</code></em> :</span></p></td>
1057
<td>A description of the applet.
1061
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
1062
<td>The factory callback.
1066
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1067
<td>The factory user data pointer.
1074
<div class="refsect1" title="Signal Details">
1075
<a name="PanelApplet.signal-details"></a><h2>Signal Details</h2>
1076
<div class="refsect2" title='The "change-background" signal'>
1077
<a name="PanelApplet-change-background"></a><h3>The <code class="literal">"change-background"</code> signal</h3>
1078
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a> *panelapplet,
1079
<a class="link" href="PanelApplet.html#PanelAppletBackgroundType" title="enum PanelAppletBackgroundType"><span class="type">PanelAppletBackgroundType</span></a> arg1,
1080
<span class="type">GdkColor</span> *arg2,
1081
<span class="type">GdkPixmap</span> *arg3,
1082
<span class="type">gpointer</span> user_data) : Run Last</pre>
1084
Emitted when the background of the panel changes. Use <em class="parameter"><code>type</code></em> to
1085
determine which, if any, of <em class="parameter"><code>color</code></em> and <em class="parameter"><code>pimxap</code></em> is valid.
1087
<div class="variablelist"><table border="0">
1088
<col align="left" valign="top">
1091
<td><p><span class="term"><em class="parameter"><code>panelapplet</code></em> :</span></p></td>
1092
<td>The object which received the signal.
1096
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
1101
<td><p><span class="term"><em class="parameter"><code>arg2</code></em> :</span></p></td>
1106
<td><p><span class="term"><em class="parameter"><code>arg3</code></em> :</span></p></td>
1111
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1112
<td>user data set when the signal handler was connected.</td>
1118
<div class="refsect2" title='The "change-orient" signal'>
1119
<a name="PanelApplet-change-orient"></a><h3>The <code class="literal">"change-orient"</code> signal</h3>
1120
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a> *panelapplet,
1121
<span class="type">guint</span> arg1,
1122
<span class="type">gpointer</span> user_data) : Run Last</pre>
1124
Emitted when the orientation of the panel changes.
1126
<div class="variablelist"><table border="0">
1127
<col align="left" valign="top">
1130
<td><p><span class="term"><em class="parameter"><code>panelapplet</code></em> :</span></p></td>
1131
<td>The object which received the signal.
1135
<td><p><span class="term"><em class="parameter"><code>orient</code></em> :</span></p></td>
1136
<td>The new <a class="link" href="PanelApplet.html#PanelAppletOrient" title="PanelAppletOrient"><span class="type">PanelAppletOrient</span></a> of the applet.
1140
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1141
<td>user data set when the signal handler was connected.</td>
1147
<div class="refsect2" title='The "change-size" signal'>
1148
<a name="PanelApplet-change-size"></a><h3>The <code class="literal">"change-size"</code> signal</h3>
1149
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a> *panelapplet,
1150
<span class="type">gint</span> arg1,
1151
<span class="type">gpointer</span> user_data) : Run Last</pre>
1153
Emitted when the size of the panel changes.
1156
Note: this is different for size negotiation which is handled by
1157
<code class="function">size_request()</code> and <code class="function">size_allocate()</code> as usual. This signal should
1158
be used to determine what font size or widget layout to use
1159
depending on the size of the panel. See <a class="link" href="PanelApplet.html#panel-applet-get-size" title="panel_applet_get_size ()"><code class="function">panel_applet_get_size()</code></a>.
1161
<div class="variablelist"><table border="0">
1162
<col align="left" valign="top">
1165
<td><p><span class="term"><em class="parameter"><code>panelapplet</code></em> :</span></p></td>
1166
<td>The object which received the signal.
1170
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
1171
<td>The size hint of the panel.
1175
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1176
<td>user data set when the signal handler was connected.</td>
1182
<div class="refsect2" title='The "move-focus-out-of-applet" signal'>
1183
<a name="PanelApplet-move-focus-out-of-applet"></a><h3>The <code class="literal">"move-focus-out-of-applet"</code> signal</h3>
1184
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="PanelApplet.html" title="PanelApplet"><span class="type">PanelApplet</span></a> *panelapplet,
1185
<span class="type">GtkDirectionType</span> arg1,
1186
<span class="type">gpointer</span> user_data) : Run Last / Action</pre>
1188
Emitted when the applet has lost focus. This signal is used internally and is not meant to be used by applets themselves.
1190
<div class="variablelist"><table border="0">
1191
<col align="left" valign="top">
1194
<td><p><span class="term"><em class="parameter"><code>panelapplet</code></em> :</span></p></td>
1195
<td>The object which received the signal.
1199
<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
1200
<td>The direction of focus movement.
1204
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1205
<td>user data set when the signal handler was connected.</td>
1212
<div class="footer">
1214
Generated by GTK-Doc V1.14</div>
b'\\ No newline at end of file'