← Back to branch summary

~ubuntu-branches/debian/experimental/gtk+2.0/experimental

« back to all changes in this revision

Viewing changes to docs/reference/gtk/html/GtkCellRendererProgress.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2007-09-17 11:15:05 UTC
  • mto: (72.1.1 lenny) (1.4.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 55.
  • Revision ID: james.westby@ubuntu.com-20070917111505-giz9c5xltxkb5y54
Tags: upstream-2.12.0
Import upstream version 2.12.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gtk/html/GtkCellRendererProgress.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>GtkCellRendererProgress</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
7
<link rel="start" href="index.html" title="GTK+ Reference Manual">
8
8
<link rel="up" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
9
9
<link rel="prev" href="GtkCellRendererPixbuf.html" title="GtkCellRendererPixbuf">
10
10
<link rel="next" href="GtkCellRendererSpin.html" title="GtkCellRendererSpin">
11
 
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="gtk.html" title="Part&#160;I.&#160;GTK+ Overview">
14
14
<link rel="part" href="gtkbase.html" title="Part&#160;II.&#160;GTK+ Core Reference">
68
68
<th width="100%" align="center">GTK+ Reference Manual</th>
69
69
<td><a accesskey="n" href="GtkCellRendererSpin.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
70
70
</tr>
71
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3672513" class="shortcut">Top</a>
72
 
                  &#160;|&#160;
73
 
                  <a href="#id3672714" class="shortcut">Description</a>
74
 
                  &#160;|&#160;
75
 
                  <a href="#id3672552" class="shortcut">Object Hierarchy</a>
76
 
                  &#160;|&#160;
77
 
                  <a href="#id3672599" class="shortcut">Properties</a></nobr></td></tr>
 
71
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3424934" class="shortcut">Top</a>
 
72
                  &#160;|&#160;
 
73
                  <a href="#id3425142" class="shortcut">Description</a>
 
74
                  &#160;|&#160;
 
75
                  <a href="#id3424973" class="shortcut">Object Hierarchy</a>
 
76
                  &#160;|&#160;
 
77
                  <a href="#id3425020" class="shortcut">Properties</a></nobr></td></tr>
78
78
</table>
79
79
<div class="refentry" lang="en">
80
80
<a name="GtkCellRendererProgress"></a><div class="titlepage"></div>
81
81
<div class="refnamediv"><table width="100%"><tr>
82
82
<td valign="top">
83
83
<h2>
84
 
<a name="id3672513"></a><span class="refentrytitle">GtkCellRendererProgress</span>
 
84
<a name="id3424934"></a><span class="refentrytitle">GtkCellRendererProgress</span>
85
85
</h2>
86
86
<p>GtkCellRendererProgress &#8212; Renders numbers as progress bars</p>
87
87
</td>
94
94
#include &lt;gtk/gtk.h&gt;
95
95
 
96
96
 
97
 
                    <a href="GtkCellRendererProgress.html#GtkCellRendererProgress-struct">GtkCellRendererProgress</a>;
98
 
<a href="GtkCellRenderer.html" title="GtkCellRenderer">GtkCellRenderer</a>*    <a href="GtkCellRendererProgress.html#gtk-cell-renderer-progress-new">gtk_cell_renderer_progress_new</a>      (void);
 
97
                    <a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress-struct">GtkCellRendererProgress</a>;
 
98
<a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer">GtkCellRenderer</a>*    <a class="link" href="GtkCellRendererProgress.html#gtk-cell-renderer-progress-new">gtk_cell_renderer_progress_new</a>      (void);
99
99
 
100
100
 
101
101
</pre>
102
102
</div>
103
103
<div class="refsect1" lang="en">
104
 
<a name="id3672552"></a><h2>Object Hierarchy</h2>
 
104
<a name="id3424973"></a><h2>Object Hierarchy</h2>
105
105
<pre class="synopsis">
106
106
 
107
107
  <a
108
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
 
108
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
109
109
>GObject</a>
110
110
   +----<a
111
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
 
111
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
112
112
>GInitiallyUnowned</a>
113
 
         +----<a href="GtkObject.html" title="GtkObject">GtkObject</a>
114
 
               +----<a href="GtkCellRenderer.html" title="GtkCellRenderer">GtkCellRenderer</a>
 
113
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
 
114
               +----<a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer">GtkCellRenderer</a>
115
115
                     +----GtkCellRendererProgress
116
116
</pre>
117
117
</div>
118
118
<div class="refsect1" lang="en">
119
 
<a name="id3672599"></a><h2>Properties</h2>
 
119
<a name="id3425020"></a><h2>Properties</h2>
120
120
<pre class="synopsis">
121
121
 
122
 
  <a href="GtkCellRendererProgress.html#GtkCellRendererProgress--orientation">orientation</a>              <a href="GtkProgressBar.html#GtkProgressBarOrientation">GtkProgressBarOrientation</a>  : Read / Write
123
 
  <a href="GtkCellRendererProgress.html#GtkCellRendererProgress--pulse">pulse</a>                    <a
124
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
122
  "<a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress--orientation">orientation</a>"              <a class="link" href="GtkProgressBar.html#GtkProgressBarOrientation">GtkProgressBarOrientation</a>  : Read / Write
 
123
  "<a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress--pulse">pulse</a>"                    <a
 
124
href="../glib/glib-Basic-Types.html#gint"
125
125
>gint</a>                  : Read / Write
126
 
  <a href="GtkCellRendererProgress.html#GtkCellRendererProgress--text">text</a>                     <a
127
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
 
126
  "<a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress--text">text</a>"                     <a
 
127
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
128
128
>gchararray</a>            : Read / Write
129
 
  <a href="GtkCellRendererProgress.html#GtkCellRendererProgress--text-xalign">text-xalign</a>              <a
130
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"
131
 
>gfloat</a>                : Read / Write
132
 
  <a href="GtkCellRendererProgress.html#GtkCellRendererProgress--text-yalign">text-yalign</a>              <a
133
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"
134
 
>gfloat</a>                : Read / Write
135
 
  <a href="GtkCellRendererProgress.html#GtkCellRendererProgress--value">value</a>                    <a
136
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
129
  "<a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress--text-xalign">text-xalign</a>"              <a
 
130
href="../glib/glib-Basic-Types.html#gfloat"
 
131
>gfloat</a>                : Read / Write
 
132
  "<a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress--text-yalign">text-yalign</a>"              <a
 
133
href="../glib/glib-Basic-Types.html#gfloat"
 
134
>gfloat</a>                : Read / Write
 
135
  "<a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress--value">value</a>"                    <a
 
136
href="../glib/glib-Basic-Types.html#gint"
137
137
>gint</a>                  : Read / Write
138
138
</pre>
139
139
</div>
140
140
<div class="refsect1" lang="en">
141
 
<a name="id3672714"></a><h2>Description</h2>
 
141
<a name="id3425142"></a><h2>Description</h2>
142
142
<p>
143
 
<a href="GtkCellRendererProgress.html" title="GtkCellRendererProgress"><span class="type">GtkCellRendererProgress</span></a> renders a numeric value as a progress par in a cell.
 
143
<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.
144
144
Additionally, it can display a text on top of the progress bar.
145
145
</p>
146
146
<p>
147
 
The <a href="GtkCellRendererProgress.html" title="GtkCellRendererProgress"><span class="type">GtkCellRendererProgress</span></a> cell renderer was added in GTK+ 2.6.
 
147
The <a class="link" href="GtkCellRendererProgress.html" title="GtkCellRendererProgress"><span class="type">GtkCellRendererProgress</span></a> cell renderer was added in GTK+ 2.6.
148
148
</p>
149
149
</div>
150
150
<div class="refsect1" lang="en">
151
 
<a name="id3672751"></a><h2>Details</h2>
 
151
<a name="id3425179"></a><h2>Details</h2>
152
152
<div class="refsect2" lang="en">
153
 
<a name="id3672761"></a><h3>
 
153
<a name="id3425190"></a><h3>
154
154
<a name="GtkCellRendererProgress-struct"></a>GtkCellRendererProgress</h3>
155
 
<a class="indexterm" name="id3672775"></a><pre class="programlisting">typedef struct _GtkCellRendererProgress GtkCellRendererProgress;</pre>
 
155
<a class="indexterm" name="id3425204"></a><pre class="programlisting">typedef struct _GtkCellRendererProgress GtkCellRendererProgress;</pre>
156
156
<p>
157
157
 
158
158
</p>
159
159
</div>
160
160
<hr>
161
161
<div class="refsect2" lang="en">
162
 
<a name="id3672791"></a><h3>
 
162
<a name="id3425220"></a><h3>
163
163
<a name="gtk-cell-renderer-progress-new"></a>gtk_cell_renderer_progress_new ()</h3>
164
 
<a class="indexterm" name="id3672807"></a><pre class="programlisting"><a href="GtkCellRenderer.html" title="GtkCellRenderer">GtkCellRenderer</a>*    gtk_cell_renderer_progress_new      (void);</pre>
 
164
<a class="indexterm" name="id3425235"></a><pre class="programlisting"><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer">GtkCellRenderer</a>*    gtk_cell_renderer_progress_new      (void);</pre>
165
165
<p>
166
 
Creates a new <a href="GtkCellRendererProgress.html" title="GtkCellRendererProgress"><span class="type">GtkCellRendererProgress</span></a>.</p>
 
166
Creates a new <a class="link" href="GtkCellRendererProgress.html" title="GtkCellRendererProgress"><span class="type">GtkCellRendererProgress</span></a>.</p>
167
167
<p>
168
168
 
169
169
</p>
170
170
<div class="variablelist"><table border="0">
171
171
<col align="left" valign="top">
172
172
<tbody><tr>
173
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
173
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
174
174
<td> the new cell renderer
175
175
 
176
176
</td>
181
181
</div>
182
182
</div>
183
183
<div class="refsect1" lang="en">
184
 
<a name="id3672863"></a><h2>Property Details</h2>
 
184
<a name="id3425292"></a><h2>Property Details</h2>
185
185
<div class="refsect2" lang="en">
186
 
<a name="id3672874"></a><h3>
187
 
<a name="GtkCellRendererProgress--orientation"></a>The :<code class="literal">orientation</code> property</h3>
188
 
<a class="indexterm" name="id3672891"></a><pre class="programlisting">  orientation              <a href="GtkProgressBar.html#GtkProgressBarOrientation">GtkProgressBarOrientation</a>  : Read / Write</pre>
 
186
<a name="id3425303"></a><h3>
 
187
<a name="GtkCellRendererProgress--orientation"></a>The <code class="literal">"orientation"</code> property</h3>
 
188
<a class="indexterm" name="id3425320"></a><pre class="programlisting">  "orientation"              <a class="link" href="GtkProgressBar.html#GtkProgressBarOrientation">GtkProgressBarOrientation</a>  : Read / Write</pre>
189
189
<p>
190
190
The "orientation" property controls the direction and growth
191
191
direction of the progress bar (left-to-right, right-to-left,
199
199
</div>
200
200
<hr>
201
201
<div class="refsect2" lang="en">
202
 
<a name="id3672929"></a><h3>
203
 
<a name="GtkCellRendererProgress--pulse"></a>The :<code class="literal">pulse</code> property</h3>
204
 
<a class="indexterm" name="id3672946"></a><pre class="programlisting">  pulse                    <a
205
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
202
<a name="id3425358"></a><h3>
 
203
<a name="GtkCellRendererProgress--pulse"></a>The <code class="literal">"pulse"</code> property</h3>
 
204
<a class="indexterm" name="id3425375"></a><pre class="programlisting">  "pulse"                    <a
 
205
href="../glib/glib-Basic-Types.html#gint"
206
206
>gint</a>                  : Read / Write</pre>
207
207
<p>
208
208
Setting this to a non-negative value causes the cell renderer to
217
217
<p>
218
218
To indicate that the activity has not started yet, set the property
219
219
to zero. To indicate completion, set the property to <a
220
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Limits-of-Basic-Types.html#G-MAXINT:CAPS"
 
220
href="../glib/glib-Limits-of-Basic-Types.html#G-MAXINT:CAPS"
221
221
><code class="literal">G_MAXINT</code></a>.</p>
222
222
<p>
223
223
 
229
229
</div>
230
230
<hr>
231
231
<div class="refsect2" lang="en">
232
 
<a name="id3673009"></a><h3>
233
 
<a name="GtkCellRendererProgress--text"></a>The :<code class="literal">text</code> property</h3>
234
 
<a class="indexterm" name="id3673026"></a><pre class="programlisting">  text                     <a
235
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
 
232
<a name="id3425440"></a><h3>
 
233
<a name="GtkCellRendererProgress--text"></a>The <code class="literal">"text"</code> property</h3>
 
234
<a class="indexterm" name="id3425456"></a><pre class="programlisting">  "text"                     <a
 
235
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
236
236
>gchararray</a>            : Read / Write</pre>
237
237
<p>
238
238
The "text" property determines the label which will be drawn
239
239
over the progress bar. Setting this property to <a
240
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
240
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
241
241
><code class="literal">NULL</code></a> causes the default 
242
242
label to be displayed. Setting this property to an empty string causes 
243
243
no label to be displayed.</p>
250
250
</div>
251
251
<hr>
252
252
<div class="refsect2" lang="en">
253
 
<a name="id3673074"></a><h3>
254
 
<a name="GtkCellRendererProgress--text-xalign"></a>The :<code class="literal">text-xalign</code> property</h3>
255
 
<a class="indexterm" name="id3673091"></a><pre class="programlisting">  text-xalign              <a
256
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"
 
253
<a name="id3425505"></a><h3>
 
254
<a name="GtkCellRendererProgress--text-xalign"></a>The <code class="literal">"text-xalign"</code> property</h3>
 
255
<a class="indexterm" name="id3425523"></a><pre class="programlisting">  "text-xalign"              <a
 
256
href="../glib/glib-Basic-Types.html#gfloat"
257
257
>gfloat</a>                : Read / Write</pre>
258
258
<p>
259
259
The "text-xalign" property controls the horizontal alignment of the
269
269
</div>
270
270
<hr>
271
271
<div class="refsect2" lang="en">
272
 
<a name="id3673133"></a><h3>
273
 
<a name="GtkCellRendererProgress--text-yalign"></a>The :<code class="literal">text-yalign</code> property</h3>
274
 
<a class="indexterm" name="id3673149"></a><pre class="programlisting">  text-yalign              <a
275
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"
 
272
<a name="id3425565"></a><h3>
 
273
<a name="GtkCellRendererProgress--text-yalign"></a>The <code class="literal">"text-yalign"</code> property</h3>
 
274
<a class="indexterm" name="id3425582"></a><pre class="programlisting">  "text-yalign"              <a
 
275
href="../glib/glib-Basic-Types.html#gfloat"
276
276
>gfloat</a>                : Read / Write</pre>
277
277
<p>
278
278
The "text-yalign" property controls the vertical alignment of the
288
288
</div>
289
289
<hr>
290
290
<div class="refsect2" lang="en">
291
 
<a name="id3673191"></a><h3>
292
 
<a name="GtkCellRendererProgress--value"></a>The :<code class="literal">value</code> property</h3>
293
 
<a class="indexterm" name="id3673207"></a><pre class="programlisting">  value                    <a
294
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
291
<a name="id3425624"></a><h3>
 
292
<a name="GtkCellRendererProgress--value"></a>The <code class="literal">"value"</code> property</h3>
 
293
<a class="indexterm" name="id3425640"></a><pre class="programlisting">  "value"                    <a
 
294
href="../glib/glib-Basic-Types.html#gint"
295
295
>gint</a>                  : Read / Write</pre>
296
296
<p>
297
297
The "value" property determines the percentage to which the
305
305
</p>
306
306
</div>
307
307
</div>
 
308
<div class="refsect1" lang="en">
 
309
<a name="id3425682"></a><div class="refsect2" lang="en"><a name="id3425683"></a></div>
 
310
<hr>
 
311
<div class="refsect2" lang="en"><a name="id3425684"></a></div>
 
312
</div>
308
313
</div>
309
314
</body>
310
315
</html>