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
|
<?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="libwnck-WnckClassGroup">
<refmeta>
<refentrytitle role="top_of_page">WnckClassGroup</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBWNCK Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>WnckClassGroup</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="WnckClassGroupPrivate">WnckClassGroupPrivate</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);
<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);
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);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="WnckClassGroupPrivate" role="struct"/>WnckClassGroupPrivate</title>
<indexterm><primary>WnckClassGroupPrivate</primary></indexterm><programlisting>typedef struct _WnckClassGroupPrivate WnckClassGroupPrivate;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="wnck-class-group-get" role="function"/>wnck_class_group_get ()</title>
<indexterm><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 an existing class group based on its resource class name.</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> An existing <link linkend="WnckClassGroup"><type>WnckClassGroup</type></link>, or NULL if there is no groups with
the specified <parameter>res_class</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wnck-class-group-get-windows" role="function"/>wnck_class_group_get_windows ()</title>
<indexterm><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 windows that are grouped in a <parameter>class_group</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>class_group</parameter> :</term>
<listitem><simpara> A window class group.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A list of windows, or NULL if the group contains no windows.
The list should not be freed, as it belongs to the <parameter>class_group</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wnck-class-group-get-res-class" role="function"/>wnck_class_group_get_res_class ()</title>
<indexterm><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>
Queries the resource class name for a class group.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>class_group</parameter> :</term>
<listitem><simpara> A window class group.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The resource class name of the specified <parameter>class_group</parameter>, or the
empty string if the group has no name. The string should not be freed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wnck-class-group-get-name" role="function"/>wnck_class_group_get_name ()</title>
<indexterm><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>
Queries the human-readable name for a class group.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>class_group</parameter> :</term>
<listitem><simpara> A window class group.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Name of the class group.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wnck-class-group-get-icon" role="function"/>wnck_class_group_get_icon ()</title>
<indexterm><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>
Queries the icon to be used for a class group.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>class_group</parameter> :</term>
<listitem><simpara> A window class group.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The icon to use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wnck-class-group-get-mini-icon" role="function"/>wnck_class_group_get_mini_icon ()</title>
<indexterm><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>
Queries the mini-icon to be used for a class group.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>class_group</parameter> :</term>
<listitem><simpara> A window class group.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The mini-icon to use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|