Gnome-specific GUI handling.

Files
file	gnc-gnome-utils.h
	Gnome specific utility functions.

Functions
void	gnc_gnome_utils_init (void)
	Initialize the gnome-utils library Should be run once before using any gnome-utils features.
void	gnc_add_css_file (void)
	Load a gtk resource configuration file to customize gtk appearance and behaviour.
void	gnc_gnome_help (GtkWindow *parent, const char *file_name, const char *anchor)
	Launch the systems default help browser, gnome's yelp for linux, and open to a given link within a given file.
void	gnc_launch_doclink (GtkWindow *parent, const char *uri)
	Launch the default browser and open the provided URI.
GtkWidget *	gnc_gnome_get_pixmap (const char *name)
	Given a file name, find and load the requested pixmap.
GdkPixbuf *	gnc_gnome_get_gdkpixbuf (const char *name)
	Given a file name, find and load the requested pixbuf.
void	gnc_shutdown (int exit_status)
	Shutdown gnucash.
GncMainWindow *	gnc_gui_init (void)
	Initialize the gnucash gui.
int	gnc_ui_start_event_loop (void)
gboolean	gnucash_ui_is_running (void)

Detailed Description

Function Documentation

gnc_add_css_file()

void gnc_add_css_file

(

void

)

Load a gtk resource configuration file to customize gtk appearance and behaviour.

Definition at line 138 of file gnc-gnome-utils.c.

{
    GtkCssProvider *provider_user, *provider_app, *provider_fallback;
    GdkDisplay *display;
    GdkScreen *screen;
    const gchar *var;
    GError *error = 0;
 
    provider_user = gtk_css_provider_new ();
    provider_app = gtk_css_provider_new ();
    provider_fallback = gtk_css_provider_new ();
    display = gdk_display_get_default ();
    screen = gdk_display_get_default_screen (display);
 
    gtk_style_context_add_provider_for_screen (screen, GTK_STYLE_PROVIDER (provider_fallback), GTK_STYLE_PROVIDER_PRIORITY_FALLBACK);
    gtk_style_context_add_provider_for_screen (screen, GTK_STYLE_PROVIDER (provider_app), GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);
    gtk_style_context_add_provider_for_screen (screen, GTK_STYLE_PROVIDER (provider_user), GTK_STYLE_PROVIDER_PRIORITY_USER);
 
    gtk_css_provider_load_from_resource (provider_app, GNUCASH_RESOURCE_PREFIX "/gnucash.css");
    gtk_css_provider_load_from_resource (provider_fallback,  GNUCASH_RESOURCE_PREFIX "/gnucash-fallback.css");
 
    var = gnc_userconfig_dir ();
    if (var)
    {
        gchar *str;
        str = g_build_filename (var, "gtk-3.0.css", (char *)NULL);
        gtk_css_provider_load_from_path (provider_user, str, &error);
        g_free (str);
    }
    g_object_unref (provider_user);
    g_object_unref (provider_app);
    g_object_unref (provider_fallback);
}

gnc_gnome_get_gdkpixbuf()

GdkPixbuf * gnc_gnome_get_gdkpixbuf

(

const char *

name

)

Given a file name, find and load the requested pixbuf.

This routine will display an error message if it can't find the file or load the pixbuf.

Parameters

name	The name of the pixbuf file to load.

Returns

A pointer to the pixbuf, or NULL of the file couldn't be found or loaded..

Definition at line 516 of file gnc-gnome-utils.c.

{
    GdkPixbuf *pixbuf;
    GError *error = NULL;
    char *fullname;
 
    g_return_val_if_fail (name != NULL, NULL);
 
    fullname = gnc_filepath_locate_pixmap (name);
    if (fullname == NULL)
        return NULL;
 
    DEBUG ("Loading pixbuf file %s", fullname);
    pixbuf = gdk_pixbuf_new_from_file (fullname, &error);
    if (error != NULL)
    {
        g_assert (pixbuf == NULL);
        PERR ("Could not load pixbuf: %s", error->message);
        g_error_free (error);
    }
    g_free (fullname);
 
    return pixbuf;
}

gnc_gnome_get_pixmap()

GtkWidget * gnc_gnome_get_pixmap

(

const char *

name

)

Given a file name, find and load the requested pixmap.

This routine will display an error message if it can't find the file or load the pixmap.

Parameters

name	The name of the pixmap file to load.

Returns

A pointer to the pixmap, or NULL of the file couldn't be found or loaded..

Definition at line 485 of file gnc-gnome-utils.c.

{
    GtkWidget *pixmap;
    char *fullname;
 
    g_return_val_if_fail (name != NULL, NULL);
 
    fullname = gnc_filepath_locate_pixmap (name);
    if (fullname == NULL)
        return NULL;
 
    DEBUG ("Loading pixmap file %s", fullname);
 
    pixmap = gtk_image_new_from_file (fullname);
    if (pixmap == NULL)
    {
        PERR ("Could not load pixmap");
    }
    g_free (fullname);
 
    return pixmap;
}

gnc_gnome_help()

void gnc_gnome_help	(	GtkWindow *	parent,
		const char *	file_name,
		const char *	anchor
	)

Launch the systems default help browser, gnome's yelp for linux, and open to a given link within a given file.

This routine will display an error message if it can't find the help file or can't open the help browser.

Parameters

parent	The parent window for any dialogs.
file_name	The name of the help file.
anchor	The anchor the help browser should scroll to.

Definition at line 343 of file gnc-gnome-utils.c.

{
    GError *error = NULL;
    gchar *uri = NULL;
    gboolean success = TRUE;
 
    if (anchor)
        uri = g_strconcat ("help:", file_name, "/", anchor, NULL);
    else
        uri = g_strconcat ("help:", file_name, NULL);
 
    DEBUG ("Attempting to opening help uri %s", uri);
 
    if (uri)
        success = gtk_show_uri_on_window (NULL, uri, gtk_get_current_event_time (), &error);
 
    g_free (uri);
    if (success)
        return;
 
    g_assert(error != NULL);
    {
        gnc_error_dialog (parent, "%s\n%s", _(msg_no_help_found), _(msg_no_help_reason));
    }
    PERR ("%s", error->message);
    g_error_free(error);
}

gnc_gnome_utils_init()

void gnc_gnome_utils_init

(

void

)

Initialize the gnome-utils library Should be run once before using any gnome-utils features.

Definition at line 76 of file gnc-gnome-utils.c.

{
    gnc_component_manager_init ();
 
    scm_init_sw_gnome_utils_module();
    scm_c_use_module ("sw_gnome_utils");
    scm_c_use_module("gnucash gnome-utils");
}

gnc_gui_init()

GncMainWindow * gnc_gui_init

(

void

)

Initialize the gnucash gui.

Definition at line 599 of file gnc-gnome-utils.c.

{
    static GncMainWindow *main_window;
    gchar *map;
 
    ENTER ("");
 
    if (gnome_is_initialized)
        return main_window;
 
    /* use custom icon */
    gnc_load_app_icons();
    gtk_window_set_default_icon_name(GNC_ICON_APP);
 
    g_set_application_name(PACKAGE_NAME);
 
    gnc_prefs_init();
    gnc_show_splash_screen();
 
    gnome_is_initialized = TRUE;
 
    gnc_ui_util_init();
    gnc_configure_date_format();
    gnc_configure_date_completion();
 
    gnc_prefs_register_cb (GNC_PREFS_GROUP_GENERAL,
                           GNC_PREF_DATE_FORMAT,
                           gnc_configure_date_format,
                           NULL);
    gnc_prefs_register_cb (GNC_PREFS_GROUP_GENERAL,
                           GNC_PREF_DATE_COMPL_THISYEAR,
                           gnc_configure_date_completion,
                           NULL);
    gnc_prefs_register_cb (GNC_PREFS_GROUP_GENERAL,
                           GNC_PREF_DATE_COMPL_SLIDING,
                           gnc_configure_date_completion,
                           NULL);
    gnc_prefs_register_cb (GNC_PREFS_GROUP_GENERAL,
                           GNC_PREF_DATE_BACKMONTHS,
                           gnc_configure_date_completion,
                           NULL);
    gnc_prefs_register_group_cb (GNC_PREFS_GROUP_GENERAL,
                                gnc_gui_refresh_all,
                                NULL);
 
    gnc_file_set_shutdown_callback (gnc_shutdown);
 
    main_window = gnc_main_window_new ();
    // Bug#350993:
    // gtk_widget_show (GTK_WIDGET (main_window));
    gnc_window_set_progressbar_window (GNC_WINDOW(main_window));
 
 
    map = gnc_build_userdata_path(ACCEL_MAP_NAME);
    if (!g_file_test (map, G_FILE_TEST_EXISTS))
    {
        gchar *text = NULL;
        gsize length;
        gchar *map_source;
        gchar *data_dir = gnc_path_get_pkgdatadir();
#ifdef MAC_INTEGRATION
        map_source = g_build_filename (data_dir, "ui", "accelerator-map-osx", NULL);
#else
        map_source = g_build_filename (data_dir, "ui", "accelerator-map", NULL);
#endif /* MAC_INTEGRATION */
 
        if (map_source && g_file_get_contents (map_source, &text, &length, NULL))
        {
            if (length)
                g_file_set_contents (map, text, length, NULL);
            g_free (text);
        }
        g_free (map_source);
        g_free(data_dir);
    }
 
    gtk_accel_map_load(map);
    g_free(map);
 
    /* Load css configuration file */
    gnc_add_css_file ();
 
    gnc_totd_dialog (gnc_get_splash_screen (), TRUE);
 
    LEAVE ("");
    return main_window;
}

gnc_launch_doclink()

void gnc_launch_doclink	(	GtkWindow *	parent,
		const char *	uri
	)

Launch the default browser and open the provided URI.

Definition at line 438 of file gnc-gnome-utils.c.

{
    GError *error = NULL;
    gboolean success;
 
    if (!uri)
        return;
 
    DEBUG ("Attempting to open uri %s", uri);
 
    success = gtk_show_uri_on_window (NULL, uri, gtk_get_current_event_time (), &error);
 
    if (success)
        return;
 
    g_assert (error != NULL);
    {
        gchar *error_uri = NULL;
        const gchar *message =
            _("GnuCash could not open the linked document:");
 
        if (gnc_uri_is_file_uri (uri))
        {
            gchar *uri_scheme = gnc_uri_get_scheme (uri);
            error_uri = gnc_doclink_get_unescape_uri (NULL, uri, uri_scheme);
            g_free (uri_scheme);
        }
        else
            error_uri = g_strdup (uri);
 
        gnc_error_dialog (parent, "%s\n%s", message, error_uri);
        g_free (error_uri);
    }
    PERR ("%s", error->message);
    g_error_free (error);
}

gnc_shutdown()

void gnc_shutdown

(

int

exit_status

)

Shutdown gnucash.

This function will initiate an orderly shutdown, and when that has finished it will exit the program.

Parameters

exit_status

The exit status for the program.

Definition at line 747 of file gnc-gnome-utils.c.

{
    if (gnucash_ui_is_running())
    {
        if (!gnome_is_terminating)
        {
            if (gnc_file_query_save (gnc_ui_get_main_window (NULL), FALSE))
            {
                gnc_hook_run(HOOK_UI_SHUTDOWN, NULL);
                gnc_gui_shutdown();
            }
        }
    }
    else
    {
        gnc_gui_destroy();
        gnc_hook_run(HOOK_SHUTDOWN, NULL);
        gnc_engine_shutdown();
        exit(exit_status);
    }
}

gnc_ui_start_event_loop()

int gnc_ui_start_event_loop

(

void

)

Definition at line 574 of file gnc-gnome-utils.c.

{
    guint id;
 
    gnome_is_running = TRUE;
 
    id = g_timeout_add_full (G_PRIORITY_DEFAULT_IDLE, 10000, /* 10 secs */
                             gnc_ui_check_events, NULL, NULL);
 
    scm_call_1(scm_c_eval_string("gnc:set-ui-status"), SCM_BOOL_T);
 
    /* Enter gnome event loop */
    gtk_main ();
 
    g_source_remove (id);
 
    scm_call_1(scm_c_eval_string("gnc:set-ui-status"), SCM_BOOL_F);
 
    gnome_is_running = FALSE;
    gnome_is_terminating = FALSE;
 
    return 0;
}

gnucash_ui_is_running()

gboolean gnucash_ui_is_running

(

void

)

Definition at line 688 of file gnc-gnome-utils.c.

{
    return gnome_is_running;
}