Class Index | File Index

Classes


Class gtk.ProgressBar


Extends gtk.Widget.

Defined in: jsgtk_merge_for_doc.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ProgressBar is a class to create a progress bar or loading bar
Method Summary
Method Attributes Method Name and Description
 
 
getOrientation(orientation)
Returns the current progress bar orientation.
 
Method to return the pulse step set with the set_pulse_step()
 
A method to get the text superimposed on the progress bar.
 
A method to nudge the progressbar to indicate that some progress has been made, but you don't know how much longer.
 
 
resize(width, height)
A method to resize both height and width of the widget
 
A method to resize height of the widget
 
A method to resize width of the widget
 
setFraction(fraction)
Method to cause the progress bar to "fill in" the portion of the bar specified by fraction.
 
setOrientation(Torientation)
Switches the progress bar to a different orientation as specified by the value of orientation
 
setPulseStep(fraction)
Method to set the portion (specified by fraction) of the total progress bar length to move the bouncing block for each call to the pulse() method.
 
setText(text)
A method to superimpose the text specified by text on the progress bar
Methods borrowed from class gtk.Widget:
activate, disable, enable, getActivateSignal, getHeight, getMinHeightComposite, getMinWidthComposite, getNode, getParent, getSize, getSizeRequest, getTag, getWidth, hide, hideLoading, hideTooltip, isHidden, refresh, resetHeightComposite, resetMinHeight, resetMinWidth, resetWidthComposite, setActivateSignal, setBoldTitle, setEnable, setHeight, setParent, setSize, setSizeRequest, setTag, setTooltip, setWidth, show, showLoading, showTooltip, sizeRequest
Methods borrowed from class gobject.GObject:
connect, disconnect, emit
Class Detail
gtk.ProgressBar()
ProgressBar is a class to create a progress bar or loading bar
Method Detail
getFraction()

{String
These are the constant values of progress bar orientation:
- gtk.PROGRESS_LEFT_TO_RIGHT To show the progress bar loading from left to right
- gtk.PROGRESS_RIGHT_TO_LEFT To show the progress bar loading from right to left
- gtk.PROGRESS_TOP_TO_BOTTOM To show the progress bar loading from top to bottom
- gtk.PROGRESS_BOTTOM_TO_TOP To show the progress bar loading from bottom to top}
getOrientation(orientation)
Returns the current progress bar orientation.
Parameters:
orientation
Returns:
{String} The orientation of the progress bar

{Double} getPulseStep()
Method to return the pulse step set with the set_pulse_step()
Returns:
{Double} A fraction from 0.0 to 1.0

{String} getText()
A method to get the text superimposed on the progress bar. If there is no superimposed text this method returns None.
Returns:
{String} The loading text in the progress bar

pulse()
A method to nudge the progressbar to indicate that some progress has been made, but you don't know how much longer. This method also changes progress bar mode to "activity mode," where a block bounces back and forth

render()

resize(width, height)
A method to resize both height and width of the widget
Parameters:
{Integer} width
The width in pixel value to set
{Integer} height
The height in pixel value to set

resizeHeightComposite(height)
A method to resize height of the widget
Parameters:
{Integer} height
The height in pixel value to set

resizeWidthComposite(width)
A method to resize width of the widget
Parameters:
{Integer} width
The width in pixel value to set

setFraction(fraction)
Method to cause the progress bar to "fill in" the portion of the bar specified by fraction. The value of fraction should be between 0.0 and 1.0.
Parameters:
{Double} fraction
The fraction of the task that's been completed

setOrientation(Torientation)
Switches the progress bar to a different orientation as specified by the value of orientation
Parameters:
{String} Torientation
The constant values of progressbar orientations
These are the constant values of progress bar orientation:
- gtk.PROGRESS_LEFT_TO_RIGHT To show the progress bar loading from left to right
- gtk.PROGRESS_RIGHT_TO_LEFT To show the progress bar loading from right to left
- gtk.PROGRESS_TOP_TO_BOTTOM To show the progress bar loading from top to bottom
- gtk.PROGRESS_BOTTOM_TO_TOP To show the progress bar loading from bottom to top

setPulseStep(fraction)
Method to set the portion (specified by fraction) of the total progress bar length to move the bouncing block for each call to the pulse() method.
Parameters:
{Double} fraction
A value scales between 0.0 and 1.0

setText(text)
A method to superimpose the text specified by text on the progress bar
Parameters:
{String} text
The string text to be shown

Documentation generated by JsDoc Toolkit 2.1.0 on Fri Jul 02 2010 10:22:46 GMT+0700 (ICT)