EIterator

EIterator

Functions

gconstpointer e_iterator_get ()
void e_iterator_reset ()
void e_iterator_last ()
gboolean e_iterator_next ()
gboolean e_iterator_prev ()
void e_iterator_delete ()
void e_iterator_insert ()
void e_iterator_set ()
gboolean e_iterator_is_valid ()
void e_iterator_invalidate ()

Types and Values

struct EIterator

Description

Functions

e_iterator_get ()

gconstpointer
e_iterator_get (EIterator *iterator);

e_iterator_get is deprecated and should not be used in newly-written code.

Parameters

iterator

an EIterator

 

Returns

the iterator value.

[transfer none]


e_iterator_reset ()

void
e_iterator_reset (EIterator *iterator);

e_iterator_reset is deprecated and should not be used in newly-written code.

Resets the iterator to the beginning.

Parameters

iterator

an EIterator

 

e_iterator_last ()

void
e_iterator_last (EIterator *iterator);

e_iterator_last is deprecated and should not be used in newly-written code.

Moves the iterator to the last item.

Parameters

iterator

an EIterator

 

e_iterator_next ()

gboolean
e_iterator_next (EIterator *iterator);

e_iterator_next is deprecated and should not be used in newly-written code.

Moves the iterator to the next item.

Parameters

iterator

an EIterator

 

Returns

Whether succeeded


e_iterator_prev ()

gboolean
e_iterator_prev (EIterator *iterator);

e_iterator_prev is deprecated and should not be used in newly-written code.

Moves the iterator to the previous item.

Parameters

iterator

an EIterator

 

Returns

Whether succeeded


e_iterator_delete ()

void
e_iterator_delete (EIterator *iterator);

e_iterator_delete is deprecated and should not be used in newly-written code.

Deletes the item in the current position of the iterator.

Parameters

iterator

an EIterator

 

e_iterator_insert ()

void
e_iterator_insert (EIterator *iterator,
                   gconstpointer object,
                   gboolean before);

e_iterator_insert is deprecated and should not be used in newly-written code.

Inserts the object before or after the current position of the iterator.

Parameters

iterator

an EIterator

 

object

an object to insert

 

before

where to insert the object

 

e_iterator_set ()

void
e_iterator_set (EIterator *iterator,
                gconstpointer object);

e_iterator_set is deprecated and should not be used in newly-written code.

Sets value of the current position of the iterator to the object .

Parameters

iterator

an EIterator

 

object

an object to set

 

e_iterator_is_valid ()

gboolean
e_iterator_is_valid (EIterator *iterator);

e_iterator_is_valid is deprecated and should not be used in newly-written code.

Parameters

iterator

an EIterator

 

Returns

whether the iterator is valid.


e_iterator_invalidate ()

void
e_iterator_invalidate (EIterator *iterator);

e_iterator_invalidate is deprecated and should not be used in newly-written code.

Invalidates the iterator.

Parameters

iterator

an EIterator

 

Types and Values

struct EIterator

struct EIterator {
};

EIterator is deprecated and should not be used in newly-written code.

Contains only private data that should be read and manipulated using the functions below.