gi-handy-1.0.4: 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.SwipeGroup

Description

An object for syncing swipeable widgets.

The HdySwipeGroup object can be used to sync multiple swipeable widgets that implement the [ifaceswipeable] interface, such as [classcarousel], so that animating one of them also animates all the other widgets in the group.

This can be useful for syncing widgets between a window's titlebar and content area.

HdySwipeGroup as GtkBuildable

HdySwipeGroup can be created in an UI definition. The list of swipeable widgets is specified with a <swipeables> element containing multiple <swipeable> elements with their ”name” attribute specifying the id of the widgets.

xml code

<object class="HdySwipeGroup">
  <swipeables>
    <swipeable name="carousel1"/>
    <swipeable name="carousel2"/>
  </swipeables>
</object>

HdySwipeGroup has been deprecated, [classwindow] and [classapplicationWindow] allow using a single leaflet for both content and header bar, without the need to sync them.

Since: 1.0

Synopsis

Exported types

newtype SwipeGroup Source #

Memory-managed wrapper type.

Constructors

SwipeGroup (ManagedPtr SwipeGroup) 

Instances

Instances details
Eq SwipeGroup Source # 
Instance details

Defined in GI.Handy.Objects.SwipeGroup

GObject SwipeGroup Source # 
Instance details

Defined in GI.Handy.Objects.SwipeGroup

ManagedPtrNewtype SwipeGroup Source # 
Instance details

Defined in GI.Handy.Objects.SwipeGroup

Methods

toManagedPtr :: SwipeGroup -> ManagedPtr SwipeGroup

TypedObject SwipeGroup Source # 
Instance details

Defined in GI.Handy.Objects.SwipeGroup

Methods

glibType :: IO GType

HasParentTypes SwipeGroup Source # 
Instance details

Defined in GI.Handy.Objects.SwipeGroup

IsGValue (Maybe SwipeGroup) Source #

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

Instance details

Defined in GI.Handy.Objects.SwipeGroup

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes SwipeGroup Source # 
Instance details

Defined in GI.Handy.Objects.SwipeGroup

type ParentTypes SwipeGroup = '[Object, Buildable]

class (GObject o, IsDescendantOf SwipeGroup o) => IsSwipeGroup o Source #

Type class for types which can be safely cast to SwipeGroup, for instance with toSwipeGroup.

Instances

Instances details
(GObject o, IsDescendantOf SwipeGroup o) => IsSwipeGroup o Source # 
Instance details

Defined in GI.Handy.Objects.SwipeGroup

toSwipeGroup :: (MonadIO m, IsSwipeGroup o) => o -> m SwipeGroup Source #

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

Methods

addSwipeable

swipeGroupAddSwipeable Source #

Arguments

:: (HasCallStack, MonadIO m, IsSwipeGroup a, IsSwipeable b) 
=> a

self: a swipe group

-> b

swipeable: the [ifaceswipeable] to add

-> m () 

Deprecated: (Since version 1.4)

Adds a swipeable to self.

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

Since: 1.0

getSwipeables

swipeGroupGetSwipeables Source #

Arguments

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

self: a swipe group

-> m [Swipeable]

Returns: a list of swipeables

Deprecated: (Since version 1.4)

Gets the list of swipeables associated with self.

Since: 1.0

new

swipeGroupNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m SwipeGroup

Returns: the newly created HdySwipeGroup

Deprecated: (Since version 1.4)

Creates a new HdySwipeGroup.

Since: 1.0

removeSwipeable

swipeGroupRemoveSwipeable Source #

Arguments

:: (HasCallStack, MonadIO m, IsSwipeGroup a, IsSwipeable b) 
=> a

self: a swipe group

-> b

swipeable: the [ifaceswipeable] to remove

-> m () 

Deprecated: (Since version 1.4)

Removes a widget from a [classswipeGroup].

Since: 1.0