timer

timer widget

A timer attached to a GtkLabel

---

Definition

<timer tag_attr="value"...>
	<variable>varname</variable>
	<input>command</input>
	<input file>filename</input>
	<sensitive>state</sensitive>
	<action>activity</action>...
	<action signal="type">activity</action>...
	<action function="type">parameter</action>...
</timer>

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

Tag Attributes

See the GtkWidget widget properties^[1].

The following custom tag attributes are available:

Name	Description	Value	Since
milliseconds	Timer precision	true or false
interval[2]	Timer frequency	An unsigned integer value representing seconds or milliseconds
block-function-signals	Block signal emissions from functions	true or false
file-monitor	Emit signal when input file(s) change	true or false	0.8.1
auto-refresh	Auto refresh when input file(s) change	true or false	0.8.1

Directives

Some of these may have tag attribute equivalents.

Name	Description	Contents	Since
variable	Variable name
variable export="false"	Variable name, not exported to shell		0.8.3
input	Data input source	Shell command	0.8.1
input file	Data input source	Filename	0.8.1
sensitive	Active state	true or false
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
action signal="type"	Perform function on signal	function:parameter
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 "tick", a custom signal emitted when the timer times-out.

The "file-changed" signal is emitted if file-monitor is true and the input file being monitored has changed.

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
enable	Reactivate timer	Variable name
disable	Deactivate timer	Variable name
show	Show widget	Variable name	0.8.1
hide	Hide widget	Variable name	0.8.1
refresh	Reload input data[3]	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

1. The "visible" tag attribute will be required to hide the timer widget as it is visible by default.

2. The default precision is seconds using a default interval of 1 second.

3. The "sensitive" property i.e. its active state constitutes the data for this widget.

This widget was introduced in version 0.7.21.

---