GLib.SequenceIter

Fields

None

Methods

  compare (b)
  get_position ()
  get_sequence ()
  is_begin ()
  is_end ()
  move (delta)
  next ()
  prev ()

Details

class GLib.SequenceIter

The GLib.SequenceIter struct is an opaque data type representing an iterator pointing into a GLib.Sequence.

compare(b)[source]
Parameters:b (GLib.SequenceIter) – a GLib.SequenceIter
Returns:a negative number if self comes before b, 0 if they are equal, and a positive number if self comes after b
Return type:int

Returns a negative number if self comes before b, 0 if they are equal, and a positive number if self comes after b.

The self and b iterators must point into the same sequence.

New in version 2.14.

get_position()[source]
Returns:the position of self
Return type:int

Returns the position of self

New in version 2.14.

get_sequence()[source]
Returns:the GLib.Sequence that self points into
Return type:GLib.Sequence

Returns the GLib.Sequence that self points into.

New in version 2.14.

is_begin()[source]
Returns:whether self is the begin iterator
Return type:bool

Returns whether self is the begin iterator

New in version 2.14.

is_end()[source]
Returns:Whether self is the end iterator
Return type:bool

Returns whether self is the end iterator

New in version 2.14.

move(delta)[source]
Parameters:delta (int) – A positive or negative number indicating how many positions away from self the returned GLib.SequenceIter will be
Returns:a GLib.SequenceIter which is delta positions away from self
Return type:GLib.SequenceIter

Returns the GLib.SequenceIter which is delta positions away from self. If self is closer than -delta positions to the beginning of the sequence, the begin iterator is returned. If self is closer than delta positions to the end of the sequence, the end iterator is returned.

New in version 2.14.

next()[source]
Returns:a GLib.SequenceIter pointing to the next position after self
Return type:GLib.SequenceIter

Returns an iterator pointing to the next position after self. If self is the end iterator, the end iterator is returned.

New in version 2.14.

prev()[source]
Returns:a GLib.SequenceIter pointing to the previous position before self
Return type:GLib.SequenceIter

Returns an iterator pointing to the previous position before self. If self is the begin iterator, the begin iterator is returned.

New in version 2.14.