blob: b395f5bb9fb87baa1e960140318c4548efa08304 (
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
|
<?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-gtkcellrendererspinner">
<refnamediv>
<refname>gtk.CellRendererSpinner</refname>
<refpurpose>an object that renders a spinning animation in a cell (new in PyGTK 2.22)</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.CellRendererSpinner</classname></ooclass>
<ooclass><classname><link linkend="class-gtkcellrenderer">gtk.CellRenderer</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gtkcellrendererspinner">gtk.CellRendererSpinner</link></methodname>
<methodparam></methodparam>
</constructorsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtkobject">gtk.Object</link>
+-- <link linkend="class-gtkcellrenderer">gtk.CellRenderer</link>
+-- <link linkend="class-gtkcellrendererspinner">gtk.CellRendererSpinner</link>
</synopsis>
</refsect1>
<refsect1 id="properties-gtkcellrendererspinner">
<title>gtk.CellRendererSpinner Properties</title>
<para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
<para><link linkend="properties-gtkcellrenderer">gtk.CellRenderer Properties</link></para>
<para><link linkend="properties-gtkcellrenderertext">gtk.CellRendererText Properties</link></para>
<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>"active"</entry>
<entry>Read-Write</entry>
<entry>Wheter the spinner is active (ie. shown) in the cell. Default value: <literal>False</literal></entry>
</row>
<row valign="top">
<entry>"pulse"</entry>
<entry>Read-Write</entry>
<entry>Pulse of the spinner. Increment this value to draw the next frame of the spinner animation. Usually, you would update this value in a timeout. Default value: 0</entry>
</row>
<row valign="top">
<entry>"size"</entry>
<entry>Read-Write</entry>
<entry>The gtk.IconSize value that specifies the size of the renderer spinner. Default value: gtk.ICON_SIZE_MENU</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="signal-prototypes-gtkcellrendererspinner">
<title>gtk.CellRendererSpin Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkcellrenderer">gtk.CellRenderer Signal Prototypes</link></para>
</refsect1>
<refsect1>
<title>Description</title>
<para><link linkend="class-gtkcellrendererspinner"><classname>gtk.CellRendererSpinner</classname></link> renders a spinning
animation in a cell, very similar to <link linkend="class-gtkspinner"><classname>gtk.Spinner</classname></link>. It can
often be used as an alternative to a <link linkend="class-gtkcellrendererprogress"><classname>gtk.CellRendererProgress</classname></link>
for displaying indefinite activity, instead of actual progress.</para>
<para>To start the animation in a cell, set the "active" property to <literal>True</literal> and increment the "pulse" property
at regular intervals. The usual way to set the cell renderer properties for each cell is to bind them to columns in your tree
model using e.g. <link linkend="method-gtktreeviewcolumn--add-attribute"><methodname>gtk.TreeViewColumn.add_attribute</methodname></link>().</para>
</refsect1>
<refsect1>
<title>Constructor</title>
<refsect2 id="constructor-gtkcellrendererspinner">
<title>gtk.CellRendererSpinner</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.CellRendererSpinner</methodname>
<methodparam></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link
linkend="class-gtkcellrendererspinner"><classname>gtk.CellRendererSpinner</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This constructor is available in PyGTK 2.22 and above.</para>
</note>
<para>Creates a new <link
linkend="class-gtkcellrendererspinner"><classname>gtk.CellRendererSpinner</classname></link>.</para>
</refsect2>
</refsect1>
</refentry>
|
