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`
image-position^[1]	Image position relative to label	`0`, `1`, `2`, `3` (left, right, top, bottom)

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"^[2]	GTK theme icon name
input file stock="gtk-image"^[3]	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^[4]
action signal="type"	Execute command on signal	Shell command
action signal="type"	Perform function on signal	function:parameter^[4]
action type="function"	Perform function on default signal	parameter

Signals

The default signal is "toggled", emitted when the state is changed.

See also the GtkToggleButton widget and ancestor class signals.

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
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 launched dialog	Launched dialog's shell variable name
launch	Launch new dialog	New dialog's shell variable name

Notes

1. The existing "image-position" GTK+ property -- normally only applicable to stock buttons -- has been extended to apply to all Gtkdialog buttons.

2. Theme icons default to 20 and do not scale or refresh (the height or width directives can be used to request a size).

3. 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).

4. 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.

► Sign in to add a comment