| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gio.Objects.MenuLinkIter
Description
MenuLinkIter is an opaque structure type. You must access it using
the functions below.
Since: 2.32
Synopsis
- newtype MenuLinkIter = MenuLinkIter (ManagedPtr MenuLinkIter)
- class (GObject o, IsDescendantOf MenuLinkIter o) => IsMenuLinkIter o
- toMenuLinkIter :: (MonadIO m, IsMenuLinkIter o) => o -> m MenuLinkIter
- type family ResolveMenuLinkIterMethod (t :: Symbol) o where ...
- data MenuLinkIterGetNameMethodInfo
- menuLinkIterGetName :: (HasCallStack, MonadIO m, IsMenuLinkIter a) => a -> m Text
- data MenuLinkIterGetNextMethodInfo
- menuLinkIterGetNext :: (HasCallStack, MonadIO m, IsMenuLinkIter a) => a -> m (Bool, Text, MenuModel)
- data MenuLinkIterGetValueMethodInfo
- menuLinkIterGetValue :: (HasCallStack, MonadIO m, IsMenuLinkIter a) => a -> m MenuModel
- data MenuLinkIterNextMethodInfo
- menuLinkIterNext :: (HasCallStack, MonadIO m, IsMenuLinkIter a) => a -> m Bool
Exported types
newtype MenuLinkIter Source #
Memory-managed wrapper type.
Constructors
| MenuLinkIter (ManagedPtr MenuLinkIter) |
Instances
class (GObject o, IsDescendantOf MenuLinkIter o) => IsMenuLinkIter o Source #
Type class for types which can be safely cast to MenuLinkIter, for instance with toMenuLinkIter.
Instances
| (GObject o, IsDescendantOf MenuLinkIter o) => IsMenuLinkIter o Source # | |
Defined in GI.Gio.Objects.MenuLinkIter | |
toMenuLinkIter :: (MonadIO m, IsMenuLinkIter o) => o -> m MenuLinkIter Source #
Cast to MenuLinkIter, 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
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, next, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getName, getNext, getProperty, getQdata, getValue.
Setters
type family ResolveMenuLinkIterMethod (t :: Symbol) o where ... Source #
Equations
getName
data MenuLinkIterGetNameMethodInfo Source #
Instances
| (signature ~ m Text, MonadIO m, IsMenuLinkIter a) => OverloadedMethod MenuLinkIterGetNameMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.MenuLinkIter Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo MenuLinkIterGetNameMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.MenuLinkIter Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsMenuLinkIter a) | |
| => a |
|
| -> m Text | Returns: the type of the link |
Gets the name of the link at the current iterator position.
The iterator is not advanced.
Since: 2.32
getNext
data MenuLinkIterGetNextMethodInfo Source #
Instances
| (signature ~ m (Bool, Text, MenuModel), MonadIO m, IsMenuLinkIter a) => OverloadedMethod MenuLinkIterGetNextMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.MenuLinkIter Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo MenuLinkIterGetNextMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.MenuLinkIter Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsMenuLinkIter a) | |
| => a |
|
| -> m (Bool, Text, MenuModel) | Returns: |
This function combines menuLinkIterNext with
menuLinkIterGetName and menuLinkIterGetValue.
First the iterator is advanced to the next (possibly first) link.
If that fails, then False is returned and there are no other effects.
If successful, outLink and value are set to the name and MenuModel
of the link that has just been advanced to. At this point,
menuLinkIterGetName and menuLinkIterGetValue will return the
same values again.
The value returned in outLink remains valid for as long as the iterator
remains at the current position. The value returned in value must
be unreffed using objectUnref when it is no longer in use.
Since: 2.32
getValue
data MenuLinkIterGetValueMethodInfo Source #
Instances
| (signature ~ m MenuModel, MonadIO m, IsMenuLinkIter a) => OverloadedMethod MenuLinkIterGetValueMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.MenuLinkIter Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo MenuLinkIterGetValueMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.MenuLinkIter Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsMenuLinkIter a) | |
| => a |
|
| -> m MenuModel | Returns: the |
next
data MenuLinkIterNextMethodInfo Source #
Instances
| (signature ~ m Bool, MonadIO m, IsMenuLinkIter a) => OverloadedMethod MenuLinkIterNextMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.MenuLinkIter Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo MenuLinkIterNextMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.MenuLinkIter Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsMenuLinkIter a) | |
| => a |
|
| -> m Bool | Returns: |