Collection Iterator

Data Structures
struct	JCollectionIterator

Typedefs
typedef struct JCollectionIterator	JCollectionIterator

Functions
G_END_DECLS G_BEGIN_DECLS JCollectionIterator *	j_collection_iterator_new (void)
void	j_collection_iterator_free (JCollectionIterator *iterator)
gboolean	j_collection_iterator_next (JCollectionIterator *iterator)
JCollection *	j_collection_iterator_get (JCollectionIterator *iterator)

Detailed Description

Data structures and functions for iterating over collections.

Typedef Documentation

JCollectionIterator

typedef struct JCollectionIterator JCollectionIterator

Function Documentation

j_collection_iterator_free()

void j_collection_iterator_free

(

JCollectionIterator *

iterator

)

Frees the memory allocated by the JCollectionIterator.

Parameters

iterator

A JCollectionIterator.

j_collection_iterator_get()

JCollection * j_collection_iterator_get

(

JCollectionIterator *

iterator

)

Returns the current collection.

Parameters

iterator

A store iterator.

Returns

A new collection. Should be freed with j_collection_unref().

j_collection_iterator_new()

JCollectionIterator * j_collection_iterator_new

(

void

)

Creates a new JCollectionIterator.

Returns

A new JCollectionIterator.

j_collection_iterator_next()

gboolean j_collection_iterator_next

(

JCollectionIterator *

iterator

)

Checks whether another collection is available.

Parameters

iterator

A store iterator.

Returns

TRUE on success, FALSE if the end of the store is reached.