Field Iterator support
[Data Fields]

---

Detailed Description

For target fields grouped in a table-like organization, the matcher is used to iterate/select rows. It acts as a "WHERE" term that can be used to match a target row for target updates. The 'matcher' value is updated for every source row, which is why the matcher value can be used to select a target row.

Functions
void	dui_field_iter_pre (DuiField *matcher, gboolean do_clear)
gboolean	dui_field_iter_next (DuiField *matcher)
void	dui_field_iter_column (DuiField *target_column, DuiField *matcher)
void	dui_field_iter_post (DuiField *matcher)
gpointer	get_gobj_field (DuiField *f)

---

Function Documentation

void dui_field_iter_column	(	DuiField *	target_column,
		DuiField *	matcher
	)

This routine will be called once for every target column in the target row. The matcher will be the same field as previously set up with dui_field_iter_next().

Definition at line 104 of file duifield.c.

{
    if (NULL == target) return;
    if (NULL == target->iter_column) return;
    (target->iter_column) (target, matcher);
}

gboolean dui_field_iter_next

(

DuiField *

matcher

)

The dui_field_iter_next() will be called once for each row of the source table. The value passed in 'matcher' will be based on the matching term in the source table. It should return TRUE if the source is to be mapped to the target, else it should return FALSE.

Definition at line 96 of file duifield.c.

{
    if (NULL == matcher) return TRUE;
    if (NULL == matcher->iter_next) return TRUE;
    return (matcher->iter_next) (matcher);
}

void dui_field_iter_post

(

DuiField *

matcher

)

Called at the end of the source row iteration.

Definition at line 112 of file duifield.c.

{
    if (NULL == matcher) return;
    if (NULL == matcher->iter_post) return;
    (matcher->iter_post) (matcher);
}

void dui_field_iter_pre	(	DuiField *	matcher,
		gboolean	do_clear
	)

The dui_field_iter_pre() will be called before the start of the source row iteration. Set the do_clear flag to true if you want to clear the table before you fill it in. Otherwise, if you are matching only certain rows, you probably don't want to clear the table.

Definition at line 88 of file duifield.c.

{
    if (NULL == matcher) return;
    if (NULL == matcher->iter_pre) return;
    (matcher->iter_pre) (matcher, do_clear);
}