frame widget
A GtkFrame containing a GtkVBox
Definition
<frame label>
widget...
<label>text</label>
<variable>varname</variable>
<input>command</input>
<input file>filename</input>
<sensitive>state</sensitive>
<action signal="type">activity</action>...
<output file>filename</output>
</frame>
"..." denotes acceptance of multiples of the same thing.
Tag Attributes
None, as the label consumes all of the space normally occupied by the tag attributes.
The following custom tag attributes are available:
None.
Directives
Some of these may have tag attribute equivalents.
| Name | Description | Contents | Since |
|---|
| label | Initial text | | 0.8.1 |
| variable | Variable name | | 0.8.1 |
| variable export="false" | Variable name, not exported to shell | | 0.8.3 |
| input | Data input source | Shell command | 0.8.1 |
| input file | Data input source | Filename | 0.8.1 |
| sensitive | Sensitive state | true or false | 0.8.1 |
| action signal="type" | Execute command on signal | Shell command | 0.8.1 |
| action signal="type" | Perform function on signal | function:parameter | 0.8.1 |
| 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 | 0.8.1 |
Signals
There is no default signal for this widget.
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 | 0.8.1 |
| disable | Desensitise widget | Variable name | 0.8.1 |
| show | Show widget | Variable name | 0.8.1 |
| hide | Hide widget | Variable name | 0.8.1 |
| refresh | Reload input data | Variable name | 0.8.1 |
| save | Save widget data | Variable name | 0.8.1 |
| clear | Remove all widget data | Variable name | 0.8.1 |
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 | 0.8.1 |
| exit | Exit dialog | A value for the EXIT variable | 0.8.1 |
| closewindow | Close dialog | Variable name | 0.8.1 |
| launch | Launch dialog | Variable name | 0.8.1 |
| 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
This widget has a default border width of 5 and a default spacing of 5 which cannot be overridden.
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,
|