|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/gtk-doc/html/gtk/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GtkProgress</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GTK+ Reference Manual">
<link rel="up" href="DeprecatedObjects.html" title="Deprecated">
<link rel="prev" href="GtkPreview.html" title="GtkPreview">
<link rel="next" href="GtkText.html" title="GtkText">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and
GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
</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="GtkPreview.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="DeprecatedObjects.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+ Reference Manual</th>
<td><a accesskey="n" href="GtkText.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3923870" class="shortcut">Top</a>
 | 
<a href="#id3924445" class="shortcut">Description</a>
 | 
<a href="#id3924285" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id3924339" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id3924362" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkProgress"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id3923870"></a><span class="refentrytitle">GtkProgress</span>
</h2>
<p>GtkProgress — Base class for GtkProgressBar</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <gtk/gtk.h>
<a href="GtkProgress.html#GtkProgress-struct">GtkProgress</a>;
void <a href="GtkProgress.html#gtk-progress-set-show-text">gtk_progress_set_show_text</a> (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> show_text);
void <a href="GtkProgress.html#gtk-progress-set-text-alignment">gtk_progress_set_text_alignment</a> (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
<a
href="../glib/glib-Basic-Types.html#gfloat"
>gfloat</a> x_align,
<a
href="../glib/glib-Basic-Types.html#gfloat"
>gfloat</a> y_align);
void <a href="GtkProgress.html#gtk-progress-set-format-string">gtk_progress_set_format_string</a> (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *format);
void <a href="GtkProgress.html#gtk-progress-set-adjustment">gtk_progress_set_adjustment</a> (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
<a href="GtkAdjustment.html" title="GtkAdjustment">GtkAdjustment</a> *adjustment);
void <a href="GtkProgress.html#gtk-progress-set-percentage">gtk_progress_set_percentage</a> (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> percentage);
void <a href="GtkProgress.html#gtk-progress-set-value">gtk_progress_set_value</a> (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> value);
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> <a href="GtkProgress.html#gtk-progress-get-value">gtk_progress_get_value</a> (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress);
void <a href="GtkProgress.html#gtk-progress-set-activity-mode">gtk_progress_set_activity_mode</a> (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> activity_mode);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="GtkProgress.html#gtk-progress-get-current-text">gtk_progress_get_current_text</a> (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="GtkProgress.html#gtk-progress-get-text-from-value">gtk_progress_get_text_from_value</a>
(<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> value);
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> <a href="GtkProgress.html#gtk-progress-get-current-percentage">gtk_progress_get_current_percentage</a>
(<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress);
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> <a href="GtkProgress.html#gtk-progress-get-percentage-from-value">gtk_progress_get_percentage_from_value</a>
(<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> value);
void <a href="GtkProgress.html#gtk-progress-configure">gtk_progress_configure</a> (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> value,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> hmin,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> max);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3924285"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a href="GtkObject.html" title="GtkObject">GtkObject</a>
+----<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
+----GtkProgress
+----<a href="GtkProgressBar.html" title="GtkProgressBar">GtkProgressBar</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3924339"></a><h2>Implemented Interfaces</h2>
<p>
GtkProgress implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id3924362"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GtkProgress.html#GtkProgress--activity-mode">activity-mode</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write
"<a href="GtkProgress.html#GtkProgress--show-text">show-text</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write
"<a href="GtkProgress.html#GtkProgress--text-xalign">text-xalign</a>" <a
href="../glib/glib-Basic-Types.html#gfloat"
>gfloat</a> : Read / Write
"<a href="GtkProgress.html#GtkProgress--text-yalign">text-yalign</a>" <a
href="../glib/glib-Basic-Types.html#gfloat"
>gfloat</a> : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3924445"></a><h2>Description</h2>
<p>
A <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> is the abstract base class used to derive
a <a href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> which provides a visual representation of
the progress of a long running operation.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id3924478"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id3924488"></a><h3>
<a name="GtkProgress-struct"></a>GtkProgress</h3>
<a class="indexterm" name="id3924501"></a><pre class="programlisting">typedef struct _GtkProgress GtkProgress;</pre>
<p>
The <a href="GtkProgress.html#GtkProgress-struct"><span class="type">GtkProgress</span></a> struct contains private data only.
and should be accessed using the functions below.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3924526"></a><h3>
<a name="gtk-progress-set-show-text"></a>gtk_progress_set_show_text ()</h3>
<a class="indexterm" name="id3924542"></a><pre class="programlisting">void gtk_progress_set_show_text (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> show_text);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_progress_set_show_text</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Controls whether progress text is shown.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>progress</code></em> :</span></td>
<td>a <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>show_text</code></em> :</span></td>
<td>a boolean indicating whether the progress text
is shown.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3924631"></a><h3>
<a name="gtk-progress-set-text-alignment"></a>gtk_progress_set_text_alignment ()</h3>
<a class="indexterm" name="id3924646"></a><pre class="programlisting">void gtk_progress_set_text_alignment (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
<a
href="../glib/glib-Basic-Types.html#gfloat"
>gfloat</a> x_align,
<a
href="../glib/glib-Basic-Types.html#gfloat"
>gfloat</a> y_align);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_progress_set_text_alignment</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Controls the alignment of the text within the progress bar area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>progress</code></em> :</span></td>
<td>a <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>x_align</code></em> :</span></td>
<td>a number between 0.0 and 1.0 indicating the horizontal
alignment of the progress text within the <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y_align</code></em> :</span></td>
<td>a number between 0.0 and 1.0 indicating the vertical
alignment of the progress text within the <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3924776"></a><h3>
<a name="gtk-progress-set-format-string"></a>gtk_progress_set_format_string ()</h3>
<a class="indexterm" name="id3924792"></a><pre class="programlisting">void gtk_progress_set_format_string (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *format);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_progress_set_format_string</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Sets a format string used to display text indicating the
current progress. The string can contain the following substitution characters:
</p>
<div class="itemizedlist"><ul type="disc">
<li><p>
%v - the current progress value.
</p></li>
<li><p>
%l - the lower bound for the progress value.
</p></li>
<li><p>
%u - the upper bound for the progress value.
</p></li>
<li><p>
%p - the current progress percentage.
</p></li>
</ul></div>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>progress</code></em> :</span></td>
<td>a <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>format</code></em> :</span></td>
<td>a string used to display progress text, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
to restore to the default format.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3924926"></a><h3>
<a name="gtk-progress-set-adjustment"></a>gtk_progress_set_adjustment ()</h3>
<a class="indexterm" name="id3924943"></a><pre class="programlisting">void gtk_progress_set_adjustment (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
<a href="GtkAdjustment.html" title="GtkAdjustment">GtkAdjustment</a> *adjustment);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_progress_set_adjustment</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Associates a <a href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> with the <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>. A <a href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>
is used to represent the upper and lower bounds and the step interval
of the underlying value for which progress is shown.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>progress</code></em> :</span></td>
<td>a <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>adjustment</code></em> :</span></td>
<td>the <a href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> to be associated with the <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3925074"></a><h3>
<a name="gtk-progress-set-percentage"></a>gtk_progress_set_percentage ()</h3>
<a class="indexterm" name="id3925090"></a><pre class="programlisting">void gtk_progress_set_percentage (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> percentage);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_progress_set_percentage</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Sets the current percentage completion for the <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>progress</code></em> :</span></td>
<td>a <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>percentage</code></em> :</span></td>
<td>the percentage complete which must be between 0.0
and 1.0.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3925187"></a><h3>
<a name="gtk-progress-set-value"></a>gtk_progress_set_value ()</h3>
<a class="indexterm" name="id3925203"></a><pre class="programlisting">void gtk_progress_set_value (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> value);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_progress_set_value</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Sets the value within the <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> to an absolute value.
The value must be within the valid range of values for the
underlying <a href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>progress</code></em> :</span></td>
<td>a <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>value</code></em> :</span></td>
<td>the value indicating the current completed amount.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3925310"></a><h3>
<a name="gtk-progress-get-value"></a>gtk_progress_get_value ()</h3>
<a class="indexterm" name="id3925325"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> gtk_progress_get_value (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_progress_get_value</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Returns the current progress complete value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>progress</code></em> :</span></td>
<td>a <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the current progress complete value.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3925404"></a><h3>
<a name="gtk-progress-set-activity-mode"></a>gtk_progress_set_activity_mode ()</h3>
<a class="indexterm" name="id3925419"></a><pre class="programlisting">void gtk_progress_set_activity_mode (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> activity_mode);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_progress_set_activity_mode</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
A <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> can be in one of two different modes: percentage
mode (the default) and activity mode. In activity mode, the
progress is simply indicated as activity rather than as a percentage
complete.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>progress</code></em> :</span></td>
<td>a <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>activity_mode</code></em> :</span></td>
<td>a boolean, <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> for activity mode.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3925529"></a><h3>
<a name="gtk-progress-get-current-text"></a>gtk_progress_get_current_text ()</h3>
<a class="indexterm" name="id3925545"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gtk_progress_get_current_text (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_progress_get_current_text</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Returns the current text associated with the <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>. This
text is the based on the underlying format string after any substitutions
are made.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>progress</code></em> :</span></td>
<td>a <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>the text indicating the current progress.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3925633"></a><h3>
<a name="gtk-progress-get-text-from-value"></a>gtk_progress_get_text_from_value ()</h3>
<a class="indexterm" name="id3925649"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gtk_progress_get_text_from_value
(<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> value);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_progress_get_text_from_value</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Returns the text indicating the progress based on the supplied value.
The current value for the <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a> remains unchanged.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>progress</code></em> :</span></td>
<td>a <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>value</code></em> :</span></td>
<td>an absolute progress value to use when formatting the progress text.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>a string indicating the progress.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3925760"></a><h3>
<a name="gtk-progress-get-current-percentage"></a>gtk_progress_get_current_percentage ()</h3>
<a class="indexterm" name="id3925777"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> gtk_progress_get_current_percentage
(<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_progress_get_current_percentage</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Returns the current progress as a percentage.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>progress</code></em> :</span></td>
<td>a <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>a number between 0.0 and 1.0 indicating the percentage complete.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3925856"></a><h3>
<a name="gtk-progress-get-percentage-from-value"></a>gtk_progress_get_percentage_from_value ()</h3>
<a class="indexterm" name="id3925873"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> gtk_progress_get_percentage_from_value
(<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> value);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_progress_get_percentage_from_value</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Returns the progress as a percentage calculated from the supplied
absolute progress value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>progress</code></em> :</span></td>
<td>a <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>value</code></em> :</span></td>
<td>an absolute progress value.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>a number between 0.0 and 1.0 indicating the percentage complete
represented by <em class="parameter"><code>value</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3925982"></a><h3>
<a name="gtk-progress-configure"></a>gtk_progress_configure ()</h3>
<a class="indexterm" name="id3925997"></a><pre class="programlisting">void gtk_progress_configure (<a href="GtkProgress.html" title="GtkProgress">GtkProgress</a> *progress,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> value,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> hmin,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> max);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_progress_configure</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Allows the configuration of the minimum, maximum, and current values for
the <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>progress</code></em> :</span></td>
<td>a <a href="GtkProgress.html" title="GtkProgress"><span class="type">GtkProgress</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>value</code></em> :</span></td>
<td>the current progress value.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>hmin</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>max</code></em> :</span></td>
<td>the maximum progress value.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3926138"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id3926149"></a><h3>
<a name="GtkProgress--activity-mode"></a>The "<code class="literal">activity-mode</code>" property</h3>
<a class="indexterm" name="id3926166"></a><pre class="programlisting"> "activity-mode" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write</pre>
<p>If TRUE, the GtkProgress is in activity mode, meaning that it signals something is happening, but not how much of the activity is finished. This is used when you're doing something that you don't know how long it will take.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3926196"></a><h3>
<a name="GtkProgress--show-text"></a>The "<code class="literal">show-text</code>" property</h3>
<a class="indexterm" name="id3926212"></a><pre class="programlisting"> "show-text" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write</pre>
<p>Whether the progress is shown as text.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3926239"></a><h3>
<a name="GtkProgress--text-xalign"></a>The "<code class="literal">text-xalign</code>" property</h3>
<a class="indexterm" name="id3926256"></a><pre class="programlisting"> "text-xalign" <a
href="../glib/glib-Basic-Types.html#gfloat"
>gfloat</a> : Read / Write</pre>
<p>A number between 0.0 and 1.0 specifying the horizontal alignment of the text in the progress widget.</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0.5</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3926287"></a><h3>
<a name="GtkProgress--text-yalign"></a>The "<code class="literal">text-yalign</code>" property</h3>
<a class="indexterm" name="id3926304"></a><pre class="programlisting"> "text-yalign" <a
href="../glib/glib-Basic-Types.html#gfloat"
>gfloat</a> : Read / Write</pre>
<p>A number between 0.0 and 1.0 specifying the vertical alignment of the text in the progress widget.</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0.5</p>
</div>
</div>
</div>
</body>
</html>