File: libwnck-Miscellaneous-Functions.html

package info (click to toggle)
libwnck 2.30.4-2
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 6,836 kB
  • ctags: 2,640
  • sloc: ansic: 19,661; sh: 10,249; makefile: 216
file content (134 lines) | stat: -rw-r--r-- 7,273 bytes parent folder | download
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Miscellaneous Functions</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Libwnck Reference Manual">
<link rel="up" href="utils.html" title="Part IV. Libwnck Utilities">
<link rel="prev" href="libwnck-Resource-Usage-of-X-Clients.html" title="Resource Usage of X Clients">
<link rel="next" href="indexes.html" title="Part V. Index of symbols">
<meta name="generator" content="GTK-Doc V1.14 (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="libwnck-Resource-Usage-of-X-Clients.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="utils.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="indexes.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libwnck-Miscellaneous-Functions.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libwnck-Miscellaneous-Functions.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="Miscellaneous Functions">
<a name="libwnck-Miscellaneous-Functions"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libwnck-Miscellaneous-Functions.top_of_page"></a>Miscellaneous Functions</span></h2>
<p>Miscellaneous Functions — other additional features.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="libwnck-Miscellaneous-Functions.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libwnck-Miscellaneous-Functions.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libwnck/libwnck.h&gt;

<span class="returnvalue">void</span>                <a class="link" href="libwnck-Miscellaneous-Functions.html#wnck-gtk-window-set-dock-type" title="wnck_gtk_window_set_dock_type ()">wnck_gtk_window_set_dock_type</a>       (<em class="parameter"><code><span class="type">GtkWindow</span> *window</code></em>);
enum                <a class="link" href="libwnck-Miscellaneous-Functions.html#WnckClientType" title="enum WnckClientType">WnckClientType</a>;
<span class="returnvalue">void</span>                <a class="link" href="libwnck-Miscellaneous-Functions.html#wnck-set-client-type" title="wnck_set_client_type ()">wnck_set_client_type</a>                (<em class="parameter"><code><a class="link" href="libwnck-Miscellaneous-Functions.html#WnckClientType" title="enum WnckClientType"><span class="type">WnckClientType</span></a> ewmh_sourceindication_client_type</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libwnck-Miscellaneous-Functions.description"></a><h2>Description</h2>
<p>
These functions are utility functions providing some additional features to
libwcnk users.</p>
</div>
<div class="refsect1" title="Details">
<a name="libwnck-Miscellaneous-Functions.details"></a><h2>Details</h2>
<div class="refsect2" title="wnck_gtk_window_set_dock_type ()">
<a name="wnck-gtk-window-set-dock-type"></a><h3>wnck_gtk_window_set_dock_type ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                wnck_gtk_window_set_dock_type       (<em class="parameter"><code><span class="type">GtkWindow</span> *window</code></em>);</pre>
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">wnck_gtk_window_set_dock_type</code> has been deprecated since version 2.20 and should not be used in newly-written code. Use <code class="function">gdk_window_set_type_hint()</code> instead.</p>
</div>
<p>
Sets the semantic type of <em class="parameter"><code>window</code></em> to <a class="link" href="WnckWindow.html#WNCK-WINDOW-DOCK:CAPS"><code class="literal">WNCK_WINDOW_DOCK</code></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
<td>a <code class="classname">GtkWindow</code>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum WnckClientType">
<a name="WnckClientType"></a><h3>enum WnckClientType</h3>
<pre class="programlisting">typedef enum {
  WNCK_CLIENT_TYPE_APPLICATION = 1,
  WNCK_CLIENT_TYPE_PAGER = 2
} WnckClientType;
</pre>
<p>
Type describing the role of the libwnck user.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="WNCK-CLIENT-TYPE-APPLICATION:CAPS"></a><span class="term"><code class="literal">WNCK_CLIENT_TYPE_APPLICATION</code></span></p></td>
<td>the libwnck user is a normal application.
</td>
</tr>
<tr>
<td><p><a name="WNCK-CLIENT-TYPE-PAGER:CAPS"></a><span class="term"><code class="literal">WNCK_CLIENT_TYPE_PAGER</code></span></p></td>
<td>the libwnck user is an utility application dealing
with window management, like pagers and taskbars.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.14</p>
</div>
<hr>
<div class="refsect2" title="wnck_set_client_type ()">
<a name="wnck-set-client-type"></a><h3>wnck_set_client_type ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                wnck_set_client_type                (<em class="parameter"><code><a class="link" href="libwnck-Miscellaneous-Functions.html#WnckClientType" title="enum WnckClientType"><span class="type">WnckClientType</span></a> ewmh_sourceindication_client_type</code></em>);</pre>
<p>
Sets the role of the libwnck user.
</p>
<p>
The default role is <a class="link" href="libwnck-Miscellaneous-Functions.html#WNCK-CLIENT-TYPE-APPLICATION:CAPS"><code class="literal">WNCK_CLIENT_TYPE_APPLICATION</code></a>. Therefore, for
applications providing some window management features, like pagers or
tasklists, it is important to set the role to <a class="link" href="libwnck-Miscellaneous-Functions.html#WNCK-CLIENT-TYPE-PAGER:CAPS"><code class="literal">WNCK_CLIENT_TYPE_PAGER</code></a> for
libwnck to properly work.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>ewmh_sourceindication_client_type</code></em> :</span></p></td>
<td>a role for the client.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.14</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.14</div>
</body>
</html>