Preferences Dialog

Files
file	dialog-preferences.c
	Dialog for handling user preferences.
file	dialog-preferences.h
	Dialog for handling user preferences.

Data Structures
struct	addition
	This data structure holds the information for a single addition to the preferences dialog. More...
struct	copy_data
	This data structure is used while building the preferences dialog to copy a grid from a glade file to the dialog under construction. More...

Macros
#define	DIALOG_PREFERENCES_CM_CLASS   "dialog-newpreferences"
#define	GNC_PREFS_GROUP   "dialogs.preferences"
#define	PREF_PREFIX_LEN   sizeof("pref/") - 1
#define	PREFS_WIDGET_HASH   "prefs_widget_hash"
#define	NOTEBOOK   "notebook"

Functions
void	gnc_preferences_response_cb (GtkDialog *dialog, gint response, GtkDialog *unused)
	Handle a user click on one of the buttons at the bottom of the preference dialog.
void	gnc_account_separator_pref_changed_cb (GtkEntry *entry, GtkWidget *dialog)
	This function is called whenever the account separator is changed in the preferences dialog.
void	gnc_save_on_close_expires_cb (GtkToggleButton *button, GtkWidget *dialog)
	Called when the save-on-close checkbutton is toggled.
gboolean	gnc_preferences_delete_event_cb (GtkWidget *widget, GdkEvent *event, gpointer user_data)
void	gnc_preferences_add_page (const gchar *filename, const gchar *widgetname, const gchar *tabname)
	This function adds a full page of preferences to the preferences dialog.
void	gnc_preferences_add_to_page (const gchar *filename, const gchar *widgetname, const gchar *tabname)
	This function adds a partial page of preferences to the preferences dialog.
void	gnc_preferences_dialog (GtkWindow *parent)
	This function creates the preferences dialog and presents it to the user.

Variables
GSList *	add_ins = NULL
	A list of all additions that have been made to the preferences dialog.

Detailed Description

Macro Definition Documentation

DIALOG_PREFERENCES_CM_CLASS

#define DIALOG_PREFERENCES_CM_CLASS   "dialog-newpreferences"

Definition at line 84 of file dialog-preferences.c.

GNC_PREFS_GROUP

#define GNC_PREFS_GROUP   "dialogs.preferences"

Definition at line 85 of file dialog-preferences.c.

NOTEBOOK

#define NOTEBOOK   "notebook"

Definition at line 88 of file dialog-preferences.c.

PREF_PREFIX_LEN

#define PREF_PREFIX_LEN   sizeof("pref/") - 1

Definition at line 86 of file dialog-preferences.c.

PREFS_WIDGET_HASH

#define PREFS_WIDGET_HASH   "prefs_widget_hash"

Definition at line 87 of file dialog-preferences.c.

Function Documentation

gnc_account_separator_pref_changed_cb()

void gnc_account_separator_pref_changed_cb	(	GtkEntry *	entry,
		GtkWidget *	dialog
	)

This function is called whenever the account separator is changed in the preferences dialog.

It updates the example label in the "Account" page of the preferences dialog.

Definition at line 156 of file dialog-preferences.c.

{
    GtkWidget *label, *image;
    gchar *sample;
    gchar *separator = NULL;
 
    gchar *conflict_msg = gnc_account_separator_is_valid (gtk_entry_get_text (entry), &separator);
 
    label = g_object_get_data (G_OBJECT(dialog), "sample_account");
    DEBUG("Sample Account pointer is %p", label);
    /* Translators: Both %s will be the account separator character; the
       resulting string is a demonstration how the account separator
       character will look like. You can replace these three account
       names with other account names that are more suitable for your
       language - just keep in mind to have exactly two %s in your
       translation. */
    sample = g_strdup_printf (_("Income%sSalary%sTaxable"),
                              separator, separator);
    PINFO(" Label set to '%s'", sample);
    gtk_label_set_text (GTK_LABEL(label), sample);
    g_free (sample);
 
    /* Check if the new separator clashes with existing account names */
    image = g_object_get_data (G_OBJECT(dialog), "separator_error");
    DEBUG("Separator Error Image pointer is %p", image);
 
    if (conflict_msg)
    {
        gtk_widget_set_tooltip_text (GTK_WIDGET(image), conflict_msg);
        gtk_widget_show (GTK_WIDGET(image));
        g_free (conflict_msg);
    }
    else
        gtk_widget_hide (GTK_WIDGET(image));
 
    g_free (separator);
}

gnc_preferences_add_page()

void gnc_preferences_add_page	(	const gchar *	filename,
		const gchar *	widgetname,
		const gchar *	tabname
	)

This function adds a full page of preferences to the preferences dialog.

When the dialog is created, the specified widget will be pulled from the specified glade file and added to the preferences dialog with the specified tab name. The tab name may not be duplicated. For example, the Business code might have a full page of its own preferences.

Parameters

filename	The name of a glade file.
widgetname	The name of the widget to extract from the glade file.
tabname	The (translated!) name this page of preferences should have in the dialog notebook.

Definition at line 419 of file dialog-preferences.c.

{
    gnc_preferences_add_page_internal (filename, widgetname, tabname, TRUE);
}

gnc_preferences_add_to_page()

void gnc_preferences_add_to_page	(	const gchar *	filename,
		const gchar *	widgetname,
		const gchar *	tabname
	)

This function adds a partial page of preferences to the preferences dialog.

When the dialog is created, the specified widget will be pulled from the specified glade file and added to the preferences dialog with the specified tab name. The tab name may be duplicated. For example, the HBCI preferences may share a "Data Import" page with QIF and other methods.

Parameters

filename	The name of a glade file.
widgetname	The name of the widget to extract from the glade file.
tabname	The (translated!) name this page of preferences should have in the dialog notebook.

Definition at line 434 of file dialog-preferences.c.

{
    gnc_preferences_add_page_internal (filename, widgetname, tabname, FALSE);
}

gnc_preferences_delete_event_cb()

gboolean gnc_preferences_delete_event_cb	(	GtkWidget *	widget,
		GdkEvent *	event,
		gpointer	user_data
	)

Definition at line 1185 of file dialog-preferences.c.

{
    /* need to block this for the account separator test */
    return TRUE;
}

gnc_preferences_dialog()

void gnc_preferences_dialog

(

GtkWindow *

parent

)

This function creates the preferences dialog and presents it to the user.

The preferences dialog is a singleton, so if a preferences dialog already exists it will be raised to the top of the window stack instead of creating a new dialog.

Definition at line 1564 of file dialog-preferences.c.

{
    GtkWidget *dialog;
 
    ENTER("");
    if (gnc_forall_gui_components (DIALOG_PREFERENCES_CM_CLASS,
                                   show_handler, NULL))
    {
        LEAVE("existing window");
        return;
    }
 
    dialog = gnc_preferences_dialog_create(parent);
 
    gnc_restore_window_size (GNC_PREFS_GROUP, GTK_WINDOW(dialog), parent);
    gtk_widget_show (dialog);
 
    gnc_register_gui_component (DIALOG_PREFERENCES_CM_CLASS,
                                NULL, close_handler, dialog);
 
    LEAVE(" ");
}

gnc_preferences_response_cb()

void gnc_preferences_response_cb	(	GtkDialog *	dialog,
		gint	response,
		GtkDialog *	unused
	)

Handle a user click on one of the buttons at the bottom of the preference dialog.

Also handles delete_window events, which have conveniently converted to a response by GtkDialog.

Definition at line 1207 of file dialog-preferences.c.

{
    switch (response)
    {
    case GTK_RESPONSE_HELP:
        gnc_gnome_help (GTK_WINDOW(dialog), DF_MANUAL, DL_GLOBPREFS);
        break;
 
    case GTK_RESPONSE_DELETE_EVENT:
    default:
        if (gnc_account_separator_validate (GTK_WIDGET(dialog)))
        {
            gnc_save_window_size (GNC_PREFS_GROUP, GTK_WINDOW(dialog));
            gnc_unregister_gui_component_by_data (DIALOG_PREFERENCES_CM_CLASS,
                                                  dialog);
            gtk_widget_destroy (GTK_WIDGET(dialog));
        }
        else
            gnc_preferences_select_account_page (dialog);
        break;
    }
}

gnc_save_on_close_expires_cb()

void gnc_save_on_close_expires_cb	(	GtkToggleButton *	button,
		GtkWidget *	dialog
	)

Called when the save-on-close checkbutton is toggled.

Definition at line 290 of file dialog-preferences.c.

{
    GtkWidget *spinner = g_object_get_data (G_OBJECT(dialog),
                                            "save_on_close_wait_time");
    gtk_widget_set_sensitive (spinner, gtk_toggle_button_get_active (button));
}

Variable Documentation

add_ins

GSList* add_ins = NULL

A list of all additions that have been made to the preferences dialog.

The data fields for this list are addition data structures.

Definition at line 122 of file dialog-preferences.c.