|
|
|
GTK+ Reference Manual | |
|---|---|---|---|---|
#include <gtk/gtk.h>
GtkProgressBar;
GtkWidget* gtk_progress_bar_new (void);
void gtk_progress_bar_pulse (GtkProgressBar *pbar);
void gtk_progress_bar_set_text (GtkProgressBar *pbar,
const gchar *text);
void gtk_progress_bar_set_fraction (GtkProgressBar *pbar,
gdouble fraction);
void gtk_progress_bar_set_pulse_step (GtkProgressBar *pbar,
gdouble fraction);
void gtk_progress_bar_set_orientation (GtkProgressBar *pbar,
GtkProgressBarOrientation orientation);
void gtk_progress_bar_set_ellipsize (GtkProgressBar *pbar,
PangoEllipsizeMode mode);
enum GtkProgressBarOrientation;
const gchar* gtk_progress_bar_get_text (GtkProgressBar *pbar);
gdouble gtk_progress_bar_get_fraction (GtkProgressBar *pbar);
gdouble gtk_progress_bar_get_pulse_step (GtkProgressBar *pbar);
GtkProgressBarOrientation gtk_progress_bar_get_orientation
(GtkProgressBar *pbar);
PangoEllipsizeMode gtk_progress_bar_get_ellipsize (GtkProgressBar *pbar);
GtkWidget* gtk_progress_bar_new_with_adjustment
(GtkAdjustment *adjustment);
void gtk_progress_bar_set_bar_style (GtkProgressBar *pbar,
GtkProgressBarStyle style);
enum GtkProgressBarStyle;
void gtk_progress_bar_set_discrete_blocks
(GtkProgressBar *pbar,
guint blocks);
void gtk_progress_bar_set_activity_step (GtkProgressBar *pbar,
guint step);
void gtk_progress_bar_set_activity_blocks
(GtkProgressBar *pbar,
guint blocks);
void gtk_progress_bar_update (GtkProgressBar *pbar,
gdouble percentage);
GObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkProgress +----GtkProgressBar
"activity-blocks" guint : Read / Write "activity-step" guint : Read / Write "adjustment" GtkAdjustment : Read / Write "bar-style" GtkProgressBarStyle : Read / Write "discrete-blocks" guint : Read / Write "ellipsize" PangoEllipsizeMode : Read / Write "fraction" gdouble : Read / Write "orientation" GtkProgressBarOrientation : Read / Write "pulse-step" gdouble : Read / Write "text" gchararray : Read / Write
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.
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.
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.
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.
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 10
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(), gtk_progress_bar_get_orientation().
These have been grouped at the beginning of this section, followed by
a large chunk of deprecated 1.2 compatibility functions.
typedef struct _GtkProgressBar GtkProgressBar;
The GtkProgressBar struct contains private data only, and should be accessed using the functions below.
GtkWidget* gtk_progress_bar_new (void);
Creates a new GtkProgressBar.
| Returns : | a GtkProgressBar. |
void gtk_progress_bar_pulse (GtkProgressBar *pbar);
Indicates that some progress is made, but you don't know how much.
Causes the progress bar to enter "activity mode," where a block
bounces back and forth. Each call to gtk_progress_bar_pulse()
causes the block to move by a little bit (the amount of movement
per pulse is determined by gtk_progress_bar_set_pulse_step()).
pbar : |
a GtkProgressBar |
void gtk_progress_bar_set_text (GtkProgressBar *pbar, const gchar *text);
Causes the given text to appear superimposed on the progress bar.
pbar : |
a GtkProgressBar |
text : |
a UTF-8 string, or NULL
|
void gtk_progress_bar_set_fraction (GtkProgressBar *pbar, gdouble fraction);
Causes the progress bar to "fill in" the given fraction of the bar. The fraction should be between 0.0 and 1.0, inclusive.
pbar : |
a GtkProgressBar |
fraction : |
fraction of the task that's been completed |
void gtk_progress_bar_set_pulse_step (GtkProgressBar *pbar, gdouble fraction);
Sets the fraction of total progress bar length to move the
bouncing block for each call to gtk_progress_bar_pulse().
pbar : |
a GtkProgressBar |
fraction : |
fraction between 0.0 and 1.0 |
void gtk_progress_bar_set_orientation (GtkProgressBar *pbar, GtkProgressBarOrientation orientation);
Causes the progress bar to switch to a different orientation (left-to-right, right-to-left, top-to-bottom, or bottom-to-top).
pbar : |
a GtkProgressBar |
orientation : |
orientation of the progress bar |
void gtk_progress_bar_set_ellipsize (GtkProgressBar *pbar, PangoEllipsizeMode mode);
Sets the mode used to ellipsize (add an ellipsis: "...") the text if there is not enough space to render the entire string.
pbar : |
a GtkProgressBar |
mode : |
a PangoEllipsizeMode |
Since 2.6
typedef enum
{
GTK_PROGRESS_LEFT_TO_RIGHT,
GTK_PROGRESS_RIGHT_TO_LEFT,
GTK_PROGRESS_BOTTOM_TO_TOP,
GTK_PROGRESS_TOP_TO_BOTTOM
} GtkProgressBarOrientation;
An enumeration representing possible orientations and growth directions for the visible progress bar.
const gchar* gtk_progress_bar_get_text (GtkProgressBar *pbar);
Retrieves the text displayed superimposed on the progress bar,
if any, otherwise NULL. The return value is a reference
to the text, not a copy of it, so will become invalid
if you change the text in the progress bar.
pbar : |
a GtkProgressBar |
| Returns : | text, or NULL; this string is owned by the widget
and should not be modified or freed.
|
gdouble gtk_progress_bar_get_fraction (GtkProgressBar *pbar);
Returns the current fraction of the task that's been completed.
pbar : |
a GtkProgressBar |
| Returns : | a fraction from 0.0 to 1.0 |
gdouble gtk_progress_bar_get_pulse_step (GtkProgressBar *pbar);
Retrieves the pulse step set with gtk_progress_bar_set_pulse_step()
pbar : |
a GtkProgressBar |
| Returns : | a fraction from 0.0 to 1.0 |
GtkProgressBarOrientation gtk_progress_bar_get_orientation (GtkProgressBar *pbar);
Retrieves the current progress bar orientation.
pbar : |
a GtkProgressBar |
| Returns : | orientation of the progress bar |
PangoEllipsizeMode gtk_progress_bar_get_ellipsize (GtkProgressBar *pbar);
Returns the ellipsizing position of the progressbar.
See gtk_progress_bar_set_ellipsize().
pbar : |
a GtkProgressBar |
| Returns : | PangoEllipsizeMode |
Since 2.6
GtkWidget* gtk_progress_bar_new_with_adjustment (GtkAdjustment *adjustment);
gtk_progress_bar_new_with_adjustment is deprecated and should not be used in newly-written code.
Creates a new GtkProgressBar with an associated GtkAdjustment.
adjustment : |
a GtkAdjustment. |
| Returns : | a GtkProgressBar. |
void gtk_progress_bar_set_bar_style (GtkProgressBar *pbar, GtkProgressBarStyle style);
gtk_progress_bar_set_bar_style is deprecated and should not be used in newly-written code.
Sets the style of the GtkProgressBar. The default style is
GTK_PROGRESS_CONTINUOUS.
pbar : |
a GtkProgressBar. |
style : |
a GtkProgressBarStyle value indicating the desired style. |
typedef enum
{
GTK_PROGRESS_CONTINUOUS,
GTK_PROGRESS_DISCRETE
} GtkProgressBarStyle;
An enumeration representing the styles for drawing the progress bar.
void gtk_progress_bar_set_discrete_blocks
(GtkProgressBar *pbar,
guint blocks);
gtk_progress_bar_set_discrete_blocks is deprecated and should not be used in newly-written code.
Sets the number of blocks that the progress bar is divided into
when the style is GTK_PROGRESS_DISCRETE.
pbar : |
a GtkProgressBar. |
blocks : |
number of individual blocks making up the bar. |
void gtk_progress_bar_set_activity_step (GtkProgressBar *pbar, guint step);
gtk_progress_bar_set_activity_step is deprecated and should not be used in newly-written code.
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.
pbar : |
a GtkProgressBar. |
step : |
the amount which the progress is incremented in activity mode. |
void gtk_progress_bar_set_activity_blocks
(GtkProgressBar *pbar,
guint blocks);
gtk_progress_bar_set_activity_blocks is deprecated and should not be used in newly-written code.
Sets the number of blocks used when the progress bar is in activity mode. Larger numbers make the visible block smaller.
pbar : |
a GtkProgressBar. |
blocks : |
number of blocks which can fit within the progress bar area. |
void gtk_progress_bar_update (GtkProgressBar *pbar, gdouble percentage);
gtk_progress_bar_update is deprecated and should not be used in newly-written code.
This function is deprecated. Please use gtk_progress_set_value() or
gtk_progress_set_percentage() instead.
pbar : |
a GtkProgressBar. |
percentage : |
the new percent complete value. |
"activity-blocks" property"activity-blocks" guint : Read / Write
The number of blocks which can fit in the progress bar area in activity mode (Deprecated).
Allowed values: >= 2
Default value: 5
"activity-step" property"activity-step" guint : Read / Write
The increment used for each iteration in activity mode (Deprecated).
Default value: 3
"adjustment" property"adjustment" GtkAdjustment : Read / Write
The GtkAdjustment connected to the progress bar (Deprecated).
"bar-style" property"bar-style" GtkProgressBarStyle : Read / Write
Specifies the visual style of the bar in percentage mode (Deprecated).
Default value: GTK_PROGRESS_CONTINUOUS
"discrete-blocks" property"discrete-blocks" guint : Read / Write
The number of discrete blocks in a progress bar (when shown in the discrete style).
Allowed values: >= 2
Default value: 10
"ellipsize" property"ellipsize" PangoEllipsizeMode : Read / Write
The preferred place to ellipsize the string, if the progressbar does not have enough room to display the entire string, specified as a PangoEllisizeMode.
Note that setting this property to a value other than
PANGO_ELLIPSIZE_NONE has the side-effect that the progressbar requests
only enough space to display the ellipsis "...". Another means to set a
progressbar's width is gtk_widget_set_size_request().
Default value: PANGO_ELLIPSIZE_NONE
Since 2.6
"fraction" property"fraction" gdouble : Read / Write
The fraction of total work that has been completed.
Allowed values: [0,1]
Default value: 0
"orientation" property"orientation" GtkProgressBarOrientation : Read / Write
Orientation and growth direction of the progress bar.
Default value: GTK_PROGRESS_LEFT_TO_RIGHT
"pulse-step" property"pulse-step" gdouble : Read / Write
The fraction of total progress to move the bouncing block when pulsed.
Allowed values: [0,1]
Default value: 0.1
"text" property"text" gchararray : Read / Write
Text to be displayed in the progress bar.
Default value: "%P %%"
"xspacing" style property"xspacing" gint : Read / Write
Extra spacing applied to the width of a progress bar.
Allowed values: >= 0
Default value: 7
"yspacing" style property"yspacing" gint : Read / Write
Extra spacing applied to the height of a progress bar.
Allowed values: >= 0
Default value: 7