CsvImpPriceAssist Class Reference

Public Member Functions
	CsvImpPriceAssist (const CsvImpPriceAssist &)=delete
CsvImpPriceAssist &	operator= (const CsvImpPriceAssist &)=delete
	CsvImpPriceAssist (CsvImpPriceAssist &&)=delete
CsvImpPriceAssist &	operator= (CsvImpPriceAssist &&)=delete
void	assist_prepare_cb (GtkWidget *page)
void	assist_file_page_prepare ()
void	assist_preview_page_prepare ()
void	assist_confirm_page_prepare ()
void	assist_summary_page_prepare ()
void	assist_finish ()
void	assist_compmgr_close ()
void	file_activated_cb ()
void	file_selection_changed_cb ()
void	preview_settings_delete ()
void	preview_settings_save ()
void	preview_settings_name (GtkEntry *entry)
void	preview_settings_load ()
void	preview_update_skipped_rows ()
void	preview_over_write (bool over)
void	preview_update_separators (GtkWidget *widget)
	Event handler for separator changes. More...
void	preview_update_file_format ()
	Event handler for clicking one of the format type radio buttons. More...
void	preview_update_encoding (const char *encoding)
	Event handler for a new encoding. More...
void	preview_update_date_format ()
void	preview_update_currency_format ()
void	preview_update_currency ()
void	preview_update_commodity ()
void	preview_reparse_col_type (GncPricePropType type)
void	preview_update_col_type (GtkComboBox *cbox)
	Event handler for the user selecting a new column type. More...
void	preview_update_fw_columns (GtkTreeView *treeview, GdkEventButton *event)
	Event handler for clicking on column headers. More...
void	preview_populate_settings_combo ()
void	preview_handle_save_del_sensitivity (GtkComboBox *combo)
void	preview_split_column (int col, int offset)
void	preview_refresh_table ()
void	preview_refresh ()
void	preview_validate_settings ()

Friends
gboolean	fixed_context_menu_handler_price (GnumericPopupMenuElement const *element, gpointer userdata)

Detailed Description

Definition at line 80 of file assistant-csv-price-import.cpp.

Member Function Documentation

preview_update_col_type()

void CsvImpPriceAssist::preview_update_col_type

(

GtkComboBox *

cbox

)

Event handler for the user selecting a new column type.

When the user selects a new column type, that column's text must be changed to the selection, and any other columns containing that selection must be changed to "None" because we don't allow duplicates.

Parameters

renderer	The renderer of the column the user changed
path	There is only 1 row in info->ctreeview, so this is always 0.
new_text	The text the user selected
info	The display of the data being imported

Definition at line 1239 of file assistant-csv-price-import.cpp.

{
    /* Get the new text */
    GtkTreeIter iter;
    auto model = gtk_combo_box_get_model (cbox);
    gtk_combo_box_get_active_iter (cbox, &iter);
    auto new_col_type = GncPricePropType::NONE;
    gtk_tree_model_get (model, &iter, COL_TYPE_ID, &new_col_type, -1);

    auto col_num = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT(cbox), "col-num"));

    auto column_types = price_imp->column_types_price();
    auto old_col_type = column_types.at(col_num);

    price_imp->set_column_type_price (col_num, new_col_type);

    // if old_col_type is TO_CURRENCY, force a reparse of commodity
    if (old_col_type == GncPricePropType::TO_CURRENCY)
    {
        // look for a from_commodity column to reparse
        preview_reparse_col_type (GncPricePropType::FROM_SYMBOL);
        preview_reparse_col_type (GncPricePropType::FROM_NAMESPACE);
    }

    // if old_col_type is FROM_SYMBOL, or FROM_NAMESPACE force a reparse of currency
    if ((old_col_type == GncPricePropType::FROM_SYMBOL) ||
        (old_col_type == GncPricePropType::FROM_NAMESPACE))
    {
        // look for a to_currency column to reparse
        preview_reparse_col_type (GncPricePropType::TO_CURRENCY);
    }

    /* Delay rebuilding our data table to avoid critical warnings due to
     * pending events still acting on them after this event is processed.
     */
    g_idle_add ((GSourceFunc)csv_imp_preview_queue_rebuild_table, this);
}

preview_update_encoding()

void CsvImpPriceAssist::preview_update_encoding

(

const char *

encoding

)

Event handler for a new encoding.

This is called when the user selects a new encoding; the data is reparsed and shown to the user.

Parameters

selector	The widget the user uses to select a new encoding
encoding	The encoding that the user selected

Definition at line 1136 of file assistant-csv-price-import.cpp.

{
    /* This gets called twice every time a new encoding is selected. The
     * second call actually passes the correct data; thus, we only do
     * something the second time this is called. */

    /* If this is the second time the function is called ... */
    if (encoding_selected_called)
    {
        std::string previous_encoding = price_imp->m_tokenizer->encoding();
        /* Try converting the new encoding and reparsing. */
        try
        {
            price_imp->encoding (encoding);
            preview_refresh_table ();
        }
        catch (...)
        {
            /* If it fails, change back to the old encoding. */
            gnc_error_dialog (GTK_WINDOW (csv_imp_asst), "%s", _("Invalid encoding selected"));
            go_charmap_sel_set_encoding (encselector, previous_encoding.c_str());
        }
    }
    encoding_selected_called = !encoding_selected_called;
}

preview_update_file_format()

void CsvImpPriceAssist::preview_update_file_format

(

)

Event handler for clicking one of the format type radio buttons.

This occurs if the format (Fixed-Width or CSV) is changed.

Parameters

csv_button	The "Separated" radio button
info	The display of the data being imported

Definition at line 1090 of file assistant-csv-price-import.cpp.

{
    /* Set the parsing type correctly. */
    try
    {
        if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON(csv_button)))
        {
            price_imp->file_format (GncImpFileFormat::CSV);
            g_signal_handlers_disconnect_by_func(G_OBJECT(treeview),
                    (gpointer)csv_price_imp_preview_treeview_clicked_cb, (gpointer)this);
            gtk_widget_set_visible (separator_table, true);
            gtk_widget_set_visible (fw_instructions_hbox, false);
        }
        else
        {
            price_imp->file_format (GncImpFileFormat::FIXED_WIDTH);
            /* Enable context menu for adding/removing columns. */
            g_signal_connect (G_OBJECT(treeview), "button-press-event",
                    G_CALLBACK(csv_price_imp_preview_treeview_clicked_cb), (gpointer)this);
            gtk_widget_set_visible (separator_table, false);
            gtk_widget_set_visible (fw_instructions_hbox, true);

        }
        price_imp->tokenize (false);
        preview_refresh_table ();
    }
    catch (std::range_error &e)
    {
        /* Parsing failed ... */
        gnc_error_dialog (GTK_WINDOW (csv_imp_asst), "%s", e.what());
        return;
    }
    catch (...)
    {
        // FIXME Handle file loading errors (possibly thrown by file_format above)
        PWARN("Got an error during file loading");
    }
}

preview_update_fw_columns()

void CsvImpPriceAssist::preview_update_fw_columns	(	GtkTreeView *	treeview,
		GdkEventButton *	event
	)

Event handler for clicking on column headers.

This function is called whenever the user clicks on column headers in preview->treeview to modify columns when in fixed-width mode.

Parameters

button	The button at the top of a column of the treeview
event	The event that happened (where the user clicked)
info	The data being configured

Returns

true if further processing of this even should stop, false if other event handlers can have a go at this as well

Definition at line 1455 of file assistant-csv-price-import.cpp.

{
    /* Nothing to do if this was not triggered on our treeview body */
    if (event->window != gtk_tree_view_get_bin_window (treeview))
        return;

    /* Find the column that was clicked. */
    GtkTreeViewColumn *tcol = nullptr;
    int cell_x = 0;
    auto success = gtk_tree_view_get_path_at_pos (treeview,
            (int)event->x, (int)event->y,
            nullptr, &tcol, &cell_x, nullptr);
    if (!success)
        return;

    /* Stop if no column found in this treeview (-1) or
     * if column is the error messages column (0) */
    auto tcol_list = gtk_tree_view_get_columns(treeview);
    auto tcol_num = g_list_index (tcol_list, tcol);
    g_list_free (tcol_list);
    if (tcol_num <= 0)
        return;

    /* Data columns in the treeview are offset by one
     * because the first column is the error column
     */
    auto dcol = tcol_num - 1;
    auto offset = get_new_col_rel_pos (tcol, cell_x);
    if (event->type == GDK_2BUTTON_PRESS && event->button == 1)
        /* Double clicks can split columns. */
        preview_split_column (dcol, offset);
    else if (event->type == GDK_BUTTON_PRESS && event->button == 3)
        /* Right clicking brings up a context menu. */
        fixed_context_menu (event, dcol, offset);
}

preview_update_separators()

void CsvImpPriceAssist::preview_update_separators

(

GtkWidget *

widget

)

Event handler for separator changes.

This function is called whenever one of the widgets for configuring the separators (the separator checkbuttons, the escape checkbutton or the custom separator entry) is changed.

Parameters

widget	The widget that was changed
info	The data that is being configured

Definition at line 1022 of file assistant-csv-price-import.cpp.

{
    /* Only manipulate separator characters if the currently open file is
     * csv separated. */
    if (price_imp->file_format() != GncImpFileFormat::CSV)
        return;

    /* Add the corresponding characters to checked_separators for each
     * button that is checked. */
    auto checked_separators = std::string();
    const auto stock_sep_chars = std::string (" \t,:;-");
    for (int i = 0; i < SEP_NUM_OF_TYPES; i++)
    {
        if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON(sep_button[i])))
            checked_separators += stock_sep_chars[i];
    }

    /* Add the custom separator if the user checked its button. */
    if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON(custom_cbutton)))
    {
        auto custom_sep = gtk_entry_get_text (custom_entry);
        if (custom_sep[0] != '\0') /* Don't add a blank separator (bad things will happen!). */
            checked_separators += custom_sep;
    }

    /* Set the parse options using the checked_separators list. */
    price_imp->separators (checked_separators);
    price_imp->enable_escape (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON(escape_cbutton)));
                                                                    
    /* if there are no separators, there will only be one column
     * so make sure column header is NONE */
    if (checked_separators.empty())
        price_imp->set_column_type_price (0, GncPricePropType::NONE);

    /* Parse the data using the new options. We don't want to reguess
     * the column types because we want to leave the user's
     * configurations intact. */
    try
    {
        price_imp->tokenize (false);
        preview_refresh_table ();
    }
    catch (std::range_error &e)
    {
        /* Warn the user there was a problem and try to undo what caused
         * the error. (This will cause a reparsing and ideally a usable
         * configuration.) */
        gnc_error_dialog (GTK_WINDOW(csv_imp_asst), "Error in parsing");
        /* If we're here because the user changed the file format, we should just wait for the user
         * to update the configuration */
        if (!widget)
            return;
        /* If the user changed the custom separator, erase that custom separator. */
        if (widget == GTK_WIDGET(custom_entry))
            gtk_entry_set_text (GTK_ENTRY(widget), "");
        /* If the user checked a checkbutton, toggle that checkbutton back. */
        else
            gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON(widget),
                                         !gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON(widget)));
        return;
    }
}

---

The documentation for this class was generated from the following file:

• assistant-csv-price-import.cpp