The only function in this file is meant to initialize the preferences system early in the load process. More...

Files
file	gnc-prefs-utils.h
	Preferences initialization function.

file	gnc-prefs.h
	Generic api to store and retrieve preferences.

Macros
#define	GNC_PREFS_GROUP_GENERAL "general"

#define	GNC_PREFS_GROUP_GENERAL_REGISTER "general.register"

#define	GNC_PREFS_GROUP_GENERAL_REPORT "general.report"

#define	GNC_PREFS_GROUP_WARNINGS "general.warnings"

#define	GNC_PREFS_GROUP_WARNINGS_TEMP "warnings.temporary"

#define	GNC_PREFS_GROUP_WARNINGS_PERM "warnings.permanent"

#define	GNC_PREFS_GROUP_ACCT_SUMMARY "window.pages.account-tree.summary"

#define	GNC_PREF_VERSION "prefs-version"

#define	GNC_PREF_SAVE_GEOMETRY "save-window-geometry"

#define	GNC_PREF_LAST_PATH "last-path"

#define	GNC_PREF_USE_NEW "use-new-window"

#define	GNC_PREF_ACCOUNTING_LABELS "use-accounting-labels"

#define	GNC_PREF_ACCOUNT_SEPARATOR "account-separator"

#define	GNC_PREF_NEGATIVE_IN_RED "negative-in-red"

#define	GNC_PREF_NUM_SOURCE "num-source"

#define	GNC_PREF_DATE_FORMAT "date-format"

#define	GNC_PREF_DATE_COMPL_THISYEAR "date-completion-thisyear"

#define	GNC_PREF_DATE_COMPL_SLIDING "date-completion-sliding"

#define	GNC_PREF_DATE_BACKMONTHS "date-backmonths"

#define	GNC_PREF_SHOW_LEAF_ACCT_NAMES "show-leaf-account-names"

#define	GNC_PREF_ENTER_MOVES_TO_END "enter-moves-to-end"

#define	GNC_PREF_DRAW_HOR_LINES "draw-horizontal-lines"

#define	GNC_PREF_DRAW_VERT_LINES "draw-vertical-lines"

#define	GNC_PREF_ALT_COLOR_BY_TRANS "alternate-color-by-transaction"

#define	GNC_PREF_USE_THEME_COLORS "use-theme-colors"

#define	GNC_PREF_USE_GNUCASH_COLOR_THEME "use-gnucash-color-theme"

#define	GNC_PREF_TAB_TRANS_MEMORISED "tab-to-transfer-on-memorised"

#define	GNC_PREF_FUTURE_AFTER_BLANK "future-after-blank-transaction"

#define	GNC_PREF_JUMP_MULT_SPLITS "jump-multiple-splits"

#define	GNC_PREF_START_CHOICE_ABS "start-choice-absolute"

#define	GNC_PREF_START_CHOICE_REL "start-choice-relative"

#define	GNC_PREF_START_DATE "start-date"

#define	GNC_PREF_START_PERIOD "start-period"

#define	GNC_PREF_END_CHOICE_ABS "end-choice-absolute"

#define	GNC_PREF_END_CHOICE_REL "end-choice-relative"

#define	GNC_PREF_END_DATE "end-date"

#define	GNC_PREF_END_PERIOD "end-period"

#define	GNC_PREF_CURRENCY_OTHER "currency-other"

#define	GNC_PREF_CURRENCY_CHOICE_LOCALE "currency-choice-locale"

#define	GNC_PREF_CURRENCY_CHOICE_OTHER "currency-choice-other"

Functions
void	gnc_prefs_init (void)
	This function is called early in the load process to preload a number of preferences from the settings backend.

void	gnc_prefs_remove_registered (void)
	This function is called to remove the registered preference call backs setup in this file.

gboolean	gnc_prefs_is_set_up (void)
	Test if preferences backend is set up.

void	gnc_prefs_block_all (void)
	Block all preference callbacks.

void	gnc_prefs_unblock_all (void)
	Unblock all preferences callbacks.

Early bird functions, needed before any backend has been set up
const gchar *	gnc_prefs_get_namespace_regexp (void)

void	gnc_prefs_set_namespace_regexp (const gchar *str)

gboolean	gnc_prefs_is_debugging_enabled (void)

void	gnc_prefs_set_debugging (gboolean d)

gboolean	gnc_prefs_is_extra_enabled (void)

void	gnc_prefs_set_extra (gboolean enabled)

gboolean	gnc_prefs_get_file_save_compressed (void)

void	gnc_prefs_set_file_save_compressed (gboolean compressed)

gint	gnc_prefs_get_file_retention_policy (void)

void	gnc_prefs_set_file_retention_policy (gint policy)

gint	gnc_prefs_get_file_retention_days (void)

void	gnc_prefs_set_file_retention_days (gint days)

guint	gnc_prefs_get_long_version (void)

Listening for changes
gulong	gnc_prefs_register_cb (const char group, const gchar pref_name, gpointer func, gpointer user_data)
	Register a callback that gets triggered when the given preference changes.

void	gnc_prefs_remove_cb_by_func (const gchar group, const gchar pref_name, gpointer func, gpointer user_data)
	Remove a function that was registered for a callback when the given preference changed.

void	gnc_prefs_remove_cb_by_id (const gchar *group, guint id)
	Remove a function that was registered for a callback when a specific preference in the settings group changed.

guint	gnc_prefs_register_group_cb (const gchar *group, gpointer func, gpointer user_data)
	Register a callback for when any preference in the settings group is changed.

void	gnc_prefs_remove_group_cb_by_func (const gchar *group, gpointer func, gpointer user_data)
	Remove a function that was registered for a callback when any preference in the given settings group changed.

void	gnc_prefs_bind (const gchar group, const gchar pref_name, const gchar pref_value, gpointer object, const gchar property)
	Bind a setting to a g_object property.

Preference Getters
gboolean	gnc_prefs_get_bool (const gchar group, const gchar pref_name)
	Get a boolean value from the preferences backend.

gint	gnc_prefs_get_int (const gchar group, const gchar pref_name)
	Get an integer value from the preferences backend.

gint64	gnc_prefs_get_int64 (const gchar group, const gchar pref_name)
	Get an 64 bit integer value from the preferences backend.

gdouble	gnc_prefs_get_float (const gchar group, const gchar pref_name)
	Get an float value from the preferences backend.

gchar *	gnc_prefs_get_string (const gchar group, const gchar pref_name)
	Get a string value from the preferences backend.

gint	gnc_prefs_get_enum (const gchar group, const gchar pref_name)
	Get an enum value from the preferences backend.

void	gnc_prefs_get_coords (const gchar group, const gchar pref_name, gdouble x, gdouble y)
	Get a pair of coordinates from the preferences backend.

GVariant *	gnc_prefs_get_value (const gchar group, const gchar pref_name)
	Get an arbitrary combination of values from the preferences backend.

Preference Setters and Unset Functions
gboolean	gnc_prefs_set_bool (const gchar group, const gchar pref_name, gboolean value)
	Store a boolean value into the preferences backend.

gboolean	gnc_prefs_set_int (const gchar group, const gchar pref_name, gint value)
	Store an integer value into the preferences backend.

gboolean	gnc_prefs_set_int64 (const gchar group, const gchar pref_name, gint64 value)
	Store a 64 bit integer value into the preferences backend.

gboolean	gnc_prefs_set_float (const gchar group, const gchar pref_name, gdouble value)
	Store a float value into the preferences backend.

gboolean	gnc_prefs_set_string (const gchar group, const gchar pref_name, const gchar *value)
	Store a string into the preferences backend.

gboolean	gnc_prefs_set_enum (const gchar group, const gchar pref_name, gint value)
	Store an enum value into the preferences backend.

gboolean	gnc_prefs_set_coords (const gchar group, const gchar pref_name, gdouble x, gdouble y)
	Store coordinates into the preferences backend.

gboolean	gnc_prefs_set_value (const gchar group, const gchar pref_name, GVariant *value)
	Store an arbitrary combination of values into the preferences backend.

void	gnc_prefs_reset (const gchar group, const gchar pref_name)
	Reset a preference to its default value in the preferences backend.

void	gnc_prefs_reset_group (const gchar *group)
	Reset all preferences in a group to their default values in the preferences backend.

gulong	gnc_prefs_get_reg_auto_raise_lists_id (void)
	Get and Set registered preference id for register auto_raise_lists.

void	gnc_prefs_set_reg_auto_raise_lists_id (gulong id)

gulong	gnc_prefs_get_reg_negative_color_pref_id (void)
	Get and Set registered preference id for register negative_color_pref.

void	gnc_prefs_set_reg_negative_color_pref_id (gulong id)

Detailed Description

The only function in this file is meant to initialize the preferences system early in the load process.

The API in this file is used to read and store preferences used by gnucash.

This is done in a way to hide the actual preferences backend from the rest of the engine.

This api is a generic one. To actually store and load preferences, a preferences backend should be configured. Currently only one backend is defined: the preferences backend.

Note that preferences are organized in groups. Most functions will require both a group and a preference name to find the exact preference to work with.

Macro Definition Documentation

◆ GNC_PREF_ACCOUNT_SEPARATOR

#define GNC_PREF_ACCOUNT_SEPARATOR "account-separator"

Definition at line 65 of file gnc-prefs.h.

◆ GNC_PREF_ACCOUNTING_LABELS

#define GNC_PREF_ACCOUNTING_LABELS "use-accounting-labels"

Definition at line 64 of file gnc-prefs.h.

◆ GNC_PREF_ALT_COLOR_BY_TRANS

#define GNC_PREF_ALT_COLOR_BY_TRANS "alternate-color-by-transaction"

Definition at line 77 of file gnc-prefs.h.

◆ GNC_PREF_CURRENCY_CHOICE_LOCALE

#define GNC_PREF_CURRENCY_CHOICE_LOCALE "currency-choice-locale"

Definition at line 94 of file gnc-prefs.h.

◆ GNC_PREF_CURRENCY_CHOICE_OTHER

#define GNC_PREF_CURRENCY_CHOICE_OTHER "currency-choice-other"

Definition at line 95 of file gnc-prefs.h.

◆ GNC_PREF_CURRENCY_OTHER

#define GNC_PREF_CURRENCY_OTHER "currency-other"

Definition at line 93 of file gnc-prefs.h.

◆ GNC_PREF_DATE_BACKMONTHS

#define GNC_PREF_DATE_BACKMONTHS "date-backmonths"

Definition at line 71 of file gnc-prefs.h.

◆ GNC_PREF_DATE_COMPL_SLIDING

#define GNC_PREF_DATE_COMPL_SLIDING "date-completion-sliding"

Definition at line 70 of file gnc-prefs.h.

◆ GNC_PREF_DATE_COMPL_THISYEAR

#define GNC_PREF_DATE_COMPL_THISYEAR "date-completion-thisyear"

Definition at line 69 of file gnc-prefs.h.

◆ GNC_PREF_DATE_FORMAT

#define GNC_PREF_DATE_FORMAT "date-format"

Definition at line 68 of file gnc-prefs.h.

◆ GNC_PREF_DRAW_HOR_LINES

#define GNC_PREF_DRAW_HOR_LINES "draw-horizontal-lines"

Definition at line 75 of file gnc-prefs.h.

◆ GNC_PREF_DRAW_VERT_LINES

#define GNC_PREF_DRAW_VERT_LINES "draw-vertical-lines"

Definition at line 76 of file gnc-prefs.h.

◆ GNC_PREF_END_CHOICE_ABS

#define GNC_PREF_END_CHOICE_ABS "end-choice-absolute"

Definition at line 88 of file gnc-prefs.h.

◆ GNC_PREF_END_CHOICE_REL

#define GNC_PREF_END_CHOICE_REL "end-choice-relative"

Definition at line 89 of file gnc-prefs.h.

◆ GNC_PREF_END_DATE

#define GNC_PREF_END_DATE "end-date"

Definition at line 90 of file gnc-prefs.h.

◆ GNC_PREF_END_PERIOD

#define GNC_PREF_END_PERIOD "end-period"

Definition at line 91 of file gnc-prefs.h.

◆ GNC_PREF_ENTER_MOVES_TO_END

#define GNC_PREF_ENTER_MOVES_TO_END "enter-moves-to-end"

Definition at line 73 of file gnc-prefs.h.

◆ GNC_PREF_FUTURE_AFTER_BLANK

#define GNC_PREF_FUTURE_AFTER_BLANK "future-after-blank-transaction"

Definition at line 81 of file gnc-prefs.h.

◆ GNC_PREF_JUMP_MULT_SPLITS

#define GNC_PREF_JUMP_MULT_SPLITS "jump-multiple-splits"

Definition at line 82 of file gnc-prefs.h.

◆ GNC_PREF_LAST_PATH

#define GNC_PREF_LAST_PATH "last-path"

Definition at line 62 of file gnc-prefs.h.

◆ GNC_PREF_NEGATIVE_IN_RED

#define GNC_PREF_NEGATIVE_IN_RED "negative-in-red"

Definition at line 66 of file gnc-prefs.h.

◆ GNC_PREF_NUM_SOURCE

#define GNC_PREF_NUM_SOURCE "num-source"

Definition at line 67 of file gnc-prefs.h.

◆ GNC_PREF_SAVE_GEOMETRY

#define GNC_PREF_SAVE_GEOMETRY "save-window-geometry"

Definition at line 61 of file gnc-prefs.h.

◆ GNC_PREF_SHOW_LEAF_ACCT_NAMES

#define GNC_PREF_SHOW_LEAF_ACCT_NAMES "show-leaf-account-names"

Definition at line 72 of file gnc-prefs.h.

◆ GNC_PREF_START_CHOICE_ABS

#define GNC_PREF_START_CHOICE_ABS "start-choice-absolute"

Definition at line 84 of file gnc-prefs.h.

◆ GNC_PREF_START_CHOICE_REL

#define GNC_PREF_START_CHOICE_REL "start-choice-relative"

Definition at line 85 of file gnc-prefs.h.

◆ GNC_PREF_START_DATE

#define GNC_PREF_START_DATE "start-date"

Definition at line 86 of file gnc-prefs.h.

◆ GNC_PREF_START_PERIOD

#define GNC_PREF_START_PERIOD "start-period"

Definition at line 87 of file gnc-prefs.h.

◆ GNC_PREF_TAB_TRANS_MEMORISED

#define GNC_PREF_TAB_TRANS_MEMORISED "tab-to-transfer-on-memorised"

Definition at line 80 of file gnc-prefs.h.

◆ GNC_PREF_USE_GNUCASH_COLOR_THEME

#define GNC_PREF_USE_GNUCASH_COLOR_THEME "use-gnucash-color-theme"

Definition at line 79 of file gnc-prefs.h.

◆ GNC_PREF_USE_NEW

#define GNC_PREF_USE_NEW "use-new-window"

Definition at line 63 of file gnc-prefs.h.

◆ GNC_PREF_USE_THEME_COLORS

#define GNC_PREF_USE_THEME_COLORS "use-theme-colors"

Definition at line 78 of file gnc-prefs.h.

◆ GNC_PREF_VERSION

#define GNC_PREF_VERSION "prefs-version"

Definition at line 60 of file gnc-prefs.h.

◆ GNC_PREFS_GROUP_ACCT_SUMMARY

#define GNC_PREFS_GROUP_ACCT_SUMMARY "window.pages.account-tree.summary"

Definition at line 57 of file gnc-prefs.h.

◆ GNC_PREFS_GROUP_GENERAL

#define GNC_PREFS_GROUP_GENERAL "general"

Definition at line 51 of file gnc-prefs.h.

◆ GNC_PREFS_GROUP_GENERAL_REGISTER

#define GNC_PREFS_GROUP_GENERAL_REGISTER "general.register"

Definition at line 52 of file gnc-prefs.h.

◆ GNC_PREFS_GROUP_GENERAL_REPORT

#define GNC_PREFS_GROUP_GENERAL_REPORT "general.report"

Definition at line 53 of file gnc-prefs.h.

◆ GNC_PREFS_GROUP_WARNINGS

#define GNC_PREFS_GROUP_WARNINGS "general.warnings"

Definition at line 54 of file gnc-prefs.h.

◆ GNC_PREFS_GROUP_WARNINGS_PERM

#define GNC_PREFS_GROUP_WARNINGS_PERM "warnings.permanent"

Definition at line 56 of file gnc-prefs.h.

◆ GNC_PREFS_GROUP_WARNINGS_TEMP

#define GNC_PREFS_GROUP_WARNINGS_TEMP "warnings.temporary"

Definition at line 55 of file gnc-prefs.h.

Function Documentation

◆ gnc_prefs_bind()

void gnc_prefs_bind	(	const gchar *	group,
		const gchar *	pref_name,
		const gchar *	pref_value,
		gpointer	object,
		const gchar *	property
	)

Bind a setting to a g_object property.

When this succeeds a change of the setting will automatically update the bound object property and vice versa.

Parameters

group	This string contains the group name of the preference to bind to.
pref_name	This string is the name of the particular preference to bind to.
pref_value	This string is the enum value of the preference to bind to.
object	The object to be bound.
property	The property of the object to bind to.

Definition at line 180 of file gnc-prefs.cpp.

{
    if (prefsbackend && prefsbackend->bind)
        (prefsbackend->bind) (group, pref_name, pref_value, object, property);
}

◆ gnc_prefs_block_all()

void gnc_prefs_block_all ( void )

Block all preference callbacks.

Definition at line 379 of file gnc-prefs.cpp.

{
    if (prefsbackend && prefsbackend->block_all)
        (prefsbackend->block_all) ();
}

◆ gnc_prefs_get_bool()

gboolean gnc_prefs_get_bool	(	const gchar *	group,
		const gchar *	pref_name
	)

Get a boolean value from the preferences backend.

Parameters

group	This string specifies the group to which the preference belongs
preference	This string is the name of the particular preference within the named group of the preferences backend.

Returns: This function returns the TRUE or FALSE value stored at the requested preference in the preferences backend. If the preference has never been set, this function passes on the default value returned by the preferences backend.

Definition at line 16 of file gmock-gnc-prefs.cpp.

{
    EXPECT_NE(prefsbackend, nullptr);
    return prefsbackend ? prefsbackend->get_bool(group, pref_name) : FALSE;
}

◆ gnc_prefs_get_coords()

void gnc_prefs_get_coords	(	const gchar *	group,
		const gchar *	pref_name,
		gdouble *	x,
		gdouble *	y
	)

Get a pair of coordinates from the preferences backend.

Parameters

group	This string specifies the group to which the preference belongs
preference	This string is the name of the particular preference within the named group of the preferences backend.
x	The x coordinate to retrieve.
y	The y coordinate to retrieve.

If there is an error in processing, both coordinates will be set to zero.

Definition at line 58 of file gmock-gnc-prefs.cpp.

{
    EXPECT_NE(prefsbackend, nullptr);
 
    *x = 0.0;
    *y = 0.0;
 
    if (prefsbackend != nullptr)
        prefsbackend->get_coords(group, pref_name, x, y);
}

◆ gnc_prefs_get_enum()

gint gnc_prefs_get_enum	(	const gchar *	group,
		const gchar *	pref_name
	)

Get an enum value from the preferences backend.

Parameters

group	This string specifies the group to which the preference belongs
preference	This string is the name of the particular preference within the named group of the preferences backend.

Returns: This function returns the enum value stored at the requested preference in the preferences backend. If the preference has never been set, this function passes on the default value returned by the preferences backend. If there is an error in processing, zero will be returned.

Definition at line 51 of file gmock-gnc-prefs.cpp.

{
    EXPECT_NE(prefsbackend, nullptr);
    return prefsbackend ? prefsbackend->get_enum(group, pref_name) : 0;
}

◆ gnc_prefs_get_file_retention_days()

gint gnc_prefs_get_file_retention_days ( void )

Definition at line 110 of file gnc-prefs.cpp.

{
    return file_retention_days;
}

◆ gnc_prefs_get_file_retention_policy()

gint gnc_prefs_get_file_retention_policy ( void )

Definition at line 98 of file gnc-prefs.cpp.

{
    return file_retention_policy;
}

◆ gnc_prefs_get_file_save_compressed()

gboolean gnc_prefs_get_file_save_compressed ( void )

Definition at line 86 of file gnc-prefs.cpp.

{
    return use_compression;
}

◆ gnc_prefs_get_float()

gdouble gnc_prefs_get_float	(	const gchar *	group,
		const gchar *	pref_name
	)

Get an float value from the preferences backend.

Parameters

group	This string specifies the group to which the preference belongs
preference	This string is the name of the particular preference within the named group of the preferences backend.

Returns: This function returns the float value stored at the requested preference in the preferences backend. If the preference has never been set, this function passes on the default value returned by the preferences backend. If there is an error in processing, zero will be returned.

Definition at line 37 of file gmock-gnc-prefs.cpp.

{
    EXPECT_NE(prefsbackend, nullptr);
    return prefsbackend ? prefsbackend->get_float(group, pref_name) : 0.0;
}

◆ gnc_prefs_get_int()

gint gnc_prefs_get_int	(	const gchar *	group,
		const gchar *	pref_name
	)

Get an integer value from the preferences backend.

Parameters

group	This string specifies the group to which the preference belongs
preference	This string is the name of the particular preference within the named group of the preferences backend.

Returns: This function returns the integer value stored at the requested preference in the preferences backend. If the preference has never been set, this function passes on the default value returned by the preferences backend. If there is an error in processing, zero will be returned.

Definition at line 23 of file gmock-gnc-prefs.cpp.

{
    EXPECT_NE(prefsbackend, nullptr);
    return prefsbackend ? prefsbackend->get_int(group, pref_name) : 0;
}

◆ gnc_prefs_get_int64()

gint64 gnc_prefs_get_int64	(	const gchar *	group,
		const gchar *	pref_name
	)

Get an 64 bit integer value from the preferences backend.

Parameters

group	This string specifies the group to which the preference belongs
preference	This string is the name of the particular preference within the named group of the preferences backend.

Returns: This function returns the 64 bit integer value stored at the requested preference in the preferences backend. If the preference has never been set, this function passes on the default value returned by the preferences backend. If there is an error in processing, zero will be returned.

Definition at line 30 of file gmock-gnc-prefs.cpp.

{
    EXPECT_NE(prefsbackend, nullptr);
    return prefsbackend ? prefsbackend->get_int64(group, pref_name) : 0;
}

◆ gnc_prefs_get_long_version()

guint gnc_prefs_get_long_version ( void )

Definition at line 122 of file gnc-prefs.cpp.

{
     return PROJECT_VERSION_MAJOR * 1000000 + PROJECT_VERSION_MINOR;
}

◆ gnc_prefs_get_namespace_regexp()

const gchar * gnc_prefs_get_namespace_regexp ( void )

Definition at line 49 of file gnc-prefs.cpp.

{
    return namespace_regexp.c_str();
}

◆ gnc_prefs_get_reg_auto_raise_lists_id()

gulong gnc_prefs_get_reg_auto_raise_lists_id ( void )

Get and Set registered preference id for register auto_raise_lists.

Definition at line 391 of file gnc-prefs.cpp.

{
    return reg_auto_raise_lists_id;
}

◆ gnc_prefs_get_reg_negative_color_pref_id()

gulong gnc_prefs_get_reg_negative_color_pref_id ( void )

Get and Set registered preference id for register negative_color_pref.

Definition at line 401 of file gnc-prefs.cpp.

{
    return reg_negative_color_pref_id;
}

◆ gnc_prefs_get_string()

gchar * gnc_prefs_get_string	(	const gchar *	group,
		const gchar *	pref_name
	)

Get a string value from the preferences backend.

Parameters

group	This string specifies the group to which the preference belongs
preference	This string is the name of the particular preference within the named group of the preferences backend.

Returns: This function returns the string value stored at the requested preference in the preferences backend. If the preference has never been set, this function passes on the default value returned by the preferences backend If there is an error in processing, NULL will be returned.

Definition at line 44 of file gmock-gnc-prefs.cpp.

{
    EXPECT_NE(prefsbackend, nullptr);
    return prefsbackend ? prefsbackend->get_string(group, pref_name) : NULL;
}

◆ gnc_prefs_get_value()

GVariant * gnc_prefs_get_value	(	const gchar *	group,
		const gchar *	pref_name
	)

Get an arbitrary combination of values from the preferences backend.

This combination of values can be anything that can be encapsulated in a GVariant structure.

Parameters

group	This string specifies the group to which the preference belongs
preference	This string is the name of the particular preference within the named group of the preferences backend.

Returns: This function returns the a GVariant encapsulating the combination of values stored at the requested preference in the preferences backend. If the preference has never been set, this function passes on the default value returned by the preferences backend. If there is an error in processing, NULL will be returned. It is the callers responsibility to free any GVariant data returned by this function.

Definition at line 267 of file gnc-prefs.cpp.

{
    if (prefsbackend && prefsbackend->get_value)
        return (prefsbackend->get_value) (group,pref_name);
    else
        return NULL;
}

◆ gnc_prefs_init()

void gnc_prefs_init ( void )

This function is called early in the load process to preload a number of preferences from the settings backend.

Definition at line 82 of file gnc-prefs-utils.c.

{
    gnc_gsettings_load_backend();
 
    /* Initialize the core preferences by reading their values from the loaded backend.
     * Note: if no backend was loaded, these functions will return sane default values.
     */
    file_retain_changed_cb (NULL, NULL, NULL);
    file_retain_type_changed_cb (NULL, NULL, NULL);
    file_compression_changed_cb (NULL, NULL, NULL);
 
    /* Check for invalid retain_type (days)/retain_days (0) combo.
     * This can happen either because a user changed the preferences
     * manually outside of GnuCash, or because the user upgraded from
     * gnucash version 2.3.15 or older. Back then, 0 retain_days meant
     * "keep forever". From 2.3.15 on this is controlled via a multiple
     * choice ("retain_type").
     * So if we find a 0 retain_days value with a "days" retain_type,
     * we will silently and conservatively interpret is as meaning
     * retain forever ("forever" retain_type).
     */
    if ( (gnc_prefs_get_file_retention_policy () == XML_RETAIN_DAYS) &&
            (gnc_prefs_get_file_retention_days () == 0 ) )
    {
        gnc_prefs_set_file_retention_policy (XML_RETAIN_ALL);
        gnc_prefs_set_file_retention_days (30);
        gnc_prefs_set_bool (GNC_PREFS_GROUP_GENERAL, GNC_PREF_RETAIN_TYPE_FOREVER, TRUE);
        gnc_prefs_set_float (GNC_PREFS_GROUP_GENERAL, GNC_PREF_RETAIN_DAYS, 30);
        PWARN("retain 0 days policy was set, but this is probably not what the user wanted,\n"
              "assuming conservative policy 'forever'");
    }
 
    /* Add hooks to update core preferences whenever the associated preference changes */
    gnc_prefs_register_cb (GNC_PREFS_GROUP_GENERAL, GNC_PREF_RETAIN_DAYS,
                           file_retain_changed_cb, NULL);
    gnc_prefs_register_cb (GNC_PREFS_GROUP_GENERAL, GNC_PREF_RETAIN_TYPE_NEVER,
                           file_retain_type_changed_cb, NULL);
    gnc_prefs_register_cb (GNC_PREFS_GROUP_GENERAL, GNC_PREF_RETAIN_TYPE_DAYS,
                           file_retain_type_changed_cb, NULL);
    gnc_prefs_register_cb (GNC_PREFS_GROUP_GENERAL, GNC_PREF_RETAIN_TYPE_FOREVER,
                           file_retain_type_changed_cb, NULL);
    gnc_prefs_register_cb (GNC_PREFS_GROUP_GENERAL, GNC_PREF_FILE_COMPRESSION,
                           file_compression_changed_cb, NULL);
 
}

◆ gnc_prefs_is_debugging_enabled()

gboolean gnc_prefs_is_debugging_enabled ( void )

Definition at line 62 of file gnc-prefs.cpp.

{
    return is_debugging;
}

◆ gnc_prefs_is_extra_enabled()

gboolean gnc_prefs_is_extra_enabled ( void )

Definition at line 74 of file gnc-prefs.cpp.

{
    return extras_enabled;
}

◆ gnc_prefs_is_set_up()

gboolean gnc_prefs_is_set_up ( void )

Test if preferences backend is set up.

Definition at line 374 of file gnc-prefs.cpp.

{
    return (prefsbackend !=NULL);
}

◆ gnc_prefs_register_cb()

gulong gnc_prefs_register_cb	(	const char *	group,
		const gchar *	pref_name,
		gpointer	func,
		gpointer	user_data
	)

Register a callback that gets triggered when the given preference changes.

Any time the preference's value changes, the routine will be invoked and will be passed both the changed preference and the user data passed to this function.

Parameters

group	This string contains the group name of the preference to watch.
preference	This string contains the name of the preference to watch.
func	This is a pointer to the function to call when the preference changes.
user_data	This pointer will be passed to the callback function.

Returns: This function returns the handler id for the registered callback.

Definition at line 127 of file gnc-prefs.cpp.

{
    if (prefsbackend && prefsbackend->register_cb)
        return (prefsbackend->register_cb) (group, pref_name, func, user_data);
    else
    {
        g_warning ("no preferences backend loaded, or the backend doesn't define register_cb, returning 0");
        return 0;
    }
}

◆ gnc_prefs_register_group_cb()

guint gnc_prefs_register_group_cb	(	const gchar *	group,
		gpointer	func,
		gpointer	user_data
	)

Register a callback for when any preference in the settings group is changed.

Any time the value of a preference in this group changes, the routine will be invoked and will be passed the specified user data.

Parameters

group	This string contains the name of the group that is being watched.
func	This is a pointer to the function to call when a preference changes.
user_data	This pointer will be passed to the callback function.

Definition at line 160 of file gnc-prefs.cpp.

{
    if (prefsbackend && prefsbackend->register_group_cb)
        return (prefsbackend->register_group_cb) (group, func, user_data);
    else
        return 0;
}

◆ gnc_prefs_remove_cb_by_func()

void gnc_prefs_remove_cb_by_func	(	const gchar *	group,
		const gchar *	pref_name,
		gpointer	func,
		gpointer	user_data
	)

Remove a function that was registered for a callback when the given preference changed.

Both the func and user_data arguments are used to match up the callback to remove. If no matching func and user_data are found to be registered for the given preference, nothing will happen.

Parameters

group	This string contains the group name of the preference that is being watched.
preference	This string contains the name of the preference being watched.
func	This is a pointer to the function that was registered earlier.
user_data	This pointer was passed to the callback function when it was registered.

Definition at line 142 of file gnc-prefs.cpp.

{
    if (prefsbackend && prefsbackend->remove_cb_by_func)
        (prefsbackend->remove_cb_by_func) (group, pref_name, func, user_data);
}

◆ gnc_prefs_remove_cb_by_id()

void gnc_prefs_remove_cb_by_id	(	const gchar *	group,
		guint	id
	)

Remove a function that was registered for a callback when a specific preference in the settings group changed.

The handler id that was generated when the callback was registered is use to find the callback to remove. If no handler id is found nothing will happen.

Parameters

group	This string contains the group name of the preference that is being watched.
id	The handler id of the callback to be removed.

Definition at line 152 of file gnc-prefs.cpp.

{
    if (prefsbackend && prefsbackend->remove_cb_by_id)
        (prefsbackend->remove_cb_by_id) (group, id);
}

◆ gnc_prefs_remove_group_cb_by_func()

void gnc_prefs_remove_group_cb_by_func	(	const gchar *	group,
		gpointer	func,
		gpointer	user_data
	)

Remove a function that was registered for a callback when any preference in the given settings group changed.

Both the func and user_data arguments are used to match up the callback to remove. If no matching func and user_data are found to be registered for the given preference, nothing will happen.

Parameters

group	This string contains the name of the group that is being watched.
func	This is a pointer to the function that was registered earlier.
user_data	This pointer was passed to the callback function when it was registered.

Note: there is no gnc_settings_remove_any_cb_by_id. Use gnc_settings_remove_cb_by_id instead if you want to remove a callback set with gnc_settings_register_any_cb by its handler id.

Definition at line 171 of file gnc-prefs.cpp.

{
    if (prefsbackend && prefsbackend->remove_group_cb_by_func)
        (prefsbackend->remove_group_cb_by_func) (group, func, user_data);
}

◆ gnc_prefs_remove_registered()

void gnc_prefs_remove_registered ( void )

This function is called to remove the registered preference call backs setup in this file.

Definition at line 129 of file gnc-prefs-utils.c.

{
    // remove the registered pref call backs above
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL, GNC_PREF_RETAIN_DAYS,
                           file_retain_changed_cb, NULL);
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL, GNC_PREF_RETAIN_TYPE_NEVER,
                           file_retain_type_changed_cb, NULL);
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL, GNC_PREF_RETAIN_TYPE_DAYS,
                           file_retain_type_changed_cb, NULL);
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL, GNC_PREF_RETAIN_TYPE_FOREVER,
                           file_retain_type_changed_cb, NULL);
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL, GNC_PREF_FILE_COMPRESSION,
                           file_compression_changed_cb, NULL);
    gnc_gsettings_shutdown ();
}

◆ gnc_prefs_reset()

void gnc_prefs_reset	(	const gchar *	group,
		const gchar *	pref_name
	)

Reset a preference to its default value in the preferences backend.

Parameters

group	This string specifies the group to which the preference belongs
preference	This string is the name of the particular preference within the named group of the preferences backend.

Definition at line 361 of file gnc-prefs.cpp.

{
    if (prefsbackend && prefsbackend->reset)
        (prefsbackend->reset) (group, pref_name);
}

◆ gnc_prefs_reset_group()

void gnc_prefs_reset_group ( const gchar * group )

Reset all preferences in a group to their default values in the preferences backend.

Parameters

group This string specifies the group to which the preference belongs

Definition at line 368 of file gnc-prefs.cpp.

{
    if (prefsbackend && prefsbackend->reset_group)
        (prefsbackend->reset_group) (group);
}

◆ gnc_prefs_set_bool()

gboolean gnc_prefs_set_bool	(	const gchar *	group,
		const gchar *	pref_name,
		gboolean	value
	)

Store a boolean value into the preferences backend.

Parameters

group	This string specifies the group to which the preference belongs
preference	This string is the name of the particular preference within the named group of the preferences backend.
value	The boolean value to be stored.

Returns: This function returns true if the value was set successfully on the preference or false if not.

Definition at line 277 of file gnc-prefs.cpp.

{
    if (prefsbackend && prefsbackend->set_bool)
        return (prefsbackend->set_bool) (group, pref_name, value);
    else
        return FALSE;
}

◆ gnc_prefs_set_coords()

gboolean gnc_prefs_set_coords	(	const gchar *	group,
		const gchar *	pref_name,
		gdouble	x,
		gdouble	y
	)

Store coordinates into the preferences backend.

Coordinates consist of a pair of floating point values (x and y).

Parameters

group	This string specifies the group to which the preference belongs
preference	This string is the name of the particular preference within the named group of the preferences backend.
x	The x coordinate to be stored.
y	The y coordinate to be stored.

Returns: This function returns true if the value was set successfully on the preference or false if not.

Definition at line 341 of file gnc-prefs.cpp.

{
    GVariant *var = g_variant_new ("(dd)",x, y);
    return gnc_prefs_set_value (group, pref_name, var);
}

◆ gnc_prefs_set_debugging()

void gnc_prefs_set_debugging ( gboolean d )

Definition at line 68 of file gnc-prefs.cpp.

{
    is_debugging = d;
}

◆ gnc_prefs_set_enum()

gboolean gnc_prefs_set_enum	(	const gchar *	group,
		const gchar *	pref_name,
		gint	value
	)

Store an enum value into the preferences backend.

Parameters

group	This string specifies the group to which the preference belongs
preference	This string is the name of the particular preference within the named group of the preferences backend.
value	The enum number to be stored.

Returns: This function returns true if the value was set successfully on the preference or false if not.

Definition at line 330 of file gnc-prefs.cpp.

{
    if (prefsbackend && prefsbackend->set_enum)
        return (prefsbackend->set_enum) (group, pref_name, value);
    else
        return FALSE;
}

◆ gnc_prefs_set_extra()

void gnc_prefs_set_extra ( gboolean enabled )

Definition at line 80 of file gnc-prefs.cpp.

{
    extras_enabled = enabled;
}

◆ gnc_prefs_set_file_retention_days()

void gnc_prefs_set_file_retention_days ( gint days )

Definition at line 116 of file gnc-prefs.cpp.

{
    file_retention_days = days;
}

◆ gnc_prefs_set_file_retention_policy()

void gnc_prefs_set_file_retention_policy ( gint policy )

Definition at line 104 of file gnc-prefs.cpp.

{
    file_retention_policy = policy;
}

◆ gnc_prefs_set_file_save_compressed()

void gnc_prefs_set_file_save_compressed ( gboolean compressed )

Definition at line 92 of file gnc-prefs.cpp.

{
    use_compression = compressed;
}

◆ gnc_prefs_set_float()

gboolean gnc_prefs_set_float	(	const gchar *	group,
		const gchar *	pref_name,
		gdouble	value
	)

Store a float value into the preferences backend.

Parameters

group	This string specifies the group to which the preference belongs
preference	This string is the name of the particular preference within the named group of the preferences backend.
value	The floating point number to be stored.

Returns: This function returns true if the value was set successfully on the preference or false if not.

Definition at line 308 of file gnc-prefs.cpp.

{
    if (prefsbackend && prefsbackend->set_float)
        return (prefsbackend->set_float) (group, pref_name, value);
    else
        return FALSE;
}

◆ gnc_prefs_set_int()

gboolean gnc_prefs_set_int	(	const gchar *	group,
		const gchar *	pref_name,
		gint	value
	)

Store an integer value into the preferences backend.

Parameters

group	This string specifies the group to which the preference belongs
preference	This string is the name of the particular preference within the named group of the preferences backend.
value	The integer number to be stored.

Returns: This function returns true if the value was set successfully on the preference or false if not.

Definition at line 288 of file gnc-prefs.cpp.

{
    if (prefsbackend && prefsbackend->set_int)
        return (prefsbackend->set_int) (group, pref_name, value);
    else
        return FALSE;
}

◆ gnc_prefs_set_int64()

gboolean gnc_prefs_set_int64	(	const gchar *	group,
		const gchar *	pref_name,
		gint64	value
	)

Store a 64 bit integer value into the preferences backend.

Parameters

group	This string specifies the group to which the preference belongs
preference	This string is the name of the particular preference within the named group of the preferences backend.
value	The 64 bit integer number to be stored.

Returns: This function returns true if the value was set successfully on the preference or false if not.

Definition at line 299 of file gnc-prefs.cpp.

{
    GVariant *var = g_variant_new ("x",value);
    return gnc_prefs_set_value (group, pref_name, var);
}

◆ gnc_prefs_set_namespace_regexp()

void gnc_prefs_set_namespace_regexp ( const gchar * str )

Definition at line 55 of file gnc-prefs.cpp.

{
    if (str)
        namespace_regexp = str;
}

◆ gnc_prefs_set_reg_auto_raise_lists_id()

void gnc_prefs_set_reg_auto_raise_lists_id ( gulong id )

Definition at line 396 of file gnc-prefs.cpp.

{
    reg_auto_raise_lists_id = id;
}

◆ gnc_prefs_set_reg_negative_color_pref_id()

void gnc_prefs_set_reg_negative_color_pref_id ( gulong id )

Definition at line 406 of file gnc-prefs.cpp.

{
    reg_negative_color_pref_id = id;
}

◆ gnc_prefs_set_string()

gboolean gnc_prefs_set_string	(	const gchar *	group,
		const gchar *	pref_name,
		const gchar *	value
	)

Store a string into the preferences backend.

Parameters

group	This string specifies the group to which the preference belongs
preference	This string is the name of the particular preference within the named group of the preferences backend.
value	The string to be stored. the preferences backend will make a copy of this string, so it is the callers responsibility to free the space used by this string (if necessary).

Returns: This function returns true if the value was set successfully on the preference or false if not.

Definition at line 319 of file gnc-prefs.cpp.

{
    if (prefsbackend && prefsbackend->set_string)
        return (prefsbackend->set_string) (group, pref_name, value);
    else
        return FALSE;
}

◆ gnc_prefs_set_value()

gboolean gnc_prefs_set_value	(	const gchar *	group,
		const gchar *	pref_name,
		GVariant *	value
	)

Store an arbitrary combination of values into the preferences backend.

Parameters

group	This string specifies the group to which the preference belongs
preference	This string is the name of the particular preference within the named group of the preferences backend.
value	The combination of values encapsulated in a GVariant to be stored.

Returns: This function returns true if the value was set successfully on the preference or false if not.

Definition at line 350 of file gnc-prefs.cpp.

{
    if (prefsbackend && prefsbackend->set_value)
        return (prefsbackend->set_value) (group, pref_name, value);
    else
        return FALSE;
}

◆ gnc_prefs_unblock_all()

void gnc_prefs_unblock_all ( void )

Unblock all preferences callbacks.

Definition at line 385 of file gnc-prefs.cpp.

{
    if (prefsbackend && prefsbackend->unblock_all)
        (prefsbackend->unblock_all) ();
}

Files

Macros

Functions

Early bird functions, needed before any backend has been set up

Listening for changes

Preference Getters

Preference Setters and Unset Functions

Detailed Description

Macro Definition Documentation

◆ GNC_PREF_ACCOUNT_SEPARATOR

◆ GNC_PREF_ACCOUNTING_LABELS

◆ GNC_PREF_ALT_COLOR_BY_TRANS

◆ GNC_PREF_CURRENCY_CHOICE_LOCALE

◆ GNC_PREF_CURRENCY_CHOICE_OTHER

◆ GNC_PREF_CURRENCY_OTHER

◆ GNC_PREF_DATE_BACKMONTHS

◆ GNC_PREF_DATE_COMPL_SLIDING

◆ GNC_PREF_DATE_COMPL_THISYEAR

◆ GNC_PREF_DATE_FORMAT

◆ GNC_PREF_DRAW_HOR_LINES

◆ GNC_PREF_DRAW_VERT_LINES

◆ GNC_PREF_END_CHOICE_ABS

◆ GNC_PREF_END_CHOICE_REL

◆ GNC_PREF_END_DATE

◆ GNC_PREF_END_PERIOD

◆ GNC_PREF_ENTER_MOVES_TO_END

◆ GNC_PREF_FUTURE_AFTER_BLANK

◆ GNC_PREF_JUMP_MULT_SPLITS

◆ GNC_PREF_LAST_PATH

◆ GNC_PREF_NEGATIVE_IN_RED

◆ GNC_PREF_NUM_SOURCE

◆ GNC_PREF_SAVE_GEOMETRY

◆ GNC_PREF_SHOW_LEAF_ACCT_NAMES

◆ GNC_PREF_START_CHOICE_ABS

◆ GNC_PREF_START_CHOICE_REL

◆ GNC_PREF_START_DATE

◆ GNC_PREF_START_PERIOD

◆ GNC_PREF_TAB_TRANS_MEMORISED

◆ GNC_PREF_USE_GNUCASH_COLOR_THEME

◆ GNC_PREF_USE_NEW

◆ GNC_PREF_USE_THEME_COLORS

◆ GNC_PREF_VERSION

◆ GNC_PREFS_GROUP_ACCT_SUMMARY

◆ GNC_PREFS_GROUP_GENERAL

◆ GNC_PREFS_GROUP_GENERAL_REGISTER

◆ GNC_PREFS_GROUP_GENERAL_REPORT

◆ GNC_PREFS_GROUP_WARNINGS

◆ GNC_PREFS_GROUP_WARNINGS_PERM

◆ GNC_PREFS_GROUP_WARNINGS_TEMP

Function Documentation

◆ gnc_prefs_bind()

◆ gnc_prefs_block_all()

◆ gnc_prefs_get_bool()

◆ gnc_prefs_get_coords()

◆ gnc_prefs_get_enum()

◆ gnc_prefs_get_file_retention_days()

◆ gnc_prefs_get_file_retention_policy()

◆ gnc_prefs_get_file_save_compressed()

◆ gnc_prefs_get_float()

◆ gnc_prefs_get_int()

◆ gnc_prefs_get_int64()

◆ gnc_prefs_get_long_version()

◆ gnc_prefs_get_namespace_regexp()

◆ gnc_prefs_get_reg_auto_raise_lists_id()

◆ gnc_prefs_get_reg_negative_color_pref_id()

◆ gnc_prefs_get_string()

◆ gnc_prefs_get_value()

◆ gnc_prefs_init()

◆ gnc_prefs_is_debugging_enabled()

◆ gnc_prefs_is_extra_enabled()

◆ gnc_prefs_is_set_up()

◆ gnc_prefs_register_cb()

◆ gnc_prefs_register_group_cb()

◆ gnc_prefs_remove_cb_by_func()

◆ gnc_prefs_remove_cb_by_id()

◆ gnc_prefs_remove_group_cb_by_func()

◆ gnc_prefs_remove_registered()

◆ gnc_prefs_reset()

◆ gnc_prefs_reset_group()

◆ gnc_prefs_set_bool()