docs/reference/gtk/html/GtkCellRendererProgress.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GtkCellRendererProgress</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
   8 <link rel="up" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
   9 <link rel="prev" href="GtkCellRendererPixbuf.html" title="GtkCellRendererPixbuf">
  10 <link rel="next" href="GtkCellRendererSpin.html" title="GtkCellRendererSpin">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="GtkCellRendererPixbuf.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="TreeWidgetObjects.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GTK+ 3 Reference Manual</th>
  21 <td><a accesskey="n" href="GtkCellRendererSpin.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#GtkCellRendererProgress.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GtkCellRendererProgress.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GtkCellRendererProgress.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#GtkCellRendererProgress.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#GtkCellRendererProgress.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="GtkCellRendererProgress"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="GtkCellRendererProgress.top_of_page"></a>GtkCellRendererProgress</span></h2>
  40 <p>GtkCellRendererProgress — Renders numbers as progress bars</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="GtkCellRendererProgress.synopsis"></a><h2>Synopsis</h2>
  46 <pre class="synopsis">
  47 #include &lt;gtk/gtk.h&gt;
  48
  49 struct              <a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress-struct" title="struct GtkCellRendererProgress">GtkCellRendererProgress</a>;
  50 <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>);
  51 </pre>
  52 </div>
  53 <div class="refsect1">
  54 <a name="GtkCellRendererProgress.object-hierarchy"></a><h2>Object Hierarchy</h2>
  55 <pre class="synopsis">
  56   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  57    +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
  58          +----<a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer">GtkCellRenderer</a>
  59                +----GtkCellRendererProgress
  60 </pre>
  61 </div>
  62 <div class="refsect1">
  63 <a name="GtkCellRendererProgress.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  64 <p>
  65 GtkCellRendererProgress implements
  66  <a class="link" href="gtk3-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
  67 </div>
  68 <div class="refsect1">
  69 <a name="GtkCellRendererProgress.properties"></a><h2>Properties</h2>
  70 <pre class="synopsis">
  71   "<a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress--inverted" title='The "inverted" property'>inverted</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  72   "<a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress--pulse" title='The "pulse" property'>pulse</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  73   "<a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress--text" title='The "text" property'>text</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  74   "<a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress--text-xalign" title='The "text-xalign" property'>text-xalign</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write
  75   "<a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress--text-yalign" title='The "text-yalign" property'>text-yalign</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write
  76   "<a class="link" href="GtkCellRendererProgress.html#GtkCellRendererProgress--value" title='The "value" property'>value</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  77 </pre>
  78 </div>
  79 <div class="refsect1">
  80 <a name="GtkCellRendererProgress.description"></a><h2>Description</h2>
  81 <p>
  82 <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.
  83 Additionally, it can display a text on top of the progress bar.
  84 </p>
  85 <p>
  86 The <a class="link" href="GtkCellRendererProgress.html" title="GtkCellRendererProgress"><span class="type">GtkCellRendererProgress</span></a> cell renderer was added in GTK+ 2.6.
  87 </p>
  88 </div>
  89 <div class="refsect1">
  90 <a name="GtkCellRendererProgress.details"></a><h2>Details</h2>
  91 <div class="refsect2">
  92 <a name="GtkCellRendererProgress-struct"></a><h3>struct GtkCellRendererProgress</h3>
  93 <pre class="programlisting">struct GtkCellRendererProgress;</pre>
  94 </div>
  95 <hr>
  96 <div class="refsect2">
  97 <a name="gtk-cell-renderer-progress-new"></a><h3>gtk_cell_renderer_progress_new ()</h3>
  98 <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>
  99 <p>
 100 Creates a new <a class="link" href="GtkCellRendererProgress.html" title="GtkCellRendererProgress"><span class="type">GtkCellRendererProgress</span></a>.
 101 </p>
 102 <div class="variablelist"><table border="0">
 103 <col align="left" valign="top">
 104 <tbody><tr>
 105 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 106 <td>the new cell renderer</td>
 107 </tr></tbody>
 108 </table></div>
 109 <p class="since">Since 2.6</p>
 110 </div>
 111 </div>
 112 <div class="refsect1">
 113 <a name="GtkCellRendererProgress.property-details"></a><h2>Property Details</h2>
 114 <div class="refsect2">
 115 <a name="GtkCellRendererProgress--inverted"></a><h3>The <code class="literal">"inverted"</code> property</h3>
 116 <pre class="programlisting">  "inverted"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 117 <p>Invert the direction in which the progress bar grows.</p>
 118 <p>Default value: FALSE</p>
 119 </div>
 120 <hr>
 121 <div class="refsect2">
 122 <a name="GtkCellRendererProgress--pulse"></a><h3>The <code class="literal">"pulse"</code> property</h3>
 123 <pre class="programlisting">  "pulse"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 124 <p>
 125 Setting this to a non-negative value causes the cell renderer to
 126 enter "activity mode", where a block bounces back and forth to
 127 indicate that some progress is made, without specifying exactly how
 128 much.
 129 </p>
 130 <p>
 131 Each increment of the property causes the block to move by a little
 132 bit.
 133 </p>
 134 <p>
 135 To indicate that the activity has not started yet, set the property
 136 to zero. To indicate completion, set the property to <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#G-MAXINT:CAPS"><code class="literal">G_MAXINT</code></a>.
 137 </p>
 138 <p>Allowed values: &gt;= G_MAXULONG</p>
 139 <p>Default value: -1</p>
 140 <p class="since">Since 2.12</p>
 141 </div>
 142 <hr>
 143 <div class="refsect2">
 144 <a name="GtkCellRendererProgress--text"></a><h3>The <code class="literal">"text"</code> property</h3>
 145 <pre class="programlisting">  "text"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 146 <p>
 147 The "text" property determines the label which will be drawn
 148 over the progress bar. Setting this property to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> causes the default
 149 label to be displayed. Setting this property to an empty string causes
 150 no label to be displayed.
 151 </p>
 152 <p>Default value: NULL</p>
 153 <p class="since">Since 2.6</p>
 154 </div>
 155 <hr>
 156 <div class="refsect2">
 157 <a name="GtkCellRendererProgress--text-xalign"></a><h3>The <code class="literal">"text-xalign"</code> property</h3>
 158 <pre class="programlisting">  "text-xalign"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write</pre>
 159 <p>
 160 The "text-xalign" property controls the horizontal alignment of the
 161 text in the progress bar.  Valid values range from 0 (left) to 1
 162 (right).  Reserved for RTL layouts.
 163 </p>
 164 <p>Allowed values: [0,1]</p>
 165 <p>Default value: 0.5</p>
 166 <p class="since">Since 2.12</p>
 167 </div>
 168 <hr>
 169 <div class="refsect2">
 170 <a name="GtkCellRendererProgress--text-yalign"></a><h3>The <code class="literal">"text-yalign"</code> property</h3>
 171 <pre class="programlisting">  "text-yalign"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write</pre>
 172 <p>
 173 The "text-yalign" property controls the vertical alignment of the
 174 text in the progress bar.  Valid values range from 0 (top) to 1
 175 (bottom).
 176 </p>
 177 <p>Allowed values: [0,1]</p>
 178 <p>Default value: 0.5</p>
 179 <p class="since">Since 2.12</p>
 180 </div>
 181 <hr>
 182 <div class="refsect2">
 183 <a name="GtkCellRendererProgress--value"></a><h3>The <code class="literal">"value"</code> property</h3>
 184 <pre class="programlisting">  "value"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 185 <p>
 186 The "value" property determines the percentage to which the
 187 progress bar will be "filled in".
 188 </p>
 189 <p>Allowed values: [0,100]</p>
 190 <p>Default value: 0</p>
 191 <p class="since">Since 2.6</p>
 192 </div>
 193 </div>
 194 </div>
 195 <div class="footer">
 196 <hr>
 197           Generated by GTK-Doc V1.18</div>
 198 </body>
 199 </html>