gtk.ProgressBar.ProgressBar Class Reference

Inheritance diagram for gtk.ProgressBar.ProgressBar:

gtk.Progress.Progress gtk.Widget.Widget gtk.ObjectGtk.ObjectGtk gobject.ObjectG.ObjectG List of all members.

Public Member Functions

GtkProgressBargetProgressBarStruct ()
 this (GtkProgressBar *gtkProgressBar)
 Sets our main struct and passes it to the parent class.
 this ()
 Creates a new GtkProgressBar.
void pulse ()
 Indicates that some progress is made, but you don't know how much.
void setText (char[] text)
 Causes the given text to appear superimposed on the progress bar.
void setFraction (double fraction)
 Causes the progress bar to "fill in" the given fraction of the bar.
void setPulseStep (double fraction)
 Sets the fraction of total progress bar length to move the bouncing block for each call to gtk_progress_bar_pulse().
void setOrientation (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).
void setEllipsize (PangoEllipsizeMode mode)
 Sets the mode used to ellipsize (add an ellipsis: "...") the text if there is not enough space to render the entire string.
char[] getText ()
 Retrieves the text displayed superimposed on the progress bar, if any, otherwise NULL.
double getFraction ()
 Returns the current fraction of the task that's been completed.
double getPulseStep ()
 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 getOrientation ()
 Retrieves the current progress bar orientation.
PangoEllipsizeMode getEllipsize ()
 Returns the ellipsizing position of the progressbar.
 this (Adjustment adjustment)
 Warning gtk_progress_bar_new_with_adjustment is deprecated and should not be used in newly-written code.
void setBarStyle (GtkProgressBarStyle style)
 Warning gtk_progress_bar_set_bar_style is deprecated and should not be used in newly-written code.
void setDiscreteBlocks (uint blocks)
 Warning gtk_progress_bar_set_discrete_blocks is deprecated and should not be used in newly-written code.
void setActivityStep (uint step)
 Warning gtk_progress_bar_set_activity_step is deprecated and should not be used in newly-written code.
void setActivityBlocks (uint blocks)
 Warning gtk_progress_bar_set_activity_blocks is deprecated and should not be used in newly-written code.
void update (double percentage)
 Warning gtk_progress_bar_update is deprecated and should not be used in newly-written code.

Protected Member Functions

void * getStruct ()
 the main Gtk struct as a void*

Protected Attributes

GtkProgressBargtkProgressBar
 the main Gtk struct

Constructor & Destructor Documentation

gtk.ProgressBar.ProgressBar.this ( GtkProgressBar gtkProgressBar  ) 

Sets our main struct and passes it to the parent class.

gtk.ProgressBar.ProgressBar.this (  ) 

Creates a new GtkProgressBar.

Returns: a GtkProgressBar.

gtk.ProgressBar.ProgressBar.this ( Adjustment  adjustment  ) 

Warning 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.


Member Function Documentation

PangoEllipsizeMode gtk.ProgressBar.ProgressBar.getEllipsize (  ) 

Returns the ellipsizing position of the progressbar.

See gtk_progress_bar_set_ellipsize(). pbar: a GtkProgressBar Returns: PangoEllipsizeMode Since 2.6

double gtk.ProgressBar.ProgressBar.getFraction (  ) 

Returns the current fraction of the task that's been completed.

pbar: a GtkProgressBar Returns: a fraction from 0.0 to 1.0

GtkProgressBarOrientation gtk.ProgressBar.ProgressBar.getOrientation (  ) 

Retrieves the current progress bar orientation.

pbar: a GtkProgressBar Returns: orientation of the progress bar

GtkProgressBar* gtk.ProgressBar.ProgressBar.getProgressBarStruct (  ) 

double gtk.ProgressBar.ProgressBar.getPulseStep (  ) 

Retrieves the pulse step set with gtk_progress_bar_set_pulse_step() pbar: a GtkProgressBar Returns: a fraction from 0.0 to 1.0.

void* gtk.ProgressBar.ProgressBar.getStruct (  )  [protected]

the main Gtk struct as a void*

Reimplemented from gtk.Progress.Progress.

char [] gtk.ProgressBar.ProgressBar.getText (  ) 

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.

void gtk.ProgressBar.ProgressBar.pulse (  ) 

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.ProgressBar.ProgressBar.setActivityBlocks ( uint  blocks  ) 

Warning 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.ProgressBar.ProgressBar.setActivityStep ( uint  step  ) 

Warning 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.ProgressBar.ProgressBar.setBarStyle ( GtkProgressBarStyle  style  ) 

Warning 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.

void gtk.ProgressBar.ProgressBar.setDiscreteBlocks ( uint  blocks  ) 

Warning 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.ProgressBar.ProgressBar.setEllipsize ( 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

void gtk.ProgressBar.ProgressBar.setFraction ( double  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.ProgressBar.ProgressBar.setOrientation ( 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.ProgressBar.ProgressBar.setPulseStep ( double  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.ProgressBar.ProgressBar.setText ( char[]  text  ) 

Causes the given text to appear superimposed on the progress bar.

pbar: a GtkProgressBar text: a UTF-8 string, or NULL

void gtk.ProgressBar.ProgressBar.update ( double  percentage  ) 

Warning 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. Property Details The "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


Member Data Documentation

GtkProgressBar* gtk.ProgressBar.ProgressBar.gtkProgressBar [protected]

the main Gtk struct


SourceForge.net Logo DSource.org Logo digitalmars.com Logo