Class Index Cross Index Namespace Index

Class Gtk::ProgressBar

A widget which indicates progress visually.
Contained in: Gtk
Derived from: Gtk::Progress
Derived by: none

#include <gtk--/progressbar.h>


public function member index:

ProgressBar();
explicit ProgressBar(Adjustment& adjustment);
guint get_activity_blocks() const;
guint get_activity_step() const;
GtkProgressBarStyle get_bar_style() const;
guint get_discrete_blocks() const;
GtkProgressBarOrientation get_orientation() const;
GtkProgressBar* gtkobj();
const GtkProgressBar* gtkobj() const;
static bool isA(Object* object);
void set_activity_blocks(guint blocks=5);
void set_activity_step(guint step=3);
void set_bar_style(GtkProgressBarStyle style=GTK_PROGRESS_CONTINUOUS);
void set_discrete_blocks(guint blocks=10);
void set_orientation(GtkProgressBarOrientation orientation=GTK_PROGRESS_LEFT_TO_RIGHT);
virtual ~ProgressBar();
 

Description:

The Gtk::ProgressBar is typically used to display the progress of a long running operation. It provides a visual clue that processing is underway. The Gtk::ProgressBar 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 Gtk::ProgressBar 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 either the or functions 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. In this mode the progress bar shows activity by a block moving back and forth within the progress area.

There is quite a bit of flexibility provided to control the appearance of the Gtk::ProgressBar. Functions are provided to control the orientation of the bar, optional text which can be displayed along with the bar, and the style in which the bar grows.


Function Member Descriptions:

Gtk::ProgressBar::ProgressBar - Creates a new Gtk::ProgressBar with an associated Gtk::Adjustment.

explicit ProgressBar(Adjustment& adjustment);
adjustment: A Gtk::Adjustment


Gtk::ProgressBar::gtkobj - Returns the underlaying gtk+ object.

GtkProgressBar* gtkobj();

Gtk::ProgressBar::isA - Returns true if object is this type.

static bool isA(Object* object);

Gtk::ProgressBar::set_bar_style - Sets the style of the Gtk::ProgressBar. The default style is GTK_PROGRESS_CONTINUOUS.

void set_bar_style(GtkProgressBarStyle style=GTK_PROGRESS_CONTINUOUS);
style: A Gtk::ProgressBarStyle value indicating the desired style.