blob: fe0e44c7c6f521d2b566b797cf9669783f243329 (
plain)
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
|
<?xml version="1.0" standalone="no"?>
<!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="class-giothemedicon">
<refnamediv>
<refname>gio.ThemedIcon</refname>
<refpurpose>Icon theming support.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gio.ThemedIcon</classname></ooclass>
<ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-giothemedicon">gio.ThemedIcon</link></methodname>
<methodparam></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giothemedicon--append-name">append_name</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giothemedicon--get-names">get_names</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giothemedicon--prepend-name">prepend_name</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-giothemedicon">gio.ThemedIcon</link>
</synopsis>
</refsect1>
<refsect1 id="properties-giomountoperation">
<title>gio.ThemedIcon Properties</title>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="4in"/>
<tbody>
<row valign="top">
<entry>"name"</entry>
<entry>Write/Contruct Only</entry>
<entry>
The icon name. Default value: <literal>None</literal>
</entry>
</row>
<row valign="top">
<entry>"names"</entry>
<entry>Read/Write/Contruct Only</entry>
<entry>
A list of icon names.
</entry>
</row>
<row valign="top">
<entry>"use-default-fallbacks"</entry>
<entry>Read/Write/Contruct Only</entry>
<entry>
Whether to use the default fallbacks found by shortening the
icon name at '-' characters. If the "names" array has more
than one element, ignores any past the first.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1>
<title>Description</title>
<para>
<link linkend="class-giothemedicon"><classname>gio.ThemedIcon</classname></link>
is an implementation of <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
that supports icon themes. GThemedIcon contains a list of all of the icons present in an icon
theme, so that icons can be looked up quickly.
</para>
<para>
<link linkend="class-giothemedicon"><classname>gio.ThemedIcon</classname></link>
does not provide actual pixmaps for icons, just the icon names. Ideally something like
<methodname><link linkend="method-gtkicontheme--choose-icon">gtk.IconTheme.choose_icon</link></methodname>()
should be used to resolve the list of names so that fallback icons work nicely
with themes that inherit other themes
</para>
</refsect1>
<refsect1 id="constructor-giothemedicon">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gio.ThemedIcon</methodname>
<methodparam><parameter>name</parameter></methodparam>
<methodparam><parameter>use_default_fallbacks</parameter><initializer><literal>False</literal></initializer></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>name</parameter> :</term>
<listitem><simpara>a string containing an icon name.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new
<link linkend="class-giothemedicon"><classname>gio.ThemedIcon</classname></link>.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
Creates a new themed icon from icon name, if instead of an icon name you
provide a list of icon names, the <link linkend="class-giothemedicon"><classname>gio.ThemedIcon</classname></link>
will be constructed using the items in the list.
</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-giothemedicon--append-name">
<title>gio.ThemedIcon.append_name</title>
<programlisting><methodsynopsis language="python">
<methodname>append_name</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>name</emphasis> :</term>
<listitem><simpara>name of icon to append to list of icons from within icon.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>append_name</methodname>() method appends a name to
the list of icons from within icon.
</para>
</refsect2>
<refsect2 id="method-giothemedicon--get-names">
<title>gio.ThemedIcon.get_names</title>
<programlisting><methodsynopsis language="python">
<methodname>get_names</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a list of icon names.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_names</methodname>() method gets the names
of icons from within icon.
</para>
</refsect2>
<refsect2 id="method-giothemedicon--prepend-name">
<title>gio.ThemedIcon.prepend_name</title>
<programlisting><methodsynopsis language="python">
<methodname>prepend_name</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>name</emphasis> :</term>
<listitem><simpara>name of icon to prepend to list of icons from within icon.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>prepend_name</methodname>() method prepends a name to
the list of icons from within icon.
</para>
</refsect2>
</refsect1>
</refentry>
|
