progressbar - step-/gtkdialog GitHub Wiki

progressbar widget

A GtkProgressBar


Definition

<progressbar tag_attr="value"...>
	<label>text</label>
	<variable>varname</variable>
	<input>command</input>
	<action>activity</action>...
	<action signal="type">activity</action>...
	<action function="type">parameter</action>...
</progressbar>

"..." denotes acceptance of multiples of the same thing.

Tag Attributes

See the GtkProgressBar widget and ancestor class properties.

The following custom tag attributes are available:

Name Description Value Since
space-expand Pack widget expanding into space true or false 0.7.21
space-fill Pack widget filling space true or false 0.7.21
block-function-signals Block signal emissions from functions true or false 0.7.21

Directives

Some of these may have tag attribute equivalents.

Name Description Contents Since
label Initial text
variable Variable name
variable export="false" Variable name, not exported to shell 0.8.3
input Data input source Shell command
action Execute command on default signal Shell command
action Perform function on default signal function:parameter
action signal="type" Execute command on signal Shell command 0.8.1
action signal="type" Perform function on signal function:parameter 0.8.1
action function="type" Perform function on default signal parameter 0.8.3
action condition="type" Execute command on default signal conditionally Shell command 0.8.3
action condition="type" Perform function on default signal conditionally function:parameter 0.8.3
action signal="type" condition="type" Execute command on signal conditionally Shell command 0.8.3
action signal="type" condition="type" Perform function on signal conditionally function:parameter 0.8.3
action function="type" condition="type" Perform function on default signal conditionally parameter 0.8.3

Signals

The default signal is "time-out", emitted when the input data reaches 100.

The following signals are connected-up for all widgets:

button-press-event, button-release-event, configure-event, enter-notify-event, leave-notify-event, focus-in-event, focus-out-event, hide, show, realize, key-press-event, key-release-event, map-event, unmap-event

Functions

The following functions can be performed upon this widget by any widget capable of emitting signals:

Type Description Parameter Since
show Show widget Variable name 0.8.1
hide Hide widget Variable name 0.8.1

The following general functions can be performed by any widget capable of emitting signals:

Type Description Parameter Since
break Break out of actions list None 0.8.3
command Execute command Shell command
exit Exit dialog A value for the EXIT variable
closewindow Close dialog Variable name
launch Launch dialog Variable name
presentwindow Present dialog Variable name 0.8.1

Conditions

The following conditions can be used within the condition attribute of action directives:

Type Description Argument Since
active_is_true(argument) Active state of toggle widget Variable name 0.8.3
active_is_false(argument) Active state of toggle widget Variable name 0.8.3
command_is_true(argument) Output of shell command Shell command 0.8.3
command_is_false(argument) Output of shell command Shell command 0.8.3
file_is_true(argument) Contents of a file Filename 0.8.3
file_is_false(argument) Contents of a file Filename 0.8.3
sensitive_is_true(argument) Sensitive state of widget Variable name 0.8.3
sensitive_is_false(argument) Sensitive state of widget Variable name 0.8.3
visible_is_true(argument) Visible state of widget Variable name 0.8.3
visible_is_false(argument) Visible state of widget Variable name 0.8.3

true means "true", "yes" or a non-zero value, false means "false", "no" or zero, therefore the shell command is expected to echo one of these values to stdout.

Notes

None.


⚠️ **GitHub.com Fallback** ⚠️