/usr/share/gtk-doc/html/libwnck-3.0/libwnck-Miscellaneous-Functions.html is in libwnck-3-dev 3.14.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 | <!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: 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="utils.html" title="Part V. Libwnck Utilities">
<link rel="prev" href="libwnck-Icons-Functions.html" title="Icon Files">
<link rel="next" href="libwnck-Version-Information.html" title="Version Information">
<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="#libwnck-Miscellaneous-Functions.description" class="shortcut">Description</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="utils.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libwnck-Icons-Functions.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libwnck-Version-Information.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<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 class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libwnck-Miscellaneous-Functions.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="libwnck-Miscellaneous-Functions.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">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libwnck-Miscellaneous-Functions.html#wnck-set-client-type" title="wnck_set_client_type ()">wnck_set_client_type</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="libwnck-Miscellaneous-Functions.html#wnck-shutdown" title="wnck_shutdown ()">wnck_shutdown</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libwnck-Miscellaneous-Functions.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">enum</td>
<td class="function_name"><a class="link" href="libwnck-Miscellaneous-Functions.html#WnckClientType" title="enum WnckClientType">WnckClientType</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libwnck-Miscellaneous-Functions.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libwnck/libwnck.h>
</pre>
</div>
<div class="refsect1">
<a name="libwnck-Miscellaneous-Functions.description"></a><h2>Description</h2>
<p>These functions are utility functions providing some additional features to
libwnck users.</p>
</div>
<div class="refsect1">
<a name="libwnck-Miscellaneous-Functions.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<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="refsect3">
<a name="wnck-set-client-type.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>ewmh_sourceindication_client_type</p></td>
<td class="parameter_description"><p>a role for the client.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 2.14</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-shutdown"></a><h3>wnck_shutdown ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
wnck_shutdown (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Makes libwnck stop listening to events and tear down all resources from
libwnck. This should be done if you are not going to need the state change
notifications for an extended period of time, to avoid wakeups with every
key and focus event.</p>
<p>After this, all pointers to Wnck object you might still hold are invalid.</p>
<p>Due to the fact that <a class="link" href="getting-started.html#getting-started.pitfalls.memory-management" title="Memory management">Wnck objects are all
owned by libwnck</a>, users of this API through introspection should be
extremely careful: they must explicitly clear variables referencing objects
before this call. Failure to do so might result in crashes.</p>
<p class="since">Since: 3.4</p>
</div>
</div>
<div class="refsect1">
<a name="libwnck-Miscellaneous-Functions.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="WnckClientType"></a><h3>enum WnckClientType</h3>
<p>Type describing the role of the libwnck user.</p>
<div class="refsect3">
<a name="WnckClientType.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-CLIENT-TYPE-APPLICATION:CAPS"></a>WNCK_CLIENT_TYPE_APPLICATION</p></td>
<td class="enum_member_description">
<p>the libwnck user is a normal application.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="WNCK-CLIENT-TYPE-PAGER:CAPS"></a>WNCK_CLIENT_TYPE_PAGER</p></td>
<td class="enum_member_description">
<p>the libwnck user is an utility application dealing
with window management, like pagers and taskbars.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.14</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|