Recent Changes - Search:

WikiDoc

Categories

The [progressBar] command

Commands.ProgressBarCommand History

Hide minor edits - Show changes to markup

January 11, 2007, at 08:04 PM by bd - Title prettified
Added lines 1-2:

(:title The [progressBar] command:)

May 18, 2006, at 08:13 AM by bd - No breakline in list item. Modified image.
Changed lines 20-21 from:
Determinate progress bar
Used when the full length of an operation can be determined and you can tell the user how much of the process has been completed.

You could use a determinate progress indicator to show the progress of a file conversion, for example.

to:
Determinate progress bar
Used when the full length of an operation can be determined and you can tell the user how much of the process has been completed. You could use a determinate progress indicator to show the progress of a file conversion, for example.
Changed lines 23-25 from:
Indeterminate progress bar
Used when the duration of a process canít be determined. You might use an indeterminate progress indicator

to let the user know that the application is attempting a dial-up communication connection, for example, when thereís no way to accurately determine how long it will take to complete.

to:
Indeterminate progress bar
Used when the duration of a process canít be determined. You might use an indeterminate progress indicator to let the user know that the application is attempting a dial-up communication connection, for example, when thereís no way to accurately determine how long it will take to complete.
May 17, 2006, at 07:14 AM by bd - Centering the snapshots
Changed lines 22-23 from:

http://alphatcl.sourceforge.net/wiki/pub/images/progBarDet.png

to:

http://alphatcl.sourceforge.net/wiki/pub/images/progBarDet.png

Changed lines 27-33 from:

http://alphatcl.sourceforge.net/wiki/pub/images/progBarIndet.png

Asynchronous progress indicator
Used when space is very constrained. These indicators are best used for asynchronous events that take place in the background,

such as retrieving messages from a server. http://alphatcl.sourceforge.net/wiki/pub/images/asynchProgIndicator.png

to:

http://alphatcl.sourceforge.net/wiki/pub/images/progBarIndet.png

Asynchronous progress indicator
Used when space is very constrained. These indicators are best used for asynchronous events that take place in the background, such as retrieving messages from a server.

http://alphatcl.sourceforge.net/wiki/pub/images/asynchProgIndicator.png

May 17, 2006, at 07:12 AM by bd - Screen snapshots
Added lines 22-23:

http://alphatcl.sourceforge.net/wiki/pub/images/progBarDet.png

Added lines 27-28:

http://alphatcl.sourceforge.net/wiki/pub/images/progBarIndet.png

Changed lines 31-33 from:
to:

http://alphatcl.sourceforge.net/wiki/pub/images/asynchProgIndicator.png

May 17, 2006, at 06:32 AM by bd - Added link to ProgressIndicators page
Added lines 117-118:

bd In some cases, it may be sufficient to display an asynchronous progress indicator at the document level. The ProgressIndicators page explains how to do that.

April 24, 2006, at 08:02 AM by 84.37.69.107 -
Changed line 63 from:
 [=
to:
[@
Changed line 66 from:

=]

to:

@]

Changed line 83 from:
 [=
to:
[@
Changed lines 101-102 from:

=]

to:

@]

Changed line 105 from:
 [=
to:
[@
Changed line 114 from:

=]

to:

@]

April 24, 2006, at 08:00 AM by 84.37.69.107 -
Deleted line 0:
Changed line 45 from:
 [=
to:
[@
Changed lines 47-49 from:
 progressBar configur option value ?option value...?

=]

to:
 progressBar configure option value ?option value...?

@]

April 23, 2006, at 08:43 AM by 84.37.69.107 -
Added line 18:
Changed lines 46-50 from:

progressBar configure option

progressBar configure option value ?option value...?

to:
 
 progressBar configure option
 progressBar configur option value ?option value...?

Deleted lines 117-119:

Last updated 2006-04-23 10:40:11

April 23, 2006, at 08:40 AM by 84.37.69.107 -
Added line 3:

Changed lines 19-20 from:
Determinate progress bar
Used when the full length of an operation can be determined and you can tell the user how much of the process has been completed.
to:
Determinate progress bar
Used when the full length of an operation can be determined and you can tell the user how much of the process has been completed.
Changed line 22 from:
Indeterminate progress bar
Used when the duration of a process canít be determined. You might use an indeterminate progress indicator
to:
Indeterminate progress bar
Used when the duration of a process canít be determined. You might use an indeterminate progress indicator
Changed line 25 from:
Asynchronous progress indicator
Used when space is very constrained. These indicators are best used for asynchronous events that take place in the background,
to:
Asynchronous progress indicator
Used when space is very constrained. These indicators are best used for asynchronous events that take place in the background,
Added line 40:
Added line 49:
Added line 52:
Changed lines 64-65 from:
     progressBar configure -determinate 1 -label 1
     progressBar configure -label 1 -determinate 1
to:
 progressBar configure -determinate 1 -label 1
 progressBar configure -label 1 -determinate 1
Changed lines 71-72 from:

progressBar hide

to:
 
     progressBar hide

Deleted lines 76-80:

progressBar show

Examples

Here are a few basic examples which can be executed from the Tcl shell in AlphaX:

Deleted lines 78-93:
     progressBar hide

     progressBar configure -determinate

     progressBar configure -determinate 0
     progressBar configure -determinate 1

     progressBar configure -label

     progressBar configure -label 0
     progressBar configure -label 1

     progressBar configure -value

     progressBar configure -value 25
Changed lines 80-82 from:

Here is a small code snippet demonstrating how to use the progress bar during a lengthy operation;

to:

Examples

Here are a few basic examples which can be executed from the Tcl shell in AlphaX:

Changed lines 84-91 from:
     progressBar configure -determinate 1 -label 1
     progressBar show

     for {set i 0} {$i <= 100} {incr i} {
     	progressBar configure -value $i
     	# do some action here
     }
     progressBar hide
to:
 progressBar show

 progressBar hide

 progressBar configure -determinate

 progressBar configure -determinate 0
 progressBar configure -determinate 1

 progressBar configure -label

 progressBar configure -label 0
 progressBar configure -label 1

 progressBar configure -value

 progressBar configure -value 25
Added lines 102-114:

Here is a small code snippet demonstrating how to use the progress bar during a lengthy operation;

 
 progressBar configure -determinate 1 -label 1
 progressBar show

 for {set i 0} {$i <= 100} {incr i} {
 	progressBar configure -value $i
 	# do some action here
 }
 progressBar hide

Changed line 119 from:

Last updated 2006-04-23 10:34:20

to:

Last updated 2006-04-23 10:40:11

April 23, 2006, at 08:34 AM by 84.37.69.107 -
Added lines 1-112:
This file documents the [progressBar] command introduced in version 8.1 of AlphaX.
  • Introduction
  • Synopsis
    • The [configure] subcommand
    • The [hide] subcommand
    • The [show] subcommand
  • Examples

Introduction

The [progressBar] command lets you interact with the progress bar located at the right of the global status bar. It is possible to show or hide this progress bar, and modify some of its attributes. By default, the progress bar is invisible. Progress indicators inform users about the status of lengthy operations. There are three types of progress indicators:

Determinate progress bar
Used when the full length of an operation can be determined and you can tell the user how much of the process has been completed.

You could use a determinate progress indicator to show the progress of a file conversion, for example.

Indeterminate progress bar
Used when the duration of a process canít be determined. You might use an indeterminate progress indicator

to let the user know that the application is attempting a dial-up communication connection, for example, when thereís no way to accurately determine how long it will take to complete.

Asynchronous progress indicator
Used when space is very constrained. These indicators are best used for asynchronous events that take place in the background,

such as retrieving messages from a server.

The [progressBar] command implements the first two types of indicators by displaying a progress bar in the global status bar. Version 8.1 of AlphaX also introduces a per-window small asynchronous progress indicator located in the bottom right corner of the message bar (see the [setWinInfo] command with the "busy" property).

Note that if an indeterminate process reaches a point where its duration can be determined, one can easily switch to a determinate progress indicator.

Synopsis

The formal syntax of the [progressBar] command is:

progressBar subcommand ?options? The possible subcommands are described below. Depending on the subcommand, various options can be additionnally specified.

The [configure] subcommand

There are two forms for the syntax of this subcommand:

progressBar configure option

progressBar configure option value ?option value...? The first form returns the value of the option specified as the third argument. The second form lets you set the value of different options. Here is the description of the currently available options:

  • the -determinate option lets you specify the type of the progress bar (determinate or indeterminate). In a determinate progress bar, the "fill" moves from left to right and should fill in completely before it is dismissed. An indeterminate progress bar displays a spinning striped cylinder to indicate an ongoing process. The possible values for the -determinate option are 0 or 1. The default initial value is 0 (indeterminate).

  • the -label option concerns determinate progress bars only. It lets you specify whether the value of the progress bar should be displayed or not. If it is set to 1, the value (followed by a percent sign) is displayed on the right hand side. The possible values for this option are 0 or 1. The default initial value is 0. In the case of an indeterminate progress bar, there is no label.

  • the -value option concerns determinate progress bars only. It lets you specify the value of the progress bar. The value should be an integer between 0 and 100. If the progress bar is of type indeterminate, this option is ignored.

Caution: swtiching to indeterminate automatically resets the value of the -label option to 0. So, the following two instructions are not equivalent:

 
     progressBar configure -determinate 1 -label 1
     progressBar configure -label 1 -determinate 1

Actually, the second one will result in the -label option to have value 0 since the arguments are parsed from left to right.

The [hide] subcommand

This command lets you hide the progress bar. The syntax is simply:

progressBar hide

The [show] subcommand

This subcommand is the opposite of the [hide] subcommand. It lets you display the progress bar if it is hidden.

progressBar show

Examples

Here are a few basic examples which can be executed from the Tcl shell in AlphaX:

 
     progressBar show

     progressBar hide

     progressBar configure -determinate

     progressBar configure -determinate 0
     progressBar configure -determinate 1

     progressBar configure -label

     progressBar configure -label 0
     progressBar configure -label 1

     progressBar configure -value

     progressBar configure -value 25

Here is a small code snippet demonstrating how to use the progress bar during a lengthy operation;

 
     progressBar configure -determinate 1 -label 1
     progressBar show

     for {set i 0} {$i <= 100} {incr i} {
     	progressBar configure -value $i
     	# do some action here
     }
     progressBar hide


(add your comments here...)


Last updated 2006-04-23 10:34:20

Page last modified on January 11, 2007, at 08:04 PM
Hosted on SourceForge.net Logo