← Back to branch summary

~ubuntu-branches/ubuntu/edgy/xfce4-panel/edgy

« back to all changes in this revision

Viewing changes to docs/API/xml/xfce-panel-plugin-iface.xml

  • Committer: Bazaar Package Importer
  • Author(s): Jani Monoses
  • Date: 2006-09-12 15:36:53 UTC
  • mfrom: (1.1.12 upstream)
  • Revision ID: james.westby@ubuntu.com-20060912153653-sajops08au69e9r6
Tags: 4.3.99.1-0ubuntu1
* New upstream release (4.4RC1)
* Bumped library and policy versions

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/API/xml/xfce-panel-plugin-iface.xml
3
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
4
<refentry id="XfcePanelPlugin">
5
5
<refmeta>
6
 
<refentrytitle>XfcePanelPlugin</refentrytitle>
 
6
<refentrytitle id="top_of_page">XfcePanelPlugin</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
8
<refmiscinfo>LIBXFCE4PANEL Library</refmiscinfo>
9
9
</refmeta>
10
10
 
11
11
<refnamediv>
12
 
<refname>XfcePanelPlugin</refname><refpurpose><para>
 
12
<refname>XfcePanelPlugin</refname>
 
13
<refpurpose><para>
13
14
Panel plugin interface.
14
15
</para></refpurpose>
 
16
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
15
17
</refnamediv>
16
18
 
17
 
<refsynopsisdiv><title>Synopsis</title>
 
19
<refsynopsisdiv id="synopsis">
 
20
<title id="synopsis.title">Synopsis</title>
18
21
 
19
22
<synopsis>
20
23
 
56
59
</synopsis>
57
60
</refsynopsisdiv>
58
61
 
59
 
<refsect1>
60
 
<title>Object Hierarchy</title>
 
62
<refsect1 id="object_hierarchy">
 
63
<title id="object_hierarchy.title">Object Hierarchy</title>
61
64
<synopsis>
62
65
 
63
66
  <link linkend="GInterface">GInterface</link>
66
69
 
67
70
</refsect1>
68
71
 
69
 
<refsect1>
70
 
<title>Prerequisites</title>
 
72
<refsect1 id="prerequisites">
 
73
<title id="prerequisites.title">Prerequisites</title>
71
74
<para>
72
75
XfcePanelPlugin requires
73
 
 <link linkend="GtkContainer">GtkContainer</link>.</para>
 
76
 <link linkend="GInitiallyUnowned">GInitiallyUnowned</link>,  <link linkend="GtkObject">GtkObject</link>,  <link linkend="GtkWidget">GtkWidget</link> and  <link linkend="GtkContainer">GtkContainer</link>.</para>
74
77
 
75
78
</refsect1>
76
79
 
77
80
 
78
81
 
79
 
<refsect1>
80
 
<title>Known Implementations</title>
 
82
<refsect1 id="implementations">
 
83
<title id="implementations.title">Known Implementations</title>
81
84
<para>
82
85
XfcePanelPlugin is implemented by
83
86
 <link linkend="XfceExternalPanelPlugin">XfceExternalPanelPlugin</link> and  <link linkend="XfceInternalPanelPlugin">XfceInternalPanelPlugin</link>.</para>
84
87
 
85
88
</refsect1>
86
89
 
87
 
<refsect1>
88
 
<title>Properties</title>
 
90
<refsect1 id="properties">
 
91
<title id="properties.title">Properties</title>
89
92
<synopsis>
90
93
 
91
94
  &quot;<link linkend="XfcePanelPlugin--display-name">display-name</link>&quot;         <link linkend="gchararray">gchararray</link>            : Read
97
100
</synopsis>
98
101
</refsect1>
99
102
 
100
 
<refsect1>
101
 
<title>Signal Prototypes</title>
 
103
<refsect1 id="signal_proto">
 
104
<title id="signal_proto.title">Signals</title>
102
105
<synopsis>
103
106
 
104
107
&quot;<link linkend="XfcePanelPlugin-about">about</link>&quot;     <link linkend="void">void</link>        user_function      (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
105
 
                                            <link linkend="gpointer">gpointer</link> user_data);
 
108
                                            <link linkend="gpointer">gpointer</link>         user_data)      : Run last / No recursion / No hooks
106
109
&quot;<link linkend="XfcePanelPlugin-configure-plugin">configure-plugin</link>&quot;
107
110
            <link linkend="void">void</link>        user_function      (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
108
 
                                            <link linkend="gpointer">gpointer</link> user_data);
 
111
                                            <link linkend="gpointer">gpointer</link>         user_data)      : Run last / No recursion / No hooks
109
112
&quot;<link linkend="XfcePanelPlugin-free-data">free-data</link>&quot; <link linkend="void">void</link>        user_function      (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
110
 
                                            <link linkend="gpointer">gpointer</link> user_data);
 
113
                                            <link linkend="gpointer">gpointer</link>         user_data)      : Run last / No recursion / No hooks
111
114
&quot;<link linkend="XfcePanelPlugin-orientation-changed">orientation-changed</link>&quot;
112
115
            <link linkend="void">void</link>        user_function      (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
113
 
                                            <link linkend="GtkOrientation">GtkOrientation</link> orientation,
114
 
                                            <link linkend="gpointer">gpointer</link> user_data);
 
116
                                            <link linkend="GtkOrientation">GtkOrientation</link>  *orientation,
 
117
                                            <link linkend="gpointer">gpointer</link>         user_data)        : Run last / No recursion / No hooks
115
118
&quot;<link linkend="XfcePanelPlugin-save">save</link>&quot;      <link linkend="void">void</link>        user_function      (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
116
 
                                            <link linkend="gpointer">gpointer</link> user_data);
 
119
                                            <link linkend="gpointer">gpointer</link>         user_data)      : Run last / No recursion / No hooks
117
120
&quot;<link linkend="XfcePanelPlugin-screen-position-changed">screen-position-changed</link>&quot;
118
 
            <link linkend="void">void</link>        user_function      (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
119
 
                                            <link linkend="XfceScreenPosition">XfceScreenPosition</link> position,
120
 
                                            <link linkend="gpointer">gpointer</link> user_data);
 
121
            <link linkend="void">void</link>        user_function      (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link>    *plugin,
 
122
                                            <link linkend="XfceScreenPosition">XfceScreenPosition</link> *position,
 
123
                                            <link linkend="gpointer">gpointer</link>            user_data)      : Run last / No recursion / No hooks
121
124
&quot;<link linkend="XfcePanelPlugin-size-changed">size-changed</link>&quot;
122
125
            <link linkend="gboolean">gboolean</link>    user_function      (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
123
 
                                            <link linkend="gint">gint</link> size,
124
 
                                            <link linkend="gpointer">gpointer</link> user_data);
 
126
                                            <link linkend="gint">gint</link>             size,
 
127
                                            <link linkend="gpointer">gpointer</link>         user_data)      : Run last / No recursion / No hooks
125
128
</synopsis>
126
129
</refsect1>
127
130
 
128
131
 
129
 
<refsect1>
130
 
<title>Description</title>
 
132
<refsect1 id="desc">
 
133
<title id="desc.title">Description</title>
131
134
<para>
132
135
The interface implemented by both internal and external plugins. Plugin
133
136
writers may use the functions described below to interact with the plugin
135
138
</para>
136
139
</refsect1>
137
140
 
138
 
<refsect1>
139
 
<title>Details</title>
 
141
<refsect1 id="details">
 
142
<title id="details.title">Details</title>
140
143
<refsect2>
141
 
<title><anchor id="XfcePanelPlugin-struct"/>XfcePanelPlugin</title>
 
144
<title><anchor id="XfcePanelPlugin-struct" role="struct"/>XfcePanelPlugin</title>
142
145
<indexterm><primary>XfcePanelPlugin</primary></indexterm><programlisting>typedef struct _XfcePanelPlugin XfcePanelPlugin;</programlisting>
143
146
<para>
144
147
The <link linkend="XfcePanelPlugin-struct"><type>XfcePanelPlugin-struct</type></link> is a purely virtual object to describe an instance
145
148
of a widget implementing the panel plugin interface.
146
149
</para></refsect2>
147
150
<refsect2>
148
 
<title><anchor id="XfcePanelPluginFunc"/>XfcePanelPluginFunc ()</title>
 
151
<title><anchor id="XfcePanelPluginFunc" role="function"/>XfcePanelPluginFunc ()</title>
149
152
<indexterm><primary>XfcePanelPluginFunc</primary></indexterm><programlisting><link linkend="void">void</link>        (*XfcePanelPluginFunc)          (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
150
153
<para>
151
154
Callback function to create the plugin contents. It should be given as 
162
165
</simpara></listitem></varlistentry>
163
166
</variablelist></refsect2>
164
167
<refsect2>
165
 
<title><anchor id="xfce-panel-plugin-get-name"/>xfce_panel_plugin_get_name ()</title>
 
168
<title><anchor id="xfce-panel-plugin-get-name" role="function"/>xfce_panel_plugin_get_name ()</title>
166
169
<indexterm><primary>xfce_panel_plugin_get_name</primary></indexterm><programlisting>const <link linkend="char">char</link>* xfce_panel_plugin_get_name      (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
167
170
<para>
168
171
The plugin name identifies a plugin type and therefore must be unique.</para>
176
179
</simpara></listitem></varlistentry>
177
180
</variablelist></refsect2>
178
181
<refsect2>
179
 
<title><anchor id="xfce-panel-plugin-get-id"/>xfce_panel_plugin_get_id ()</title>
 
182
<title><anchor id="xfce-panel-plugin-get-id" role="function"/>xfce_panel_plugin_get_id ()</title>
180
183
<indexterm><primary>xfce_panel_plugin_get_id</primary></indexterm><programlisting>const <link linkend="char">char</link>* xfce_panel_plugin_get_id        (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
181
184
<para>
182
185
The plugin id is a unique identifier string that is given to every instance
191
194
</simpara></listitem></varlistentry>
192
195
</variablelist></refsect2>
193
196
<refsect2>
194
 
<title><anchor id="xfce-panel-plugin-get-display-name"/>xfce_panel_plugin_get_display_name ()</title>
 
197
<title><anchor id="xfce-panel-plugin-get-display-name" role="function"/>xfce_panel_plugin_get_display_name ()</title>
195
198
<indexterm><primary>xfce_panel_plugin_get_display_name</primary></indexterm><programlisting>const <link linkend="char">char</link>* xfce_panel_plugin_get_display_name
196
199
                                            (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
197
200
<para>
207
210
</simpara></listitem></varlistentry>
208
211
</variablelist></refsect2>
209
212
<refsect2>
210
 
<title><anchor id="xfce-panel-plugin-get-size"/>xfce_panel_plugin_get_size ()</title>
 
213
<title><anchor id="xfce-panel-plugin-get-size" role="function"/>xfce_panel_plugin_get_size ()</title>
211
214
<indexterm><primary>xfce_panel_plugin_get_size</primary></indexterm><programlisting><link linkend="int">int</link>         xfce_panel_plugin_get_size      (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
212
215
<para>
213
216
</para>
221
224
</simpara></listitem></varlistentry>
222
225
</variablelist></refsect2>
223
226
<refsect2>
224
 
<title><anchor id="xfce-panel-plugin-get-screen-position"/>xfce_panel_plugin_get_screen_position ()</title>
 
227
<title><anchor id="xfce-panel-plugin-get-screen-position" role="function"/>xfce_panel_plugin_get_screen_position ()</title>
225
228
<indexterm><primary>xfce_panel_plugin_get_screen_position</primary></indexterm><programlisting><link linkend="XfceScreenPosition">XfceScreenPosition</link> xfce_panel_plugin_get_screen_position
226
229
                                            (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
227
230
<para>
236
239
</simpara></listitem></varlistentry>
237
240
</variablelist></refsect2>
238
241
<refsect2>
239
 
<title><anchor id="xfce-panel-plugin-set-expand"/>xfce_panel_plugin_set_expand ()</title>
 
242
<title><anchor id="xfce-panel-plugin-set-expand" role="function"/>xfce_panel_plugin_set_expand ()</title>
240
243
<indexterm><primary>xfce_panel_plugin_set_expand</primary></indexterm><programlisting><link linkend="void">void</link>        xfce_panel_plugin_set_expand    (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
241
244
                                             <link linkend="gboolean">gboolean</link> expand);</programlisting>
242
245
<para>
252
255
</simpara></listitem></varlistentry>
253
256
</variablelist></refsect2>
254
257
<refsect2>
255
 
<title><anchor id="xfce-panel-plugin-get-expand"/>xfce_panel_plugin_get_expand ()</title>
 
258
<title><anchor id="xfce-panel-plugin-get-expand" role="function"/>xfce_panel_plugin_get_expand ()</title>
256
259
<indexterm><primary>xfce_panel_plugin_get_expand</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    xfce_panel_plugin_get_expand    (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
257
260
<para>
258
261
</para>
266
269
</simpara></listitem></varlistentry>
267
270
</variablelist></refsect2>
268
271
<refsect2>
269
 
<title><anchor id="xfce-panel-plugin-get-orientation"/>xfce_panel_plugin_get_orientation ()</title>
 
272
<title><anchor id="xfce-panel-plugin-get-orientation" role="function"/>xfce_panel_plugin_get_orientation ()</title>
270
273
<indexterm><primary>xfce_panel_plugin_get_orientation</primary></indexterm><programlisting><link linkend="GtkOrientation">GtkOrientation</link> xfce_panel_plugin_get_orientation
271
274
                                            (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
272
275
<para>
281
284
</simpara></listitem></varlistentry>
282
285
</variablelist></refsect2>
283
286
<refsect2>
284
 
<title><anchor id="xfce-panel-plugin-add-action-widget"/>xfce_panel_plugin_add_action_widget ()</title>
 
287
<title><anchor id="xfce-panel-plugin-add-action-widget" role="function"/>xfce_panel_plugin_add_action_widget ()</title>
285
288
<indexterm><primary>xfce_panel_plugin_add_action_widget</primary></indexterm><programlisting><link linkend="void">void</link>        xfce_panel_plugin_add_action_widget
286
289
                                            (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
287
290
                                             <link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>
301
304
</simpara></listitem></varlistentry>
302
305
</variablelist></refsect2>
303
306
<refsect2>
304
 
<title><anchor id="xfce-panel-plugin-menu-insert-item"/>xfce_panel_plugin_menu_insert_item ()</title>
 
307
<title><anchor id="xfce-panel-plugin-menu-insert-item" role="function"/>xfce_panel_plugin_menu_insert_item ()</title>
305
308
<indexterm><primary>xfce_panel_plugin_menu_insert_item</primary></indexterm><programlisting><link linkend="void">void</link>        xfce_panel_plugin_menu_insert_item
306
309
                                            (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
307
310
                                             <link linkend="GtkMenuItem">GtkMenuItem</link> *item);</programlisting>
318
321
</simpara></listitem></varlistentry>
319
322
</variablelist></refsect2>
320
323
<refsect2>
321
 
<title><anchor id="xfce-panel-plugin-menu-show-about"/>xfce_panel_plugin_menu_show_about ()</title>
 
324
<title><anchor id="xfce-panel-plugin-menu-show-about" role="function"/>xfce_panel_plugin_menu_show_about ()</title>
322
325
<indexterm><primary>xfce_panel_plugin_menu_show_about</primary></indexterm><programlisting><link linkend="void">void</link>        xfce_panel_plugin_menu_show_about
323
326
                                            (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
324
327
<para>
332
335
</simpara></listitem></varlistentry>
333
336
</variablelist></refsect2>
334
337
<refsect2>
335
 
<title><anchor id="xfce-panel-plugin-menu-show-configure"/>xfce_panel_plugin_menu_show_configure ()</title>
 
338
<title><anchor id="xfce-panel-plugin-menu-show-configure" role="function"/>xfce_panel_plugin_menu_show_configure ()</title>
336
339
<indexterm><primary>xfce_panel_plugin_menu_show_configure</primary></indexterm><programlisting><link linkend="void">void</link>        xfce_panel_plugin_menu_show_configure
337
340
                                            (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
338
341
<para>
346
349
</simpara></listitem></varlistentry>
347
350
</variablelist></refsect2>
348
351
<refsect2>
349
 
<title><anchor id="xfce-panel-plugin-block-menu"/>xfce_panel_plugin_block_menu ()</title>
 
352
<title><anchor id="xfce-panel-plugin-block-menu" role="function"/>xfce_panel_plugin_block_menu ()</title>
350
353
<indexterm><primary>xfce_panel_plugin_block_menu</primary></indexterm><programlisting><link linkend="void">void</link>        xfce_panel_plugin_block_menu    (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
351
354
<para>
352
355
Temporarily block the menu from being shown. This can be used by plugin
362
365
</simpara></listitem></varlistentry>
363
366
</variablelist></refsect2>
364
367
<refsect2>
365
 
<title><anchor id="xfce-panel-plugin-unblock-menu"/>xfce_panel_plugin_unblock_menu ()</title>
 
368
<title><anchor id="xfce-panel-plugin-unblock-menu" role="function"/>xfce_panel_plugin_unblock_menu ()</title>
366
369
<indexterm><primary>xfce_panel_plugin_unblock_menu</primary></indexterm><programlisting><link linkend="void">void</link>        xfce_panel_plugin_unblock_menu  (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
367
370
<para>
368
371
Don't block the menu from being shown.
377
380
</simpara></listitem></varlistentry>
378
381
</variablelist></refsect2>
379
382
<refsect2>
380
 
<title><anchor id="xfce-panel-plugin-register-menu"/>xfce_panel_plugin_register_menu ()</title>
 
383
<title><anchor id="xfce-panel-plugin-register-menu" role="function"/>xfce_panel_plugin_register_menu ()</title>
381
384
<indexterm><primary>xfce_panel_plugin_register_menu</primary></indexterm><programlisting><link linkend="void">void</link>        xfce_panel_plugin_register_menu (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
382
385
                                             <link linkend="GtkMenu">GtkMenu</link> *menu);</programlisting>
383
386
<para>
394
397
</simpara></listitem></varlistentry>
395
398
</variablelist></refsect2>
396
399
<refsect2>
397
 
<title><anchor id="xfce-panel-plugin-lookup-rc-file"/>xfce_panel_plugin_lookup_rc_file ()</title>
 
400
<title><anchor id="xfce-panel-plugin-lookup-rc-file" role="function"/>xfce_panel_plugin_lookup_rc_file ()</title>
398
401
<indexterm><primary>xfce_panel_plugin_lookup_rc_file</primary></indexterm><programlisting><link linkend="char">char</link>*       xfce_panel_plugin_lookup_rc_file
399
402
                                            (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin);</programlisting>
400
403
<para>
406
409
<varlistentry><term><parameter>plugin</parameter>&nbsp;:</term>
407
410
<listitem><simpara> an <link linkend="XfcePanelPlugin"><type>XfcePanelPlugin</type></link>
408
411
</simpara></listitem></varlistentry>
409
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> path to configuration file or <literal>NULL</literal> if none was found.  The 
 
412
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> path to configuration file or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if none was found.  The 
410
413
         returned string must be freed using <link linkend="g-free"><function>g_free()</function></link>.
411
414
 
412
415
See also: <link linkend="xfce-panel-plugin-save-location"><function>xfce_panel_plugin_save_location()</function></link>
413
416
</simpara></listitem></varlistentry>
414
417
</variablelist></refsect2>
415
418
<refsect2>
416
 
<title><anchor id="xfce-panel-plugin-save-location"/>xfce_panel_plugin_save_location ()</title>
 
419
<title><anchor id="xfce-panel-plugin-save-location" role="function"/>xfce_panel_plugin_save_location ()</title>
417
420
<indexterm><primary>xfce_panel_plugin_save_location</primary></indexterm><programlisting><link linkend="char">char</link>*       xfce_panel_plugin_save_location (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
418
421
                                             <link linkend="gboolean">gboolean</link> create);</programlisting>
419
422
<para>
428
431
<varlistentry><term><parameter>create</parameter>&nbsp;:</term>
429
432
<listitem><simpara> whether the file should be created
430
433
</simpara></listitem></varlistentry>
431
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> path to configuration file or <literal>NULL</literal> is the file could not be
 
434
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> path to configuration file or <link linkend="NULL:CAPS"><literal>NULL</literal></link> is the file could not be
432
435
         created. The returned string must be freed using <link linkend="g-free"><function>g_free()</function></link>.
433
436
 
434
437
See also: <link linkend="xfce-panel-plugin-lookup-rc-file"><function>xfce_panel_plugin_lookup_rc_file()</function></link> 
436
439
</variablelist></refsect2>
437
440
 
438
441
</refsect1>
439
 
<refsect1>
440
 
<title>Properties</title>
 
442
<refsect1 id="property_details">
 
443
<title id="property_details.title">Property Details</title>
441
444
<refsect2><title><anchor id="XfcePanelPlugin--display-name"/>The &quot;<literal>display-name</literal>&quot; property</title>
442
 
<programlisting>  &quot;display-name&quot;         <link linkend="gchararray">gchararray</link>            : Read</programlisting>
 
445
<indexterm><primary>XfcePanelPlugin:display-name</primary></indexterm><programlisting>  &quot;display-name&quot;         <link linkend="gchararray">gchararray</link>            : Read</programlisting>
443
446
<para>
444
447
Translated plugin name. This is the name that can be presented to
445
448
the user, e.g. in dialogs or menus.</para>
448
451
</para><para>Default value: NULL</para>
449
452
</refsect2>
450
453
<refsect2><title><anchor id="XfcePanelPlugin--expand"/>The &quot;<literal>expand</literal>&quot; property</title>
451
 
<programlisting>  &quot;expand&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
454
<indexterm><primary>XfcePanelPlugin:expand</primary></indexterm><programlisting>  &quot;expand&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
452
455
<para>
453
456
Whether to expand the plugin when the panel width increases.</para>
454
457
<para>
456
459
</para><para>Default value: FALSE</para>
457
460
</refsect2>
458
461
<refsect2><title><anchor id="XfcePanelPlugin--id"/>The &quot;<literal>id</literal>&quot; property</title>
459
 
<programlisting>  &quot;id&quot;                   <link linkend="gchararray">gchararray</link>            : Read</programlisting>
 
462
<indexterm><primary>XfcePanelPlugin:id</primary></indexterm><programlisting>  &quot;id&quot;                   <link linkend="gchararray">gchararray</link>            : Read</programlisting>
460
463
<para>
461
464
Unique identifier string created for every <link linkend="XfcePanelPlugin"><type>XfcePanelPlugin</type></link> instance.</para>
462
465
<para>
464
467
</para><para>Default value: NULL</para>
465
468
</refsect2>
466
469
<refsect2><title><anchor id="XfcePanelPlugin--name"/>The &quot;<literal>name</literal>&quot; property</title>
467
 
<programlisting>  &quot;name&quot;                 <link linkend="gchararray">gchararray</link>            : Read</programlisting>
 
470
<indexterm><primary>XfcePanelPlugin:name</primary></indexterm><programlisting>  &quot;name&quot;                 <link linkend="gchararray">gchararray</link>            : Read</programlisting>
468
471
<para>
469
472
Untranslated plugin name. This identifies the plugin type and 
470
473
therefore has to be unique.</para>
473
476
</para><para>Default value: NULL</para>
474
477
</refsect2>
475
478
<refsect2><title><anchor id="XfcePanelPlugin--screen-position"/>The &quot;<literal>screen-position</literal>&quot; property</title>
476
 
<programlisting>  &quot;screen-position&quot;      <link linkend="XfceScreenPosition">XfceScreenPosition</link>    : Read</programlisting>
 
479
<indexterm><primary>XfcePanelPlugin:screen-position</primary></indexterm><programlisting>  &quot;screen-position&quot;      <link linkend="XfceScreenPosition">XfceScreenPosition</link>    : Read</programlisting>
477
480
<para>
478
481
The current <link linkend="XfceScreenPosition"><type>XfceScreenPosition</type></link> of the panel.</para>
479
482
<para>
481
484
</para><para>Default value: XFCE_SCREEN_POSITION_S</para>
482
485
</refsect2>
483
486
<refsect2><title><anchor id="XfcePanelPlugin--size"/>The &quot;<literal>size</literal>&quot; property</title>
484
 
<programlisting>  &quot;size&quot;                 <link linkend="gint">gint</link>                  : Read</programlisting>
 
487
<indexterm><primary>XfcePanelPlugin:size</primary></indexterm><programlisting>  &quot;size&quot;                 <link linkend="gint">gint</link>                  : Read</programlisting>
485
488
<para>
486
489
The current panel size.</para>
487
490
<para>
492
495
 
493
496
</refsect1>
494
497
 
495
 
<refsect1>
496
 
<title>Signals</title>
 
498
<refsect1 id="signals">
 
499
<title id="signals.title">Signal Details</title>
497
500
<refsect2><title><anchor id="XfcePanelPlugin-about"/>The &quot;about&quot; signal</title>
498
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
499
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
501
<indexterm><primary>XfcePanelPlugin::about</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
 
502
                                            <link linkend="gpointer">gpointer</link>         user_data)      : Run last / No recursion / No hooks</programlisting>
500
503
<para>
501
504
Emitted when the 'About' menu item is clicked. Plugin writers 
502
505
should connect to this signal to show information about their
513
516
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
514
517
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
515
518
</variablelist></refsect2><refsect2><title><anchor id="XfcePanelPlugin-configure-plugin"/>The &quot;configure-plugin&quot; signal</title>
516
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
517
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
519
<indexterm><primary>XfcePanelPlugin::configure-plugin</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
 
520
                                            <link linkend="gpointer">gpointer</link>         user_data)      : Run last / No recursion / No hooks</programlisting>
518
521
<para>
519
522
Emitted when the 'Configure' menu item is clicked. Plugin writers 
520
523
should connect to this signal to show a settings dialog.
530
533
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
531
534
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
532
535
</variablelist></refsect2><refsect2><title><anchor id="XfcePanelPlugin-free-data"/>The &quot;free-data&quot; signal</title>
533
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
534
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
536
<indexterm><primary>XfcePanelPlugin::free-data</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
 
537
                                            <link linkend="gpointer">gpointer</link>         user_data)      : Run last / No recursion / No hooks</programlisting>
535
538
<para>
536
539
Emitted when the panel is closing. Plugin writers should connect to
537
540
this signal to free any allocated resources.
538
541
</para>
539
542
<para>
540
 
See also: <link linkend="XfcePanelPlugin"><type>XfcePanelPlugin</type></link>::save</para>
 
543
See also: <link linkend="XfcePanelPlugin-save"><type>XfcePanelPlugin::save</type></link></para>
541
544
<para>
542
545
 
543
546
</para><variablelist role="params">
547
550
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
548
551
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
549
552
</variablelist></refsect2><refsect2><title><anchor id="XfcePanelPlugin-orientation-changed"/>The &quot;orientation-changed&quot; signal</title>
550
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
551
 
                                            <link linkend="GtkOrientation">GtkOrientation</link> orientation,
552
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
553
<indexterm><primary>XfcePanelPlugin::orientation-changed</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
 
554
                                            <link linkend="GtkOrientation">GtkOrientation</link>  *orientation,
 
555
                                            <link linkend="gpointer">gpointer</link>         user_data)        : Run last / No recursion / No hooks</programlisting>
553
556
<para>
554
557
Emitted when the panel orientation changes.</para>
555
558
<para>
564
567
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
565
568
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
566
569
</variablelist></refsect2><refsect2><title><anchor id="XfcePanelPlugin-save"/>The &quot;save&quot; signal</title>
567
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
568
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
570
<indexterm><primary>XfcePanelPlugin::save</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
 
571
                                            <link linkend="gpointer">gpointer</link>         user_data)      : Run last / No recursion / No hooks</programlisting>
569
572
<para>
570
573
Emitted before the panel is closing. May be called more than once
571
574
while the panel is running. Plugin writers should connect to
582
585
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
583
586
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
584
587
</variablelist></refsect2><refsect2><title><anchor id="XfcePanelPlugin-screen-position-changed"/>The &quot;screen-position-changed&quot; signal</title>
585
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
586
 
                                            <link linkend="XfceScreenPosition">XfceScreenPosition</link> position,
587
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
588
<indexterm><primary>XfcePanelPlugin::screen-position-changed</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link>    *plugin,
 
589
                                            <link linkend="XfceScreenPosition">XfceScreenPosition</link> *position,
 
590
                                            <link linkend="gpointer">gpointer</link>            user_data)      : Run last / No recursion / No hooks</programlisting>
588
591
<para>
589
592
Emitted when the screen position changes. Most plugins will be
590
593
more interested in the "orientation-changed" signal.</para>
600
603
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
601
604
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
602
605
</variablelist></refsect2><refsect2><title><anchor id="XfcePanelPlugin-size-changed"/>The &quot;size-changed&quot; signal</title>
603
 
<programlisting><link linkend="gboolean">gboolean</link>    user_function                  (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
604
 
                                            <link linkend="gint">gint</link> size,
605
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
606
<indexterm><primary>XfcePanelPlugin::size-changed</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    user_function                  (<link linkend="XfcePanelPlugin">XfcePanelPlugin</link> *plugin,
 
607
                                            <link linkend="gint">gint</link>             size,
 
608
                                            <link linkend="gpointer">gpointer</link>         user_data)      : Run last / No recursion / No hooks</programlisting>
606
609
<para>
607
610
Emitted when the panel size changes.</para>
608
611
<para>
616
619
</simpara></listitem></varlistentry>
617
620
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
618
621
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
619
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> when handled, <literal>FALSE</literal> otherwise.
 
622
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> when handled, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
620
623
</simpara></listitem></varlistentry>
621
624
</variablelist></refsect2>
622
625
</refsect1>