GI.Gio.Objects.MenuAttributeIter

MenuAttributeIter is an opaque structure type. You must access it using the functions below.

Exported types

newtype MenuAttributeIter

Constructors

MenuAttributeIter (ManagedPtr MenuAttributeIter)

Instances

GObject MenuAttributeIter

Methods

gobjectType :: MenuAttributeIter -> IO GType

IsObject MenuAttributeIter

IsMenuAttributeIter MenuAttributeIter

class GObject o => IsMenuAttributeIter o

Instances

(GObject a, UnknownAncestorError Constraint MenuAttributeIter a) => IsMenuAttributeIter a

IsMenuAttributeIter MenuAttributeIter

toMenuAttributeIter :: (MonadIO m, IsMenuAttributeIter o) => o -> m MenuAttributeIter

noMenuAttributeIter :: Maybe MenuAttributeIter

Methods

getName

menuAttributeIterGetName

Arguments

:: (HasCallStack, MonadIO m, IsMenuAttributeIter a)

=> a

iter: a MenuAttributeIter

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

menuAttributeIterGetNext

Arguments

:: (HasCallStack, MonadIO m, IsMenuAttributeIter a)

=> a

iter: a MenuAttributeIter

-> m (Bool, Text, GVariant)

Returns: True on success, or False if there is no additional attribute

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

menuAttributeIterGetValue

Arguments

:: (HasCallStack, MonadIO m, IsMenuAttributeIter a)

=> a

iter: a MenuAttributeIter

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

menuAttributeIterNext

Arguments

:: (HasCallStack, MonadIO m, IsMenuAttributeIter a)

=> a

iter: a MenuAttributeIter

-> m Bool

Returns: True on success, or False when there are no more attributes

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