gtk2/docs/reference/gtk/tmpl/gtkprogressbar.sgml

324 lines
7.5 KiB
Plaintext
Raw Normal View History

1999-08-16 18:51:52 +00:00
<!-- ##### SECTION Title ##### -->
GtkProgressBar
<!-- ##### SECTION Short_Description ##### -->
a widget which indicates progress visually.
1999-08-16 18:51:52 +00:00
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkProgressBar is typically used to display the progress of a long
running operation. It provides a visual clue that processing
is underway. The #GtkProgressBar can be used in two different
modes: percentage mode and activity mode.
</para>
<para>
When an application can determine how much work needs to take place
(e.g. read a fixed number of bytes from a file) and can monitor its
progress, it can use the #GtkProgressBar in percentage mode and the user
sees a growing bar indicating the percentage of the work that has
been completed. In this mode, the application is required to call
gtk_progress_bar_set_fraction() periodically to update the progress bar.
</para>
1999-08-16 18:51:52 +00:00
<para>
When an application has no accurate way of knowing the amount of work
to do, it can use the #GtkProgressBar in activity mode, which shows activity
by a block moving back and forth within the progress area. In this mode,
the application is required to call gtk_progress_bar_pulse() perodically
to update the progress bar.
</para>
<para>
There is quite a bit of flexibility provided to control the appearance
of the #GtkProgressBar. Functions are provided to control the
orientation of the bar, optional text can be displayed along with
the bar, and the step size used in activity mode can be set.
1999-08-16 18:51:52 +00:00
</para>
<note>
<para>
The #GtkProgressBar/#GtkProgress API in GTK 1.2 was bloated, needlessly complex
and hard to use properly. Therefore #GtkProgress has been deprecated
completely and the #GtkProgressBar API has been reduced to the following 9
functions: gtk_progress_bar_new(), gtk_progress_bar_pulse(), gtk_progress_bar_set_text(),
gtk_progress_bar_set_fraction(), gtk_progress_bar_set_pulse_step(),
gtk_progress_bar_set_orientation(), gtk_progress_bar_get_text(),
gtk_progress_bar_get_fraction(), gtk_progress_bar_get_pulse_step(). These have
been grouped at the beginning of this section, followed by a large chunk of
deprecated 1.2 compatibility functions.
</para>
</note>
1999-08-16 18:51:52 +00:00
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkProgressBar ##### -->
<para>
The #GtkProgressBar-struct struct contains private data only,
and should be accessed using the functions below.
1999-08-16 18:51:52 +00:00
</para>
<!-- ##### FUNCTION gtk_progress_bar_new ##### -->
1999-08-16 18:51:52 +00:00
<para>
Creates a new #GtkProgressBar.
</para>
1999-08-16 18:51:52 +00:00
@Returns: a #GtkProgressBar.
<!-- ##### FUNCTION gtk_progress_bar_pulse ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
@pbar:
<!-- ##### FUNCTION gtk_progress_bar_set_text ##### -->
<para>
</para>
@pbar:
@text:
<!-- ##### FUNCTION gtk_progress_bar_set_fraction ##### -->
<para>
</para>
@pbar:
@fraction:
<!-- ##### FUNCTION gtk_progress_bar_set_pulse_step ##### -->
<para>
</para>
@pbar:
@fraction:
<!-- ##### FUNCTION gtk_progress_bar_set_orientation ##### -->
<para>
</para>
@pbar:
@orientation:
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GtkProgressBarOrientation ##### -->
<para>
An enumeration representing possible orientations and growth
directions for the visible progress bar.
1999-08-16 18:51:52 +00:00
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GTK_PROGRESS_LEFT_TO_RIGHT</entry>
<entry>A horizontal progress bar growing from left to right.</entry>
</row>
<row>
<entry>GTK_PROGRESS_RIGHT_TO_LEFT</entry>
<entry>A horizontal progress bar growing from right to left.</entry>
</row>
1999-08-16 18:51:52 +00:00
<row>
<entry>GTK_PROGRESS_BOTTOM_TO_TOP</entry>
<entry>A vertical progress bar growing from bottom to top.</entry>
</row>
<row>
<entry>GTK_PROGRESS_TOP_TO_BOTTOM</entry>
<entry>A vertical progress bar growing from top to bottom.</entry>
</row>
</tbody></tgroup></informaltable>
</para>
1999-08-16 18:51:52 +00:00
@GTK_PROGRESS_LEFT_TO_RIGHT:
@GTK_PROGRESS_RIGHT_TO_LEFT:
@GTK_PROGRESS_BOTTOM_TO_TOP:
@GTK_PROGRESS_TOP_TO_BOTTOM:
<!-- ##### FUNCTION gtk_progress_bar_get_text ##### -->
<para>
</para>
@pbar:
@Returns:
<!-- ##### FUNCTION gtk_progress_bar_get_fraction ##### -->
<para>
</para>
@pbar:
@Returns:
<!-- ##### FUNCTION gtk_progress_bar_get_pulse_step ##### -->
<para>
</para>
@pbar:
@Returns:
<!-- ##### FUNCTION gtk_progress_bar_get_orientation ##### -->
<para>
</para>
@pbar:
@Returns:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_progress_bar_new_with_adjustment ##### -->
<para>
Creates a new #GtkProgressBar with an associated #GtkAdjustment.
1999-08-16 18:51:52 +00:00
</para>
@adjustment: a #GtkAdjustment.
@Returns: a #GtkProgressBar.
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_progress_bar_set_bar_style ##### -->
<para>
Sets the style of the #GtkProgressBar. The default style is
%GTK_PROGRESS_CONTINUOUS.
1999-08-16 18:51:52 +00:00
</para>
@pbar: a #GtkProgressBar.
@style: a #GtkProgressBarStyle value indicating the desired style.
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GtkProgressBarStyle ##### -->
<para>
An enumeration representing the styles for drawing the progress bar.
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GTK_PROGRESS_CONTINUOUS</entry>
<entry>The progress bar grows in a smooth, continuous manner.</entry>
</row>
<row>
<entry>GTK_PROGRESS_DISCRETE</entry>
<entry>The progress bar grows in discrete, visible blocks.</entry>
</row>
</tbody></tgroup></informaltable>
</para>
@GTK_PROGRESS_CONTINUOUS:
@GTK_PROGRESS_DISCRETE:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_progress_bar_set_discrete_blocks ##### -->
<para>
Sets the number of blocks that the progress bar is divided into
when the style is %GTK_PROGRESS_DISCRETE.
1999-08-16 18:51:52 +00:00
</para>
@pbar: a #GtkProgressBar.
@blocks: number of individual blocks making up the bar.
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_progress_bar_set_activity_step ##### -->
<para>
Sets the step value used when the progress bar is in activity
mode. The step is the amount by which the progress is incremented
each iteration.
1999-08-16 18:51:52 +00:00
</para>
@pbar: a #GtkProgressBar.
@step: the amount which the progress is incremented in activity
mode.
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_progress_bar_set_activity_blocks ##### -->
<para>
Sets the number of blocks used when the progress bar is in activity
mode. Larger numbers make the visible block smaller.
1999-08-16 18:51:52 +00:00
</para>
@pbar: a #GtkProgressBar.
@blocks: number of blocks which can fit within the progress bar area.
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_progress_bar_update ##### -->
<para>
This function is deprecated. Please use gtk_progress_set_value() or
gtk_progress_set_percentage() instead.
1999-08-16 18:51:52 +00:00
</para>
@pbar: a #GtkProgressBar.
@percentage: the new percent complete value.
1999-08-16 18:51:52 +00:00
<!-- ##### ARG GtkProgressBar:fraction ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
<!-- ##### ARG GtkProgressBar:pulse-step ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
<!-- ##### ARG GtkProgressBar:orientation ##### -->
<para>
a #GtkProgressBarOrientation value which specifies the
orientation and growth direction of the bar.
1999-08-16 18:51:52 +00:00
</para>
<!-- ##### ARG GtkProgressBar:text ##### -->
<para>
</para>
<!-- ##### ARG GtkProgressBar:adjustment ##### -->
<para>
a #GtkAdjustment to be used with the #GtkProgressBar.
</para>
<!-- ##### ARG GtkProgressBar:bar-style ##### -->
1999-08-16 18:51:52 +00:00
<para>
a #GtkProgressBarStyle value which specifies the
visual style of the bar in percentage mode.
1999-08-16 18:51:52 +00:00
</para>
<!-- ##### ARG GtkProgressBar:activity-step ##### -->
1999-08-16 18:51:52 +00:00
<para>
The increment used for each iteration in activity mode.
1999-08-16 18:51:52 +00:00
</para>
<!-- ##### ARG GtkProgressBar:activity-blocks ##### -->
1999-08-16 18:51:52 +00:00
<para>
The number of blocks which can fit in the progress bar
area in activity mode.
1999-08-16 18:51:52 +00:00
</para>
<!-- ##### ARG GtkProgressBar:discrete-blocks ##### -->
1999-08-16 18:51:52 +00:00
<para>
The number of blocks which which make up progress bar
when it is shown in %GTK_PROGRESS_DISCRETE style.
1999-08-16 18:51:52 +00:00
</para>