1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="XfcePanelWindow">
<refmeta>
<refentrytitle>XfcePanelWindow</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBXFCE4PANEL Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>XfcePanelWindow</refname><refpurpose><para>
A toplevel borderless window with optional move handles.
</para></refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="XfcePanelWindow-struct">XfcePanelWindow</link>;
enum <link linkend="XfceHandleStyle">XfceHandleStyle</link>;
<link linkend="void">void</link> (<link linkend="XfcePanelWindowMoveFunc">*XfcePanelWindowMoveFunc</link>) (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="gpointer">gpointer</link> data,
<link linkend="int">int</link> *x,
<link linkend="int">int</link> *y);
<link linkend="void">void</link> (<link linkend="XfcePanelWindowResizeFunc">*XfcePanelWindowResizeFunc</link>) (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="gpointer">gpointer</link> data,
<link linkend="GtkAllocation">GtkAllocation</link> *previous,
<link linkend="GtkAllocation">GtkAllocation</link> *allocation,
<link linkend="int">int</link> *x,
<link linkend="int">int</link> *y);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="xfce-panel-window-new">xfce_panel_window_new</link> (void);
<link linkend="void">void</link> <link linkend="xfce-panel-window-set-orientation">xfce_panel_window_set_orientation</link>
(<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="GtkOrientation">GtkOrientation</link> orientation);
<link linkend="GtkOrientation">GtkOrientation</link> <link linkend="xfce-panel-window-get-orientation">xfce_panel_window_get_orientation</link>
(<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window);
<link linkend="void">void</link> <link linkend="xfce-panel-window-set-handle-style">xfce_panel_window_set_handle_style</link>
(<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="XfceHandleStyle">XfceHandleStyle</link> handle_style);
<link linkend="XfceHandleStyle">XfceHandleStyle</link> <link linkend="xfce-panel-window-get-handle-style">xfce_panel_window_get_handle_style</link>
(<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window);
<link linkend="void">void</link> <link linkend="xfce-panel-window-set-show-border">xfce_panel_window_set_show_border</link>
(<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="gboolean">gboolean</link> top_border,
<link linkend="gboolean">gboolean</link> bottom_border,
<link linkend="gboolean">gboolean</link> left_border,
<link linkend="gboolean">gboolean</link> right_border);
<link linkend="void">void</link> <link linkend="xfce-panel-window-get-show-border">xfce_panel_window_get_show_border</link>
(<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="gboolean">gboolean</link> *top_border,
<link linkend="gboolean">gboolean</link> *bottom_border,
<link linkend="gboolean">gboolean</link> *left_border,
<link linkend="gboolean">gboolean</link> *right_border);
<link linkend="void">void</link> <link linkend="xfce-panel-window-set-resize-function">xfce_panel_window_set_resize_function</link>
(<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="XfcePanelWindowResizeFunc">XfcePanelWindowResizeFunc</link> function,
<link linkend="gpointer">gpointer</link> data);
<link linkend="void">void</link> <link linkend="xfce-panel-window-set-move-function">xfce_panel_window_set_move_function</link>
(<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="XfcePanelWindowMoveFunc">XfcePanelWindowMoveFunc</link> function,
<link linkend="gpointer">gpointer</link> data);
<link linkend="void">void</link> <link linkend="xfce-panel-window-set-movable">xfce_panel_window_set_movable</link> (<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="gboolean">gboolean</link> movable);
<link linkend="gboolean">gboolean</link> <link linkend="xfce-panel-window-get-movable">xfce_panel_window_get_movable</link> (<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBin">GtkBin</link>
+----<link linkend="GtkWindow">GtkWindow</link>
+----XfcePanelWindow
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
XfcePanelWindow implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
</refsect1>
<refsect1>
<title>Properties</title>
<synopsis>
"<link linkend="XfcePanelWindow--handle-style">handle-style</link>" <link linkend="XfceHandleStyle">XfceHandleStyle</link> : Read / Write
"<link linkend="XfcePanelWindow--orientation">orientation</link>" <link linkend="GtkOrientation">GtkOrientation</link> : Read / Write
</synopsis>
</refsect1>
<refsect1>
<title>Signal Prototypes</title>
<synopsis>
"<link linkend="XfcePanelWindow-move">move</link>" <link linkend="void">void</link> user_function (<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="gint">gint</link> x,
<link linkend="gint">gint</link> y,
<link linkend="gpointer">gpointer</link> user_data);
"<link linkend="XfcePanelWindow-move-end">move-end</link>" <link linkend="void">void</link> user_function (<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="gint">gint</link> x,
<link linkend="gint">gint</link> y,
<link linkend="gpointer">gpointer</link> user_data);
"<link linkend="XfcePanelWindow-move-start">move-start</link>"
<link linkend="void">void</link> user_function (<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="gpointer">gpointer</link> user_data);
"<link linkend="XfcePanelWindow-orientation-changed">orientation-changed</link>"
<link linkend="void">void</link> user_function (<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="GtkOrientation">GtkOrientation</link> orientation,
<link linkend="gpointer">gpointer</link> user_data);
</synopsis>
</refsect1>
<refsect1>
<title>Description</title>
<para>
A widget derived from <link linkend="GtkWindow"><type>GtkWindow</type></link> that implements a toplevel window for panels.
It optionally can have one or two move handles.
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="XfcePanelWindow-struct"/>XfcePanelWindow</title>
<indexterm><primary>XfcePanelWindow</primary></indexterm><programlisting>typedef struct _XfcePanelWindow XfcePanelWindow;</programlisting>
<para>
The <link linkend="XfcePanelWindow-struct"><type>XfcePanelWindow-struct</type></link> struct contains private data only, and
should be accessed using the functions below.
</para></refsect2>
<refsect2>
<title><anchor id="XfceHandleStyle"/>enum XfceHandleStyle</title>
<indexterm><primary>XfceHandleStyle</primary></indexterm><programlisting>typedef enum /*<enum,prefix=XFCE_HANDLE_STYLE >*/
{
XFCE_HANDLE_STYLE_NONE,
XFCE_HANDLE_STYLE_BOTH,
XFCE_HANDLE_STYLE_START,
XFCE_HANDLE_STYLE_END
}
XfceHandleStyle;
</programlisting>
<para>
Style of the handles on an <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link>.</para>
<para>
</para><variablelist role="enum">
<varlistentry>
<term><literal>XFCE_HANDLE_STYLE_NONE</literal></term>
<listitem><simpara> No handles.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>XFCE_HANDLE_STYLE_BOTH</literal></term>
<listitem><simpara> Two handles, one on each side.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>XFCE_HANDLE_STYLE_START</literal></term>
<listitem><simpara> One handle at the start.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>XFCE_HANDLE_STYLE_END</literal></term>
<listitem><simpara> One handle at the end.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="XfcePanelWindowMoveFunc"/>XfcePanelWindowMoveFunc ()</title>
<indexterm><primary>XfcePanelWindowMoveFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*XfcePanelWindowMoveFunc) (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="gpointer">gpointer</link> data,
<link linkend="int">int</link> *x,
<link linkend="int">int</link> *y);</programlisting>
<para>
Callback function that can be used to restrict manual movement of the
<link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link>. The function should modify <parameter>x</parameter> and <parameter>y</parameter> to set the new
position.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> The <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> user data supplied with the function
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter> :</term>
<listitem><simpara> location of the new x coordinate
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter> :</term>
<listitem><simpara> location of the new y coordinate
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="XfcePanelWindowResizeFunc"/>XfcePanelWindowResizeFunc ()</title>
<indexterm><primary>XfcePanelWindowResizeFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*XfcePanelWindowResizeFunc) (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="gpointer">gpointer</link> data,
<link linkend="GtkAllocation">GtkAllocation</link> *previous,
<link linkend="GtkAllocation">GtkAllocation</link> *allocation,
<link linkend="int">int</link> *x,
<link linkend="int">int</link> *y);</programlisting>
<para>
Callback function that can be used to adjust the position of the
<link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link> when its size changes. The function should modify <parameter>x</parameter>
and <parameter>y</parameter> to set the new position.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> The <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> user data supplied with the function
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>previous</parameter> :</term>
<listitem><simpara> Old <link linkend="GtkAllocation"><type>GtkAllocation</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>allocation</parameter> :</term>
<listitem><simpara> New <link linkend="GtkAllocation"><type>GtkAllocation</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter> :</term>
<listitem><simpara> location of the new x coordinate
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter> :</term>
<listitem><simpara> location of the new y coordinate
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="xfce-panel-window-new"/>xfce_panel_window_new ()</title>
<indexterm><primary>xfce_panel_window_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* xfce_panel_window_new (void);</programlisting>
<para>
Create new panel window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> New <link linkend="GtkWidget"><type>GtkWidget</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="xfce-panel-window-set-orientation"/>xfce_panel_window_set_orientation ()</title>
<indexterm><primary>xfce_panel_window_set_orientation</primary></indexterm><programlisting><link linkend="void">void</link> xfce_panel_window_set_orientation
(<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="GtkOrientation">GtkOrientation</link> orientation);</programlisting>
<para>
Set orientation for panel window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter> :</term>
<listitem><simpara> <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>orientation</parameter> :</term>
<listitem><simpara> new <link linkend="GtkOrientation"><type>GtkOrientation</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="xfce-panel-window-get-orientation"/>xfce_panel_window_get_orientation ()</title>
<indexterm><primary>xfce_panel_window_get_orientation</primary></indexterm><programlisting><link linkend="GtkOrientation">GtkOrientation</link> xfce_panel_window_get_orientation
(<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window);</programlisting>
<para>
Get orientation of panel window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter> :</term>
<listitem><simpara> <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="GtkOrientation"><type>GtkOrientation</type></link> of <parameter>window</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="xfce-panel-window-set-handle-style"/>xfce_panel_window_set_handle_style ()</title>
<indexterm><primary>xfce_panel_window_set_handle_style</primary></indexterm><programlisting><link linkend="void">void</link> xfce_panel_window_set_handle_style
(<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="XfceHandleStyle">XfceHandleStyle</link> handle_style);</programlisting>
<para>
Set handle style for panel window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter> :</term>
<listitem><simpara> <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>handle_style</parameter> :</term>
<listitem><simpara> new <link linkend="XfceHandleStyle"><type>XfceHandleStyle</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="xfce-panel-window-get-handle-style"/>xfce_panel_window_get_handle_style ()</title>
<indexterm><primary>xfce_panel_window_get_handle_style</primary></indexterm><programlisting><link linkend="XfceHandleStyle">XfceHandleStyle</link> xfce_panel_window_get_handle_style
(<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window);</programlisting>
<para>
Get handle style of panel window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter> :</term>
<listitem><simpara> <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="XfceHandleStyle"><type>XfceHandleStyle</type></link> of <parameter>window</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="xfce-panel-window-set-show-border"/>xfce_panel_window_set_show_border ()</title>
<indexterm><primary>xfce_panel_window_set_show_border</primary></indexterm><programlisting><link linkend="void">void</link> xfce_panel_window_set_show_border
(<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="gboolean">gboolean</link> top_border,
<link linkend="gboolean">gboolean</link> bottom_border,
<link linkend="gboolean">gboolean</link> left_border,
<link linkend="gboolean">gboolean</link> right_border);</programlisting>
<para>
Set border visibility for the panel window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter> :</term>
<listitem><simpara> <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>top_border</parameter> :</term>
<listitem><simpara> show top border
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>bottom_border</parameter> :</term>
<listitem><simpara> show bottom border
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>left_border</parameter> :</term>
<listitem><simpara> show left border
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>right_border</parameter> :</term>
<listitem><simpara> show right border
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="xfce-panel-window-get-show-border"/>xfce_panel_window_get_show_border ()</title>
<indexterm><primary>xfce_panel_window_get_show_border</primary></indexterm><programlisting><link linkend="void">void</link> xfce_panel_window_get_show_border
(<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="gboolean">gboolean</link> *top_border,
<link linkend="gboolean">gboolean</link> *bottom_border,
<link linkend="gboolean">gboolean</link> *left_border,
<link linkend="gboolean">gboolean</link> *right_border);</programlisting>
<para>
Get visibility of panel window borders.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter> :</term>
<listitem><simpara> <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>top_border</parameter> :</term>
<listitem><simpara> location for top border or <literal>NULL</literal>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>bottom_border</parameter> :</term>
<listitem><simpara> location for bottom border or <literal>NULL</literal>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>left_border</parameter> :</term>
<listitem><simpara> location for left border or <literal>NULL</literal>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>right_border</parameter> :</term>
<listitem><simpara> location for right border or <literal>NULL</literal>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="xfce-panel-window-set-resize-function"/>xfce_panel_window_set_resize_function ()</title>
<indexterm><primary>xfce_panel_window_set_resize_function</primary></indexterm><programlisting><link linkend="void">void</link> xfce_panel_window_set_resize_function
(<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="XfcePanelWindowResizeFunc">XfcePanelWindowResizeFunc</link> function,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Set a function to modify resize behaviour of the panel window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter> :</term>
<listitem><simpara> <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>function</parameter> :</term>
<listitem><simpara> <link linkend="XfcePanelWindowResizeFunc"><type>XfcePanelWindowResizeFunc</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> user data
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="xfce-panel-window-set-move-function"/>xfce_panel_window_set_move_function ()</title>
<indexterm><primary>xfce_panel_window_set_move_function</primary></indexterm><programlisting><link linkend="void">void</link> xfce_panel_window_set_move_function
(<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="XfcePanelWindowMoveFunc">XfcePanelWindowMoveFunc</link> function,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Set a function to modify move behaviour of the panel window.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter> :</term>
<listitem><simpara> <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>function</parameter> :</term>
<listitem><simpara> <link linkend="XfcePanelWindowMoveFunc"><type>XfcePanelWindowMoveFunc</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> user data
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="xfce-panel-window-set-movable"/>xfce_panel_window_set_movable ()</title>
<indexterm><primary>xfce_panel_window_set_movable</primary></indexterm><programlisting><link linkend="void">void</link> xfce_panel_window_set_movable (<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="gboolean">gboolean</link> movable);</programlisting>
<para>
Set if the panel window can be moved by the user.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter> :</term>
<listitem><simpara> <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>movable</parameter> :</term>
<listitem><simpara> <literal>TRUE</literal> or <literal>FALSE</literal>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="xfce-panel-window-get-movable"/>xfce_panel_window_get_movable ()</title>
<indexterm><primary>xfce_panel_window_get_movable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> xfce_panel_window_get_movable (<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window);</programlisting>
<para>
Check if the panel window can be moved by the user.
By default this is <literal>TRUE</literal>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter> :</term>
<listitem><simpara> <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if the user is allowed to move <parameter>window</parameter>, <literal>FALSE</literal> if not.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1>
<title>Properties</title>
<refsect2><title><anchor id="XfcePanelWindow--handle-style"/>The "<literal>handle-style</literal>" property</title>
<programlisting> "handle-style" <link linkend="XfceHandleStyle">XfceHandleStyle</link> : Read / Write</programlisting>
<para>
The <link linkend="XfceHandleStyle"><type>XfceHandleStyle</type></link> to use when drawing handles.</para>
<para>
</para><para>Default value: XFCE_HANDLE_STYLE_BOTH</para>
</refsect2>
<refsect2><title><anchor id="XfcePanelWindow--orientation"/>The "<literal>orientation</literal>" property</title>
<programlisting> "orientation" <link linkend="GtkOrientation">GtkOrientation</link> : Read / Write</programlisting>
<para>
The orientation of the window. This the determines the way the handles
are drawn.</para>
<para>
</para><para>Default value: GTK_ORIENTATION_HORIZONTAL</para>
</refsect2>
</refsect1>
<refsect1>
<title>Signals</title>
<refsect2><title><anchor id="XfcePanelWindow-move"/>The "move" signal</title>
<programlisting><link linkend="void">void</link> user_function (<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="gint">gint</link> x,
<link linkend="gint">gint</link> y,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Emitted when the user moves the <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link> to a new position with
coordinates (<parameter>x</parameter>, <parameter>y</parameter>).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter> :</term>
<listitem><simpara> the <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link> which emitted the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter> :</term>
<listitem><simpara> x coordinate of the new position
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter> :</term>
<listitem><simpara> y coordinate of the new position
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="XfcePanelWindow-move-end"/>The "move-end" signal</title>
<programlisting><link linkend="void">void</link> user_function (<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="gint">gint</link> x,
<link linkend="gint">gint</link> y,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Emitted when the user stops dragging the <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link>. The latest
position has coordinates (<parameter>x</parameter>, <parameter>y</parameter>).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter> :</term>
<listitem><simpara> the <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link> which emitted the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter> :</term>
<listitem><simpara> x coordinate of the new positions
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter> :</term>
<listitem><simpara> y coordinate of the new position
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="XfcePanelWindow-move-start"/>The "move-start" signal</title>
<programlisting><link linkend="void">void</link> user_function (<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Emitted when the user starts to drag the <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter> :</term>
<listitem><simpara> the <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link> which emitted the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="XfcePanelWindow-orientation-changed"/>The "orientation-changed" signal</title>
<programlisting><link linkend="void">void</link> user_function (<link linkend="XfcePanelWindow">XfcePanelWindow</link> *window,
<link linkend="GtkOrientation">GtkOrientation</link> orientation,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Emitted when the orientation of the <link linkend="XfcePanelWindow"><type>XfcePanelWindow</type></link> changes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter> :</term>
<listitem><simpara> the object which emitted the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>orientation</parameter> :</term>
<listitem><simpara> the new <link linkend="GtkOrientation"><type>GtkOrientation</type></link> of the window
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
