gprogressbar: Basic progress bar widget

Description Usage Arguments Value Examples

View source: R/gprogressbar.R

Description

Basic progress bar widget

S3 generic whose methods are implemented in the toolkit packages

Usage

1
2
3
gprogressbar(value = 10, container = NULL, ..., toolkit = guiToolkit())

.gprogressbar(toolkit, value, container, ...)

Arguments

value

Initial value, between 0 and 100. A value of NULL will make pulsing bar with indeterminate state. For some toolkits, this must be called periodically to pulse the bar.

container

A parent container. When a widget is created it can be incorporated into the widget heirarchy by passing in a parent container at construction time. (For some toolkits this is not optional, e.g. gWidgets2tcltk or gWidgets2WWW2.)

...

These values are passed to the add method of the parent container. Examples of values are expand, fill, and anchor, although they're not always supported by a given widget. For more details see add. Occasionally the variable arguments feature has been used to sneak in hidden arguments to toolkit implementations. For example, when using a widget as a menubar object one can specify a parent argument to pass in parent information, similar to how the argument is used with gaction and the dialogs.

toolkit

Each widget constructor is passed in the toolkit it will use. This is typically done using the default, which will lookup the toolkit through guiToolkit.

Value

a GButton instance. While this object has its own (reference) methods, one primarily interacts with it through S3 methods defined within the package.

Examples

1
2
3
4
5
6
## Not run: 
w <- gwindow("progress bar example")
pb <- gprogressbar(cont=w)
for(i in 10:100) {Sys.sleep(.1); svalue(pb) <- i}

## End(Not run)

jverzani/gWidgets2 documentation built on May 20, 2019, 5:17 a.m.