← Back to branch summary

~ubuntu-branches/ubuntu/precise/xfce4-panel/precise

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Lionel Le Folgoc
  • Date: 2010-12-04 15:45:53 UTC
  • mto: (4.1.3 experimental)
  • mto: This revision was merged to the branch mainline in revision 50.
  • Revision ID: james.westby@ubuntu.com-20101204154553-f452gq02eiksf09f
Tags: upstream-4.7.5
Import upstream version 4.7.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/API/tmpl/xfce-panel-plugin-iface.sgml
1
 
<!-- ##### SECTION Title ##### -->
2
 
XfcePanelPlugin
3
 
 
4
 
<!-- ##### SECTION Short_Description ##### -->
5
 
Panel plugin interface.
6
 
 
7
 
<!-- ##### SECTION Long_Description ##### -->
8
 
<para>
9
 
The interface implemented by both internal and external plugins. Plugin
10
 
writers may use the functions described below to interact with the plugin
11
 
widget.
12
 
</para>
13
 
 
14
 
<!-- ##### SECTION See_Also ##### -->
15
 
<para>
16
 
<link linkend="libxfce4panel-Register-Plugins">Register Plugins</link>
17
 
</para>
18
 
 
19
 
<!-- ##### SECTION Stability_Level ##### -->
20
 
 
21
 
 
22
 
<!-- ##### SECTION Image ##### -->
23
 
 
24
 
 
25
 
<!-- ##### STRUCT XfcePanelPlugin ##### -->
26
 
<para>
27
 
The #XfcePanelPlugin-struct is a purely virtual object to describe an instance
28
 
of a widget implementing the panel plugin interface.
29
 
</para>
30
 
 
31
 
 
32
 
<!-- ##### SIGNAL XfcePanelPlugin::about ##### -->
33
 
<para>
34
 
 
35
 
</para>
36
 
 
37
 
@xfcepanelplugin: the object which received the signal.
38
 
 
39
 
<!-- ##### SIGNAL XfcePanelPlugin::configure-plugin ##### -->
40
 
<para>
41
 
 
42
 
</para>
43
 
 
44
 
@xfcepanelplugin: the object which received the signal.
45
 
 
46
 
<!-- ##### SIGNAL XfcePanelPlugin::free-data ##### -->
47
 
<para>
48
 
 
49
 
</para>
50
 
 
51
 
@xfcepanelplugin: the object which received the signal.
52
 
 
53
 
<!-- ##### SIGNAL XfcePanelPlugin::orientation-changed ##### -->
54
 
<para>
55
 
 
56
 
</para>
57
 
 
58
 
@xfcepanelplugin: the object which received the signal.
59
 
@arg1: 
60
 
 
61
 
<!-- ##### SIGNAL XfcePanelPlugin::save ##### -->
62
 
<para>
63
 
 
64
 
</para>
65
 
 
66
 
@xfcepanelplugin: the object which received the signal.
67
 
 
68
 
<!-- ##### SIGNAL XfcePanelPlugin::screen-position-changed ##### -->
69
 
<para>
70
 
 
71
 
</para>
72
 
 
73
 
@xfcepanelplugin: the object which received the signal.
74
 
@arg1: 
75
 
 
76
 
<!-- ##### SIGNAL XfcePanelPlugin::size-changed ##### -->
77
 
<para>
78
 
 
79
 
</para>
80
 
 
81
 
@xfcepanelplugin: the object which received the signal.
82
 
@arg1: 
83
 
@Returns: 
84
 
 
85
 
<!-- ##### ARG XfcePanelPlugin:display-name ##### -->
86
 
<para>
87
 
 
88
 
</para>
89
 
 
90
 
<!-- ##### ARG XfcePanelPlugin:expand ##### -->
91
 
<para>
92
 
 
93
 
</para>
94
 
 
95
 
<!-- ##### ARG XfcePanelPlugin:id ##### -->
96
 
<para>
97
 
 
98
 
</para>
99
 
 
100
 
<!-- ##### ARG XfcePanelPlugin:name ##### -->
101
 
<para>
102
 
 
103
 
</para>
104
 
 
105
 
<!-- ##### ARG XfcePanelPlugin:screen-position ##### -->
106
 
<para>
107
 
 
108
 
</para>
109
 
 
110
 
<!-- ##### ARG XfcePanelPlugin:size ##### -->
111
 
<para>
112
 
 
113
 
</para>
114
 
 
115
 
<!-- ##### USER_FUNCTION XfcePanelPluginFunc ##### -->
116
 
<para>
117
 
 
118
 
</para>
119
 
 
120
 
@plugin: 
121
 
 
122
 
 
123
 
<!-- ##### USER_FUNCTION XfcePanelPluginCheck ##### -->
124
 
<para>
125
 
 
126
 
</para>
127
 
 
128
 
@screen: 
129
 
@Returns: 
130
 
 
131
 
 
132
 
<!-- ##### USER_FUNCTION XfcePanelPluginPreInit ##### -->
133
 
<para>
134
 
 
135
 
</para>
136
 
 
137
 
@argc: 
138
 
@argv: 
139
 
@Returns: 
140
 
 
141
 
 
142
 
<!-- ##### FUNCTION xfce_panel_plugin_get_name ##### -->
143
 
<para>
144
 
 
145
 
</para>
146
 
 
147
 
@plugin: 
148
 
@Returns: 
149
 
 
150
 
 
151
 
<!-- ##### FUNCTION xfce_panel_plugin_get_id ##### -->
152
 
<para>
153
 
 
154
 
</para>
155
 
 
156
 
@plugin: 
157
 
@Returns: 
158
 
 
159
 
 
160
 
<!-- ##### FUNCTION xfce_panel_plugin_get_display_name ##### -->
161
 
<para>
162
 
 
163
 
</para>
164
 
 
165
 
@plugin: 
166
 
@Returns: 
167
 
 
168
 
 
169
 
<!-- ##### FUNCTION xfce_panel_plugin_get_size ##### -->
170
 
<para>
171
 
 
172
 
</para>
173
 
 
174
 
@plugin: 
175
 
@Returns: 
176
 
 
177
 
 
178
 
<!-- ##### FUNCTION xfce_panel_plugin_get_screen_position ##### -->
179
 
<para>
180
 
 
181
 
</para>
182
 
 
183
 
@plugin: 
184
 
@Returns: 
185
 
 
186
 
 
187
 
<!-- ##### FUNCTION xfce_panel_plugin_set_expand ##### -->
188
 
<para>
189
 
 
190
 
</para>
191
 
 
192
 
@plugin: 
193
 
@expand: 
194
 
 
195
 
 
196
 
<!-- ##### FUNCTION xfce_panel_plugin_get_expand ##### -->
197
 
<para>
198
 
 
199
 
</para>
200
 
 
201
 
@plugin: 
202
 
@Returns: 
203
 
 
204
 
 
205
 
<!-- ##### FUNCTION xfce_panel_plugin_get_orientation ##### -->
206
 
<para>
207
 
 
208
 
</para>
209
 
 
210
 
@plugin: 
211
 
@Returns: 
212
 
 
213
 
 
214
 
<!-- ##### FUNCTION xfce_panel_plugin_add_action_widget ##### -->
215
 
<para>
216
 
 
217
 
</para>
218
 
 
219
 
@plugin: 
220
 
@widget: 
221
 
 
222
 
 
223
 
<!-- ##### FUNCTION xfce_panel_plugin_menu_insert_item ##### -->
224
 
<para>
225
 
 
226
 
</para>
227
 
 
228
 
@plugin: 
229
 
@item: 
230
 
 
231
 
 
232
 
<!-- ##### FUNCTION xfce_panel_plugin_menu_show_about ##### -->
233
 
<para>
234
 
 
235
 
</para>
236
 
 
237
 
@plugin: 
238
 
 
239
 
 
240
 
<!-- ##### FUNCTION xfce_panel_plugin_menu_show_configure ##### -->
241
 
<para>
242
 
 
243
 
</para>
244
 
 
245
 
@plugin: 
246
 
 
247
 
 
248
 
<!-- ##### FUNCTION xfce_panel_plugin_block_menu ##### -->
249
 
<para>
250
 
 
251
 
</para>
252
 
 
253
 
@plugin: 
254
 
 
255
 
 
256
 
<!-- ##### FUNCTION xfce_panel_plugin_unblock_menu ##### -->
257
 
<para>
258
 
 
259
 
</para>
260
 
 
261
 
@plugin: 
262
 
 
263
 
 
264
 
<!-- ##### FUNCTION xfce_panel_plugin_register_menu ##### -->
265
 
<para>
266
 
 
267
 
</para>
268
 
 
269
 
@plugin: 
270
 
@menu: 
271
 
 
272
 
 
273
 
<!-- ##### FUNCTION xfce_panel_plugin_lookup_rc_file ##### -->
274
 
<para>
275
 
 
276
 
</para>
277
 
 
278
 
@plugin: 
279
 
@Returns: 
280
 
 
281
 
 
282
 
<!-- ##### FUNCTION xfce_panel_plugin_save_location ##### -->
283
 
<para>
284
 
 
285
 
</para>
286
 
 
287
 
@plugin: 
288
 
@create: 
289
 
@Returns: 
290
 
 
291
 
 
292
 
<!-- ##### FUNCTION xfce_panel_plugin_focus_widget ##### -->
293
 
<para>
294
 
 
295
 
</para>
296
 
 
297
 
@plugin: 
298
 
@widget: 
299
 
 
300
 
 
301
 
<!-- ##### FUNCTION xfce_panel_plugin_set_panel_hidden ##### -->
302
 
<para>
303
 
 
304
 
</para>
305
 
 
306
 
@plugin: 
307
 
@hidden: 
308
 
 
309