GI.Handy.Objects.SwipeGroup

The SwipeGroup object can be used to sync multiple swipeable widgets that implement the Swipeable interface, such as Paginator, 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.

# SwipeGroup as Buildable

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

<object class="HdySwipeGroup">
  <swipeables>
    <swipeable name="paginator1"/>
    <swipeable name="paginator2"/>
  </swipeables>
</object>

Since: 0.0.12

Exported types

newtype SwipeGroup

Memory-managed wrapper type.

Constructors

SwipeGroup (ManagedPtr SwipeGroup)

Instances

Eq SwipeGroup

Defined in GI.Handy.Objects.SwipeGroup

Methods

(==) :: SwipeGroup -> SwipeGroup -> Bool

(/=) :: SwipeGroup -> SwipeGroup -> Bool

GObject SwipeGroup

Defined in GI.Handy.Objects.SwipeGroup

ManagedPtrNewtype SwipeGroup

Defined in GI.Handy.Objects.SwipeGroup

Methods

toManagedPtr :: SwipeGroup -> ManagedPtr SwipeGroup

TypedObject SwipeGroup

Defined in GI.Handy.Objects.SwipeGroup

Methods

glibType :: IO GType

HasParentTypes SwipeGroup

Defined in GI.Handy.Objects.SwipeGroup

IsGValue (Maybe SwipeGroup)

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

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

Defined in GI.Handy.Objects.SwipeGroup

type ParentTypes SwipeGroup = '[Object, Buildable]

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

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

Instances

(GObject o, IsDescendantOf SwipeGroup o) => IsSwipeGroup o

Defined in GI.Handy.Objects.SwipeGroup

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

Cast to SwipeGroup, 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

Methods

addChild, addSwipeable, bindProperty, bindPropertyFull, constructChild, customFinished, customTagEnd, customTagStart, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, parserFinished, ref, refSink, removeSwipeable, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getInternalChild, getName, getProperty, getQdata, getSwipeables.

Setters

setBuildableProperty, setData, setDataFull, setName, setProperty.

addSwipeable

swipeGroupAddSwipeable

Arguments

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

=> a

self: a SwipeGroup

-> b

swipeable: the Swipeable to add

-> m ()

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

Since: 0.0.12

getSwipeables

swipeGroupGetSwipeables

Arguments

:: (HasCallStack, MonadIO m, IsSwipeGroup a)

=> a

self: a SwipeGroup

-> m [Swipeable]

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

Returns the list of swipeables associated with self.

Since: 0.0.12

new

swipeGroupNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SwipeGroup

Returns: The newly created SwipeGroup object

Create a new SwipeGroup object.

Since: 0.0.12

removeSwipeable

swipeGroupRemoveSwipeable

Arguments

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

=> a

self: a SwipeGroup

-> b

swipeable: the Swipeable to remove

-> m ()

Removes a widget from a SwipeGroup.

Since: 0.0.12