PtrArray

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

Aliases

doref alias doref = ref_: Undocumented in source.
foreac alias foreac = foreach_: Undocumented in source.

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.
copy PtrArray copy(GCopyFunc func, void* userData): Makes a full (deep) copy of a #GPtrArray.
extend void extend(PtrArray array, GCopyFunc func, void* userData): Adds all pointers of @array to the end of the array @array_to_extend. The array will grow in size automatically if needed. @array_to_extend is modified in-place.
extendAndSteal void extendAndSteal(PtrArray array): Adds all the pointers in @array to the end of @array_to_extend, transferring ownership of each element from @array to @array_to_extend and modifying @array_to_extend in-place. @array is then freed.
find bool find(void* needle, uint index): Checks whether @needle exists in @haystack. If the element is found, %TRUE is returned and the element’s index is returned in @index_ (if non-%NULL). Otherwise, %FALSE is returned and @index_ is undefined. If @needle exists multiple times in @haystack, the index of the first instance is returned.
findWithEqualFunc bool findWithEqualFunc(void* needle, GEqualFunc equalFunc, uint index): Checks whether @needle exists in @haystack, using the given @equal_func. If the element is found, %TRUE is returned and the element’s index is returned in @index_ (if non-%NULL). Otherwise, %FALSE is returned and @index_ is undefined. If @needle exists multiple times in @haystack, the index of the first instance is returned.
foreach_ void foreach_(GFunc func, void* userData): Calls a function for each element of a #GPtrArray. @func must not add elements to or remove elements from the array.
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(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
index void* index(uint idx): Returns the pointer at the given index of the pointer array.
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.
len uint len(): Number of pointers in the array
ref_ PtrArray ref_(): Atomically increments the reference count of @array by one. This function is thread-safe and may be called from any thread.
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. If so, the return value from this function will potentially point to freed memory (depending on the #GDestroyNotify implementation).
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. If so, the return value from this function will potentially point to freed memory (depending on the #GDestroyNotify implementation).
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.
steal
void** steal(size_t len): Frees the data in the array and resets the size to zero, while the underlying array is preserved for use elsewhere and returned to the caller.
stealIndex void* stealIndex(uint index): Removes the pointer at the given index from the pointer array. The following elements are moved down one place. The #GDestroyNotify for @array is *not* called on the removed element; ownership is transferred to the caller of this function.
stealIndexFast void* stealIndexFast(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_steal_index(). The #GDestroyNotify for @array is *not* called on the removed element; ownership is transferred to the caller of this function.
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 thread-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

Constructors

Members

Aliases

Functions

Static functions

Variables

Meta

Source