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 type="function">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 | Mandatory | Since |
variable | Shell variable name | | | |
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 type="function" | Perform function on default signal | parameter | | |
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, 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 | Shell variable name | |
disable | Deactivate timer | Shell variable name | |
show | Show widget | Shell variable name | 0.8.1 |
hide | Hide widget | Shell variable name | 0.8.1 |
refresh | Reload input data[3] | Shell variable name | 0.8.1 |
The following general functions can be performed by any widget capable of emitting signals:
Type | Description | Parameter | Since |
command | Execute command | Shell command | |
exit | Exit dialog | A value for the EXIT shell variable | |
closewindow | Close dialog | Shell variable name | |
launch | Launch dialog | Shell variable name | |
presentwindow | Present dialog | Shell variable name | 0.8.1 |
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.
button,
checkbox,
colorbutton,
comboboxentry,
comboboxtext,
combobox,
edit,
entry,
eventbox,
expander,
fontbutton,
frame,
hbox,
hscale,
hseparator,
list,
menubar,
menuitemseparator,
menuitem,
menu,
notebook,
pixmap,
progressbar,
radiobutton,
separator,
spinbutton,
statusbar,
table,
terminal,
text,
timer,
togglebutton,
tree,
vbox,
vscale,
vseparator,
window,
|