menuitem widget

A GtkMenuItem, GtkCheckMenuItem, GtkRadioMenuItem or GtkImageMenuItem

Definition

<menuitem tag_attr="value"...>
	<label>text</label>
	<variable>varname</variable>
	<height>value</height>
	<width>value</width>
	<input>command</input>
	<input file>filename</input>
	<sensitive>state</sensitive>
	<action>activity</action>...
	<action signal="type">activity</action>...
	<action type="function">parameter</action>...
	<output file>filename</output>
</menuitem>

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

Tag Attributes

See the GtkMenuItem, GtkCheckMenuItem, GtkRadioMenuItem or GtkImageMenuItem widget and ancestor class properties.

The following custom tag attributes are available:

Name	Description	Value	Since
block-function-signals	Block signal emissions from functions	`true` or `false`	0.7.21
accel-key	Accelerator key	A decimal or hexadecimal value (full list)	0.7.21
accel-mods^[1]	Accelerator modifiers	A decimal or hexadecimal value (full list)	0.7.21
icon-name^[2]	GTK theme icon name		0.7.21
stock-id	GTK stock icon ID	`gtk-about`, `gtk-add`, ... (full list)	0.7.21
image-name	Image filename		0.7.21
checkbox	Active state	`true` or `false`	0.7.21
radiobutton	Active state	`true` or `false`	0.7.21

Directives

Some of these may have tag attribute equivalents.

Name	Description	Contents	Mandatory	Since
label	Initial text
variable	Shell variable name
height	Image scaling dimension	An integer > `0` or `-1` to ignore		0.7.21
width	Image scaling dimension	An integer > `0` or `-1` to ignore		0.7.21
input	Data input source	Shell command		0.7.21
input file^[3]	Data input source	Filename		0.7.21
sensitive	Sensitive state	`true` or `false`		0.7.21
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
output file	Data output target	Filename		0.7.21

Signals

The default signal for the checkbox and radiobutton menuitem widgets is "toggled", emitted when the state is changed, otherwise the default signal is "activate", emitted when the item is activated.

All widgets emit the "activate" signal.

See also the GtkMenuItem, GtkCheckMenuItem or GtkRadioMenuItem 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	0.7.21
save	Save widget data	Shell variable name	0.7.21

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. SHIFT is 1, CTRL is 4 and ALT is 8 and you can OR them together.

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

3. The input file directive is used exclusively by the checkbox and radiobutton menuitem widgets since the "image-name" custom tag attribute would contain any image filename.

4. The checkbox and radiobutton menuitem widgets support conditional function execution by prepending function:parameter with if true or if false.

► Sign in to add a comment