PtrArray

Constructors

this

this(GPtrArray* gPtrArray, bool ownedRef)

Sets our main struct and passes it to the parent class.

this

this()

Creates a new #GPtrArray with a reference count of 1.

this

this(uint reservedSize, GDestroyNotify elementFreeFunc)

Creates a new #GPtrArray with @reserved_size pointers preallocated and a reference count of 1. This avoids frequent reallocation, if you are going to add many pointers to the array. Note however that the size of the array is still 0. It also set @element_free_func for freeing each element when the array is destroyed either via g_ptr_array_unref(), when g_ptr_array_free() is called with @free_segment set to %TRUE or when removing elements.

this

this(GDestroyNotify elementFreeFunc)

Creates a new #GPtrArray with a reference count of 1 and use @element_free_func for freeing each element when the array is destroyed either via g_ptr_array_unref(), when g_ptr_array_free() is called with @free_segment set to %TRUE or when removing elements.

Members

Functions

add

void add(void* data)

Adds a pointer to the end of the pointer array. The array will grow in size automatically if necessary.

doref

PtrArray doref()

Atomically increments the reference count of @array by one. This function is thread-safe and may be called from any thread.

foreac

void foreac(GFunc func, void* userData)

Calls a function for each element of a #GPtrArray.

free

void** free(bool freeSeg)

Frees the memory allocated for the #GPtrArray. If @free_seg is %TRUE it frees the memory block holding the elements as well. Pass %FALSE if you want to free the #GPtrArray wrapper but preserve the underlying array for use elsewhere. If the reference count of @array is greater than one, the #GPtrArray wrapper is preserved but the size of @array will be set to zero.

getPtrArrayStruct

GPtrArray* getPtrArrayStruct()

Get the main Gtk struct

getStruct

void* getStruct()

the main Gtk struct as a void*

insert

void insert(int index, void* data)

Inserts an element into the pointer array at the given index. The array will grow in size automatically if necessary.

remove

bool remove(void* data)

Removes the first occurrence of the given pointer from the pointer array. The following elements are moved down one place. If @array has a non-%NULL #GDestroyNotify function it is called for the removed element.

removeFast

bool removeFast(void* data)

Removes the first occurrence of the given pointer from the pointer array. The last element in the array is used to fill in the space, so this function does not preserve the order of the array. But it is faster than g_ptr_array_remove(). If @array has a non-%NULL #GDestroyNotify function it is called for the removed element.

removeIndex

void* removeIndex(uint index)

Removes the pointer at the given index from the pointer array. The following elements are moved down one place. If @array has a non-%NULL #GDestroyNotify function it is called for the removed element.

removeIndexFast

void* removeIndexFast(uint index)

Removes the pointer at the given index from the pointer array. The last element in the array is used to fill in the space, so this function does not preserve the order of the array. But it is faster than g_ptr_array_remove_index(). If @array has a non-%NULL #GDestroyNotify function it is called for the removed element.

removeRange

PtrArray removeRange(uint index, uint length)

Removes the given number of pointers starting at the given index from a #GPtrArray. The following elements are moved to close the gap. If @array has a non-%NULL #GDestroyNotify function it is called for the removed elements.

setFreeFunc

void setFreeFunc(GDestroyNotify elementFreeFunc)

Sets a function for freeing each element when @array is destroyed either via g_ptr_array_unref(), when g_ptr_array_free() is called with @free_segment set to %TRUE or when removing elements.

setSize

void setSize(int length)

Sets the size of the array. When making the array larger, newly-added elements will be set to %NULL. When making it smaller, if @array has a non-%NULL #GDestroyNotify function then it will be called for the removed elements.

sort

void sort(GCompareFunc compareFunc)

Sorts the array, using @compare_func which should be a qsort()-style comparison function (returns less than zero for first arg is less than second arg, zero for equal, greater than zero if irst arg is greater than second arg).

sortWithData

void sortWithData(GCompareDataFunc compareFunc, void* userData)

Like g_ptr_array_sort(), but the comparison function has an extra user data argument.

unref

void unref()

Atomically decrements the reference count of @array by one. If the reference count drops to 0, the effect is the same as calling g_ptr_array_free() with @free_segment set to %TRUE. This function is MT-safe and may be called from any thread.

Static functions

sizedNew

PtrArray sizedNew(uint reservedSize)

Creates a new #GPtrArray with @reserved_size pointers preallocated and a reference count of 1. This avoids frequent reallocation, if you are going to add many pointers to the array. Note however that the size of the array is still 0.

Variables

gPtrArray

GPtrArray* gPtrArray;

the main Gtk struct

ownedRef

bool ownedRef;

Undocumented in source.

• PtrArray