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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>WnckWorkspace</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Libwnck Reference Manual">
<link rel="up" href="core.html" title="Part II. Libwnck Core Window Management Support">
<link rel="prev" href="WnckApplication.html" title="WnckApplication">
<link rel="next" href="WnckScreen.html" title="WnckScreen">
<meta name="generator" content="GTK-Doc V1.17.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="WnckApplication.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="core.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Libwnck Reference Manual</th>
<td><a accesskey="n" href="WnckScreen.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#WnckWorkspace.synopsis" class="shortcut">Top</a>
|
<a href="#WnckWorkspace.description" class="shortcut">Description</a>
|
<a href="#WnckWorkspace.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#WnckWorkspace.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="WnckWorkspace"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="WnckWorkspace.top_of_page"></a>WnckWorkspace</span></h2>
<p>WnckWorkspace — an object representing a workspace.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="WnckWorkspace.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="WnckWorkspace.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libwnck/libwnck.h>
<a class="link" href="WnckWorkspace.html#WnckWorkspace-struct" title="WnckWorkspace">WnckWorkspace</a>;
<a class="link" href="WnckScreen.html" title="WnckScreen"><span class="returnvalue">WnckScreen</span></a> * <a class="link" href="WnckWorkspace.html#wnck-workspace-get-screen" title="wnck_workspace_get_screen ()">wnck_workspace_get_screen</a> (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);
<span class="returnvalue">int</span> <a class="link" href="WnckWorkspace.html#wnck-workspace-get-number" title="wnck_workspace_get_number ()">wnck_workspace_get_number</a> (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="WnckWorkspace.html#wnck-workspace-get-name" title="wnck_workspace_get_name ()">wnck_workspace_get_name</a> (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);
<span class="returnvalue">void</span> <a class="link" href="WnckWorkspace.html#wnck-workspace-change-name" title="wnck_workspace_change_name ()">wnck_workspace_change_name</a> (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
<span class="returnvalue">int</span> <a class="link" href="WnckWorkspace.html#wnck-workspace-get-width" title="wnck_workspace_get_width ()">wnck_workspace_get_width</a> (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);
<span class="returnvalue">int</span> <a class="link" href="WnckWorkspace.html#wnck-workspace-get-height" title="wnck_workspace_get_height ()">wnck_workspace_get_height</a> (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);
<span class="returnvalue">int</span> <a class="link" href="WnckWorkspace.html#wnck-workspace-get-viewport-x" title="wnck_workspace_get_viewport_x ()">wnck_workspace_get_viewport_x</a> (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);
<span class="returnvalue">int</span> <a class="link" href="WnckWorkspace.html#wnck-workspace-get-viewport-y" title="wnck_workspace_get_viewport_y ()">wnck_workspace_get_viewport_y</a> (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="WnckWorkspace.html#wnck-workspace-is-virtual" title="wnck_workspace_is_virtual ()">wnck_workspace_is_virtual</a> (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);
<span class="returnvalue">int</span> <a class="link" href="WnckWorkspace.html#wnck-workspace-get-layout-row" title="wnck_workspace_get_layout_row ()">wnck_workspace_get_layout_row</a> (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);
<span class="returnvalue">int</span> <a class="link" href="WnckWorkspace.html#wnck-workspace-get-layout-column" title="wnck_workspace_get_layout_column ()">wnck_workspace_get_layout_column</a> (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);
<a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="returnvalue">WnckWorkspace</span></a> * <a class="link" href="WnckWorkspace.html#wnck-workspace-get-neighbor" title="wnck_workspace_get_neighbor ()">wnck_workspace_get_neighbor</a> (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>,
<em class="parameter"><code><a class="link" href="WnckScreen.html#WnckMotionDirection" title="enum WnckMotionDirection"><span class="type">WnckMotionDirection</span></a> direction</code></em>);
<span class="returnvalue">void</span> <a class="link" href="WnckWorkspace.html#wnck-workspace-activate" title="wnck_workspace_activate ()">wnck_workspace_activate</a> (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> timestamp</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="WnckWorkspace.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----WnckWorkspace
</pre>
</div>
<div class="refsect1">
<a name="WnckWorkspace.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="WnckWorkspace.html#WnckWorkspace-name-changed" title='The "name-changed" signal'>name-changed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="WnckWorkspace.description"></a><h2>Description</h2>
<p>
The <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> represents what is called <a class="ulink" href="http://standards.freedesktop.org/wm-spec/wm-spec-latest.html#largedesks" target="_top">virtual
desktops</a> in the <a class="ulink" href="http://standards.freedesktop.org/wm-spec/wm-spec-latest.html" target="_top">EWMH</a>.
A workspace is a virtualization of a <a class="link" href="WnckScreen.html" title="WnckScreen"><span class="type">WnckScreen</span></a>: only one workspace
can be shown on a <a class="link" href="WnckScreen.html" title="WnckScreen"><span class="type">WnckScreen</span></a> at a time. It makes it possible, for example,
to put windows on different workspaces to organize them.
</p>
<p>
If the <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> size is bigger that the <a class="link" href="WnckScreen.html" title="WnckScreen"><span class="type">WnckScreen</span></a> size, the
workspace contains a viewport. Viewports are defined in the <a class="ulink" href="http://standards.freedesktop.org/wm-spec/wm-spec-latest.html#id2457064" target="_top">large
desktops</a> section of the <a class="ulink" href="http://standards.freedesktop.org/wm-spec/wm-spec-latest.html" target="_top">EWMH</a>.
The notion of workspaces and viewports are quite similar, and generally both
are not used at the same time: there are generally either multiple
workspaces with no viewport, or one workspace with a viewport. libwnck
supports all situations, even multiple workspaces with viewports.
</p>
<p>
Workspaces are organized according to a layout set on the <a class="link" href="WnckScreen.html" title="WnckScreen"><span class="type">WnckScreen</span></a>. See
<a class="link" href="WnckScreen.html#wnck-screen-try-set-workspace-layout" title="wnck_screen_try_set_workspace_layout ()"><code class="function">wnck_screen_try_set_workspace_layout()</code></a> and
<a class="link" href="WnckScreen.html#wnck-screen-release-workspace-layout" title="wnck_screen_release_workspace_layout ()"><code class="function">wnck_screen_release_workspace_layout()</code></a> for more information about the
layout.
</p>
<p>
The <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> objects are always owned by libwnck and must not be
referenced or unreferenced.
</p>
</div>
<div class="refsect1">
<a name="WnckWorkspace.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="WnckWorkspace-struct"></a><h3>WnckWorkspace</h3>
<pre class="programlisting">typedef struct _WnckWorkspace WnckWorkspace;</pre>
<p>
The <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> struct contains only private fields and should not be
directly accessed.
</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-workspace-get-screen"></a><h3>wnck_workspace_get_screen ()</h3>
<pre class="programlisting"><a class="link" href="WnckScreen.html" title="WnckScreen"><span class="returnvalue">WnckScreen</span></a> * wnck_workspace_get_screen (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);</pre>
<p>
Gets the <a class="link" href="WnckScreen.html" title="WnckScreen"><span class="type">WnckScreen</span></a> <em class="parameter"><code>space</code></em> is on.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>space</code></em> :</span></p></td>
<td>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="WnckScreen.html" title="WnckScreen"><span class="type">WnckScreen</span></a> <em class="parameter"><code>space</code></em> is on. The returned <a class="link" href="WnckScreen.html" title="WnckScreen"><span class="type">WnckScreen</span></a> is
owned by libwnck and must not be referenced or unreferenced.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="wnck-workspace-get-number"></a><h3>wnck_workspace_get_number ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> wnck_workspace_get_number (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);</pre>
<p>
Gets the index of <em class="parameter"><code>space</code></em> on the <a class="link" href="WnckScreen.html" title="WnckScreen"><span class="type">WnckScreen</span></a> to which it belongs. The
first workspace has an index of 0.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>space</code></em> :</span></p></td>
<td>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the index of <em class="parameter"><code>space</code></em> on its <a class="link" href="WnckScreen.html" title="WnckScreen"><span class="type">WnckScreen</span></a>, or -1 on errors.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="wnck-workspace-get-name"></a><h3>wnck_workspace_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * wnck_workspace_get_name (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);</pre>
<p>
Gets the human-readable name that should be used to refer to <em class="parameter"><code>space</code></em>. If
the user has not set a special name, a fallback like "Workspace 3" will be
used.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>space</code></em> :</span></p></td>
<td>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the name of <em class="parameter"><code>space</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="wnck-workspace-change-name"></a><h3>wnck_workspace_change_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> wnck_workspace_change_name (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
<p>
Changes the name of <em class="parameter"><code>space</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>space</code></em> :</span></p></td>
<td>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>new name for <em class="parameter"><code>space</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-workspace-get-width"></a><h3>wnck_workspace_get_width ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> wnck_workspace_get_width (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);</pre>
<p>
Gets the width of <em class="parameter"><code>space</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>space</code></em> :</span></p></td>
<td>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the width of <em class="parameter"><code>space</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-workspace-get-height"></a><h3>wnck_workspace_get_height ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> wnck_workspace_get_height (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);</pre>
<p>
Gets the height of <em class="parameter"><code>space</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>space</code></em> :</span></p></td>
<td>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the height of <em class="parameter"><code>space</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-workspace-get-viewport-x"></a><h3>wnck_workspace_get_viewport_x ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> wnck_workspace_get_viewport_x (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);</pre>
<p>
Gets the X coordinate of the viewport in <em class="parameter"><code>space</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>space</code></em> :</span></p></td>
<td>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the X coordinate of the viewport in <em class="parameter"><code>space</code></em>, or 0 if <em class="parameter"><code>space</code></em> does not
contain a viewport.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-workspace-get-viewport-y"></a><h3>wnck_workspace_get_viewport_y ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> wnck_workspace_get_viewport_y (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);</pre>
<p>
Gets the Y coordinate of the viewport in <em class="parameter"><code>space</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>space</code></em> :</span></p></td>
<td>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the Y coordinate of the viewport in <em class="parameter"><code>space</code></em>, or 0 if <em class="parameter"><code>space</code></em> does not
contain a viewport.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-workspace-is-virtual"></a><h3>wnck_workspace_is_virtual ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> wnck_workspace_is_virtual (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);</pre>
<p>
Gets whether <em class="parameter"><code>space</code></em> contains a viewport.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>space</code></em> :</span></p></td>
<td>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>space</code></em> contains a viewport, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-workspace-get-layout-row"></a><h3>wnck_workspace_get_layout_row ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> wnck_workspace_get_layout_row (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);</pre>
<p>
Gets the row of <em class="parameter"><code>space</code></em> in the <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> layout. The first row has an
index of 0 and is always the top row, regardless of the starting corner set
for the layout.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>space</code></em> :</span></p></td>
<td>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the row of <em class="parameter"><code>space</code></em> in the <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> layout, or -1 on
errors.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.20</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-workspace-get-layout-column"></a><h3>wnck_workspace_get_layout_column ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> wnck_workspace_get_layout_column (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>);</pre>
<p>
Gets the column of <em class="parameter"><code>space</code></em> in the <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> layout. The first column
has an index of 0 and is always the left column, regardless of the starting
corner set for the layout and regardless of the default direction of the
environment (i.e., in both Left-To-Right and Right-To-Left environments).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>space</code></em> :</span></p></td>
<td>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the column of <em class="parameter"><code>space</code></em> in the <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> layout, or -1 on
errors.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.20</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-workspace-get-neighbor"></a><h3>wnck_workspace_get_neighbor ()</h3>
<pre class="programlisting"><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="returnvalue">WnckWorkspace</span></a> * wnck_workspace_get_neighbor (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>,
<em class="parameter"><code><a class="link" href="WnckScreen.html#WnckMotionDirection" title="enum WnckMotionDirection"><span class="type">WnckMotionDirection</span></a> direction</code></em>);</pre>
<p>
Gets the neighbor <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> of <em class="parameter"><code>space</code></em> in the <em class="parameter"><code>direction</code></em> direction.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>space</code></em> :</span></p></td>
<td>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
<td>direction in which to search the neighbor.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the neighbor <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> of <em class="parameter"><code>space</code></em> in the <em class="parameter"><code>direction</code></em>
direction, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no such neighbor <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> exists. The returned
<a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> is owned by libwnck and must not be referenced or
unreferenced.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.20</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-workspace-activate"></a><h3>wnck_workspace_activate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> wnck_workspace_activate (<em class="parameter"><code><a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> timestamp</code></em>);</pre>
<p>
Asks the window manager to make <em class="parameter"><code>space</code></em> the active workspace. The window
manager may decide to refuse the request (to not steal the focus if there is
a more recent user activity, for example).
</p>
<p>
This function existed before 2.10, but the <em class="parameter"><code>timestamp</code></em> argument was missing
in earlier versions.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>space</code></em> :</span></p></td>
<td>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
<td>the X server timestamp of the user interaction event that caused
this call to occur.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10</p>
</div>
</div>
<div class="refsect1">
<a name="WnckWorkspace.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="WnckWorkspace-name-changed"></a><h3>The <code class="literal">"name-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> *space,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Emitted when the name of <em class="parameter"><code>space</code></em> changes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>space</code></em> :</span></p></td>
<td>the <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> which emitted the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="WnckWorkspace.see-also"></a><h2>See Also</h2>
<a class="link" href="WnckScreen.html" title="WnckScreen"><span class="type">WnckScreen</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17.1</div>
</body>
</html>
|
