| 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.MenuAttributeIter
Description
MenuAttributeIter is an opaque structure type. You must access it
using the functions below.
Since: 2.32
Synopsis
- newtype MenuAttributeIter = MenuAttributeIter (ManagedPtr MenuAttributeIter)
- class (GObject o, IsDescendantOf MenuAttributeIter o) => IsMenuAttributeIter o
- toMenuAttributeIter :: (MonadIO m, IsMenuAttributeIter o) => o -> m MenuAttributeIter
- type family ResolveMenuAttributeIterMethod (t :: Symbol) o where ...
- data MenuAttributeIterGetNameMethodInfo
- menuAttributeIterGetName :: (HasCallStack, MonadIO m, IsMenuAttributeIter a) => a -> m Text
- data MenuAttributeIterGetNextMethodInfo
- menuAttributeIterGetNext :: (HasCallStack, MonadIO m, IsMenuAttributeIter a) => a -> m (Bool, Text, GVariant)
- data MenuAttributeIterGetValueMethodInfo
- menuAttributeIterGetValue :: (HasCallStack, MonadIO m, IsMenuAttributeIter a) => a -> m GVariant
- data MenuAttributeIterNextMethodInfo
- menuAttributeIterNext :: (HasCallStack, MonadIO m, IsMenuAttributeIter a) => a -> m Bool
Exported types
newtype MenuAttributeIter Source #
Memory-managed wrapper type.
Constructors
| MenuAttributeIter (ManagedPtr MenuAttributeIter) |
Instances
class (GObject o, IsDescendantOf MenuAttributeIter o) => IsMenuAttributeIter o Source #
Type class for types which can be safely cast to MenuAttributeIter, for instance with toMenuAttributeIter.
Instances
| (GObject o, IsDescendantOf MenuAttributeIter o) => IsMenuAttributeIter o Source # | |
Defined in GI.Gio.Objects.MenuAttributeIter | |
toMenuAttributeIter :: (MonadIO m, IsMenuAttributeIter o) => o -> m MenuAttributeIter Source #
Cast to MenuAttributeIter, 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 ResolveMenuAttributeIterMethod (t :: Symbol) o where ... Source #
Equations
getName
data MenuAttributeIterGetNameMethodInfo Source #
Instances
| (signature ~ m Text, MonadIO m, IsMenuAttributeIter a) => OverloadedMethod MenuAttributeIterGetNameMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.MenuAttributeIter Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo MenuAttributeIterGetNameMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.MenuAttributeIter Methods | |
menuAttributeIterGetName Source #
Arguments
| :: (HasCallStack, MonadIO m, IsMenuAttributeIter a) | |
| => a |
|
| -> m Text | Returns: the name of the attribute |
Gets the name of the attribute at the current iterator position, as a string.
The iterator is not advanced.
Since: 2.32
getNext
data MenuAttributeIterGetNextMethodInfo Source #
Instances
| (signature ~ m (Bool, Text, GVariant), MonadIO m, IsMenuAttributeIter a) => OverloadedMethod MenuAttributeIterGetNextMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.MenuAttributeIter Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo MenuAttributeIterGetNextMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.MenuAttributeIter Methods | |
menuAttributeIterGetNext Source #
Arguments
| :: (HasCallStack, MonadIO m, IsMenuAttributeIter a) | |
| => a |
|
| -> m (Bool, Text, GVariant) | Returns: |
This function combines menuAttributeIterNext with
menuAttributeIterGetName and menuAttributeIterGetValue.
First the iterator is advanced to the next (possibly first) attribute.
If that fails, then False is returned and there are no other
effects.
If successful, name and value are set to the name and value of the
attribute that has just been advanced to. At this point,
menuAttributeIterGetName and menuAttributeIterGetValue will
return the same values again.
The value returned in name remains valid for as long as the iterator
remains at the current position. The value returned in value must
be unreffed using variantUnref when it is no longer in use.
Since: 2.32
getValue
data MenuAttributeIterGetValueMethodInfo Source #
Instances
| (signature ~ m GVariant, MonadIO m, IsMenuAttributeIter a) => OverloadedMethod MenuAttributeIterGetValueMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.MenuAttributeIter Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo MenuAttributeIterGetValueMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.MenuAttributeIter Methods | |
menuAttributeIterGetValue Source #
Arguments
| :: (HasCallStack, MonadIO m, IsMenuAttributeIter a) | |
| => a |
|
| -> m GVariant | Returns: the value of the current attribute |
Gets the value of the attribute at the current iterator position.
The iterator is not advanced.
Since: 2.32
next
data MenuAttributeIterNextMethodInfo Source #
Instances
| (signature ~ m Bool, MonadIO m, IsMenuAttributeIter a) => OverloadedMethod MenuAttributeIterNextMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.MenuAttributeIter Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo MenuAttributeIterNextMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.MenuAttributeIter Methods | |
menuAttributeIterNext Source #
Arguments
| :: (HasCallStack, MonadIO m, IsMenuAttributeIter a) | |
| => a |
|
| -> m Bool | Returns: |
Attempts to advance the iterator to the next (possibly first) attribute.
True is returned on success, or False if there are no more
attributes.
You must call this function when you first acquire the iterator to advance it to the first attribute (and determine if the first attribute exists at all).
Since: 2.32