libwnck-3-dev 3.24.1-2 / usr / share / gtk-doc / html / libwnck-3.0 / WnckWorkspace.html

This file is indexed.

/usr/share/gtk-doc/html/libwnck-3.0/WnckWorkspace.html is in libwnck-3-dev 3.24.1-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
<!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: Libwnck Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Libwnck Reference Manual">
<link rel="up" href="core.html" title="Part III. 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.25 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#WnckWorkspace.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#WnckWorkspace.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#WnckWorkspace.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="core.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="WnckApplication.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="WnckScreen.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></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 class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="WnckWorkspace.stability-level"></a><h2>Stability Level</h2>
<acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.

The Unstable interface level is a warning that these interfaces are  subject to
change without warning and should not be used in unbundled products.

Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="WnckWorkspace.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="WnckScreen.html" title="WnckScreen"><span class="returnvalue">WnckScreen</span></a> *
</td>
<td class="function_name">
<a class="link" href="WnckWorkspace.html#wnck-workspace-get-screen" title="wnck_workspace_get_screen ()">wnck_workspace_get_screen</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="WnckWorkspace.html#wnck-workspace-get-number" title="wnck_workspace_get_number ()">wnck_workspace_get_number</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="WnckWorkspace.html#wnck-workspace-get-name" title="wnck_workspace_get_name ()">wnck_workspace_get_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WnckWorkspace.html#wnck-workspace-change-name" title="wnck_workspace_change_name ()">wnck_workspace_change_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="WnckWorkspace.html#wnck-workspace-get-width" title="wnck_workspace_get_width ()">wnck_workspace_get_width</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="WnckWorkspace.html#wnck-workspace-get-height" title="wnck_workspace_get_height ()">wnck_workspace_get_height</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="WnckWorkspace.html#wnck-workspace-get-viewport-x" title="wnck_workspace_get_viewport_x ()">wnck_workspace_get_viewport_x</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="WnckWorkspace.html#wnck-workspace-get-viewport-y" title="wnck_workspace_get_viewport_y ()">wnck_workspace_get_viewport_y</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="WnckWorkspace.html#wnck-workspace-is-virtual" title="wnck_workspace_is_virtual ()">wnck_workspace_is_virtual</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="WnckWorkspace.html#wnck-workspace-get-layout-row" title="wnck_workspace_get_layout_row ()">wnck_workspace_get_layout_row</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="WnckWorkspace.html#wnck-workspace-get-layout-column" title="wnck_workspace_get_layout_column ()">wnck_workspace_get_layout_column</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="returnvalue">WnckWorkspace</span></a> *
</td>
<td class="function_name">
<a class="link" href="WnckWorkspace.html#wnck-workspace-get-neighbor" title="wnck_workspace_get_neighbor ()">wnck_workspace_get_neighbor</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WnckWorkspace.html#wnck-workspace-activate" title="wnck_workspace_activate ()">wnck_workspace_activate</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="WnckWorkspace.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="WnckWorkspace.html#WnckWorkspace-name-changed" title="The “name-changed” signal">name-changed</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="WnckWorkspace.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="WnckWorkspace.html#WnckWorkspace-struct" title="WnckWorkspace">WnckWorkspace</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="WnckWorkspace.html#WnckMotionDirection" title="enum WnckMotionDirection">WnckMotionDirection</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="WnckWorkspace.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> WnckWorkspace
</pre>
</div>
<div class="refsect1">
<a name="WnckWorkspace.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libwnck/libwnck.h&gt;
</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.functions_details"></a><h2>Functions</h2>
<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="refsect3">
<a name="wnck-workspace-get-screen.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>space</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="wnck-workspace-get-screen.returns"></a><h4>Returns</h4>
<p> 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. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</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="refsect3">
<a name="wnck-workspace-get-number.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>space</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="wnck-workspace-get-number.returns"></a><h4>Returns</h4>
<p> 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.</p>
</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="refsect3">
<a name="wnck-workspace-get-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>space</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="wnck-workspace-get-name.returns"></a><h4>Returns</h4>
<p> the name of <em class="parameter"><code>space</code></em>
.</p>
</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="refsect3">
<a name="wnck-workspace-change-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>space</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>new name for <em class="parameter"><code>space</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</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="refsect3">
<a name="wnck-workspace-get-width.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>space</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="wnck-workspace-get-width.returns"></a><h4>Returns</h4>
<p> the width of <em class="parameter"><code>space</code></em>
.</p>
</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="refsect3">
<a name="wnck-workspace-get-height.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>space</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="wnck-workspace-get-height.returns"></a><h4>Returns</h4>
<p> the height of <em class="parameter"><code>space</code></em>
.</p>
</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="refsect3">
<a name="wnck-workspace-get-viewport-x.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>space</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="wnck-workspace-get-viewport-x.returns"></a><h4>Returns</h4>
<p> 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.</p>
</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="refsect3">
<a name="wnck-workspace-get-viewport-y.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>space</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="wnck-workspace-get-viewport-y.returns"></a><h4>Returns</h4>
<p> 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.</p>
</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="/usr/share/gtk-doc/html/glib/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="refsect3">
<a name="wnck-workspace-is-virtual.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>space</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="wnck-workspace-is-virtual.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/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="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
</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="refsect3">
<a name="wnck-workspace-get-layout-row.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>space</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="wnck-workspace-get-layout-row.returns"></a><h4>Returns</h4>
<p> 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.</p>
</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="refsect3">
<a name="wnck-workspace-get-layout-column.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>space</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="wnck-workspace-get-layout-column.returns"></a><h4>Returns</h4>
<p> 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.</p>
</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="WnckWorkspace.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="refsect3">
<a name="wnck-workspace-get-neighbor.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>space</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>direction</p></td>
<td class="parameter_description"><p>direction in which to search the neighbor.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="wnck-workspace-get-neighbor.returns"></a><h4>Returns</h4>
<p> 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="/usr/share/gtk-doc/html/glib/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. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</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="/usr/share/gtk-doc/html/glib/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="refsect3">
<a name="wnck-workspace-activate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>space</p></td>
<td class="parameter_description"><p>a <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timestamp</p></td>
<td class="parameter_description"><p>the X server timestamp of the user interaction event that caused
this call to occur.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.10</p>
</div>
</div>
<div class="refsect1">
<a name="WnckWorkspace.other_details"></a><h2>Types and Values</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="WnckMotionDirection"></a><h3>enum WnckMotionDirection</h3>
<p>Type defining a direction in which to search a neighbor <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</p>
<div class="refsect3">
<a name="WnckMotionDirection.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="WNCK-MOTION-UP:CAPS"></a>WNCK_MOTION_UP</p></td>
<td class="enum_member_description">
<p>search a neighbor <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> above another
<a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>. </p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="WNCK-MOTION-DOWN:CAPS"></a>WNCK_MOTION_DOWN</p></td>
<td class="enum_member_description">
<p>search a neighbor <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> below another
<a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="WNCK-MOTION-LEFT:CAPS"></a>WNCK_MOTION_LEFT</p></td>
<td class="enum_member_description">
<p>search a neighbor <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> at the left of another
<a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="WNCK-MOTION-RIGHT:CAPS"></a>WNCK_MOTION_RIGHT</p></td>
<td class="enum_member_description">
<p>search a neighbor <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> at the right of another
<a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a>.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.14</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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>       user_data)</pre>
<p>Emitted when the name of <em class="parameter"><code>space</code></em>
 changes.</p>
<div class="refsect3">
<a name="WnckWorkspace-name-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>space</p></td>
<td class="parameter_description"><p>the <a class="link" href="WnckWorkspace.html" title="WnckWorkspace"><span class="type">WnckWorkspace</span></a> which emitted the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
<div class="refsect1">
<a name="WnckWorkspace.see-also"></a><h2>See Also</h2>
<p><a class="link" href="WnckScreen.html" title="WnckScreen"><span class="type">WnckScreen</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.