blob: 9b5ef8a6c638f19837ee9d7afc6c946f5621b8dc (
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
|
<?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-gioemblemedicon">
<refnamediv>
<refname>gio.EmblemedIcon</refname>
<refpurpose>Icon with emblems.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gio.EmblemedIcon</classname></ooclass>
<ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
<ooclass><classname><link linkend="class-gioicon">gio.Icon</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gioemblemedicon">gio.EmblemedIcon</link></methodname>
<methodparam><parameter role="keyword">icon</parameter></methodparam>
<methodparam><parameter role="keyword">emblem</parameter></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gioemblemedicon--add-emblem">add_emblem</link></methodname>
<methodparam><parameter role="keyword">emblem</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gioemblemedicon--get-icon">get_icon</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gioemblemedicon">gio.EmblemedIcon</link>
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
<link linkend="class-gioemblemedicon"><classname>gio.EmblemedIcon</classname></link>
implements
<link linkend="class-gioicon"><classname>gio.Icon</classname></link>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
The <link linkend="class-gioemblemedicon"><classname>gio.EmblemedIcon</classname></link>
class is an implementation of <classname><link linkend="class-gioicon">gio.Icon</link></classname>
that supports adding an emblem to an icon. Adding multiple emblems to an icon is ensured via
<methodname><link linkend="method-gioemblemedicon--add-emblem">gio.EmblemedIcon.add_emblem</link></methodname>().
</para>
<para>
Note that
<link linkend="class-gioemblemedicon"><classname>gio.EmblemedIcon</classname></link>
allows no control over the position of the emblems. See also
<link linkend="class-gioemblem"><classname>gio.Emblem</classname></link>
for more information.
</para>
</refsect1>
<refsect1 id="constructor-gioemblemedicon">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gio.EmblemedIcon</methodname>
<methodparam><parameter role="keyword">icon</parameter></methodparam>
<methodparam><parameter role="keyword">emblem</parameter></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>icon</parameter> :</term>
<listitem><simpara>a
<link linkend="class-gioicon"><classname>gio.Icon</classname></link>.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>emblem</parameter> :</term>
<listitem><simpara>a
<link linkend="class-gioemblem"><classname>gio.Emblem</classname></link>.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new
<link linkend="class-gioicon"><classname>gio.Icon</classname></link>.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
Creates a new <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
for icon with the emblem emblem.
</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gioemblemedicon--add-emblem">
<title>gio.EmblemedIcon.add_emblem</title>
<programlisting><methodsynopsis language="python">
<methodname>add_emblem</methodname>
<methodparam><parameter role="keyword">emblem</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>emblem</parameter> :</term>
<listitem><simpara>a
<link linkend="class-gioemblem"><classname>gio.Emblem</classname></link>
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>add_emblem</methodname>() method adds emblem to the
list of <link linkend="class-gioemblem"><classname>gio.Emblem</classname></link>s.
</para>
</refsect2>
<refsect2 id="method-gioemblemedicon--get-icon">
<title>gio.EmblemedIcon.get_icon</title>
<programlisting><methodsynopsis language="python">
<methodname>get_icon</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a
<link linkend="class-gioicon"><classname>gio.Icon</classname></link>
that is owned by emblemed.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_icon</methodname>() method gets the main icon for emblemed.
</para>
</refsect2>
</refsect1>
</refentry>
|
