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
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="WnckClassGroup">
<refmeta>
<refentrytitle role="top_of_page" id="WnckClassGroup.top_of_page">WnckClassGroup</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBWNCK Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>WnckClassGroup</refname>
<refpurpose>an object representing a group of windows of the same
class.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsect1 id="WnckClassGroup.stability-level">
<title>Stability Level</title>
Unstable, unless otherwise indicated
</refsect1>
<refsynopsisdiv id="WnckClassGroup.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <libwnck/libwnck.h>
<link linkend="WnckClassGroup-struct">WnckClassGroup</link>;
<link linkend="WnckClassGroup">WnckClassGroup</link>* <link linkend="wnck-class-group-get">wnck_class_group_get</link> (const <link linkend="char">char</link> *res_class);
const <link linkend="char">char</link>* <link linkend="wnck-class-group-get-res-class">wnck_class_group_get_res_class</link> (<link linkend="WnckClassGroup">WnckClassGroup</link> *class_group);
const <link linkend="char">char</link>* <link linkend="wnck-class-group-get-name">wnck_class_group_get_name</link> (<link linkend="WnckClassGroup">WnckClassGroup</link> *class_group);
<link linkend="GdkPixbuf">GdkPixbuf</link>* <link linkend="wnck-class-group-get-icon">wnck_class_group_get_icon</link> (<link linkend="WnckClassGroup">WnckClassGroup</link> *class_group);
<link linkend="GdkPixbuf">GdkPixbuf</link>* <link linkend="wnck-class-group-get-mini-icon">wnck_class_group_get_mini_icon</link> (<link linkend="WnckClassGroup">WnckClassGroup</link> *class_group);
<link linkend="GList">GList</link>* <link linkend="wnck-class-group-get-windows">wnck_class_group_get_windows</link> (<link linkend="WnckClassGroup">WnckClassGroup</link> *class_group);
</synopsis>
</refsynopsisdiv>
<refsect1 id="WnckClassGroup.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----WnckClassGroup
</synopsis>
</refsect1>
<refsect1 id="WnckClassGroup.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="WnckClassGroup-icon-changed">icon-changed</link>" : Run Last
"<link linkend="WnckClassGroup-name-changed">name-changed</link>" : Run Last
</synopsis>
</refsect1>
<refsect1 id="WnckClassGroup.description" role="desc">
<title role="desc.title">Description</title>
<para>
The <link linkend="WnckClassGroup"><type>WnckClassGroup</type></link> is a group of <link linkend="WnckWindow"><type>WnckWindow</type></link> 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.
</para>
<para>
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 <ulink
url="http://tronche.com/gui/x/icccm/sec-4.html#s-4.1.2.5">WM_CLASS Property</ulink>
section (section 4.1.2.5) of the <ulink
url="http://tronche.com/gui/x/icccm/">ICCCM</ulink>.
</para>
<para>
The <link linkend="WnckClassGroup"><type>WnckClassGroup</type></link> objects are always owned by libwnck and must not be
referenced or unreferenced.</para>
<para>
</para>
</refsect1>
<refsect1 id="WnckClassGroup.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="WnckClassGroup-struct" role="struct">
<title>WnckClassGroup</title>
<indexterm zone="WnckClassGroup-struct"><primary>WnckClassGroup</primary></indexterm><programlisting>typedef struct _WnckClassGroup WnckClassGroup;</programlisting>
<para>
The <link linkend="WnckClassGroup"><type>WnckClassGroup</type></link> struct contains only private fields and should not be
directly accessed.</para>
<para>
</para></refsect2>
<refsect2 id="wnck-class-group-get" role="function" condition="since:2.2">
<title>wnck_class_group_get ()</title>
<indexterm zone="wnck-class-group-get" role="2.2"><primary>wnck_class_group_get</primary></indexterm><programlisting><link linkend="WnckClassGroup">WnckClassGroup</link>* wnck_class_group_get (const <link linkend="char">char</link> *res_class);</programlisting>
<para>
Gets the <link linkend="WnckClassGroup"><type>WnckClassGroup</type></link> corresponding to <parameter>res_class</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>res_class</parameter> :</term>
<listitem><simpara> name of the sought resource class.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="WnckClassGroup"><type>WnckClassGroup</type></link> corresponding to <parameter>res_class</parameter>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if
there is no <link linkend="WnckClassGroup"><type>WnckClassGroup</type></link> with the specified <parameter>res_class</parameter>. The returned
<link linkend="WnckClassGroup"><type>WnckClassGroup</type></link> is owned by libwnck and must not be referenced or
unreferenced.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="wnck-class-group-get-res-class" role="function" condition="since:2.2">
<title>wnck_class_group_get_res_class ()</title>
<indexterm zone="wnck-class-group-get-res-class" role="2.2"><primary>wnck_class_group_get_res_class</primary></indexterm><programlisting>const <link linkend="char">char</link>* wnck_class_group_get_res_class (<link linkend="WnckClassGroup">WnckClassGroup</link> *class_group);</programlisting>
<para>
Gets the resource class name for <parameter>class_group</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>class_group</parameter> :</term>
<listitem><simpara> a <link linkend="WnckClassGroup"><type>WnckClassGroup</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the resource class name of <parameter>class_group</parameter>, or an
empty string if the group has no resource class name.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="wnck-class-group-get-name" role="function" condition="since:2.2">
<title>wnck_class_group_get_name ()</title>
<indexterm zone="wnck-class-group-get-name" role="2.2"><primary>wnck_class_group_get_name</primary></indexterm><programlisting>const <link linkend="char">char</link>* wnck_class_group_get_name (<link linkend="WnckClassGroup">WnckClassGroup</link> *class_group);</programlisting>
<para>
Gets an human-readable name for <parameter>class_group</parameter>. 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 <link linkend="WnckApplication"><type>WnckApplication</type></link> for each <link linkend="WnckWindow"><type>WnckWindow</type></link> in <parameter>class_group</parameter> if
they all have the same name. If all <link linkend="WnckApplication"><type>WnckApplication</type></link> don't have the same
name, the name is the name of all <link linkend="WnckWindow"><type>WnckWindow</type></link> in <parameter>class_group</parameter> if they all
have the same name. If all <link linkend="WnckWindow"><type>WnckWindow</type></link> don't have the same name, the
resource class name is used.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>class_group</parameter> :</term>
<listitem><simpara> a <link linkend="WnckClassGroup"><type>WnckClassGroup</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an human-readable name for <parameter>class_group</parameter>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="wnck-class-group-get-icon" role="function" condition="since:2.2">
<title>wnck_class_group_get_icon ()</title>
<indexterm zone="wnck-class-group-get-icon" role="2.2"><primary>wnck_class_group_get_icon</primary></indexterm><programlisting><link linkend="GdkPixbuf">GdkPixbuf</link>* wnck_class_group_get_icon (<link linkend="WnckClassGroup">WnckClassGroup</link> *class_group);</programlisting>
<para>
Gets the icon to be used for <parameter>class_group</parameter>. 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 <link linkend="WnckApplication"><type>WnckApplication</type></link> for each
<link linkend="WnckWindow"><type>WnckWindow</type></link> in <parameter>class_group</parameter>, then at all the <link linkend="WnckWindow"><type>WnckWindow</type></link> in <parameter>class_group</parameter>. If
no icon was found, a fallback icon is used.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>class_group</parameter> :</term>
<listitem><simpara> a <link linkend="WnckClassGroup"><type>WnckClassGroup</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the icon for <parameter>class_group</parameter>. The caller should reference the
returned <classname>GdkPixbuf</classname> if it needs to keep the icon
around.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="wnck-class-group-get-mini-icon" role="function" condition="since:2.2">
<title>wnck_class_group_get_mini_icon ()</title>
<indexterm zone="wnck-class-group-get-mini-icon" role="2.2"><primary>wnck_class_group_get_mini_icon</primary></indexterm><programlisting><link linkend="GdkPixbuf">GdkPixbuf</link>* wnck_class_group_get_mini_icon (<link linkend="WnckClassGroup">WnckClassGroup</link> *class_group);</programlisting>
<para>
Gets the mini-icon to be used for <parameter>class_group</parameter>. Since there is no way to
properly find the mini-icon, the same suboptimal heuristic as the one for
<link linkend="wnck-class-group-get-icon"><function>wnck_class_group_get_icon()</function></link> is used to find it.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>class_group</parameter> :</term>
<listitem><simpara> a <link linkend="WnckClassGroup"><type>WnckClassGroup</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the mini-icon for <parameter>class_group</parameter>. The caller should reference
the returned <classname>GdkPixbuf</classname> if it needs to keep the
mini-icon around.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="wnck-class-group-get-windows" role="function" condition="since:2.2">
<title>wnck_class_group_get_windows ()</title>
<indexterm zone="wnck-class-group-get-windows" role="2.2"><primary>wnck_class_group_get_windows</primary></indexterm><programlisting><link linkend="GList">GList</link>* wnck_class_group_get_windows (<link linkend="WnckClassGroup">WnckClassGroup</link> *class_group);</programlisting>
<para>
Gets the list of <link linkend="WnckWindow"><type>WnckWindow</type></link> that are grouped in <parameter>class_group</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>class_group</parameter> :</term>
<listitem><simpara> a <link linkend="WnckClassGroup"><type>WnckClassGroup</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the list of <link linkend="WnckWindow"><type>WnckWindow</type></link> grouped in <parameter>class_group</parameter>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if
the group contains no window. The list should not be modified nor freed, as
it is owned by <parameter>class_group</parameter>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
</refsect1>
<refsect1 id="WnckClassGroup.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="WnckClassGroup-icon-changed"><title>The <literal>"icon-changed"</literal> signal</title>
<indexterm zone="WnckClassGroup-icon-changed"><primary>WnckClassGroup::icon-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="WnckClassGroup">WnckClassGroup</link> *class_group,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
Emitted when the icon of <parameter>class_group</parameter> changes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>class_group</parameter> :</term>
<listitem><simpara> the <link linkend="WnckClassGroup"><type>WnckClassGroup</type></link> which emitted the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="WnckClassGroup-name-changed"><title>The <literal>"name-changed"</literal> signal</title>
<indexterm zone="WnckClassGroup-name-changed"><primary>WnckClassGroup::name-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="WnckClassGroup">WnckClassGroup</link> *class_group,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
Emitted when the name of <parameter>class_group</parameter> changes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>class_group</parameter> :</term>
<listitem><simpara> the <link linkend="WnckClassGroup"><type>WnckClassGroup</type></link> which emitted the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="WnckClassGroup.see-also">
<title>See Also</title>
<link linkend="wnck-window-get-class-group"><function>wnck_window_get_class_group()</function></link>
</refsect1>
</refentry>
|