glib.PtrArray.PtrArray Class Reference

List of all members.

Detailed Description

Description Pointer Arrays are similar to Arrays but are used only for storing pointers.

Note If you remove elements from the array, elements at the end of the array are moved into the space previously occupied by the removed element. This means that you should not rely on the index of particular elements remaining the same. You should also be careful when deleting elements while iterating over the array. To create a pointer array, use g_ptr_array_new(). To add elements to a pointer array, use g_ptr_array_add(). To remove elements from a pointer array, use g_ptr_array_remove(), g_ptr_array_remove_index() or g_ptr_array_remove_index_fast(). To access an element of a pointer array, use g_ptr_array_index(). To set the size of a pointer array, use g_ptr_array_set_size(). To free a pointer array, use g_ptr_array_free(). Example7.Using a GPtrArray GPtrArray *gparray; gchar *string1 = "one", *string2 = "two", *string3 = "three"; gparray = g_ptr_array_new (); g_ptr_array_add (gparray, (gpointer) string1); g_ptr_array_add (gparray, (gpointer) string2); g_ptr_array_add (gparray, (gpointer) string3); if (g_ptr_array_index (gparray, 0) != (gpointer) string1) g_print ("ERROR: got %p instead of %p\n", g_ptr_array_index (gparray, 0), string1); g_ptr_array_free (gparray, TRUE);


Public Member Functions

GPtrArraygetPtrArrayStruct ()
 this (GPtrArray *gPtrArray)
 Sets our main struct and passes it to the parent class.
 this ()
 Creates a new GPtrArray.
void add (void *data)
 Adds a pointer to the end of the pointer array.
int remove (void *data)
 Removes the first occurrence of the given pointer from the pointer array.
void * removeIndex (uint index)
 Removes the pointer at the given index from the pointer array.
int removeFast (void *data)
 Removes the first occurrence of the given pointer from the pointer array.
void * removeIndexFast (uint index)
 Removes the pointer at the given index from the pointer array.
void removeRange (uint index, uint length)
 Removes the given number of pointers starting at the given index from a GPtrArray.
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).
void sortWithData (GCompareDataFunc compareFunc, void *userData)
 Like g_ptr_array_sort(), but the comparison function has an extra user data argument.
void setSize (int length)
 Sets the size of the array, expanding it if necessary.
void ** free (int freeSeg)
 Frees all of the memory allocated for the pointer array.
void foreac (GFunc func, void *userData)
 Calls a function for each element of a GPtrArray.

Static Public Member Functions

static PtrArray sizedNew (uint reservedSize)
 Creates a new GPtrArray with reserved_size pointers preallocated.

Protected Member Functions

void * getStruct ()
 the main Gtk struct as a void*

Protected Attributes

GPtrArraygPtrArray
 the main Gtk struct


Constructor & Destructor Documentation

glib.PtrArray.PtrArray.this ( GPtrArray gPtrArray  ) 

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

glib.PtrArray.PtrArray.this (  ) 

Creates a new GPtrArray.

Returns: the new GPtrArray.


Member Function Documentation

void glib.PtrArray.PtrArray.add ( void *  data  ) 

Adds a pointer to the end of the pointer array.

The array will grow in size automatically if necessary. array: a GPtrArray. data: the pointer to add.

void glib.PtrArray.PtrArray.foreac ( GFunc  func,
void *  userData 
)

Calls a function for each element of a GPtrArray.

array: a GPtrArray func: the function to call for each array element user_data: user data to pass to the function Since 2.4

void** glib.PtrArray.PtrArray.free ( int  freeSeg  ) 

Frees all of the memory allocated for the pointer array.

array: a GPtrArray. free_seg: if TRUE the array of pointers (pdata) is freed. Returns: NULL if free_seg is TRUE, otherwise the array of pointers (pdata) is returned.

GPtrArray* glib.PtrArray.PtrArray.getPtrArrayStruct (  ) 

void* glib.PtrArray.PtrArray.getStruct (  )  [protected]

the main Gtk struct as a void*

int glib.PtrArray.PtrArray.remove ( void *  data  ) 

Removes the first occurrence of the given pointer from the pointer array.

The following elements are moved down one place. It returns TRUE if the pointer was removed, or FALSE if the pointer was not found. array: a GPtrArray. data: the pointer to remove. Returns: TRUE if the pointer is removed. FALSE if the pointer is not found in the array.

int glib.PtrArray.PtrArray.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(). It returns TRUE if the pointer was removed, or FALSE if the pointer was not found. array: a GPtrArray. data: the pointer to remove. Returns: TRUE if the pointer was found in the array.

void* glib.PtrArray.PtrArray.removeIndex ( uint  index  ) 

Removes the pointer at the given index from the pointer array.

The following elements are moved down one place. array: a GPtrArray. index_: the index of the pointer to remove. Returns: the pointer which was removed.

void* glib.PtrArray.PtrArray.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(). array: a GPtrArray. index_: the index of the pointer to remove. Returns: the pointer which was removed.

void glib.PtrArray.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. array: a GPtrArray. index_: the index of the first pointer to remove. length: the number of pointers to remove. Since 2.4

void glib.PtrArray.PtrArray.setSize ( int  length  ) 

Sets the size of the array, expanding it if necessary.

New elements are set to NULL. array: a GPtrArray. length: the new length of the pointer array.

static PtrArray glib.PtrArray.PtrArray.sizedNew ( uint  reservedSize  )  [static]

Creates a new GPtrArray with reserved_size pointers preallocated.

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. reserved_size: number of pointers preallocated. Returns: the new GPtrArray.

void glib.PtrArray.PtrArray.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).

If two array elements compare equal, their order in the sorted array is undefined. Note The comparison function for g_ptr_array_sort() doesn't take the pointers from the array as arguments, it takes pointers to the pointers in the array. array: a GPtrArray. compare_func: comparison function.

void glib.PtrArray.PtrArray.sortWithData ( GCompareDataFunc  compareFunc,
void *  userData 
)

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

Note The comparison function for g_ptr_array_sort_with_data() doesn't take the pointers from the array as arguments, it takes pointers to the pointers in the array. array: a GPtrArray. compare_func: comparison function. user_data: data to pass to compare_func.


Member Data Documentation

GPtrArray* glib.PtrArray.PtrArray.gPtrArray [protected]

the main Gtk struct


SourceForge.net Logo DSource.org Logo digitalmars.com Logo