glib/org.gtkkn.bindings.glib/List/Companion

Companion

Functions

Allocates space for one #GList element. It is called by g_list_append(), g_list_prepend(), g_list_insert() and g_list_insert_sorted() and so is rarely used on its own.

append

fun append(list: List, data: <Error class: unknown class>? = null): List

Adds a new element on to the end of the list.

concat

fun concat(list1: List, list2: List): List

Adds the second #GList onto the end of the first #GList. Note that the elements of the second #GList are not copied. They are used directly.

copy

fun copy(list: List): List

Copies a #GList.

copyDeep

fun copyDeep(list: List, func: CopyFunc): List

Makes a full (deep) copy of a #GList.

deleteLink

fun deleteLink(list: List, link: List): List

Removes the node link_ from the list and frees it. Compare this to g_list_remove_link() which removes the node without freeing it.

find

fun find(list: List, data: <Error class: unknown class>? = null): List

Finds the element in a #GList which contains the given data.

first

fun first(list: List): List

Gets the first element in a #GList.

foreach

fun foreach(list: List, func: Func)

Calls a function for each element of a #GList.

free

fun free(list: List)

Frees all of the memory used by a #GList. The freed elements are returned to the slice allocator.

free1

fun free1(list: List)

Frees one #GList element, but does not update links from the next and previous elements in the list, so you should not call this function on an element that is currently part of a list.

index

fun index(list: List, data: <Error class: unknown class>? = null): <Error class: unknown class>

Gets the position of the element containing the given data (starting from 0).

insert

fun insert(list: List, data: <Error class: unknown class>? = null, position: <Error class: unknown class>): List

Inserts a new element into the list at the given position.

insertBefore

fun insertBefore(list: List, sibling: List, data: <Error class: unknown class>? = null): List

Inserts a new element into the list before the given position.

insertBeforeLink

fun insertBeforeLink(list: List, sibling: List? = null, link: List): List

Inserts @link_ into the list before the given position.

insertSortedWithData

fun insertSortedWithData(list: List, data: <Error class: unknown class>? = null, func: CompareDataFunc): List

Inserts a new element into the list, using the given comparison function to determine its position.

last

fun last(list: List): List

Gets the last element in a #GList.

length

fun length(list: List): <Error class: unknown class>

Gets the number of elements in a #GList.

nth

fun nth(list: List, n: <Error class: unknown class>): List

Gets the element at the given position in a #GList.

nthData

fun nthData(list: List, n: <Error class: unknown class>): <Error class: unknown class>?

Gets the data of the element at the given position.

nthPrev

fun nthPrev(list: List, n: <Error class: unknown class>): List

Gets the element @n places before @list.

popAllocator

fun popAllocator()

position

fun position(list: List, llink: List): <Error class: unknown class>

Gets the position of the given element in the #GList (starting from 0).

prepend

fun prepend(list: List, data: <Error class: unknown class>? = null): List

Prepends a new element on to the start of the list.

remove

fun remove(list: List, data: <Error class: unknown class>? = null): List

Removes an element from a #GList. If two elements contain the same data, only the first is removed. If none of the elements contain the data, the #GList is unchanged.

removeAll

fun removeAll(list: List, data: <Error class: unknown class>? = null): List

Removes all list nodes with data equal to @data. Returns the new head of the list. Contrast with g_list_remove() which removes only the first node matching the given data.

removeLink

fun removeLink(list: List, llink: List): List

Removes an element from a #GList, without freeing the element. The removed element's prev and next links are set to null, so that it becomes a self-contained list with one element.

reverse

fun reverse(list: List): List

Reverses a #GList. It simply switches the next and prev pointers of each element.

sortWithData

fun sortWithData(list: List, compareFunc: CompareDataFunc): List

Like g_list_sort(), but the comparison function accepts a user data argument.