gtk.Progress.Progress Class Reference

Inheritance diagram for gtk.Progress.Progress:

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

Public Member Functions

GtkProgressgetProgressStruct ()
 this (GtkProgress *gtkProgress)
 Sets our main struct and passes it to the parent class.
void setShowText (int showText)
 Warning gtk_progress_set_show_text is deprecated and should not be used in newly-written code.
void setTextAlignment (float xAlign, float yAlign)
 Warning gtk_progress_set_text_alignment is deprecated and should not be used in newly-written code.
void setFormatString (char[] format)
 Warning gtk_progress_set_format_string is deprecated and should not be used in newly-written code.
void setAdjustment (Adjustment adjustment)
 Warning gtk_progress_set_adjustment is deprecated and should not be used in newly-written code.
void setPercentage (double percentage)
 Warning gtk_progress_set_percentage is deprecated and should not be used in newly-written code.
void setValue (double value)
 Warning gtk_progress_set_value is deprecated and should not be used in newly-written code.
double getValue ()
 Warning gtk_progress_get_value is deprecated and should not be used in newly-written code.
void setActivityMode (int activityMode)
 Warning gtk_progress_set_activity_mode is deprecated and should not be used in newly-written code.
char[] getCurrentText ()
 Warning gtk_progress_get_current_text is deprecated and should not be used in newly-written code.
char[] getTextFromValue (double value)
 Warning gtk_progress_get_text_from_value is deprecated and should not be used in newly-written code.
double getCurrentPercentage ()
 Warning gtk_progress_get_current_percentage is deprecated and should not be used in newly-written code.
double getPercentageFromValue (double value)
 Warning gtk_progress_get_percentage_from_value is deprecated and should not be used in newly-written code.
void configure (double value, double hmin, double max)
 Warning gtk_progress_configure 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

GtkProgressgtkProgress
 the main Gtk struct

Constructor & Destructor Documentation

gtk.Progress.Progress.this ( GtkProgress gtkProgress  ) 

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


Member Function Documentation

void gtk.Progress.Progress.configure ( double  value,
double  hmin,
double  max 
)

Warning gtk_progress_configure is deprecated and should not be used in newly-written code.

Allows the configuration of the minimum, maximum, and current values for the GtkProgress. progress: a GtkProgress. value: the current progress value. hmin: max: the maximum progress value. Property Details The "activity-mode" property "activity-mode" gboolean : Read / Write 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 but don't know how long it will take. Default value: FALSE

double gtk.Progress.Progress.getCurrentPercentage (  ) 

Warning gtk_progress_get_current_percentage is deprecated and should not be used in newly-written code.

Returns the current progress as a percentage. progress: a GtkProgress. Returns: a number between 0.0 and 1.0 indicating the percentage complete.

char [] gtk.Progress.Progress.getCurrentText (  ) 

Warning gtk_progress_get_current_text is deprecated and should not be used in newly-written code.

Returns the current text associated with the GtkProgress. This text is the based on the underlying format string after any substitutions are made. progress: a GtkProgress. Returns: the text indicating the current progress.

double gtk.Progress.Progress.getPercentageFromValue ( double  value  ) 

Warning gtk_progress_get_percentage_from_value is deprecated and should not be used in newly-written code.

Returns the progress as a percentage calculated from the supplied absolute progress value. progress: a GtkProgress. value: an absolute progress value. Returns: a number between 0.0 and 1.0 indicating the percentage complete represented by value.

GtkProgress* gtk.Progress.Progress.getProgressStruct (  ) 

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

the main Gtk struct as a void*

Reimplemented from gtk.Widget.Widget.

Reimplemented in gtk.ProgressBar.ProgressBar.

char [] gtk.Progress.Progress.getTextFromValue ( double  value  ) 

Warning gtk_progress_get_text_from_value is deprecated and should not be used in newly-written code.

Returns the text indicating the progress based on the supplied value. The current value for the GtkProgress remains unchanged. progress: a GtkProgress. value: an absolute progress value to use when formatting the progress text. Returns: a string indicating the progress.

double gtk.Progress.Progress.getValue (  ) 

Warning gtk_progress_get_value is deprecated and should not be used in newly-written code.

Returns the current progress complete value. progress: a GtkProgress. Returns: the current progress complete value.

void gtk.Progress.Progress.setActivityMode ( int  activityMode  ) 

Warning gtk_progress_set_activity_mode is deprecated and should not be used in newly-written code.

A GtkProgress 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. progress: a GtkProgress. activity_mode: a boolean, TRUE for activity mode.

void gtk.Progress.Progress.setAdjustment ( Adjustment  adjustment  ) 

Warning gtk_progress_set_adjustment is deprecated and should not be used in newly-written code.

Associates a GtkAdjustment with the GtkProgress. A GtkAdjustment is used to represent the upper and lower bounds and the step interval of the underlying value for which progress is shown. progress: a GtkProgress. adjustment: the GtkAdjustment to be associated with the GtkProgress.

void gtk.Progress.Progress.setFormatString ( char[]  format  ) 

Warning gtk_progress_set_format_string is deprecated and should not be used in newly-written code.

Sets a format string used to display text indicating the current progress. The string can contain the following substitution characters: v - the current progress value. l - the lower bound for the progress value. u - the upper bound for the progress value. p - the current progress percentage. progress: a GtkProgress. format: a string used to display progress text, or NULL to restore to the default format.

void gtk.Progress.Progress.setPercentage ( double  percentage  ) 

Warning gtk_progress_set_percentage is deprecated and should not be used in newly-written code.

Sets the current percentage completion for the GtkProgress. progress: a GtkProgress. percentage: the percentage complete which must be between 0.0 and 1.0.

void gtk.Progress.Progress.setShowText ( int  showText  ) 

Warning gtk_progress_set_show_text is deprecated and should not be used in newly-written code.

Controls whether progress text is shown. progress: a GtkProgress. show_text: a boolean indicating whether the progress text is shown.

void gtk.Progress.Progress.setTextAlignment ( float  xAlign,
float  yAlign 
)

Warning gtk_progress_set_text_alignment is deprecated and should not be used in newly-written code.

Controls the alignment of the text within the progress bar area. progress: a GtkProgress. x_align: a number between 0.0 and 1.0 indicating the horizontal alignment of the progress text within the GtkProgress. y_align: a number between 0.0 and 1.0 indicating the vertical alignment of the progress text within the GtkProgress.

void gtk.Progress.Progress.setValue ( double  value  ) 

Warning gtk_progress_set_value is deprecated and should not be used in newly-written code.

Sets the value within the GtkProgress to an absolute value. The value must be within the valid range of values for the underlying GtkAdjustment. progress: a GtkProgress. value: the value indicating the current completed amount.


Member Data Documentation

GtkProgress* gtk.Progress.Progress.gtkProgress [protected]

the main Gtk struct


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