Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (inaki@blueleaf.cc)
Safe Haskell	None
Language	Haskell2010

GI.Handy.Objects.HeaderGroup

Contents

Exported types
Methods
Properties
- focus

Description

No description available in the introspection data.

Synopsis

newtype HeaderGroup = HeaderGroup (ManagedPtr HeaderGroup)
class (GObject o, IsDescendantOf HeaderGroup o) => IsHeaderGroup o
toHeaderGroup :: (MonadIO m, IsHeaderGroup o) => o -> m HeaderGroup
noHeaderGroup :: Maybe HeaderGroup
headerGroupAddHeaderBar :: (HasCallStack, MonadIO m, IsHeaderGroup a, IsHeaderBar b) => a -> b -> m ()
headerGroupGetFocus :: (HasCallStack, MonadIO m, IsHeaderGroup a) => a -> m (Maybe HeaderBar)
headerGroupGetHeaderBars :: (HasCallStack, MonadIO m, IsHeaderGroup a) => a -> m [HeaderBar]
headerGroupNew :: (HasCallStack, MonadIO m) => m HeaderGroup
headerGroupRemoveHeaderBar :: (HasCallStack, MonadIO m, IsHeaderGroup a, IsHeaderBar b) => a -> b -> m ()
headerGroupSetFocus :: (HasCallStack, MonadIO m, IsHeaderGroup a, IsHeaderBar b) => a -> Maybe b -> m ()
clearHeaderGroupFocus :: (MonadIO m, IsHeaderGroup o) => o -> m ()
constructHeaderGroupFocus :: (IsHeaderGroup o, IsHeaderBar a) => a -> IO (GValueConstruct o)
getHeaderGroupFocus :: (MonadIO m, IsHeaderGroup o) => o -> m (Maybe HeaderBar)
setHeaderGroupFocus :: (MonadIO m, IsHeaderGroup o, IsHeaderBar a) => o -> a -> m ()

Exported types

newtype HeaderGroup Source #

Memory-managed wrapper type.

Constructors

HeaderGroup (ManagedPtr HeaderGroup)

Instances

GObject HeaderGroup Source #
Instance details Defined in GI.Handy.Objects.HeaderGroup Methods gobjectType :: IO GType #
HasParentTypes HeaderGroup Source #
Instance details Defined in GI.Handy.Objects.HeaderGroup
type ParentTypes HeaderGroup Source #
Instance details Defined in GI.Handy.Objects.HeaderGroup type ParentTypes HeaderGroup = Object ': (Buildable ': ([] :: [Type]))

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

(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.

noHeaderGroup :: Maybe HeaderGroup Source #

A convenience alias for Nothing :: Maybe HeaderGroup.

Methods

addHeaderBar

headerGroupAddHeaderBar Source #

Arguments

:: (HasCallStack, MonadIO m, IsHeaderGroup a, IsHeaderBar b)
=> a	`self`: a `HeaderGroup`
-> b	`headerBar`: the `HeaderBar` to add
-> m ()

Adds a header bar to a HeaderGroup. The decoration layout of the widgets will be edited depending on their position in the composite header bar, the start widget displaying only the start of the user's decoration layout and the end widget displaying only its end while widgets in the middle won't display anything. A header bar can be set as having the focus to display all the decorations. See headerBarSetDecorationLayout.

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

getFocus

headerGroupGetFocus Source #

Arguments

:: (HasCallStack, MonadIO m, IsHeaderGroup a)
=> a	`self`: a `HeaderGroup`
-> m (Maybe HeaderBar)	Returns: The currently focused header bar

No description available in the introspection data.

getHeaderBars

headerGroupGetHeaderBars Source #

Arguments

:: (HasCallStack, MonadIO m, IsHeaderGroup a)
=> a	`self`: a `HeaderGroup`
-> m [HeaderBar]	Returns: a `SList` of headerbars. The list is owned by libhandy and should not be modified.

Returns the list of headerbars associated with self.

new

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

No description available in the introspection data.

removeHeaderBar

headerGroupRemoveHeaderBar Source #

Arguments

:: (HasCallStack, MonadIO m, IsHeaderGroup a, IsHeaderBar b)
=> a	`self`: a `HeaderGroup`
-> b	`headerBar`: the `HeaderBar` to remove
-> m ()

Removes a widget from a HeaderGroup

setFocus

headerGroupSetFocus Source #

Arguments

:: (HasCallStack, MonadIO m, IsHeaderGroup a, IsHeaderBar b)
=> a	`self`: a `HeaderGroup`
-> Maybe b	`headerBar`: a `HeaderBar` of `self`, or `Nothing`
-> m ()

Sets the the currently focused header bar. If headerBar is Nothing, the decoration will be spread as if the header bars of the group were only one, otherwise headerBar will be the only one to receive the decoration.

Properties

focus

The the currently focused header bar. If Nothing, the decoration will be spread as if the header bars of the group were only one, otherwise the focused header bar will be the only one to receive the decoration.

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

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

clear #focus

constructHeaderGroupFocus :: (IsHeaderGroup o, IsHeaderBar a) => a -> IO (GValueConstruct o) Source #

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

getHeaderGroupFocus :: (MonadIO m, IsHeaderGroup o) => o -> m (Maybe HeaderBar) Source #

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

get headerGroup #focus

setHeaderGroupFocus :: (MonadIO m, IsHeaderGroup o, IsHeaderBar a) => o -> a -> m () Source #

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

set headerGroup [ #focus := value ]