Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Gtk.Objects.ActionBar

Contents

Exported types
Methods
Properties
- revealed

Description

GtkActionBar is designed to present contextual actions. It is expected to be displayed below the content and expand horizontally to fill the area.

It allows placing children at the start or the end. In addition, it contains an internal centered box which is centered with respect to the full width of the box, even if the children at either side take up different amounts of space.

CSS nodes

GtkActionBar has a single CSS node with name actionbar.

Synopsis

newtype ActionBar = ActionBar (ManagedPtr ActionBar)
class (GObject o, IsDescendantOf ActionBar o) => IsActionBar o
toActionBar :: (MonadIO m, IsActionBar o) => o -> m ActionBar
noActionBar :: Maybe ActionBar
actionBarGetCenterWidget :: (HasCallStack, MonadIO m, IsActionBar a) => a -> m (Maybe Widget)
actionBarGetRevealed :: (HasCallStack, MonadIO m, IsActionBar a) => a -> m Bool
actionBarNew :: (HasCallStack, MonadIO m) => m ActionBar
actionBarPackEnd :: (HasCallStack, MonadIO m, IsActionBar a, IsWidget b) => a -> b -> m ()
actionBarPackStart :: (HasCallStack, MonadIO m, IsActionBar a, IsWidget b) => a -> b -> m ()
actionBarSetCenterWidget :: (HasCallStack, MonadIO m, IsActionBar a, IsWidget b) => a -> Maybe b -> m ()
actionBarSetRevealed :: (HasCallStack, MonadIO m, IsActionBar a) => a -> Bool -> m ()
constructActionBarRevealed :: IsActionBar o => Bool -> IO (GValueConstruct o)
getActionBarRevealed :: (MonadIO m, IsActionBar o) => o -> m Bool
setActionBarRevealed :: (MonadIO m, IsActionBar o) => o -> Bool -> m ()

Exported types

newtype ActionBar Source #

Memory-managed wrapper type.

Constructors

ActionBar (ManagedPtr ActionBar)

Instances

Instances details

Eq ActionBar Source #
Instance details Defined in GI.Gtk.Objects.ActionBar Methods (==) :: ActionBar -> ActionBar -> Bool # (/=) :: ActionBar -> ActionBar -> Bool #
IsGValue ActionBar Source #	Convert `ActionBar` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.ActionBar Methods toGValue :: ActionBar -> IO GValue # fromGValue :: GValue -> IO ActionBar #
GObject ActionBar Source #
Instance details Defined in GI.Gtk.Objects.ActionBar Methods gobjectType :: IO GType #
HasParentTypes ActionBar Source #
Instance details Defined in GI.Gtk.Objects.ActionBar
type ParentTypes ActionBar Source #
Instance details Defined in GI.Gtk.Objects.ActionBar type ParentTypes ActionBar = '[Container, Widget, Object, ImplementorIface, Buildable]

class (GObject o, IsDescendantOf ActionBar o) => IsActionBar o Source #

Type class for types which can be safely cast to ActionBar, for instance with toActionBar.

Instances

Instances details

(GObject o, IsDescendantOf ActionBar o) => IsActionBar o Source #
Instance details Defined in GI.Gtk.Objects.ActionBar

toActionBar :: (MonadIO m, IsActionBar o) => o -> m ActionBar Source #

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

noActionBar :: Maybe ActionBar Source #

A convenience alias for Nothing :: Maybe ActionBar.

Methods

Overloaded methods

getCenterWidget

actionBarGetCenterWidget Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionBar a)
=> a	`actionBar`: a `ActionBar`
-> m (Maybe Widget)	Returns: the center `Widget` or `Nothing`.

Retrieves the center bar widget of the bar.

getRevealed

actionBarGetRevealed Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionBar a)
=> a	`actionBar`: a `ActionBar`
-> m Bool	Returns: the current value of the `ActionBar`:`revealed` property.

Gets the value of the ActionBar:revealed property.

new

actionBarNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m ActionBar	Returns: a new `ActionBar`

Creates a new ActionBar widget.

packEnd

actionBarPackEnd Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionBar a, IsWidget b)
=> a	`actionBar`: A `ActionBar`
-> b	`child`: the `Widget` to be added to `actionBar`
-> m ()

Adds child to actionBar, packed with reference to the end of the actionBar.

packStart

actionBarPackStart Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionBar a, IsWidget b)
=> a	`actionBar`: A `ActionBar`
-> b	`child`: the `Widget` to be added to `actionBar`
-> m ()

Adds child to actionBar, packed with reference to the start of the actionBar.

setCenterWidget

actionBarSetCenterWidget Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionBar a, IsWidget b)
=> a	`actionBar`: a `ActionBar`
-> Maybe b	`centerWidget`: a widget to use for the center
-> m ()

Sets the center widget for the ActionBar.

setRevealed

actionBarSetRevealed Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionBar a)
=> a	`actionBar`: a `ActionBar`
-> Bool	`revealed`: The new value of the property
-> m ()

Sets the ActionBar:revealed property to revealed. Changing this will make actionBar reveal (True) or conceal (False) itself via a sliding transition.

Note: this does not show or hide actionBar in the Widget:visible sense, so revealing has no effect if Widget:visible is False.

Properties

revealed

No description available in the introspection data.

constructActionBarRevealed :: IsActionBar o => Bool -> IO (GValueConstruct o) Source #

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

getActionBarRevealed :: (MonadIO m, IsActionBar o) => o -> m Bool Source #

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

get actionBar #revealed

setActionBarRevealed :: (MonadIO m, IsActionBar o) => o -> Bool -> m () Source #

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

set actionBar [ #revealed := value ]