interface.h File Reference

---

Detailed Description

Define the top-most DWI application structure.

Author:

Copyright (c) 2002, 2004 Linas Vepstas <linas@linas.org>

Definition in file interface.h.

#include <glib.h>
#include <glib-object.h>
#include <gio/gio.h>

Go to the source code of this file.

Data Structures
struct	DuiInterfacePlugin_s
Defines
#define	EstronInterface   DuiInterface
Typedefs
typedef struct DuiAction_s	DuiAction
typedef struct DuiDatabase_s	DuiDatabase
typedef struct DuiFilter_s	DuiFilter
typedef struct DuiInterface_s	DuiInterface
typedef struct DuiReport_s	DuiReport
typedef struct DuiInterfacePlugin_s	DuiInterfacePlugin
Functions
DuiInterface *	dui_interface_new (void)
void	dui_interface_destroy (DuiInterface *dui)
void	dui_interface_set_name (DuiInterface *dui, const gchar *name)
void	dui_interface_register_plugin (DuiInterface *, DuiInterfacePlugin *)
void	dui_interface_realize (DuiInterface *, gint fatal_if_no_main)
DuiAction *	dui_interface_find_action_by_name (DuiInterface *, const gchar *name)
DuiDatabase *	dui_interface_find_database_by_name (DuiInterface *, const gchar *name)
DuiReport *	dui_interface_find_report_by_name (DuiInterface *, const gchar *name)
void	dui_interface_kvp_insert (DuiInterface *, const gchar *key, const gchar *value)
const gchar *	dui_interface_kvp_lookup (DuiInterface *, const gchar *key)
void	dui_interface_add_action (DuiInterface *, DuiAction *)
void	dui_interface_add_database (DuiInterface *, DuiDatabase *)
void	dui_interface_add_report (DuiInterface *, DuiReport *)
void	dui_interface_add_object (DuiInterface *, const gchar *instance_name, GObject *)
GObject *	dui_interface_find_object_by_name (DuiInterface *dui, const gchar *instance_name)
void	estron_interface_set_gfile (DuiInterface *est, GFile *gfile)
gchar *	estron_interface_get_filename (DuiInterface *est)
gchar *	estron_interface_get_fileparent (DuiInterface *est)

---

Function Documentation

void dui_interface_add_object	(	DuiInterface *	,
		const gchar *	instance_name,
		GObject *
	)

Bug:

XXX hack alert -- we need to free the memory associated with the instance name when the interface is deleted

Definition at line 199 of file interface.c.

{
    if (!dui || !instance_name) return;

    /* We only allow objects; this avoids a check elsewhere */
    if (!G_IS_OBJECT(gob))
    {
        PERR ("The instance \'%s\' is not an object!\n", instance_name);
        return;
    }

    g_hash_table_insert (dui->gobs, g_strdup(instance_name), gob);
}

DuiAction* dui_interface_find_action_by_name	(	DuiInterface *	,
		const gchar *	name
	)

Scan the list of reports in this interface, and return the one with the indicated name

Definition at line 290 of file interface.c.

{
    GList *node;

    if (!dui || !name) return NULL;

    for (node=dui->action_handlers; node; node=node->next)
    {
        DuiAction *act = node->data;
        const gchar *actname = dui_action_get_name (act);
        if (actname && !strcmp(actname, name))
        {
            return act;
        }
    }
    return NULL;
}

void dui_interface_kvp_insert	(	DuiInterface *	,
		const gchar *	key,
		const gchar *	value
	)

Insert a key-value pair into a hash table associated with this interface.

Definition at line 231 of file interface.c.

{
    if (!dui || !key || !value) return;

    /* refuse insertion of new system keys */
    if (!strncmp (key, "/system/", 8)) return;

    PINFO ("(key=\'%s\' value=\'%s\')", key, value);
    g_hash_table_insert (dui->kvp, g_strdup(key), g_strdup(value));
}

const gchar* dui_interface_kvp_lookup	(	DuiInterface *	,
		const gchar *	key
	)

Fetch the value assoicated with the key in the hash table

Bug:

another fixed buffer to remove, again Timespec to blame.

Definition at line 244 of file interface.c.

{
    if (!dui) return NULL;

    /* intercept pre-defined system keys */
    if (!strncmp (key, "/system/", 8))
    {
        key += 8;
        if (!strcmp (key, "datetime"))
        {
            static gchar date_string [100];
            time_t now = time (0);
            xxxgnc_secs_to_iso8601_buff (now, date_string);
            return date_string;
        }
        return NULL;
    }
    return g_hash_table_lookup (dui->kvp, key);
}

void dui_interface_realize	(	DuiInterface *	,
		gint	fatal_if_no_main
	)

This call will start making gui calls, and must be called only after glade and gtk have been initialized. The second argument, "fatal_if_no_main", indicates whether or not its a fatal error if no main window was found.

Definition at line 332 of file interface.c.

{
    GList *node;

    if (!dui) return;

    for (node=dui->action_handlers; node; node=node->next)
    {
        DuiAction *act = node->data;
        dui_action_set_interface (act, dui);
    }
    for (node=dui->report_handlers; node; node=node->next)
    {
        DuiReport *rpt = node->data;
        dui_report_set_interface (rpt, dui);
    }

    for (node=dui->plugins; node; node=node->next)
    {
        DuiInterfacePlugin *plg = node->data;
        if (plg->realize)
        {
            (plg->realize) (plg->self, fatal_if_no_main);
        }
    }
}

gchar* estron_interface_get_filename

(

DuiInterface *

est

)

get the qualified filepath for the interface GFile

Definition at line 157 of file interface.c.

{
    g_return_val_if_fail (est, NULL);
    return g_file_get_parse_name ((est->estron_file));
}

gchar* estron_interface_get_fileparent

(

DuiInterface *

est

)

get the qualified filepath for the directory containing the GFile

Definition at line 150 of file interface.c.

{
    g_return_val_if_fail (est, NULL);
    return g_file_get_parse_name (g_file_get_parent ((est->estron_file)));
}

void estron_interface_set_gfile	(	DuiInterface *	est,
		GFile *	gfile
	)

set the GFile to allow remote and local file handling

Definition at line 144 of file interface.c.

{
    est->estron_file = gfile;
}