MenuAttributeIter

Added in version 2.32.

class MenuAttributeIter(**properties: Any)

Superclasses: Object

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

Methods

class MenuAttributeIter

do_get_next(self) → Tuple[bool, str, Variant]

get_name() → str

Gets the name of the attribute at the current iterator position, as a string.

The iterator is not advanced.

Added in version 2.32.

get_next() → Tuple[bool, str, Variant]

This function combines next() with get_name() and get_value().

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, get_name() and get_value() 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 unref() when it is no longer in use.

Added in version 2.32.

get_value() → Variant

Gets the value of the attribute at the current iterator position.

The iterator is not advanced.

Added in version 2.32.

next() → bool

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

Added in version 2.32.

Virtual Methods

class MenuAttributeIter

do_get_next() → Tuple[bool, str, Variant]

This function combines next() with get_name() and get_value().

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, get_name() and get_value() 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 unref() when it is no longer in use.

Added in version 2.32.

Fields

class MenuAttributeIter

parent_instance

priv