← Back to branch summary

~inkscape.dev/inkscape-devlibs/devlibs-gtk3 

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

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkCellRendererProgress</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
<link rel="up" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="prev" href="GtkCellRendererPixbuf.html" title="GtkCellRendererPixbuf">
<link rel="next" href="GtkCellRendererSpin.html" title="GtkCellRendererSpin">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkCellRendererPixbuf.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="TreeWidgetObjects.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ 2 Reference Manual</th>
<td><a accesskey="n" href="GtkCellRendererSpin.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkCellRendererProgress.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GtkCellRendererProgress.description" class="shortcut">Description</a>
                   | 
                  <a href="#GtkCellRendererProgress.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GtkCellRendererProgress.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="GtkCellRendererProgress"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkCellRendererProgress.top_of_page"></a>GtkCellRendererProgress</span></h2>
<p>GtkCellRendererProgress — Renders numbers as progress bars</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkCellRendererProgress.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;gtk/gtk.h&gt;

struct              <a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress-struct" title="struct GtkCellRendererProgress">GtkCellRendererProgress</a>;
<a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="returnvalue">GtkCellRenderer</span></a> *   <a class="link" href="GtkCellRendererProgress.html#gtk-cell-renderer-progress-new" title="gtk_cell_renderer_progress_new ()">gtk_cell_renderer_progress_new</a>      (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GtkCellRendererProgress.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----GInitiallyUnowned
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
               +----<a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer">GtkCellRenderer</a>
                     +----GtkCellRendererProgress
</pre>
</div>
<div class="refsect1">
<a name="GtkCellRendererProgress.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress--orientation" title='The "orientation" property'>orientation</a>"              <a class="link" href="GtkProgressBar.html#GtkProgressBarOrientation" title="enum GtkProgressBarOrientation"><span class="type">GtkProgressBarOrientation</span></a>  : Read / Write
  "<a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress--pulse" title='The "pulse" property'>pulse</a>"                    <span class="type">gint</span>                  : Read / Write
  "<a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress--text" title='The "text" property'>text</a>"                     <span class="type">gchar</span>*                : Read / Write
  "<a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress--text-xalign" title='The "text-xalign" property'>text-xalign</a>"              <span class="type">gfloat</span>                : Read / Write
  "<a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress--text-yalign" title='The "text-yalign" property'>text-yalign</a>"              <span class="type">gfloat</span>                : Read / Write
  "<a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress--value" title='The "value" property'>value</a>"                    <span class="type">gint</span>                  : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="GtkCellRendererProgress.description"></a><h2>Description</h2>
<p>
<a class="link" href="GtkCellRendererProgress.html" title="GtkCellRendererProgress"><span class="type">GtkCellRendererProgress</span></a> renders a numeric value as a progress par in a cell.
Additionally, it can display a text on top of the progress bar.
</p>
<p>
The <a class="link" href="GtkCellRendererProgress.html" title="GtkCellRendererProgress"><span class="type">GtkCellRendererProgress</span></a> cell renderer was added in GTK+ 2.6.
</p>
</div>
<div class="refsect1">
<a name="GtkCellRendererProgress.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GtkCellRendererProgress-struct"></a><h3>struct GtkCellRendererProgress</h3>
<pre class="programlisting">struct GtkCellRendererProgress;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-cell-renderer-progress-new"></a><h3>gtk_cell_renderer_progress_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="returnvalue">GtkCellRenderer</span></a> *   gtk_cell_renderer_progress_new      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new <a class="link" href="GtkCellRendererProgress.html" title="GtkCellRendererProgress"><span class="type">GtkCellRendererProgress</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new cell renderer</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.6</p>
</div>
</div>
<div class="refsect1">
<a name="GtkCellRendererProgress.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkCellRendererProgress--orientation"></a><h3>The <code class="literal">"orientation"</code> property</h3>
<pre class="programlisting">  "orientation"              <a class="link" href="GtkProgressBar.html#GtkProgressBarOrientation" title="enum GtkProgressBarOrientation"><span class="type">GtkProgressBarOrientation</span></a>  : Read / Write</pre>
<p>
The "orientation" property controls the direction and growth
direction of the progress bar (left-to-right, right-to-left,
top-to-bottom or bottom-to-top).
</p>
<p>Default value: GTK_PROGRESS_LEFT_TO_RIGHT</p>
<p class="since">Since 2.12</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkCellRendererProgress--pulse"></a><h3>The <code class="literal">"pulse"</code> property</h3>
<pre class="programlisting">  "pulse"                    <span class="type">gint</span>                  : Read / Write</pre>
<p>
Setting this to a non-negative value causes the cell renderer to
enter "activity mode", where a block bounces back and forth to
indicate that some progress is made, without specifying exactly how
much.
</p>
<p>
Each increment of the property causes the block to move by a little 
bit.
</p>
<p>
To indicate that the activity has not started yet, set the property
to zero. To indicate completion, set the property to <code class="literal">G_MAXINT</code>.
</p>
<p>Allowed values: &gt;= G_MAXULONG</p>
<p>Default value: -1</p>
<p class="since">Since 2.12</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkCellRendererProgress--text"></a><h3>The <code class="literal">"text"</code> property</h3>
<pre class="programlisting">  "text"                     <span class="type">gchar</span>*                : Read / Write</pre>
<p>
The "text" property determines the label which will be drawn
over the progress bar. Setting this property to <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> causes the default 
label to be displayed. Setting this property to an empty string causes 
no label to be displayed.
</p>
<p>Default value: NULL</p>
<p class="since">Since 2.6</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkCellRendererProgress--text-xalign"></a><h3>The <code class="literal">"text-xalign"</code> property</h3>
<pre class="programlisting">  "text-xalign"              <span class="type">gfloat</span>                : Read / Write</pre>
<p>
The "text-xalign" property controls the horizontal alignment of the
text in the progress bar.  Valid values range from 0 (left) to 1
(right).  Reserved for RTL layouts.
</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0.5</p>
<p class="since">Since 2.12</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkCellRendererProgress--text-yalign"></a><h3>The <code class="literal">"text-yalign"</code> property</h3>
<pre class="programlisting">  "text-yalign"              <span class="type">gfloat</span>                : Read / Write</pre>
<p>
The "text-yalign" property controls the vertical alignment of the
text in the progress bar.  Valid values range from 0 (top) to 1
(bottom).
</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0.5</p>
<p class="since">Since 2.12</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkCellRendererProgress--value"></a><h3>The <code class="literal">"value"</code> property</h3>
<pre class="programlisting">  "value"                    <span class="type">gint</span>                  : Read / Write</pre>
<p>
The "value" property determines the percentage to which the
progress bar will be "filled in".
</p>
<p>Allowed values: [0,100]</p>
<p>Default value: 0</p>
<p class="since">Since 2.6</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>