PHP-GTK
Saturday, August 23, 2014 
download | documentation | applications | faq | changelog | resources 


search for in the  


previousGtkProgress::text-yalign
GtkProgressBar Constructornext

Last updated: Sun, 12 May 2013
view this page in English

GtkProgressBar

A widget for displaying incremental or continuous progress.

Object Hierarchy

Description

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 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 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 progress bar is not updated after calling pulse() or set_fraction() , but in the main loop. This means that, in a long running operation, you need to let the UI update itself by using main_iteration() .

Constructors

-- Creates a new progress bar.

Methods

get_ellipsize()
  Returns the ellipsize mode used.
get_fraction()
  Returns the current fraction value.
get_orientation()
  Returns the orientation.
get_pulse_step()
  Retutns the pulse step size.
get_text()
  Returns the text on the bar.
pulse()
  Indicates that some progress is made, but you don't know how much.
set_ellipsize()
  Sets the mode used to ellipsize the text.
set_fraction()
  Set the current percentage value.
set_orientation()
  Switches to a different orientation.
set_pulse_step()
  Sets the size of the bouncing block.
set_text()
  Sets the displayed text.
set_activity_blocks()
  DEPRECATED
set_activity_step()
  DEPRECATED
set_bar_style()
  DEPRECATED
set_discrete_blocks()
  DEPRECATED


User Contributed Notes
gtk.gtkprogressbar.php
add a note about notes
There are no user contributed notes for this page.


previousGtkProgress::text-yalign
GtkProgressBar Constructornext

Last updated: Sun, 12 May 2013
view this page in English


credits 

PHP  Copyright © 2001-2014 The PHP Group
 All rights reserved.
Last updated: Sun May 12 20:50:59 2013 CEST