/usr/share/gtk-doc/html/libwnck/WnckClassGroup.html is in libwnck-doc 1:2.30.7-5ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>WnckClassGroup</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="WnckWindow.html" title="WnckWindow">
<link rel="next" href="WnckApplication.html" title="WnckApplication">
<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="WnckWindow.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="WnckApplication.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#WnckClassGroup.synopsis" class="shortcut">Top</a>
|
<a href="#WnckClassGroup.description" class="shortcut">Description</a>
|
<a href="#WnckClassGroup.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#WnckClassGroup.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="WnckClassGroup"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="WnckClassGroup.top_of_page"></a>WnckClassGroup</span></h2>
<p>WnckClassGroup — an object representing a group of windows of the same
class.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="WnckClassGroup.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="WnckClassGroup.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libwnck/libwnck.h>
<a class="link" href="WnckClassGroup.html#WnckClassGroup-struct" title="WnckClassGroup">WnckClassGroup</a>;
<a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="returnvalue">WnckClassGroup</span></a> * <a class="link" href="WnckClassGroup.html#wnck-class-group-get" title="wnck_class_group_get ()">wnck_class_group_get</a> (<em class="parameter"><code>const <span class="type">char</span> *res_class</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="WnckClassGroup.html#wnck-class-group-get-res-class" title="wnck_class_group_get_res_class ()">wnck_class_group_get_res_class</a> (<em class="parameter"><code><a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> *class_group</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="WnckClassGroup.html#wnck-class-group-get-name" title="wnck_class_group_get_name ()">wnck_class_group_get_name</a> (<em class="parameter"><code><a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> *class_group</code></em>);
<span class="returnvalue">GdkPixbuf</span> * <a class="link" href="WnckClassGroup.html#wnck-class-group-get-icon" title="wnck_class_group_get_icon ()">wnck_class_group_get_icon</a> (<em class="parameter"><code><a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> *class_group</code></em>);
<span class="returnvalue">GdkPixbuf</span> * <a class="link" href="WnckClassGroup.html#wnck-class-group-get-mini-icon" title="wnck_class_group_get_mini_icon ()">wnck_class_group_get_mini_icon</a> (<em class="parameter"><code><a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> *class_group</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * <a class="link" href="WnckClassGroup.html#wnck-class-group-get-windows" title="wnck_class_group_get_windows ()">wnck_class_group_get_windows</a> (<em class="parameter"><code><a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> *class_group</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="WnckClassGroup.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>
+----WnckClassGroup
</pre>
</div>
<div class="refsect1">
<a name="WnckClassGroup.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="WnckClassGroup.html#WnckClassGroup-icon-changed" title='The "icon-changed" signal'>icon-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>
"<a class="link" href="WnckClassGroup.html#WnckClassGroup-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="WnckClassGroup.description"></a><h2>Description</h2>
<p>
The <a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> is a group of <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> that are all in the same
class. It can be used to represent windows by classes, group windows by
classes or to manipulate all windows of a particular class.
</p>
<p>
The class of a window is defined by the WM_CLASS property of this window.
More information about the WM_CLASS property is available in the <a class="ulink" href="http://tronche.com/gui/x/icccm/sec-4.html#s-4.1.2.5" target="_top">WM_CLASS Property</a>
section (section 4.1.2.5) of the <a class="ulink" href="http://tronche.com/gui/x/icccm/" target="_top">ICCCM</a>.
</p>
<p>
The <a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> objects are always owned by libwnck and must not be
referenced or unreferenced.
</p>
</div>
<div class="refsect1">
<a name="WnckClassGroup.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="WnckClassGroup-struct"></a><h3>WnckClassGroup</h3>
<pre class="programlisting">typedef struct _WnckClassGroup WnckClassGroup;</pre>
<p>
The <a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> struct contains only private fields and should not be
directly accessed.
</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-class-group-get"></a><h3>wnck_class_group_get ()</h3>
<pre class="programlisting"><a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="returnvalue">WnckClassGroup</span></a> * wnck_class_group_get (<em class="parameter"><code>const <span class="type">char</span> *res_class</code></em>);</pre>
<p>
Gets the <a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> corresponding to <em class="parameter"><code>res_class</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>res_class</code></em> :</span></p></td>
<td>name of the sought resource class.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> corresponding to
<em class="parameter"><code>res_class</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is no <a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> with the specified
<em class="parameter"><code>res_class</code></em>. The returned <a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> is owned by libwnck and must not be
referenced or unreferenced. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-class-group-get-res-class"></a><h3>wnck_class_group_get_res_class ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * wnck_class_group_get_res_class (<em class="parameter"><code><a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> *class_group</code></em>);</pre>
<p>
Gets the resource class name for <em class="parameter"><code>class_group</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>class_group</code></em> :</span></p></td>
<td>a <a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the resource class name of <em class="parameter"><code>class_group</code></em>, or an
empty string if the group has no resource class name.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-class-group-get-name"></a><h3>wnck_class_group_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * wnck_class_group_get_name (<em class="parameter"><code><a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> *class_group</code></em>);</pre>
<p>
Gets an human-readable name for <em class="parameter"><code>class_group</code></em>. Since there is no way to
properly find this name, a suboptimal heuristic is used to find it. The name
is the name of all <a class="link" href="WnckApplication.html" title="WnckApplication"><span class="type">WnckApplication</span></a> for each <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> in <em class="parameter"><code>class_group</code></em> if
they all have the same name. If all <a class="link" href="WnckApplication.html" title="WnckApplication"><span class="type">WnckApplication</span></a> don't have the same
name, the name is the name of all <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> in <em class="parameter"><code>class_group</code></em> if they all
have the same name. If all <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> don't have the same name, the
resource class name is used.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>class_group</code></em> :</span></p></td>
<td>a <a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an human-readable name for <em class="parameter"><code>class_group</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-class-group-get-icon"></a><h3>wnck_class_group_get_icon ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> * wnck_class_group_get_icon (<em class="parameter"><code><a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> *class_group</code></em>);</pre>
<p>
Gets the icon to be used for <em class="parameter"><code>class_group</code></em>. Since there is no way to
properly find the icon, a suboptimal heuristic is used to find it. The icon
is the first icon found by looking at all the <a class="link" href="WnckApplication.html" title="WnckApplication"><span class="type">WnckApplication</span></a> for each
<a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> in <em class="parameter"><code>class_group</code></em>, then at all the <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> in <em class="parameter"><code>class_group</code></em>. If
no icon was found, a fallback icon is used.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>class_group</code></em> :</span></p></td>
<td>a <a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the icon for <em class="parameter"><code>class_group</code></em>. The caller should reference the
returned <code class="classname">GdkPixbuf</code> if it needs to keep the icon
around.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-class-group-get-mini-icon"></a><h3>wnck_class_group_get_mini_icon ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> * wnck_class_group_get_mini_icon (<em class="parameter"><code><a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> *class_group</code></em>);</pre>
<p>
Gets the mini-icon to be used for <em class="parameter"><code>class_group</code></em>. Since there is no way to
properly find the mini-icon, the same suboptimal heuristic as the one for
<a class="link" href="WnckClassGroup.html#wnck-class-group-get-icon" title="wnck_class_group_get_icon ()"><code class="function">wnck_class_group_get_icon()</code></a> is used to find it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>class_group</code></em> :</span></p></td>
<td>a <a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the mini-icon for <em class="parameter"><code>class_group</code></em>. The caller should reference
the returned <code class="classname">GdkPixbuf</code> if it needs to keep the
mini-icon around.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="wnck-class-group-get-windows"></a><h3>wnck_class_group_get_windows ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * wnck_class_group_get_windows (<em class="parameter"><code><a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> *class_group</code></em>);</pre>
<p>
Gets the list of <a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> that are grouped in <em class="parameter"><code>class_group</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>class_group</code></em> :</span></p></td>
<td>a <a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the list of
<a class="link" href="WnckWindow.html" title="WnckWindow"><span class="type">WnckWindow</span></a> grouped in <em class="parameter"><code>class_group</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the group contains no
window. The list should not be modified nor freed, as it is owned by
<em class="parameter"><code>class_group</code></em>. <span class="annotation">[<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> WnckWindow][<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</p>
</div>
</div>
<div class="refsect1">
<a name="WnckClassGroup.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="WnckClassGroup-icon-changed"></a><h3>The <code class="literal">"icon-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> *class_group,
<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 icon of <em class="parameter"><code>class_group</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>class_group</code></em> :</span></p></td>
<td>the <a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</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>
<hr>
<div class="refsect2">
<a name="WnckClassGroup-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="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</span></a> *class_group,
<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>class_group</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>class_group</code></em> :</span></p></td>
<td>the <a class="link" href="WnckClassGroup.html" title="WnckClassGroup"><span class="type">WnckClassGroup</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="WnckClassGroup.see-also"></a><h2>See Also</h2>
wnck_window_get_class_group()
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17.1</div>
</body>
</html>
|