Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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
- newtype SwipeGroup = SwipeGroup (ManagedPtr SwipeGroup)
- class (GObject o, IsDescendantOf SwipeGroup o) => IsSwipeGroup o
- toSwipeGroup :: (MonadIO m, IsSwipeGroup o) => o -> m SwipeGroup
- swipeGroupAddSwipeable :: (HasCallStack, MonadIO m, IsSwipeGroup a, IsSwipeable b) => a -> b -> m ()
- swipeGroupGetSwipeables :: (HasCallStack, MonadIO m, IsSwipeGroup a) => a -> m [Swipeable]
- swipeGroupNew :: (HasCallStack, MonadIO m) => m SwipeGroup
- swipeGroupRemoveSwipeable :: (HasCallStack, MonadIO m, IsSwipeGroup a, IsSwipeable b) => a -> b -> m ()
Exported types
newtype SwipeGroup Source #
Memory-managed wrapper type.
SwipeGroup (ManagedPtr SwipeGroup) |
Instances
Eq SwipeGroup Source # | |
Defined in GI.Handy.Objects.SwipeGroup (==) :: SwipeGroup -> SwipeGroup -> Bool # (/=) :: SwipeGroup -> SwipeGroup -> Bool # | |
GObject SwipeGroup Source # | |
Defined in GI.Handy.Objects.SwipeGroup | |
ManagedPtrNewtype SwipeGroup Source # | |
Defined in GI.Handy.Objects.SwipeGroup toManagedPtr :: SwipeGroup -> ManagedPtr SwipeGroup | |
TypedObject SwipeGroup Source # | |
Defined in GI.Handy.Objects.SwipeGroup | |
HasParentTypes SwipeGroup Source # | |
Defined in GI.Handy.Objects.SwipeGroup | |
IsGValue (Maybe SwipeGroup) Source # | Convert |
Defined in GI.Handy.Objects.SwipeGroup gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe SwipeGroup -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe SwipeGroup) | |
type ParentTypes SwipeGroup Source # | |
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
(GObject o, IsDescendantOf SwipeGroup o) => IsSwipeGroup o Source # | |
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
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 Source #
:: (HasCallStack, MonadIO m, IsSwipeGroup a, IsSwipeable b) | |
=> a |
|
-> b |
|
-> 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 #
:: (HasCallStack, MonadIO m, IsSwipeGroup a) | |
=> a |
|
-> m [Swipeable] | Returns: a list of swipeables |
Deprecated: (Since version 1.4)
Gets the list of swipeables associated with self
.
Since: 1.0
new
:: (HasCallStack, MonadIO m) | |
=> m SwipeGroup | Returns: the newly created |
Deprecated: (Since version 1.4)
Creates a new HdySwipeGroup
.
Since: 1.0
removeSwipeable
swipeGroupRemoveSwipeable Source #
:: (HasCallStack, MonadIO m, IsSwipeGroup a, IsSwipeable b) | |
=> a |
|
-> b |
|
-> m () |
Deprecated: (Since version 1.4)
Removes a widget from a [classswipeGroup
].
Since: 1.0