Sequence

The #GSequence struct is an opaque data type representing a sequence[glib-Sequences] data type.

class Sequence {
GSequence* cInstancePtr;
bool owned;
}

Destructor

A destructor is present on this object, but not explicitly documented in the source.

Members

Functions

append
glib.sequence_iter.SequenceIter append(void* data)

Adds a new item to the end of seq.

foreach_
void foreach_(glib.types.Func func)

Calls func for each item in the sequence passing user_data to the function. func must not modify the sequence itself.

getBeginIter
glib.sequence_iter.SequenceIter getBeginIter()

Returns the begin iterator for seq.

getEndIter
glib.sequence_iter.SequenceIter getEndIter()

Returns the end iterator for seg

getIterAtPos
glib.sequence_iter.SequenceIter getIterAtPos(int pos)

Returns the iterator at position pos. If pos is negative or larger than the number of items in seq, the end iterator is returned.

getLength
int getLength()

Returns the positive length (>= 0) of seq. Note that this method is O(h) where `h' is the height of the tree. It is thus more efficient to use glib.sequence.Sequence.isEmpty when comparing the length to zero.

insertSorted
glib.sequence_iter.SequenceIter insertSorted(void* data, glib.types.CompareDataFunc cmpFunc)

Inserts data into seq using cmp_func to determine the new position. The sequence must already be sorted according to cmp_func; otherwise the new position of data is undefined.

insertSortedIter
glib.sequence_iter.SequenceIter insertSortedIter(void* data, glib.types.SequenceIterCompareFunc iterCmp)

Like glib.sequence.Sequence.insertSorted, but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function.

isEmpty
bool isEmpty()

Returns true if the sequence contains zero items.

lookup
glib.sequence_iter.SequenceIter lookup(void* data, glib.types.CompareDataFunc cmpFunc)

Returns an iterator pointing to the position of the first item found equal to data according to cmp_func and cmp_data. If more than one item is equal, it is not guaranteed that it is the first which is returned. In that case, you can use glib.sequence_iter.SequenceIter.next and glib.sequence_iter.SequenceIter.prev to get others.

lookupIter
glib.sequence_iter.SequenceIter lookupIter(void* data, glib.types.SequenceIterCompareFunc iterCmp)

Like glib.sequence.Sequence.lookup, but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function.

prepend
glib.sequence_iter.SequenceIter prepend(void* data)

Adds a new item to the front of seq

search
glib.sequence_iter.SequenceIter search(void* data, glib.types.CompareDataFunc cmpFunc)

Returns an iterator pointing to the position where data would be inserted according to cmp_func and cmp_data.

searchIter
glib.sequence_iter.SequenceIter searchIter(void* data, glib.types.SequenceIterCompareFunc iterCmp)

Like glib.sequence.Sequence.search, but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function.

sort
void sort(glib.types.CompareDataFunc cmpFunc)

Sorts seq using cmp_func.

sortIter
void sortIter(glib.types.SequenceIterCompareFunc cmpFunc)

Like glib.sequence.Sequence.sort, but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function

Static functions

foreachRange
void foreachRange(glib.sequence_iter.SequenceIter begin, glib.sequence_iter.SequenceIter end, glib.types.Func func)

Calls func for each item in the range (begin, end) passing user_data to the function. func must not modify the sequence itself.

get
void* get(glib.sequence_iter.SequenceIter iter)

Returns the data that iter points to.

insertBefore
glib.sequence_iter.SequenceIter insertBefore(glib.sequence_iter.SequenceIter iter, void* data)

Inserts a new item just before the item pointed to by iter.

move
void move(glib.sequence_iter.SequenceIter src, glib.sequence_iter.SequenceIter dest)

Moves the item pointed to by src to the position indicated by dest. After calling this function dest will point to the position immediately after src. It is allowed for src and dest to point into different sequences.

moveRange
void moveRange(glib.sequence_iter.SequenceIter dest, glib.sequence_iter.SequenceIter begin, glib.sequence_iter.SequenceIter end)

Inserts the (begin, end) range at the destination pointed to by dest. The begin and end iters must point into the same sequence. It is allowed for dest to point to a different sequence than the one pointed into by begin and end.

rangeGetMidpoint
glib.sequence_iter.SequenceIter rangeGetMidpoint(glib.sequence_iter.SequenceIter begin, glib.sequence_iter.SequenceIter end)

Finds an iterator somewhere in the range (begin, end). This iterator will be close to the middle of the range, but is not guaranteed to be exactly in the middle.

remove
void remove(glib.sequence_iter.SequenceIter iter)

Removes the item pointed to by iter. It is an error to pass the end iterator to this function.

removeRange
void removeRange(glib.sequence_iter.SequenceIter begin, glib.sequence_iter.SequenceIter end)

Removes all items in the (begin, end) range.

set
void set(glib.sequence_iter.SequenceIter iter, void* data)

Changes the data for the item pointed to by iter to be data. If the sequence has a data destroy function associated with it, that function is called on the existing data that iter pointed to.

sortChanged
void sortChanged(glib.sequence_iter.SequenceIter iter, glib.types.CompareDataFunc cmpFunc)

Moves the data pointed to by iter to a new position as indicated by cmp_func. This function should be called for items in a sequence already sorted according to cmp_func whenever some aspect of an item changes so that cmp_func may return different values for that item.

sortChangedIter
void sortChangedIter(glib.sequence_iter.SequenceIter iter, glib.types.SequenceIterCompareFunc iterCmp)

Like glib.sequence.Sequence.sortChanged, but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function.

swap
void swap(glib.sequence_iter.SequenceIter a, glib.sequence_iter.SequenceIter b)

Swaps the items pointed to by a and b. It is allowed for a and b to point into difference sequences.