gi-gtk-4.0.6: Gtk bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Gtk.Objects.Expander

Description

GtkExpander allows the user to reveal its child by clicking on an expander triangle.

This is similar to the triangles used in a GtkTreeView.

Normally you use an expander as you would use a frame; you create the child widget and use expanderSetChild to add it to the expander. When the expander is toggled, it will take care of showing and hiding the child automatically.

Special Usage

There are situations in which you may prefer to show and hide the expanded widget yourself, such as when you want to actually create the widget at expansion time. In this case, create a GtkExpander but do not add a child to it. The expander widget has an [propertygtk.Expander:expanded[ property which can be used to monitor its expansion state. You should watch this property with a signal connection as follows:

c code

static void
expander_callback (GObject    *object,
                   GParamSpec *param_spec,
                   gpointer    user_data)
{
  GtkExpander *expander;

  expander = GTK_EXPANDER (object);

  if (gtk_expander_get_expanded (expander))
    {
      // Show or create widgets
    }
  else
    {
      // Hide or destroy widgets
    }
}

static void
create_expander (void)
{
  GtkWidget *expander = gtk_expander_new_with_mnemonic ("_More Options");
  g_signal_connect (expander, "notify::expanded",
                    G_CALLBACK (expander_callback), NULL);

  // ...
}

GtkExpander as GtkBuildable

The GtkExpander implementation of the GtkBuildable interface supports placing a child in the label position by specifying “label” as the “type” attribute of a <child> element. A normal content child can be specified without specifying a <child> type attribute.

An example of a UI definition fragment with GtkExpander:

xml code

<object class="GtkExpander">
  <child type="label">
    <object class="GtkLabel" id="expander-label"/>
  </child>
  <child>
    <object class="GtkEntry" id="expander-content"/>
  </child>
</object>

CSS nodes

expander
╰── box
    ├── title
    │   ├── arrow
    │   ╰── <label widget>
    ╰── <child>

GtkExpander has three CSS nodes, the main node with the name expander, a subnode with name title and node below it with name arrow. The arrow of an expander that is showing its child gets the :checked pseudoclass added to it.

Accessibility

GtkExpander uses the AccessibleRoleButton role.

Synopsis

Exported types

newtype Expander Source #

Memory-managed wrapper type.

Constructors

Expander (ManagedPtr Expander) 

Instances

Instances details
Eq Expander Source # 
Instance details

Defined in GI.Gtk.Objects.Expander

GObject Expander Source # 
Instance details

Defined in GI.Gtk.Objects.Expander

ManagedPtrNewtype Expander Source # 
Instance details

Defined in GI.Gtk.Objects.Expander

Methods

toManagedPtr :: Expander -> ManagedPtr Expander

TypedObject Expander Source # 
Instance details

Defined in GI.Gtk.Objects.Expander

Methods

glibType :: IO GType

HasParentTypes Expander Source # 
Instance details

Defined in GI.Gtk.Objects.Expander

IsGValue (Maybe Expander) Source #

Convert Expander to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.Gtk.Objects.Expander

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Expander -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Expander)

type ParentTypes Expander Source # 
Instance details

Defined in GI.Gtk.Objects.Expander

type ParentTypes Expander = '[Widget, Object, Accessible, Buildable, ConstraintTarget]

class (GObject o, IsDescendantOf Expander o) => IsExpander o Source #

Type class for types which can be safely cast to Expander, for instance with toExpander.

Instances

Instances details
(GObject o, IsDescendantOf Expander o) => IsExpander o Source # 
Instance details

Defined in GI.Gtk.Objects.Expander

toExpander :: (MonadIO m, IsExpander o) => o -> m Expander Source #

Cast to Expander, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBuildableId, getCanFocus, getCanTarget, getChild, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getExpanded, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLabel, getLabelWidget, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getResizeToplevel, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getUseMarkup, getUseUnderline, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

Setters

setCanFocus, setCanTarget, setChild, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setExpanded, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLabel, setLabelWidget, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setResizeToplevel, setSensitive, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setUseMarkup, setUseUnderline, setValign, setVexpand, setVexpandSet, setVisible.

getChild

expanderGetChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsExpander a) 
=> a

expander: a GtkExpander

-> m (Maybe Widget)

Returns: the child widget of expander

Gets the child widget of expander.

getExpanded

expanderGetExpanded Source #

Arguments

:: (HasCallStack, MonadIO m, IsExpander a) 
=> a

expander: a GtkExpander

-> m Bool

Returns: the current state of the expander

Queries a GtkExpander and returns its current state.

Returns True if the child widget is revealed.

getLabel

expanderGetLabel Source #

Arguments

:: (HasCallStack, MonadIO m, IsExpander a) 
=> a

expander: a GtkExpander

-> m (Maybe Text)

Returns: The text of the label widget. This string is owned by the widget and must not be modified or freed.

Fetches the text from a label widget.

This is including any embedded underlines indicating mnemonics and Pango markup, as set by expanderSetLabel. If the label text has not been set the return value will be Nothing. This will be the case if you create an empty button with buttonNew to use as a container.

getLabelWidget

expanderGetLabelWidget Source #

Arguments

:: (HasCallStack, MonadIO m, IsExpander a) 
=> a

expander: a GtkExpander

-> m (Maybe Widget)

Returns: the label widget

Retrieves the label widget for the frame.

getResizeToplevel

expanderGetResizeToplevel Source #

Arguments

:: (HasCallStack, MonadIO m, IsExpander a) 
=> a

expander: a GtkExpander

-> m Bool

Returns: the “resize toplevel” setting.

Returns whether the expander will resize the toplevel widget containing the expander upon resizing and collpasing.

getUseMarkup

expanderGetUseMarkup Source #

Arguments

:: (HasCallStack, MonadIO m, IsExpander a) 
=> a

expander: a GtkExpander

-> m Bool

Returns: True if the label’s text will be parsed for markup

Returns whether the label’s text is interpreted as Pango markup.

getUseUnderline

expanderGetUseUnderline Source #

Arguments

:: (HasCallStack, MonadIO m, IsExpander a) 
=> a

expander: a GtkExpander

-> m Bool

Returns: True if an embedded underline in the expander label indicates the mnemonic accelerator keys

Returns whether an underline in the text indicates a mnemonic.

new

expanderNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Maybe Text

label: the text of the label

-> m Expander

Returns: a new GtkExpander widget.

Creates a new expander using label as the text of the label.

newWithMnemonic

expanderNewWithMnemonic Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Maybe Text

label: the text of the label with an underscore in front of the mnemonic character

-> m Expander

Returns: a new GtkExpander widget.

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.

setChild

expanderSetChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsExpander a, IsWidget b) 
=> a

expander: a GtkExpander

-> Maybe b

child: the child widget

-> m () 

Sets the child widget of expander.

setExpanded

expanderSetExpanded Source #

Arguments

:: (HasCallStack, MonadIO m, IsExpander a) 
=> a

expander: a GtkExpander

-> Bool

expanded: whether the child widget is revealed

-> m () 

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.

setLabel

expanderSetLabel Source #

Arguments

:: (HasCallStack, MonadIO m, IsExpander a) 
=> a

expander: a GtkExpander

-> Maybe Text

label: a string

-> m () 

Sets the text of the label of the expander to label.

This will also clear any previously set labels.

setLabelWidget

expanderSetLabelWidget Source #

Arguments

:: (HasCallStack, MonadIO m, IsExpander a, IsWidget b) 
=> a

expander: a GtkExpander

-> Maybe b

labelWidget: the new label widget

-> m () 

Set the label widget for the expander.

This is the widget that will appear embedded alongside the expander arrow.

setResizeToplevel

expanderSetResizeToplevel Source #

Arguments

:: (HasCallStack, MonadIO m, IsExpander a) 
=> a

expander: a GtkExpander

-> Bool

resizeToplevel: whether to resize the toplevel

-> m () 

Sets whether the expander will resize the toplevel widget containing the expander upon resizing and collpasing.

setUseMarkup

expanderSetUseMarkup Source #

Arguments

:: (HasCallStack, MonadIO m, IsExpander a) 
=> a

expander: a GtkExpander

-> Bool

useMarkup: True if the label’s text should be parsed for markup

-> m () 

Sets whether the text of the label contains Pango markup.

setUseUnderline

expanderSetUseUnderline Source #

Arguments

:: (HasCallStack, MonadIO m, IsExpander a) 
=> a

expander: a GtkExpander

-> Bool

useUnderline: True if underlines in the text indicate mnemonics

-> m () 

If true, an underline in the text indicates a mnemonic.

Properties

child

The child widget.

clearExpanderChild :: (MonadIO m, IsExpander o) => o -> m () Source #

Set the value of the “child” property to Nothing. When overloading is enabled, this is equivalent to

clear #child

constructExpanderChild :: (IsExpander o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “child” property. This is rarely needed directly, but it is used by new.

getExpanderChild :: (MonadIO m, IsExpander o) => o -> m (Maybe Widget) Source #

Get the value of the “child” property. When overloading is enabled, this is equivalent to

get expander #child

setExpanderChild :: (MonadIO m, IsExpander o, IsWidget a) => o -> a -> m () Source #

Set the value of the “child” property. When overloading is enabled, this is equivalent to

set expander [ #child := value ]

expanded

Whether the expander has been opened to reveal the child.

constructExpanderExpanded :: (IsExpander o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “expanded” property. This is rarely needed directly, but it is used by new.

getExpanderExpanded :: (MonadIO m, IsExpander o) => o -> m Bool Source #

Get the value of the “expanded” property. When overloading is enabled, this is equivalent to

get expander #expanded

setExpanderExpanded :: (MonadIO m, IsExpander o) => o -> Bool -> m () Source #

Set the value of the “expanded” property. When overloading is enabled, this is equivalent to

set expander [ #expanded := value ]

label

The text of the expanders label.

clearExpanderLabel :: (MonadIO m, IsExpander o) => o -> m () Source #

Set the value of the “label” property to Nothing. When overloading is enabled, this is equivalent to

clear #label

constructExpanderLabel :: (IsExpander o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “label” property. This is rarely needed directly, but it is used by new.

getExpanderLabel :: (MonadIO m, IsExpander o) => o -> m (Maybe Text) Source #

Get the value of the “label” property. When overloading is enabled, this is equivalent to

get expander #label

setExpanderLabel :: (MonadIO m, IsExpander o) => o -> Text -> m () Source #

Set the value of the “label” property. When overloading is enabled, this is equivalent to

set expander [ #label := value ]

labelWidget

A widget to display instead of the usual expander label.

clearExpanderLabelWidget :: (MonadIO m, IsExpander o) => o -> m () Source #

Set the value of the “label-widget” property to Nothing. When overloading is enabled, this is equivalent to

clear #labelWidget

constructExpanderLabelWidget :: (IsExpander o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “label-widget” property. This is rarely needed directly, but it is used by new.

getExpanderLabelWidget :: (MonadIO m, IsExpander o) => o -> m (Maybe Widget) Source #

Get the value of the “label-widget” property. When overloading is enabled, this is equivalent to

get expander #labelWidget

setExpanderLabelWidget :: (MonadIO m, IsExpander o, IsWidget a) => o -> a -> m () Source #

Set the value of the “label-widget” property. When overloading is enabled, this is equivalent to

set expander [ #labelWidget := value ]

resizeToplevel

When this property is True, the expander will resize the toplevel widget containing the expander upon expanding and collapsing.

constructExpanderResizeToplevel :: (IsExpander o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “resize-toplevel” property. This is rarely needed directly, but it is used by new.

getExpanderResizeToplevel :: (MonadIO m, IsExpander o) => o -> m Bool Source #

Get the value of the “resize-toplevel” property. When overloading is enabled, this is equivalent to

get expander #resizeToplevel

setExpanderResizeToplevel :: (MonadIO m, IsExpander o) => o -> Bool -> m () Source #

Set the value of the “resize-toplevel” property. When overloading is enabled, this is equivalent to

set expander [ #resizeToplevel := value ]

useMarkup

Whether the text in the label is Pango markup.

constructExpanderUseMarkup :: (IsExpander o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “use-markup” property. This is rarely needed directly, but it is used by new.

getExpanderUseMarkup :: (MonadIO m, IsExpander o) => o -> m Bool Source #

Get the value of the “use-markup” property. When overloading is enabled, this is equivalent to

get expander #useMarkup

setExpanderUseMarkup :: (MonadIO m, IsExpander o) => o -> Bool -> m () Source #

Set the value of the “use-markup” property. When overloading is enabled, this is equivalent to

set expander [ #useMarkup := value ]

useUnderline

Whether an underline in the text indicates a mnemonic.

constructExpanderUseUnderline :: (IsExpander o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “use-underline” property. This is rarely needed directly, but it is used by new.

getExpanderUseUnderline :: (MonadIO m, IsExpander o) => o -> m Bool Source #

Get the value of the “use-underline” property. When overloading is enabled, this is equivalent to

get expander #useUnderline

setExpanderUseUnderline :: (MonadIO m, IsExpander o) => o -> Bool -> m () Source #

Set the value of the “use-underline” property. When overloading is enabled, this is equivalent to

set expander [ #useUnderline := value ]

Signals

activate

type ExpanderActivateCallback = IO () Source #

Activates the GtkExpander.

afterExpanderActivate :: (IsExpander a, MonadIO m) => a -> ((?self :: a) => ExpanderActivateCallback) -> m SignalHandlerId Source #

Connect a signal handler for the activate signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after expander #activate callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onExpanderActivate :: (IsExpander a, MonadIO m) => a -> ((?self :: a) => ExpanderActivateCallback) -> m SignalHandlerId Source #

Connect a signal handler for the activate signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on expander #activate callback