togglebutton widget
A GtkToggleButton containing either a GtkLabel, a GtkImage or both packed inside a GtkHBox or GtkVBox
Definition
<togglebutton tag_attr="value"...>
<label>text</label>
<default>state</default>
<variable>varname</variable>
<height>value</height>
<width>value</width>
<input>command</input>
<input file>filename</input>
<input file icon="image"></input>
<input file stock="gtk-image"></input>
<sensitive>state</sensitive>
<action>activity</action>...
<action signal="type">activity</action>...
<action type="function">parameter</action>...
</togglebutton>
"..." denotes acceptance of multiples of the same thing.
Tag Attributes
See the GtkToggleButton 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 | |
space-fill | Pack widget filling space | true or false | |
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 |
image-position[1] | Image position relative to label | 0 , 1 , 2 , 3 (left, right, top, bottom) | |
homogeneous[2] | Horizontal uniformity of an image with label | true or false | 0.8.1 |
Directives
Some of these may have tag attribute equivalents.
Name | Description | Contents | Mandatory | Since |
label | Initial text | | | |
default | Initial state | true or false | | |
variable | Shell variable name | | | |
height | Image scaling dimension | An integer > 0 or -1 to ignore | | |
width | Image scaling dimension | An integer > 0 or -1 to ignore | | |
input | Data input source | Shell command | | |
input file | Data input source | Image filename | | |
input file icon="image"[3] | GTK theme icon name | | | |
input file stock="gtk-image"[4] | GTK stock icon ID | gtk-about , gtk-add , ... (full list) | | |
sensitive | Sensitive state | true or false | | |
action | Execute command on default signal | Shell command | | |
action | Perform function on default signal | function:parameter[5] | | |
action signal="type" | Execute command on signal | Shell command | | |
action signal="type" | Perform function on signal | function:parameter[5] | | |
action type="function" | Perform function on default signal | parameter | | |
Signals
The default signal is "toggled", emitted when the state is changed.
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 | Sensitise widget | Shell variable name | |
disable | Desensitise widget | Shell variable name | |
show | Show widget | Shell variable name | 0.8.1 |
hide | Hide widget | Shell variable name | 0.8.1 |
activate | Activate widget | Shell variable name | 0.8.1 |
grabfocus | Grab input focus | Shell variable name | 0.8.1 |
refresh | Reload input data | Shell variable name | |
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 existing "image-position" GTK+ property -- normally only applicable to stock buttons -- has been extended to apply to all Gtkdialog buttons.
2. The existing "homogeneous" GTK+ property -- applicable to the hbox and vbox -- can be used here to effect the box inside the button when including an image and a label.
3. Theme icons default to 20 and do not scale or refresh (the height or width directives can be used to request a size).
4. Stock icons default to GTK_ICON_SIZE_BUTTON and do not scale or refresh (the "icon-size" tag attribute can be used to adjust the size).
5. This widget supports conditional function execution by prepending function:parameter with if true or if false .
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,
|