About all my projects
Gnome::Gio::MenuLinkIter

Gnome::Gio::MenuLinkIter

Description

Gnome::Gio::MenuLinkIter is an opaque structure type. You must access it using the functions below.

Uml Diagram

No caption

Class initialization

new

:native-object

Create an object using a native object from an object of the same type found elsewhere. See also Gnome::N::TopLevelSupportClass.

multi method new ( N-Object() :$native-object! )

Methods

get-name

Gets the name of the link at the current iterator position.

The iterator is not advanced.

method get-name (--> Str )

Return value; the type of the link.

get-next

This function combines .next() with .get-name() and .get-value().

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, $out-link and $value are set to the name and Gnome::Gio::MenuModel of the link that has just been advanced to. At this point, .get-name() and .get-value() will return the same values again.

The value returned in $out-link remains valid for as long as the iterator remains at the current position. The value returned in $value must be unreffed using g_object_unref() when it is no longer in use.

method get-next ( Array[Str] $out-link, N-Object() $value --> Bool )
  • $out-link; the name of the link.

  • $value; (transfer ownership: full) the linked Gnome::Gio::MenuModel.

Return value; True on success, or False if there is no additional link.

get-value

Gets the linked Gnome::Gio::MenuModel at the current iterator position.

The iterator is not advanced.

method get-value (--> N-Object )

Return value; the Gnome::Gio::MenuModel that is linked to.

next

Attempts to advance the iterator to the next (possibly first) link.

True is returned on success, or False if there are no more links.

You must call this function when you first acquire the iterator to advance it to the first link (and determine if the first link exists at all).

method next (--> Bool )

Return value; True on success, or False when there are no more links.