|
Graphics.UI.Gtk.Layout.Expander | Portability | portable (depends on GHC) | Stability | provisional | Maintainer | gtk2hs-users@lists.sourceforge.net |
|
|
|
|
|
Description |
A container which can hide its child
- Module available since Gtk+ version 2.4
|
|
Synopsis |
|
|
|
|
Detail
|
|
A Expander allows the user to hide or show its child by clicking on an
expander triangle similar to the triangles used in a TreeView.
Normally you use an expander as you would use any other descendant of
Bin; you create the child widget and use
Graphics.UI.Gtk.Abstract.Container.containerAdd to add it to the
expander. When the expander is toggled, it will take care of showing and
hiding the child automatically.
|
|
Class Hierarchy
|
|
| GObject
| +----Object
| +----Widget
| +----Container
| +----Bin
| +----Expander
|
|
Types
|
|
|
|
|
|
|
|
|
|
|
|
|
Constructors
|
|
|
Creates a new expander using the given string as the text of the label.
|
|
|
:: String | label - the text of the label with an underscore in
front of the mnemonic character
| -> IO Expander | | Creates a new expander using label as the text of the label. If
characters in label are preceded by an underscore, they are underlined. If
you need a literal underscore character in a label, use '__' (two
underscores). The first underlined character represents a keyboard
accelerator called a mnemonic. Pressing Alt and that key activates the
button.
|
|
|
Methods
|
|
|
Sets the state of the expander. Set to True, if you want the child
widget to be revealed, and False if you want the child widget to be
hidden.
|
|
|
Queries a Expander and returns its current state. Returns True if the
child widget is revealed.
See expanderSetExpanded.
|
|
|
Sets the spacing field of expander, which is the number of pixels to
place between expander and the child.
|
|
|
|
|
|
Sets the text of the label of the expander to label.
This will also clear any previously set labels.
|
|
|
Fetches the text from the label of the expander, as set by
expanderSetLabel.
|
|
|
:: Expander | | -> Bool | useUnderline - True if underlines in the text indicate
mnemonics
| -> IO () | | If true, an underline in the text of the expander label indicates the
next character should be used for the mnemonic accelerator key.
|
|
|
|
:: Expander | | -> IO Bool | returns True if an embedded underline in the expander
label indicates the mnemonic accelerator keys.
| Returns whether an embedded underline in the expander label indicates a
mnemonic. See expanderSetUseUnderline.
|
|
|
|
:: Expander | | -> Bool | useMarkup - True if the label's text should be parsed
for markup
| -> IO () | | Sets whether the text of the label contains markup in Pango's text markup
language. See Graphics.UI.Gtk.Display.Label.labelSetMarkup.
|
|
|
|
Returns whether the label's text is interpreted as marked up with the
Pango text markup language. See expanderSetUseMarkup.
|
|
|
:: WidgetClass labelWidget | | => Expander | labelWidget - the new label widget
| -> labelWidget | | -> IO () | | Set the label widget for the expander. This is the widget that will
appear embedded alongside the expander arrow.
|
|
|
|
|
|
Attributes
|
|
|
Whether the expander has been opened to reveal the child widget.
Default value: False
|
|
|
Text of the expander's label.
|
|
|
If set, an underline in the text indicates the next character should be
used for the mnemonic accelerator key.
Default value: False
|
|
|
The text of the label includes XML markup. See pango_parse_markup().
Default value: False
|
|
|
Space to put between the label and the child.
Allowed values: >= 0
Default value: 0
|
|
|
A widget to display in place of the usual expander label.
|
|
Signals
|
|
|
|
|
|
Produced by Haddock version 2.6.0 |