Item Iterator

Data Structures
struct	JItemIterator

Typedefs
typedef struct JItemIterator	JItemIterator

Functions
G_END_DECLS G_BEGIN_DECLS JItemIterator *	j_item_iterator_new (JCollection *collection)
void	j_item_iterator_free (JItemIterator *iterator)
gboolean	j_item_iterator_next (JItemIterator *iterator)
JItem *	j_item_iterator_get (JItemIterator *iterator)

Detailed Description

Data structures and functions for iterating over items.

Typedef Documentation

JItemIterator

typedef struct JItemIterator JItemIterator

Function Documentation

j_item_iterator_free()

void j_item_iterator_free

(

JItemIterator *

iterator

)

Frees the memory allocated by the JItemIterator.

Parameters

iterator

A JItemIterator.

j_item_iterator_get()

JItem * j_item_iterator_get

(

JItemIterator *

iterator

)

Returns the current item.

Parameters

iterator

A collection iterator.

Returns

A new item. Should be freed with j_item_unref().

j_item_iterator_new()

JItemIterator * j_item_iterator_new

(

JCollection *

collection

)

Creates a new JItemIterator.

Parameters

collection

A JCollection.

Returns

A new JItemIterator.

j_item_iterator_next()

gboolean j_item_iterator_next

(

JItemIterator *

iterator

)

Checks whether another item is available.

Parameters

iterator

A collection iterator.

Returns

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