gi-handy-1.0.1: libhandy bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Handy.Objects.HeaderGroup

Description

No description available in the introspection data.

Synopsis

Exported types

class (GObject o, IsDescendantOf HeaderGroup o) => IsHeaderGroup o Source #

Type class for types which can be safely cast to HeaderGroup, for instance with toHeaderGroup.

Instances

Instances details
(GObject o, IsDescendantOf HeaderGroup o) => IsHeaderGroup o Source # 
Instance details

Defined in GI.Handy.Objects.HeaderGroup

toHeaderGroup :: (MonadIO m, IsHeaderGroup o) => o -> m HeaderGroup Source #

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

Methods

addGtkHeaderBar

headerGroupAddGtkHeaderBar Source #

Arguments

:: (HasCallStack, MonadIO m, IsHeaderGroup a, IsHeaderBar b) 
=> a

self: a HeaderGroup

-> b

headerBar: the HeaderBar to add

-> m () 

Adds headerBar to self. When the widget is destroyed or no longer referenced elsewhere, it will be removed from the header group.

Since: 1.0

addHeaderBar

headerGroupAddHeaderBar Source #

Arguments

:: (HasCallStack, MonadIO m, IsHeaderGroup a, IsHeaderBar b) 
=> a

self: a HeaderGroup

-> b

headerBar: the HeaderBar to add

-> m () 

Adds headerBar to self. When the widget is destroyed or no longer referenced elsewhere, it will be removed from the header group.

Since: 1.0

addHeaderGroup

headerGroupAddHeaderGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsHeaderGroup a, IsHeaderGroup b) 
=> a

self: a HeaderGroup

-> b

headerGroup: the HeaderGroup to add

-> m () 

Adds headerGroup to self. When the nested group is no longer referenced elsewhere, it will be removed from the header group.

Since: 1.0

getChildren

headerGroupGetChildren Source #

Arguments

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

self: a HeaderGroup

-> m [HeaderGroupChild]

Returns: the SList of children. The list is owned by libhandy and should not be modified.

Returns the list of children associated with self.

Since: 1.0

getDecorateAll

headerGroupGetDecorateAll Source #

Arguments

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

self: a HeaderGroup

-> m Bool

Returns: True if the elements of the group should all receive the full decoration, False otherwise.

Gets whether the elements of the group should all receive the full decoration.

Since: 1.0

new

headerGroupNew :: (HasCallStack, MonadIO m) => m HeaderGroup Source #

No description available in the introspection data.

removeChild

headerGroupRemoveChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsHeaderGroup a, IsHeaderGroupChild b) 
=> a

self: a HeaderGroup

-> b

child: the HeaderGroupChild to remove

-> m () 

Removes child from self.

Since: 1.0

removeGtkHeaderBar

headerGroupRemoveGtkHeaderBar Source #

Arguments

:: (HasCallStack, MonadIO m, IsHeaderGroup a, IsHeaderBar b) 
=> a

self: a HeaderGroup

-> b

headerBar: the HeaderBar to remove

-> m () 

Removes headerBar from self.

Since: 1.0

removeHeaderBar

headerGroupRemoveHeaderBar Source #

Arguments

:: (HasCallStack, MonadIO m, IsHeaderGroup a, IsHeaderBar b) 
=> a

self: a HeaderGroup

-> b

headerBar: the HeaderBar to remove

-> m () 

Removes headerBar from self.

Since: 1.0

removeHeaderGroup

headerGroupRemoveHeaderGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsHeaderGroup a, IsHeaderGroup b) 
=> a

self: a HeaderGroup

-> b

headerGroup: the HeaderGroup to remove

-> m () 

Removes a nested HeaderGroup from a HeaderGroup

Since: 1.0

setDecorateAll

headerGroupSetDecorateAll Source #

Arguments

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

self: a HeaderGroup

-> Bool

decorateAll: whether the elements of the group should all receive the full decoration

-> m () 

Sets whether the elements of the group should all receive the full decoration.

Since: 1.0

Properties

decorateAll

Whether the elements of the group should all receive the full decoration. This is useful in conjunction with Leaflet:folded when the leaflet contains the header bars of the group, as you want them all to display the complete decoration when the leaflet is folded.

Since: 1.0

constructHeaderGroupDecorateAll :: (IsHeaderGroup o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getHeaderGroupDecorateAll :: (MonadIO m, IsHeaderGroup o) => o -> m Bool Source #

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

get headerGroup #decorateAll

setHeaderGroupDecorateAll :: (MonadIO m, IsHeaderGroup o) => o -> Bool -> m () Source #

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

set headerGroup [ #decorateAll := value ]

Signals

updateDecorationLayouts

type HeaderGroupUpdateDecorationLayoutsCallback = IO () Source #

This signal is emitted before updating the decoration layouts.

Since: 1.0

afterHeaderGroupUpdateDecorationLayouts :: (IsHeaderGroup a, MonadIO m) => a -> ((?self :: a) => HeaderGroupUpdateDecorationLayoutsCallback) -> m SignalHandlerId Source #

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

after headerGroup #updateDecorationLayouts 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.

onHeaderGroupUpdateDecorationLayouts :: (IsHeaderGroup a, MonadIO m) => a -> ((?self :: a) => HeaderGroupUpdateDecorationLayoutsCallback) -> m SignalHandlerId Source #

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

on headerGroup #updateDecorationLayouts callback