Files
file	gnc-ui-util.h
	utility functions for the GnuCash UI

Data Structures
struct	_GNCPrintAmountInfo

Macros
#define	GNC_PREFS_GROUP_OPEN_SAVE "dialogs.open-save"

#define	GNC_PREFS_GROUP_EXPORT "dialogs.export-accounts"

#define	GNC_PREFS_GROUP_REPORT "dialogs.report"

#define	GNC_PREF_AUTO_DECIMAL_POINT "auto-decimal-point"

#define	GNC_PREF_AUTO_DECIMAL_PLACES "auto-decimal-places"

Typedefs
typedef QofSession (	QofSessionCB )(void)

typedef struct _GNCPrintAmountInfo	GNCPrintAmountInfo

Enumerations
enum	GNCEquityType { EQUITY_OPENING_BALANCE, EQUITY_RETAINED_EARNINGS, NUM_EQUITY_TYPES }

Functions
gchar *	gnc_normalize_account_separator (const gchar *separator)

gboolean	gnc_reverse_balance (const Account *account)

gchar *	gnc_get_default_directory (const gchar *section)

void	gnc_set_default_directory (const gchar section, const gchar directory)

QofBook *	gnc_get_current_book (void)

gboolean	gnc_is_new_book (void)

void	gnc_set_current_book_tax_name (const gchar *tax_name)

const gchar *	gnc_get_current_book_tax_name (void)

void	gnc_set_current_book_tax_type (const gchar *tax_type)

const gchar *	gnc_get_current_book_tax_type (void)

void	gnc_book_option_num_field_source_change_cb (gboolean num_action)

Account *	gnc_get_current_root_account (void)

gnc_commodity_table *	gnc_get_current_commodities (void)

gchar *	gnc_get_account_name_for_register (const Account *account)

Account *	gnc_account_lookup_for_register (const Account base_account, const gchar name)

char *	gnc_ui_account_get_tax_info_string (const Account *account)

char *	gnc_ui_account_get_tax_info_sub_acct_string (const Account *account)

const char *	gnc_get_reconcile_str (char reconciled_flag)

const char *	gnc_get_reconcile_valid_flags (void)

const char *	gnc_get_reconcile_flag_order (void)

Account *	gnc_find_or_create_equity_account (Account root, GNCEquityType equity_type, gnc_commodity currency)

gboolean	gnc_account_create_opening_balance (Account account, gnc_numeric balance, time64 date, QofBook book)

gnc_commodity *	gnc_locale_default_currency_nodefault (void)

gnc_commodity *	gnc_locale_default_currency (void)

const char *	gnc_locale_default_iso_currency_code (void)

gnc_commodity *	gnc_default_currency (void)

gnc_commodity *	gnc_account_or_default_currency (const Account account, gboolean currency_from_account_found)

gnc_commodity *	gnc_default_report_currency (void)

GNCPrintAmountInfo	gnc_default_print_info (gboolean use_symbol)

GNCPrintAmountInfo	gnc_commodity_print_info (const gnc_commodity *commodity, gboolean use_symbol)

GNCPrintAmountInfo	gnc_account_print_info (const Account *account, gboolean use_symbol)

GNCPrintAmountInfo	gnc_split_amount_print_info (Split *split, gboolean use_symbol)

GNCPrintAmountInfo	gnc_share_print_info_places (int decplaces)

GNCPrintAmountInfo	gnc_default_share_print_info (void)

GNCPrintAmountInfo	gnc_default_price_print_info (void)

GNCPrintAmountInfo	gnc_integral_print_info (void)

const char *	xaccPrintAmount (gnc_numeric val, GNCPrintAmountInfo info)

int	xaccSPrintAmount (char *buf, gnc_numeric val, GNCPrintAmountInfo info)

const gchar *	printable_value (gdouble val, gint denom)

gchar *	number_to_words (gdouble val, gint64 denom)

gchar *	numeric_to_words (gnc_numeric val)

gboolean	xaccParseAmount (const char in_str, gboolean monetary, gnc_numeric result, char **endstr)

gboolean	xaccParseAmountExtended (const char in_str, gboolean monetary, gunichar negative_sign, gunichar decimal_point, gunichar group_separator, char group, char ignore_list, gnc_numeric result, char **endstr)

void	gnc_ui_util_init (void)

Detailed Description

Function Documentation

Account* gnc_account_lookup_for_register	(	const Account *	base_account,
		const gchar *	name
	)

Retrieve the account matching the given name starting from the descendants of base_account. name is either considered to be the name of the leaf in the account tree or to be the full account path, depending on the configuration parameter general.register/show_leaf_account_names.

Parameters

base_account	The account to start the search at.
name	The name to search for.

Returns: A pointer to the account, or NULL if the account was not found.

gnc_commodity* gnc_account_or_default_currency	(	const Account *	account,
		gboolean *	currency_from_account_found
	)

Returns a gnc_commodity that is a currency, suitable for being a Transaction's currency. The gnc_commodity is taken either from the current account, or from the next parent account that has a gnc_commodity that is a currency, or from gnc_default_currency().

If the given account or any of its parent account have a commodity that is a currency, it is returned and the gboolean currency_from_account_found is set to TRUE (if non-NULL). If neither this account nor any of its parent accounts have such a commodity, gnc_default_currency() is returned and the gboolean currency_from_account_found is set to FALSE (if non-NULL). This can be used to show an appropriate warning message.

If account is NULL, gnc_default_currency() is returned and currency_from_account_found is set to FALSE.

Parameters

account	The account where the currency should be looked up. May be NULL.
currency_from_account_found	A gboolean pointer that takes the output argument of whether the returned currency was found in the account. May be NULL.

Returns: A currency pointer (and never NULL).

Definition at line 944 of file gnc-ui-util.c.

 {
     gnc_commodity *currency;
     if (!account)
     {
         if (currency_from_account_found)
             *currency_from_account_found = FALSE;
         return gnc_default_currency();
     }
 
     currency = gnc_account_get_currency_or_parent(account);
     if (currency)
     {
         if (currency_from_account_found)
             *currency_from_account_found = TRUE;
     }
     else
     {
         if (currency_from_account_found)
             *currency_from_account_found = FALSE;
         currency = gnc_default_currency();
     }
     return currency;
 }

void gnc_book_option_num_field_source_change_cb ( gboolean num_action )

Calls gnc_book_option_num_field_source_change to initiate registered callbacks when num_field_source book option changes so that registers/reports can update themselves; sets feature flag

Definition at line 253 of file gnc-ui-util.c.

 {
     gnc_suspend_gui_refresh ();
     if (num_action)
     {
     /* Set a feature flag in the book for use of the split action field as number.
      * This will prevent older GnuCash versions that don't support this feature
      * from opening this file. */
         gnc_features_set_used (gnc_get_current_book(),
                                                 GNC_FEATURE_NUM_FIELD_SOURCE);
     }
     gnc_book_option_num_field_source_change (num_action);
     gnc_resume_gui_refresh ();
     gnc_gui_refresh_all ();
 }

gnc_commodity* gnc_default_currency ( void )

Return the default currency set by the user. If the user's preference is invalid, then this routine will return the default currency for the user's locale.

Returns: A pointer to a currency.

Definition at line 939 of file gnc-ui-util.c.

 {
     return gnc_default_currency_common (user_default_currency, GNC_PREFS_GROUP_GENERAL);
 }

gnc_commodity* gnc_default_report_currency ( void )

Return the default currency for use in reports, as set by the user. If the user's preference is invalid, then this routine will return the default currency for the user's locale.

Returns: A pointer to a currency.

Definition at line 972 of file gnc-ui-util.c.

 {
     return gnc_default_currency_common (user_report_currency, GNC_PREFS_GROUP_GENERAL_REPORT);
 }

gchar* gnc_get_account_name_for_register ( const Account * account )

Get either the full name of the account or the simple name, depending on the configuration parameter general/register/show_leaf_account_names.

Parameters

account The account to retrieve the name for.

Returns: A newly allocated string.

Definition at line 282 of file gnc-ui-util.c.

 {
     gboolean show_leaf_accounts;
     show_leaf_accounts = gnc_prefs_get_bool(GNC_PREFS_GROUP_GENERAL_REGISTER,
                                             GNC_PREF_SHOW_LEAF_ACCT_NAMES);
 
     if (show_leaf_accounts)
         return g_strdup (xaccAccountGetName (account));
     else
         return gnc_account_get_full_name (account);
 }

int xaccSPrintAmount	(	char *	bufp,
		gnc_numeric	val,
		GNCPrintAmountInfo	info
	)

Parameters

bufp	Should be at least 64 chars.

Definition at line 1437 of file gnc-ui-util.c.

 {
     struct lconv *lc;
 
     char *orig_bufp = bufp;
     const char *currency_symbol;
     const char *sign;
 
     char cs_precedes;
     char sep_by_space;
     char sign_posn;
 
     gboolean print_sign = TRUE;
     gboolean is_shares = FALSE;
     gboolean print_absolute = FALSE;
 
     if (!bufp)
         return 0;
 
     lc = gnc_localeconv();
     if (info.use_locale)
         if (gnc_numeric_negative_p (val))
         {
             cs_precedes  = lc->n_cs_precedes;
             sep_by_space = lc->n_sep_by_space;
         }
         else
         {
             cs_precedes  = lc->p_cs_precedes;
             sep_by_space = lc->p_sep_by_space;
         }
     else
     {
         cs_precedes = TRUE;
         sep_by_space = TRUE;
     }
 
     if (info.commodity && info.use_symbol)
     {
         if (gnc_commodity_is_iso (info.commodity))
             currency_symbol = gnc_commodity_get_nice_symbol (info.commodity);
         else
         {
             currency_symbol = gnc_commodity_get_mnemonic (info.commodity);
             cs_precedes  = FALSE;
             sep_by_space = TRUE;
         }
     }
     else /* !info.use_symbol || !info.commodity */
         currency_symbol = "";
 
     if (gnc_numeric_negative_p (val))
     {
         sign = lc->negative_sign;
         sign_posn = lc->n_sign_posn;
     }
     else
     {
         sign = lc->positive_sign;
         sign_posn = lc->p_sign_posn;
     }
 
     if (gnc_numeric_zero_p (val) || (sign == NULL) || (sign[0] == 0))
         print_sign = FALSE;
 
     /* See if we print sign now */
     if (print_sign && (sign_posn == 1))
         bufp = g_stpcpy(bufp, sign);
 
     /* Now see if we print currency */
     if (cs_precedes)
     {
         /* See if we print sign now */
         if (print_sign && (sign_posn == 3))
             bufp = g_stpcpy(bufp, sign);
 
         if (info.use_symbol)
         {
             bufp = g_stpcpy(bufp, currency_symbol);
             if (sep_by_space)
                 bufp = g_stpcpy(bufp, " ");
         }
 
         /* See if we print sign now */
         if (print_sign && (sign_posn == 4))
             bufp = g_stpcpy(bufp, sign);
     }
 
     /* Now see if we print parentheses */
     if (print_sign && (sign_posn == 0))
     {
         bufp = g_stpcpy(bufp, "(");
         print_absolute = TRUE;
     }
 
     /* Now print the value */
     bufp += PrintAmountInternal(bufp,
                                 print_absolute ? gnc_numeric_abs(val) : val,
                                 &info);
 
     /* Now see if we print parentheses */
     if (print_sign && (sign_posn == 0))
         bufp = g_stpcpy(bufp, ")");
 
     /* Now see if we print currency */
     if (!cs_precedes)
     {
         /* See if we print sign now */
         if (print_sign && (sign_posn == 3))
             bufp = g_stpcpy(bufp, sign);
 
         if (info.use_symbol)
         {
             if (sep_by_space)
                 bufp = g_stpcpy(bufp, " ");
             bufp = g_stpcpy(bufp, currency_symbol);
         }
 
         /* See if we print sign now */
         if (print_sign && (sign_posn == 4))
             bufp = g_stpcpy(bufp, sign);
     }
 
     /* See if we print sign now */
     if (print_sign && (sign_posn == 2))
         bufp = g_stpcpy(bufp, sign);
 
     /* return length of printed string */
     return (bufp - orig_bufp);
 }

Files

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Function Documentation