Populate values from queries
[Estron support library]

Files
file	report.h
	Fill in widget values based on results of database query.
Functions
DuiReport *	dui_report_new (const char *name)
void	dui_report_destroy (DuiReport *)
void	dui_report_set_interface (DuiReport *, DuiInterface *)
void	dui_report_add_resolver (DuiReport *, DuiResolverFieldFunc, gpointer user_data)
void	dui_report_add_realizer (DuiReport *, DuiResolverRealizeFunc, gpointer user_data)
void	dui_report_add_row (DuiReport *, DuiTxnReport *row)
void	dui_report_add_term (DuiReport *rpt, DuiFieldMap *fm)
void	dui_report_do_realize (DuiReport *)
const char *	dui_report_get_name (DuiReport *)
int	dui_report_show_data (DuiReport *, DuiDBRecordSet *)
void	dui_report_set_last_action (DuiReport *, DuiAction *)
void	dui_report_refresh (DuiReport *)

---

Function Documentation

void dui_report_add_resolver	(	DuiReport *	,
		DuiResolverFieldFunc	,
		gpointer	user_data
	)

Tell the report about how to convert names into actual objects

Definition at line 224 of file report.c.

{
   if (!rpt) return;
   dui_resolver_add_resolver (rpt->resolver, fn, ud);
}

void dui_report_add_row	(	DuiReport *	,
		DuiTxnReport *	row
	)

Add a row to the report. The row will typically hold a table widget, or possibly an object class name. If the row holds a table widget (e.g. gtklist, gtkctree, etc.), then the rows of the table will be filled in from the result of the query. If the row holds an object class, then the report will find the matching instances of that class, and fill out those instances.

Definition at line 129 of file report.c.

{
    if (!rpt || !row ) return;

    rpt->rows = g_list_append (rpt->rows, row);
    dui_txnreport_set_resolver (row, rpt->resolver);
}

void dui_report_add_term	(	DuiReport *	rpt,
		DuiFieldMap *	fm
	)

Add a report 'column'. The fieldmap target should probably contain a widget into which data will be copied, possibly specifying a column of a widget. The fieldmap source is probably going to be some SQL table column.

Definition at line 140 of file report.c.

{
    if (!rpt || !fm) return;

    /* Its valid to have reports without a row iterator. However,
     * column definitions are stored with a row iterator, so ...
     */
    if (NULL == rpt->curr_row)
    {
        DuiTxnReport *row;
        row = dui_txnreport_new (NULL, 0);
        dui_report_add_row (rpt, row);
        rpt->curr_row = row;
    }
    dui_txnreport_add_term (rpt->curr_row, fm);
}

void dui_report_do_realize

(

DuiReport *

)

Resolve stuff; the book/window/interface must be set before calling this. The report must be realized before it can be run.

Definition at line 238 of file report.c.

{
    if (!rpt) return;
    ENTER ("(rpt=%p \'%s\')", rpt, dui_report_get_name (rpt));

    /* Pull global stuff out of global anchor point */
    dui_resolver_resolve_gobj (rpt->resolver, rpt->interface);
    dui_resolver_resolve_hash (rpt->resolver, rpt->interface);
    dui_resolver_resolve (rpt->resolver);

    LEAVE ("(rpt=%p \'%s\')", rpt, dui_report_get_name (rpt));
}

const char* dui_report_get_name

(

DuiReport *

)

Return the name of the indicated report

Definition at line 207 of file report.c.

{
    if (!rpt) return NULL;
    if (rpt->name) return (rpt->name);
    return NULL;
}

void dui_report_refresh

(

DuiReport *

)

Rerun it again, using old settings.

Definition at line 254 of file report.c.

{
    GList *node;
    if (!rpt) return;

    ENTER ("(rpt=%p \'%s\')", rpt, dui_report_get_name (rpt));

    for (node=rpt->last_queries; node; node=node->next)
    {
        DuiAction *last_action = node->data;
        dui_action_rerun_last_query (last_action);
    }
    LEAVE ("(rpt=%p \'%s\')", rpt, dui_report_get_name (rpt));
}

void dui_report_set_interface	(	DuiReport *	,
		DuiInterface *
	)

Tell the report about where it should find 'globals' such as the kvp tree, gobjects, etc.

Definition at line 217 of file report.c.

{
    if (!rpt) return;
    rpt->interface = iface;
}

void dui_report_set_last_action	(	DuiReport *	,
		DuiAction *
	)

Set the most recent action that generated data for this window. If this window need to be refreshed, then this action will be used to refresh it.

Definition at line 111 of file report.c.

{
    if (!rpt) return;

    if (!act)
    {
        g_list_free (rpt->last_queries);
        rpt->last_queries = NULL;
    }

    if (!act) return;

    rpt->last_queries = g_list_append (rpt->last_queries,  act);
}

int dui_report_show_data	(	DuiReport *	,
		DuiDBRecordSet *
	)

Pull data off the indicated connection and display it. Returns a non-zero value if there was data and it was displayed. If there was no data, then no GUI element was displayed, and this retruns zero.

Definition at line 160 of file report.c.

{
    GList *node;
    gint have_rows;
    if (!rpt) return 0;

    ENTER ("(rpt=%p \'%s\', recs=%p)", rpt, dui_report_get_name (rpt), recs);

    /* Check to see if there's any data to display at all.
     * If there's not, then we don't realize the report widget,
     * we don't show anything, we bail from here, and let the
     * next action in the chain take over. */
    have_rows = 0;
    for (node=rpt->rows; node; node = node->next)
    {
        DuiTxnReport *row = node->data;

        if (!dui_txnreport_is_empty (row, recs))
        {
            have_rows = 1;
            break;
        }
    }
    if (0 == have_rows) return 0;

    /* Make window that holds report show up on screen;
     * &c. other such intialization */
    dui_resolver_realize (rpt->resolver);

    for (node=rpt->rows; node; node = node->next)
    {
        DuiTxnReport *row = node->data;

        if (dui_txnreport_is_empty (row, recs)) continue;

        /* dui_txnreport_realize (row); */
        dui_txnreport_run (row, recs);
    }

    LEAVE ("(rpt=%p \'%s\', recs=%p)", rpt, dui_report_get_name (rpt), recs);

    return 1;
}