edit

edit widget

A GtkTextView packed inside a GtkScrolledWindow

---

Definition

<edit tag_attr="value"...>
	<default>state</default>
	<variable>varname</variable>
	<height>value</height>
	<width>value</width>
	<input file>filename</input>
	<sensitive>state</sensitive>
	<action signal="type">activity</action>...
	<output file>filename</output>
</edit>

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

Tag Attributes

See the GtkTextView 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	0.7.21
space-fill	Pack widget filling space	true or false	0.7.21
block-function-signals	Block signal emissions from functions	true or false	0.7.21
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
hscrollbar-policy	Policy for the horizontal scrollbar	0, 1, 2 (always, automatic, never)	0.8.1
vscrollbar-policy	Policy for the vertical scrollbar	0, 1, 2 (always, automatic, never)	0.8.1

Directives

Some of these may have tag attribute equivalents.

Name	Description	Contents	Since
default	Initial text
variable	Variable name
variable export="false"	Variable name, not exported to shell		0.8.3
height[1]	Initial minimum height	An integer > 0 or -1 to ignore
width[1]	Initial minimum width	An integer > 0 or -1 to ignore
input file	Data input source	Filename
sensitive	Sensitive state	true or false
action signal="type"	Execute command on signal	Shell command
action signal="type"	Perform function on signal	function:parameter
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
output file	Data output target	Filename

Signals

There is no default signal for this widget.

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	Sensitise widget	Variable name
disable	Desensitise widget	Variable name
show	Show widget	Variable name	0.8.1
hide	Hide widget	Variable name	0.8.1
grabfocus	Grab input focus	Variable name	0.8.1
refresh	Reload input data	Variable name
save	Save widget data	Variable name
clear	Remove all widget data	Variable name
removeselected	Remove selected widget data	Variable name

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. This widget has a default dimension of 200x100 which can be overridden with the height and/or width directives.

---