libical-glib Reference Manual: ICalArray

Functions

ICalArray *	i_cal_array_new_full ()
gint	i_cal_array_size ()
ICalArray *	i_cal_array_new ()
ICalArray *	i_cal_array_copy ()
void	i_cal_array_free ()
void	i_cal_array_append ()
void	i_cal_array_remove_element_at ()
GObject *	i_cal_array_element_at ()
void	i_cal_array_sort ()

Types and Values

#define	I_CAL_ARRAY_TYPE
	ICalArray
struct	ICalArrayClass

Object Hierarchy

    GObject
    ╰── ICalObject
        ╰── ICalArray

Description

Functions

i_cal_array_new_full ()

ICalArray *
i_cal_array_new_full (icalarray *native,
                      GObject *owner);

Create a new libical-glib object from the native libical object and the owner.

Parameters

native	The native libical object.
owner	The parent.

Returns

The newly create libical-glib object.

[transfer full]

Since 1.0

i_cal_array_size ()

gint
i_cal_array_size (ICalArray *array);

Get the size of the array.

Parameters

array

The ICalArray

Returns

The size of current array.

Since 1.0

i_cal_array_new ()

ICalArray *
i_cal_array_new (gint element_size,
                 gint increment_size);

Create a ICalArray with the element size to be element_size and increment size to be increment_size

Parameters

element_size	The size of the element of the array
increment_size	The incremental size when the array is full

Returns

The newly create ICalArray with the properties set by element_size and increment_size .

[transfer full]

Since 1.0

i_cal_array_copy ()

ICalArray *
i_cal_array_copy (ICalArray *array);

Create a deep copy of ICalArray with the same properties as the array

Parameters

array

The ICalArray to be cloned.

[in]

Returns

The newly cloned ICalArray with the same value as the array .

[transfer full]

Since 1.0

i_cal_array_free ()

void
i_cal_array_free (ICalArray *array);

Free the ICalArray

Parameters

array

The ICalArray to be freed.

Since 1.0

i_cal_array_append ()

void
i_cal_array_append (ICalArray *array,
                    GObject *element);

Append element to the end of the array

Parameters

array	The ICalArray to be appended.
element	The element to be appended to the ICalArray. The reason why to use GOjbect * instead of gpointer is that the variable of type gpointer can only be assigned with none, integer or capsule type. The support for other types would be added in the future.

Since 1.0

i_cal_array_remove_element_at ()

void
i_cal_array_remove_element_at (ICalArray *array,
                               gint position);

Remove the element at the position from the array

Parameters

array	The ICalArray to be modified.
position	The position in which the element will be removed from the array

Since 1.0

i_cal_array_element_at ()

GObject *
i_cal_array_element_at (ICalArray *array,
                        gint position);

Get the element located in the position in the array . NULL if position if out of bound

Parameters

array	The ICalArray to be queried.
position	The position the target element is located

Returns

The element located at the position in the array .

[transfer none][allow-none]

Since 1.0

i_cal_array_sort ()

void
i_cal_array_sort (ICalArray *array,
                  gint (*compare) (const void *, const void *));

Does not work right now. Sort the array using the sort function compare

Parameters

array	The ICalArray to be sorted.
compare	The comapre function.	[scope call]

Since 1.0

Types and Values

I_CAL_ARRAY_TYPE

#define             I_CAL_ARRAY_TYPE

ICalArray

typedef struct _ICalArray ICalArray;

This is the ICalArray instance.

struct ICalArrayClass

struct ICalArrayClass {
};

This is the ICalArray class.