GncCurrencyEdit

Files
file	gnc-currency-edit.h
	Currency selection widget.

Data Structures
struct	_GNCCurrencyEdit

Basic Object Implementation
enum	{ PROP_0 , PROP_GCE_MNEMONIC , N_PROPERTIES }
enum	{ CURRENCY_COL_NAME , CURRENCY_COL_NORMALIZED_FOLDED , NUM_CURRENCY_COLS }
GtkWidget *	gnc_currency_edit_new (void)
	Create a new GNCCurrencyEdit widget which can be used to provide an easy way to enter ISO currency codes.

Get/Set Functions
void	gnc_currency_edit_set_currency (GNCCurrencyEdit *gce, const gnc_commodity *currency)
	Set the widget to display a certain currency name.
gnc_commodity *	gnc_currency_edit_get_currency (GNCCurrencyEdit *gce)
	Retrieve the displayed currency of the widget.
void	gnc_currency_edit_clear_display (GNCCurrencyEdit *gce)
	Clear the displayed currency of the widget.

Basic Object Implementation
#define	GNC_TYPE_CURRENCY_EDIT   (gnc_currency_edit_get_type())

Detailed Description

Macro Definition Documentation

GNC_TYPE_CURRENCY_EDIT

#define GNC_TYPE_CURRENCY_EDIT   (gnc_currency_edit_get_type())

Definition at line 67 of file gnc-currency-edit.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Definition at line 86 of file gnc-currency-edit.cpp.

{
    PROP_0,
 
    PROP_GCE_MNEMONIC,
 
    N_PROPERTIES
};

anonymous enum

anonymous enum

Definition at line 262 of file gnc-currency-edit.cpp.

{
    CURRENCY_COL_NAME,
    CURRENCY_COL_NORMALIZED_FOLDED,
    NUM_CURRENCY_COLS
};

Function Documentation

gnc_currency_edit_clear_display()

void gnc_currency_edit_clear_display

(

GNCCurrencyEdit *

gce

)

Clear the displayed currency of the widget.

This will clear the currency being displayed just like when first created but it still returns the default currency as usual

Parameters

gce	The currency editor widget whose values should be retrieved.

Definition at line 458 of file gnc-currency-edit.cpp.

{
    GtkTreeModel *model;
    GtkWidget *entry;
 
    g_return_if_fail(gce != nullptr);
    g_return_if_fail(GNC_IS_CURRENCY_EDIT(gce));
 
    model = gtk_combo_box_get_model (GTK_COMBO_BOX(gce));
 
    entry = gtk_bin_get_child (GTK_BIN(gce));
 
    g_object_ref (model);
 
    g_signal_handlers_block_by_func (G_OBJECT(gce),
                                     (gpointer)gnc_currency_edit_active_changed, gce);
 
    gtk_combo_box_set_model (GTK_COMBO_BOX(gce), nullptr);
    gtk_entry_set_text (GTK_ENTRY(entry),"");
    gtk_combo_box_set_active (GTK_COMBO_BOX(gce), -1);
    gtk_combo_box_set_model (GTK_COMBO_BOX(gce), model);
 
    g_signal_handlers_block_by_func (G_OBJECT(gce),
                                     (gpointer)gnc_currency_edit_active_changed, gce);
 
    g_object_unref (model);
}

gnc_currency_edit_get_currency()

gnc_commodity * gnc_currency_edit_get_currency

(

GNCCurrencyEdit *

gce

)

Retrieve the displayed currency of the widget.

Parameters

gce	The currency editor widget whose values should be retrieved.

Returns

A pointer to the selected currency (a gnc_commodity structure).

Definition at line 417 of file gnc-currency-edit.cpp.

{
    gnc_commodity *commodity;
    char *mnemonic, *name;
    GtkTreeModel *model;
    GtkTreeIter iter;
 
    g_return_val_if_fail(gce != nullptr, nullptr);
    g_return_val_if_fail(GNC_IS_CURRENCY_EDIT(gce), nullptr);
 
    if (gtk_combo_box_get_active_iter(GTK_COMBO_BOX(gce), &iter))
    {
        model = gtk_combo_box_get_model(GTK_COMBO_BOX(gce));
        gtk_tree_model_get (model, &iter, 0, &mnemonic, -1);
 
        name = strchr(mnemonic, ' ');
        if (name != nullptr)
            *name = '\0';
        commodity = gnc_commodity_table_lookup (gnc_get_current_commodities (),
                                                GNC_COMMODITY_NS_CURRENCY,
                                                mnemonic);
        g_free(mnemonic);
    }
    else
    {
        g_warning("Combo box returned 'inactive'. Using locale default currency.");
        commodity = gnc_locale_default_currency();
    }
 
 
    return commodity;
}

gnc_currency_edit_new()

GtkWidget * gnc_currency_edit_new

(

void

)

Create a new GNCCurrencyEdit widget which can be used to provide an easy way to enter ISO currency codes.

Returns

A GNCCurrencyEdit widget.

Definition at line 344 of file gnc-currency-edit.cpp.

{
    GNCCurrencyEdit *gce;
    GtkListStore *store;
    GtkEntryCompletion* completion;
 
    store = gtk_list_store_new (NUM_CURRENCY_COLS, G_TYPE_STRING, G_TYPE_STRING);
    gce = GNC_CURRENCY_EDIT(g_object_new (GNC_TYPE_CURRENCY_EDIT,
                                          "model", store,
                                          "has-entry", true,
                                          nullptr));
    g_object_unref (store);
 
    /* Set the column for the text */
    gtk_combo_box_set_entry_text_column (GTK_COMBO_BOX(gce), CURRENCY_COL_NAME);
 
    /* Now the signals to make sure the user can't leave the
       widget without a valid currency. */
    gnc_cbwe_require_list_item(GTK_COMBO_BOX(gce));
 
    /* Fill in all the data. */
    fill_currencies (gce);
    gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE(store),
                                          CURRENCY_COL_NAME,
                                          GTK_SORT_ASCENDING);
 
    completion = gtk_entry_completion_new ();
    gtk_entry_completion_set_model (completion, GTK_TREE_MODEL(store));
    gtk_entry_completion_set_text_column (completion, CURRENCY_COL_NAME);
    gtk_entry_completion_set_match_func (completion,
                                         (GtkEntryCompletionMatchFunc)match_func,
                                         GTK_TREE_MODEL(store), nullptr);
    gtk_entry_set_completion (GTK_ENTRY (gtk_bin_get_child (GTK_BIN (gce))),
                              completion);
 
    return GTK_WIDGET (gce);
}

gnc_currency_edit_set_currency()

void gnc_currency_edit_set_currency	(	GNCCurrencyEdit *	gce,
		const gnc_commodity *	currency
	)

Set the widget to display a certain currency name.

Parameters

gce	The currency editor widget to set.
currency	The currency to set as the displayed/selected value of the widget.

Definition at line 395 of file gnc-currency-edit.cpp.

{
    const gchar *printname;
 
    g_return_if_fail(gce != nullptr);
    g_return_if_fail(GNC_IS_CURRENCY_EDIT(gce));
    g_return_if_fail(currency != nullptr);
 
    printname = gnc_commodity_get_printname(currency);
    gnc_cbwe_set_by_string(GTK_COMBO_BOX(gce), printname);
}