GUI

gnc-plugin-page-report.h – A GncPlugin page for a report. More...

Modules
	Window/Plugin Structure
	Dialogs
	Assistants
	Utility functions for the GnuCash GUI
	Auto-complete typed user input.
	QuickFill is meant to be used by the GUI to auto-complete (e.g.
	Creating and editing accounts in the GUI
	Commodity windows
	Options Dialog
	GncCurrencyEdit
	Gnome-specific GUI handling.
	GUIUtility
	GnuCash Tree Model
	GncTreeView
	Reports
	Registers, Ledgers and Journals

Files
file	gnc-accounting-period.c
	General utilities for dealing with accounting periods.
file	gnc-accounting-period.h
	General utilities for dealing with accounting periods.
file	dialog-book-close.h
	This file contains the functions to present a GUI to select a book closing date and accounts into which to close the Income and Expense accounts.
file	dialog-file-access.h
	This file contains the functions to present a GUI to select a file or a database connection.
file	dialog-object-references.h
	This file contains the functions to present a dialog box with a list of object references and an explanation that these objects must be modified to not refer to another specific object so that that object may be deleted.
file	gnc-period-select.c
	A custom widget for selecting accounting periods.
file	gnc-period-select.h
	A custom widget for selecting accounting periods.
file	gnc-tree-view-sx-list.h
	GncTreeView implementation for Scheduled Transaction List.
file	gnc-tree-view.h
	common utilities for manipulating a GtkTreeView within gnucash

Data Structures
struct	_GncPeriodSelect
	Private Data Structure. More...
struct	_GncTreeViewClass

Macros
#define	GNC_TYPE_PERIOD_SELECT   (gnc_period_select_get_type())
#define	GNC_TYPE_TREE_VIEW_SX_LIST   (gnc_tree_view_sx_list_get_type ())
#define	GNC_TYPE_TREE_VIEW   (gnc_tree_view_get_type ())
#define	GNC_TREE_VIEW_NAME   "GncTreeView"
#define	MODEL_COLUMN   "model_column"
#define	REAL_TITLE   "real_title"
#define	PREF_NAME   "pref-name"
#define	ALWAYS_VISIBLE   "always-visible"
#define	DEFAULT_VISIBLE   "default-visible"
#define	GNC_TREE_VIEW_COLUMN_DATA_NONE   -1
#define	GNC_TREE_VIEW_COLUMN_COLOR_NONE   -1
#define	GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS   -1

Typedefs
typedef void(*	renderer_toggled) (GtkCellRendererToggle *cell_renderer_toggle, const gchar *path, gpointer user_data)

Enumerations
enum	GncAccountingPeriod {   GNC_ACCOUNTING_PERIOD_INVALID = -1 , GNC_ACCOUNTING_PERIOD_TODAY , GNC_ACCOUNTING_PERIOD_MONTH , GNC_ACCOUNTING_PERIOD_MONTH_PREV ,   GNC_ACCOUNTING_PERIOD_QUARTER , GNC_ACCOUNTING_PERIOD_QUARTER_PREV , GNC_ACCOUNTING_PERIOD_CYEAR , GNC_ACCOUNTING_PERIOD_CYEAR_PREV ,   GNC_ACCOUNTING_PERIOD_CYEAR_LAST , GNC_ACCOUNTING_PERIOD_FYEAR = GNC_ACCOUNTING_PERIOD_CYEAR_LAST , GNC_ACCOUNTING_PERIOD_FYEAR_PREV , GNC_ACCOUNTING_PERIOD_FYEAR_LAST ,   GNC_ACCOUNTING_PERIOD_LAST = GNC_ACCOUNTING_PERIOD_FYEAR_LAST }
	This specifies a time interval. More...
enum	{   PROP_0 , PROP_FY_END , PROP_SHOW_DATE , PROP_DATE_BASE ,   PROP_PS_ACTIVE }
enum	{ CHANGED , LAST_SIGNAL }

Functions
void	gnc_ui_close_book (QofBook *book, GtkWindow *parent)
	Create and run the dialog to close the book.
void	gnc_ui_file_access_for_open (GtkWindow *parent)
void	gnc_ui_file_access_for_save_as (GtkWindow *parent)
void	gnc_ui_file_access_for_export (GtkWindow *parent)
void	gnc_ui_object_references_show (const gchar *explanation, GList *objlist)
	GncOptionsDialog::GncOptionsDialog (const char *title, GtkWindow *parent)
	GncOptionsDialog::GncOptionsDialog (bool modal, const char *title, const char *component_class, GtkWindow *parent)
	Constructs a GncOptionsDialog.
	GncOptionsDialog::GncOptionsDialog (const GncOptionsDialog &)=default
	GncOptionsDialog::GncOptionsDialog (GncOptionsDialog &&)=default
GtkWidget *	GncOptionsDialog::get_widget () const noexcept
GtkWidget *	GncOptionsDialog::get_page_list () const noexcept
GtkWidget *	GncOptionsDialog::get_page_list_view () const noexcept
GtkWidget *	GncOptionsDialog::get_notebook () const noexcept
GncOptionDB *	GncOptionsDialog::get_option_db () noexcept
void	GncOptionsDialog::build_contents (GncOptionDB *odb)
void	GncOptionsDialog::build_contents (GncOptionDB *odb, bool show_dialog)
	Populate the dialog's notebook with the contents of odb.
void	GncOptionsDialog::set_sensitive (bool sensitive) noexcept
void	GncOptionsDialog::changed () noexcept
void	GncOptionsDialog::set_apply_cb (GncOptionsDialogCallback, void *cb_data) noexcept
void	GncOptionsDialog::call_apply_cb () noexcept
void	GncOptionsDialog::set_help_cb (GncOptionsDialogCallback, void *cb_data) noexcept
void	GncOptionsDialog::call_help_cb () noexcept
void	GncOptionsDialog::set_close_cb (GncOptionsDialogCallback, void *cb_data) noexcept
void	GncOptionsDialog::call_close_cb () noexcept
void	GncOptionsDialog::set_book_help_cb () noexcept
void	GncOptionsDialog::call_book_help_cb () noexcept
void	GncOptionsDialog::set_style_sheet_help_cb () noexcept
void	GncOptionsDialog::call_style_sheet_help_cb () noexcept
void	gnc_period_select_set_active (GncPeriodSelect *period, GncAccountingPeriod which)
	Set which item in the GncPeriodSelect is initially selected.
GncAccountingPeriod	gnc_period_select_get_active (GncPeriodSelect *period)
	Get the currently selected accounting period from a GncPeriodSelect widget.
GDate *	gnc_period_select_get_date (GncPeriodSelect *period)
	Get the currently selected accounting period choice from a GncPeriodSelect widget.
	G_DECLARE_FINAL_TYPE (GncTreeViewSxList, gnc_tree_view_sx_list, GNC, TREE_VIEW_SX_LIST, GncTreeView) GtkTreeView *gnc_tree_view_sx_list_new(GncSxInstanceModel *sx_instances)
SchedXaction *	gnc_tree_view_sx_list_get_sx_from_path (GncTreeViewSxList *view, GtkTreePath *path)

Variables
const gchar *	start_strings [GNC_ACCOUNTING_PERIOD_LAST]
const gchar *	end_strings [GNC_ACCOUNTING_PERIOD_LAST]

Accounting Periods
time64	gnc_accounting_period_fiscal_start (void)
time64	gnc_accounting_period_fiscal_end (void)
GDate *	gnc_accounting_period_start_gdate (GncAccountingPeriod which, const GDate *fy_end, const GDate *contains)
	This function returns the starting date for an accounting period.
GDate *	gnc_accounting_period_end_gdate (GncAccountingPeriod which, const GDate *fy_end, const GDate *contains)
	This function returns the ending date for an accounting period.

GncPeriodSelect Core Implementation
GtkWidget *	gnc_period_select_new (gboolean starting_labels)
	Create a new GncPeriodSelect widget which is used to select a accounting period like "previous month" or "this year".
GtkWidget *	gnc_period_select_new_glade (gchar *widget_name, gchar *string1, gchar *string2, gint int1, gint int2)
	Create a new GncPeriodSelect widget from a glade file.

GncPeriodSelect Properties
GDate *	gnc_period_select_get_fy_end (GncPeriodSelect *period)
	Get the current value of the fiscal year end setting from a GncPeriodSelect widget.
void	gnc_period_select_set_fy_end (GncPeriodSelect *period, const GDate *fy_end)
	Set the fiscal year end on a GncPeriodSelect widget.
gboolean	gnc_period_select_get_show_date (GncPeriodSelect *period)
	Get the current value of the "show sample" setting from a GncPeriodSelect widget.
void	gnc_period_select_set_show_date (GncPeriodSelect *period, const gboolean show_date)
	Set the "show sample" setting on a GncPeriodSelect widget.
GDate *	gnc_period_select_get_date_base (GncPeriodSelect *period)
void	gnc_period_select_set_date_base (GncPeriodSelect *period, const GDate *date_base)

Tree View Creation
GtkTreeViewColumn *	gnc_tree_view_add_toggle_column (GncTreeView *view, const gchar *column_title, const gchar *column_short_title, const gchar *pref_name, gint model_data_column, gint model_visibility_column, GtkTreeIterCompareFunc column_sort_fn, renderer_toggled toggle_edited_cb)
	This function adds a new toggle column to a GncTreeView base view.
GtkTreeViewColumn *	gnc_tree_view_add_text_column (GncTreeView *view, const gchar *column_title, const gchar *pref_name, const gchar *icon_name, const gchar *sizing_text, gint model_data_column, gint model_visibility_column, GtkTreeIterCompareFunc column_sort_fn)
	This function adds a new text column to a GncTreeView base view.
GtkTreeViewColumn *	gnc_tree_view_add_text_view_column (GncTreeView *view, const gchar *column_title, const gchar *pref_name, const gchar *icon_name, const gchar *sizing_text, gint model_data_column, gint model_visibility_column, GtkTreeIterCompareFunc column_sort_fn)
	This function adds a new text view column to a GncTreeView base view.
GtkTreeViewColumn *	gnc_tree_view_add_pix_column (GncTreeView *view, const gchar *column_title, const gchar *pref_name, const gchar *sizing_text, gint model_data_column, gint model_visibility_column, GtkTreeIterCompareFunc column_sort_fn)
	This function adds a pixbuf view column to a GncTreeView base view.
GtkTreeViewColumn *	gnc_tree_view_add_numeric_column (GncTreeView *view, const gchar *column_title, const gchar *pref_name, const gchar *sizing_text, gint model_data_column, gint model_color_column, gint model_visibility_column, GtkTreeIterCompareFunc column_sort_fn)
	This function adds a new numeric column to a GncTreeView base view.
gint	gnc_tree_view_append_column (GncTreeView *view, GtkTreeViewColumn *column)
	Add a column to a view based upon a GncTreeView.

Tree View Properties
void	gnc_tree_view_configure_columns (GncTreeView *view)
	Make all the correct columns visible, respecting their default visibility setting, their "always" visibility setting, and the last saved state if available.
GtkTreeViewColumn *	gnc_tree_view_find_column_by_name (GncTreeView *view, const gchar *wanted)
	Find a tree column given the "pref name".
void	gnc_tree_view_set_state_section (GncTreeView *view, const gchar *section)
	This function is called to set up or remove an association between a saved state section and the display of a view.
const gchar *	gnc_tree_view_get_state_section (GncTreeView *view)
	This function is called to get the current association between a saved state section and the display of a view.
void	gnc_tree_view_remove_state_information (GncTreeView *view)
	This function is called to completely wipe the treeview's state information (column visibility, width, sorting order,..).
void	gnc_tree_view_save_state (GncTreeView *view)
	This function is called to write the treeview's state information (column visibility, width, sorting order,..) to the state file.
void	gnc_tree_view_expand_columns (GncTreeView *view, gchar *first_column_name,...)
	This function set the columns that will be allocated the free space in the view.
void	gnc_tree_view_set_control_column_background (GncTreeView *view, gint column, GtkTreeCellDataFunc func)
	This function links the cell backgrounds of the two control columns to a column in the model that has color strings or a cell data function that sets the "cell-background" property.
void	gnc_tree_view_set_sort_user_data (GncTreeView *view, GtkTreeModel *s_model)
	This allows the columns to be setup without the model connected.
void	gnc_tree_view_set_show_column_menu (GncTreeView *view, gboolean visible)
	This function is called to set the "show-column-menu" property on this view.
gboolean	gnc_tree_view_get_show_column_menu (GncTreeView *view)
	This function is called to get the current value of the "show-column-menu" property.
GtkCellRenderer *	gnc_tree_view_column_get_renderer (GtkTreeViewColumn *column)
	Return the "main" cell renderer from a GtkTreeViewColumn added to a GncTreeView my one of the convenience routines.
void	gnc_tree_view_keynav (GncTreeView *view, GtkTreeViewColumn **col, GtkTreePath *path, GdkEventKey *event)
gboolean	gnc_tree_view_path_is_valid (GncTreeView *view, GtkTreePath *path)
void	gnc_tree_view_set_editing_started_cb (GncTreeView *view, GFunc editing_started_cb, gpointer editing_cb_data)
	Setup a callback for when the user starts editing so appropriate actions can be taken like disable the actions delete menu option.
void	gnc_tree_view_set_editing_finished_cb (GncTreeView *view, GFunc editing_finished_cb, gpointer editing_cb_data)
	Setup a callback for when the user finishes editing so appropriate actions can be taken like enable the actions delete menu option.

Detailed Description

gnc-plugin-page-report.h – A GncPlugin page for a report.

Copyright (C) 2004 Joshua Sled Author: Joshua Sled jsled.nosp@m.@asy.nosp@m.nchro.nosp@m.nous.nosp@m..org

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, contact:

Free Software Foundation Voice: +1-617-542-5942 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 Boston, MA 02110-1301, USA gnu@g.nosp@m.nu.o.nosp@m.rg

Macro Definition Documentation

ALWAYS_VISIBLE

#define ALWAYS_VISIBLE   "always-visible"

Definition at line 74 of file gnc-tree-view.h.

DEFAULT_VISIBLE

#define DEFAULT_VISIBLE   "default-visible"

Definition at line 79 of file gnc-tree-view.h.

GNC_TREE_VIEW_COLUMN_COLOR_NONE

#define GNC_TREE_VIEW_COLUMN_COLOR_NONE   -1

Definition at line 82 of file gnc-tree-view.h.

GNC_TREE_VIEW_COLUMN_DATA_NONE

#define GNC_TREE_VIEW_COLUMN_DATA_NONE   -1

Definition at line 81 of file gnc-tree-view.h.

GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS

#define GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS   -1

Definition at line 83 of file gnc-tree-view.h.

GNC_TREE_VIEW_NAME

#define GNC_TREE_VIEW_NAME   "GncTreeView"

Definition at line 43 of file gnc-tree-view.h.

GNC_TYPE_PERIOD_SELECT

#define GNC_TYPE_PERIOD_SELECT   (gnc_period_select_get_type())

Definition at line 39 of file gnc-period-select.h.

GNC_TYPE_TREE_VIEW

#define GNC_TYPE_TREE_VIEW   (gnc_tree_view_get_type ())

Definition at line 40 of file gnc-tree-view.h.

GNC_TYPE_TREE_VIEW_SX_LIST

#define GNC_TYPE_TREE_VIEW_SX_LIST   (gnc_tree_view_sx_list_get_type ())

Definition at line 41 of file gnc-tree-view-sx-list.h.

MODEL_COLUMN

#define MODEL_COLUMN   "model_column"

Definition at line 63 of file gnc-tree-view.h.

PREF_NAME

#define PREF_NAME   "pref-name"

Definition at line 70 of file gnc-tree-view.h.

REAL_TITLE

#define REAL_TITLE   "real_title"

Definition at line 66 of file gnc-tree-view.h.

Typedef Documentation

renderer_toggled

typedef void(* renderer_toggled) (GtkCellRendererToggle *cell_renderer_toggle, const gchar *path, gpointer user_data)

Definition at line 86 of file gnc-tree-view.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Definition at line 42 of file gnc-period-select.c.

{
    PROP_0,
    PROP_FY_END,
    PROP_SHOW_DATE,
    PROP_DATE_BASE,
    PROP_PS_ACTIVE,
};

anonymous enum

anonymous enum

Definition at line 51 of file gnc-period-select.c.

{
    CHANGED,
    LAST_SIGNAL
};

GncAccountingPeriod

enum GncAccountingPeriod

This specifies a time interval.

Definition at line 57 of file gnc-accounting-period.h.

{
    GNC_ACCOUNTING_PERIOD_INVALID = -1, //Force Clang to use a signed enum
    GNC_ACCOUNTING_PERIOD_TODAY,
    GNC_ACCOUNTING_PERIOD_MONTH,
    GNC_ACCOUNTING_PERIOD_MONTH_PREV,
    GNC_ACCOUNTING_PERIOD_QUARTER,
    GNC_ACCOUNTING_PERIOD_QUARTER_PREV,
    GNC_ACCOUNTING_PERIOD_CYEAR,
    GNC_ACCOUNTING_PERIOD_CYEAR_PREV,
    GNC_ACCOUNTING_PERIOD_CYEAR_LAST,
 
    GNC_ACCOUNTING_PERIOD_FYEAR = GNC_ACCOUNTING_PERIOD_CYEAR_LAST,
    GNC_ACCOUNTING_PERIOD_FYEAR_PREV,
    GNC_ACCOUNTING_PERIOD_FYEAR_LAST,
    GNC_ACCOUNTING_PERIOD_LAST = GNC_ACCOUNTING_PERIOD_FYEAR_LAST,
} GncAccountingPeriod;

Function Documentation

build_contents() [1/2]

void GncOptionsDialog::build_contents ( GncOptionDB *  odb )

inline

Definition at line 87 of file dialog-options.hpp.

                                                {
        build_contents(odb, true); }

build_contents() [2/2]

void GncOptionsDialog::build_contents	(	GncOptionDB *	odb,
		bool	show_dialog
	)

Populate the dialog's notebook with the contents of odb.

Parameters

odb	- option database to use *
show_dialog	- should dialog be made visible or not *

Definition at line 336 of file dialog-options.cpp.

{
    gint default_page = -1;
 
    g_return_if_fail (odb != NULL);
 
    m_option_db = odb;
 
    auto default_section = odb->get_default_section();
 
    PINFO("Default Section name is %s",
          default_section ? default_section->get_name().c_str() : "NULL");
 
    odb->foreach_section(
        [this, default_section, &default_page]
        (GncOptionSectionPtr& section) {
            auto page = dialog_append_page(this, section);
            if (default_section && section.get() == default_section)
                default_page = page;
        });
 
    gtk_notebook_popup_enable(GTK_NOTEBOOK(m_notebook));
    if (default_page >= 0)
    {
        /* Find the page list and set the selection to the default page */
        auto selection{gtk_tree_view_get_selection(GTK_TREE_VIEW(m_page_list_view))};
        GtkTreeIter iter;
 
        auto model{gtk_tree_view_get_model(GTK_TREE_VIEW(m_page_list_view))};
        gtk_tree_model_iter_nth_child(model, &iter, NULL, default_page);
        gtk_tree_selection_select_iter (selection, &iter);
        gtk_notebook_set_current_page(GTK_NOTEBOOK(m_notebook), default_page);
    }
    dialog_changed_internal(m_window, FALSE);
    if (show_dialog)
        gtk_widget_show(m_window);
}

call_apply_cb()

void GncOptionsDialog::call_apply_cb ( )

noexcept

Definition at line 374 of file dialog-options.cpp.

{
    auto close_cb = m_close_cb;
 
    m_close_cb = nullptr;
    if (m_apply_cb)
        (m_apply_cb)(this, m_apply_cb_data);
    m_close_cb = close_cb;
    set_sensitive(false);
}

call_book_help_cb()

void GncOptionsDialog::call_book_help_cb ( )

noexcept

Definition at line 404 of file dialog-options.cpp.

{
/*    if (m_book_options_help_cb)
        (m_book_options_help_cb)(this, m_book_options_help_cb_data);
*/
}

call_close_cb()

void GncOptionsDialog::call_close_cb ( )

noexcept

Definition at line 391 of file dialog-options.cpp.

{
    if (m_close_cb)
    {
        gtk_window_close(GTK_WINDOW(m_window));
        (m_close_cb)(this, m_close_cb_data);
    }
    else
    {
        gtk_widget_hide(m_window);
    }
}

call_help_cb()

void GncOptionsDialog::call_help_cb ( )

noexcept

Definition at line 385 of file dialog-options.cpp.

{
    if (m_help_cb)
        (m_help_cb)(this, m_help_cb_data);
}

call_style_sheet_help_cb()

void GncOptionsDialog::call_style_sheet_help_cb ( )

noexcept

Definition at line 411 of file dialog-options.cpp.

{
/*
    if (m_style_sheet_help_cb)
        (m_style_shet_help_cb)(this, m_style_sheet_help_cb_data);
*/
}

changed()

void GncOptionsDialog::changed ( )

noexcept

Definition at line 118 of file dialog-options.cpp.

{
    set_sensitive(true);
}

get_notebook()

GtkWidget * GncOptionsDialog::get_notebook ( ) const

inlinenoexcept

Definition at line 85 of file dialog-options.hpp.

{ return m_notebook; }

get_option_db()

GncOptionDB * GncOptionsDialog::get_option_db ( )

inlinenoexcept

Definition at line 86 of file dialog-options.hpp.

{ return m_option_db; }

get_page_list()

GtkWidget * GncOptionsDialog::get_page_list ( ) const

inlinenoexcept

Definition at line 83 of file dialog-options.hpp.

{ return m_page_list; }

get_page_list_view()

GtkWidget * GncOptionsDialog::get_page_list_view ( ) const

inlinenoexcept

Definition at line 84 of file dialog-options.hpp.

{ return m_page_list_view; }

get_widget()

GtkWidget * GncOptionsDialog::get_widget ( ) const

inlinenoexcept

Definition at line 82 of file dialog-options.hpp.

{ return m_window; }

gnc_accounting_period_end_gdate()

GDate * gnc_accounting_period_end_gdate	(	GncAccountingPeriod	which,
		const GDate *	fy_end,
		const GDate *	contains
	)

This function returns the ending date for an accounting period.

The date will be computed based upon the type of accounting interval requested, an optional fiscal year end value, and an optional time value.

Parameters

which	An enum specifying the type of accounting period.
fy_end	This argument specifies the month and day of the fiscal year end. If the accounting period specified in the 'which' parameter is not a fiscal accounting period, this variable is ignored and may be NULL. Note: the year field of this argument is always ignored.
contains	This argument specifies the origin time value used by the calculations in this function. If this value is NULL, the origin will be the current time.

Returns

The final day of the specified time interval, as a GDate.

Definition at line 229 of file gnc-accounting-period.c.

{
    GDate *date;
 
    if (contains)
    {
        date = g_date_new_dmy (g_date_get_day (contains),
                               g_date_get_month (contains),
                               g_date_get_year (contains));
    }
    else
    {
        date = g_date_new ();
        gnc_gdate_set_today (date);
    }
 
    switch (which)
    {
    default:
        PINFO ("Undefined relative time constant %d", which);
        g_date_free (date);
        return 0;
 
    case GNC_ACCOUNTING_PERIOD_TODAY:
        /* Already have today's date */
        break;
 
    case GNC_ACCOUNTING_PERIOD_MONTH:
        gnc_gdate_set_month_end (date);
        break;
 
    case GNC_ACCOUNTING_PERIOD_MONTH_PREV:
        gnc_gdate_set_prev_month_end (date);
        break;
 
    case GNC_ACCOUNTING_PERIOD_QUARTER:
        gnc_gdate_set_quarter_end (date);
        break;
 
    case GNC_ACCOUNTING_PERIOD_QUARTER_PREV:
        gnc_gdate_set_prev_quarter_end (date);
        break;
 
    case GNC_ACCOUNTING_PERIOD_CYEAR:
        gnc_gdate_set_year_end (date);
        break;
 
    case GNC_ACCOUNTING_PERIOD_CYEAR_PREV:
        gnc_gdate_set_prev_year_end (date);
        break;
 
    case GNC_ACCOUNTING_PERIOD_FYEAR:
        if (fy_end == NULL)
        {
            PINFO ("Request for fisal year value but no fiscal year end value provided.");
            g_date_free (date);
            return 0;
        }
        gnc_gdate_set_fiscal_year_end (date, fy_end);
        break;
 
    case GNC_ACCOUNTING_PERIOD_FYEAR_PREV:
        if (fy_end == NULL)
        {
            PINFO ("Request for fisal year value but no fiscal year end value provided.");
            g_date_free (date);
            return 0;
        }
        gnc_gdate_set_prev_fiscal_year_end (date, fy_end);
        break;
    }
 
    return date;
}

gnc_accounting_period_fiscal_end()

time64 gnc_accounting_period_fiscal_end

(

void

)

Definition at line 123 of file gnc-accounting-period.c.

{
    time64 t;
    GDate *fy_end = get_fy_end();
 
    t = lookup_end_date_option (fy_end);
    if (fy_end)
        g_date_free (fy_end);
    return t;
}

gnc_accounting_period_fiscal_start()

time64 gnc_accounting_period_fiscal_start

(

void

)

Definition at line 112 of file gnc-accounting-period.c.

{
    time64 t;
    GDate *fy_end = get_fy_end();
    t = lookup_start_date_option (fy_end);
    if (fy_end)
        g_date_free (fy_end);
    return t;
}

gnc_accounting_period_start_gdate()

GDate * gnc_accounting_period_start_gdate	(	GncAccountingPeriod	which,
		const GDate *	fy_end,
		const GDate *	contains
	)

This function returns the starting date for an accounting period.

The date will be computed based upon the type of accounting interval requested, an optional fiscal year end value, and an optional time value.

Parameters

which	An enum specifying the type of accounting period.
fy_end	This argument specifies the month and day of the fiscal year end. If the accounting period specified in the 'which' parameter is not a fiscal accounting period, this variable is ignored and may be NULL. Note: the year field of this argument is always ignored.
contains	This argument specifies the origin time value used by the calculations in this function. If this value is NULL, the origin will be the current time.

Returns

The starting day of the specified time interval, as a GDate.

Definition at line 135 of file gnc-accounting-period.c.

{
    GDate *date;
 
    if (contains)
    {
        date = g_date_new_dmy (g_date_get_day (contains),
                               g_date_get_month (contains),
                               g_date_get_year (contains));
    }
    else
    {
        date = g_date_new ();
        gnc_gdate_set_today (date);
    }
 
    switch (which)
    {
    default:
        PINFO ("Undefined relative time constant %d", which);
        g_date_free (date);
        return NULL;
 
    case GNC_ACCOUNTING_PERIOD_TODAY:
        /* Already have today's date */
        break;
 
    case GNC_ACCOUNTING_PERIOD_MONTH:
        gnc_gdate_set_month_start (date);
        break;
 
    case GNC_ACCOUNTING_PERIOD_MONTH_PREV:
        gnc_gdate_set_prev_month_start (date);
        break;
 
    case GNC_ACCOUNTING_PERIOD_QUARTER:
        gnc_gdate_set_quarter_start (date);
        break;
 
    case GNC_ACCOUNTING_PERIOD_QUARTER_PREV:
        gnc_gdate_set_prev_quarter_start (date);
        break;
 
    case GNC_ACCOUNTING_PERIOD_CYEAR:
        gnc_gdate_set_year_start (date);
        break;
 
    case GNC_ACCOUNTING_PERIOD_CYEAR_PREV:
        gnc_gdate_set_prev_year_start (date);
        break;
 
    case GNC_ACCOUNTING_PERIOD_FYEAR:
        if (fy_end == NULL)
        {
            PINFO ("Request for fiscal year value but no fiscal year end value provided.");
            g_date_free (date);
            return NULL;
        }
        gnc_gdate_set_fiscal_year_start (date, fy_end);
        break;
 
    case GNC_ACCOUNTING_PERIOD_FYEAR_PREV:
        if (fy_end == NULL)
        {
            PINFO ("Request for fiscal year value but no fiscal year end value provided.");
            g_date_free (date);
            return NULL;
        }
        gnc_gdate_set_prev_fiscal_year_start (date, fy_end);
        break;
    }
    return date;
}

gnc_period_select_get_active()

GncAccountingPeriod gnc_period_select_get_active

(

GncPeriodSelect *

period

)

Get the currently selected accounting period from a GncPeriodSelect widget.

This is used to retrieve the user's selection in the form of an enum.

Parameters

period

The selection widget to query.

Returns

An enum indicating the user's choice of accounting period.

Definition at line 684 of file gnc-period-select.c.

{
    g_return_val_if_fail(period != NULL, -1);
    g_return_val_if_fail(GNC_IS_PERIOD_SELECT(period), -1);
 
    return gtk_combo_box_get_active(GTK_COMBO_BOX(period->selector));
}

gnc_period_select_get_date()

GDate * gnc_period_select_get_date

(

GncPeriodSelect *

period

)

Get the currently selected accounting period choice from a GncPeriodSelect widget.

This is used to retrieve the user's selection in the form of a GDate.

Parameters

period

The selection widget to query.

Returns

The starting/ending time.

Definition at line 698 of file gnc-period-select.c.

{
    GncAccountingPeriod which;
 
    g_return_val_if_fail(period != NULL, 0);
    g_return_val_if_fail(GNC_IS_PERIOD_SELECT(period), 0);
 
    which = gtk_combo_box_get_active(GTK_COMBO_BOX(period->selector));
    if (which == -1)
        return NULL;
 
    if (period->start)
        return gnc_accounting_period_start_gdate(which, period->fy_end,
                period->date_base);
    return gnc_accounting_period_end_gdate(which, period->fy_end,
                                           period->date_base);
}

gnc_period_select_get_date_base()

GDate * gnc_period_select_get_date_base

(

GncPeriodSelect *

period

)

Definition at line 367 of file gnc-period-select.c.

{
    g_return_val_if_fail(period != NULL, NULL);
    g_return_val_if_fail(GNC_IS_PERIOD_SELECT(period), NULL);
 
    if (!period->date_base)
        return NULL;
    return g_date_new_dmy(g_date_get_day(period->date_base),
                          g_date_get_month(period->date_base),
                          g_date_get_year(period->date_base));
}

gnc_period_select_get_fy_end()

GDate * gnc_period_select_get_fy_end

(

GncPeriodSelect *

period

)

Get the current value of the fiscal year end setting from a GncPeriodSelect widget.

If the result is NULL then fiscal years are not currently supported.

Parameters

period

The GncPeriodSelect widget to query.

Returns

A pointer to a GDate containing the fiscal year end value, or NULL if no fiscal year end is set. Note that only the month and day fields are valid in the returned GDate.

Definition at line 242 of file gnc-period-select.c.

{
    g_return_val_if_fail(period != NULL, NULL);
    g_return_val_if_fail(GNC_IS_PERIOD_SELECT(period), NULL);
 
    if (!period->fy_end)
        return NULL;
    return g_date_new_dmy(g_date_get_day(period->fy_end),
                          g_date_get_month(period->fy_end),
                          G_DATE_BAD_YEAR);
}

gnc_period_select_get_show_date()

gboolean gnc_period_select_get_show_date

(

GncPeriodSelect *

period

)

Get the current value of the "show sample" setting from a GncPeriodSelect widget.

Definition at line 333 of file gnc-period-select.c.

{
    g_return_val_if_fail(period != NULL, FALSE);
    g_return_val_if_fail(GNC_IS_PERIOD_SELECT(period), FALSE);
 
    return (period->date_base != NULL);
}

gnc_period_select_new()

GtkWidget * gnc_period_select_new

(

gboolean

starting_labels

)

Create a new GncPeriodSelect widget which is used to select a accounting period like "previous month" or "this year".

Parameters

starting_labels

If set to TRUE then all the labels will refer to the "Start of...". If FALSE, labels will refer to "End of...".

Returns

A newly created GncPeriodSelect widget.

Definition at line 602 of file gnc-period-select.c.

{
    GncPeriodSelect *period;
    const gchar *label;
    gint i;
 
    period = g_object_new(GNC_TYPE_PERIOD_SELECT, NULL);
 
    /* Set up private data structures */
    period->selector   = gtk_combo_box_text_new();
    period->start      = starting_labels;
 
    /* Add the internal widgets to the hbox */
    gtk_box_pack_start(GTK_BOX(period), period->selector, TRUE, TRUE, 0);
    gtk_widget_show(period->selector);
 
    /* Find out when the combo box changes */
    g_signal_connect(G_OBJECT(period->selector), "changed",
                     G_CALLBACK(gnc_period_sample_combobox_changed), period);
 
    /* Build all the labels except the fiscal year labels */
    for (i = 0; i < GNC_ACCOUNTING_PERIOD_CYEAR_LAST; i++)
    {
        label = starting_labels ? _(start_strings[i]) : _(end_strings[i]);
        gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(period->selector), label);
    }
 
    /* Track changes to date formatting */
    gnc_prefs_register_cb (GNC_PREFS_GROUP_GENERAL, GNC_PREF_DATE_FORMAT,
                           gnc_period_sample_new_date_format, period);
 
    return GTK_WIDGET (period);
}

gnc_period_select_new_glade()

GtkWidget * gnc_period_select_new_glade	(	gchar *	widget_name,
		gchar *	string1,
		gchar *	string2,
		gint	int1,
		gint	int2
	)

Create a new GncPeriodSelect widget from a glade file.

The int1 argument passed from glade is used to determine whether the widget uses labels for start times or end times. A non-zero int2 argument indicates that an example date should be shown.

Returns

A newly created GncPeriodSelect widget.

Definition at line 643 of file gnc-period-select.c.

{
    GtkWidget *widget;
    widget = gnc_period_select_new(int1 != 0);
    if (int2)
        gnc_period_select_set_show_date(GNC_PERIOD_SELECT(widget), TRUE);
    gtk_widget_show(widget);
    return widget;
}

gnc_period_select_set_active()

void gnc_period_select_set_active	(	GncPeriodSelect *	period,
		GncAccountingPeriod	which
	)

Set which item in the GncPeriodSelect is initially selected.

This is used to set the initial selection before the widget is shown to the user.

Parameters

period	The selection widget to update.
which	The accounting period that should be selected.

Definition at line 667 of file gnc-period-select.c.

{
    g_return_if_fail(period != NULL);
    g_return_if_fail(GNC_IS_PERIOD_SELECT(period));
    g_return_if_fail(which >= 0);
    g_return_if_fail(which <  GNC_ACCOUNTING_PERIOD_LAST);
 
    g_object_set (G_OBJECT (period), "active", which, NULL);
}

gnc_period_select_set_date_base()

void gnc_period_select_set_date_base	(	GncPeriodSelect *	period,
		const GDate *	date_base
	)

Definition at line 384 of file gnc-period-select.c.

{
    g_return_if_fail(period != NULL);
    g_return_if_fail(GNC_IS_PERIOD_SELECT(period));
 
    gnc_period_select_set_date_common(period, date_base);
}

gnc_period_select_set_fy_end()

void gnc_period_select_set_fy_end	(	GncPeriodSelect *	period,
		const GDate *	fy_end
	)

Set the fiscal year end on a GncPeriodSelect widget.

If set to a value other than NULL then widget will include fiscal accounting period like "this fiscal year".

Parameters

period	The GncPeriodSelect widget to update.
fy_end	The new fiscal year end value, or NULL if no fiscal year is set. Note that only the month and day fields need be valid in the provided GDate.

Definition at line 260 of file gnc-period-select.c.

{
    const gchar *label;
    gint i;
 
    g_return_if_fail(period != NULL);
    g_return_if_fail(GNC_IS_PERIOD_SELECT(period));
 
    if (period->fy_end)
        g_date_free(period->fy_end);
 
    if (fy_end)
    {
        period->fy_end = g_date_copy (fy_end);
    }
    else
    {
        period->fy_end = NULL;
    }
 
    if (fy_end)
    {
        for (i = GNC_ACCOUNTING_PERIOD_CYEAR_LAST; i < GNC_ACCOUNTING_PERIOD_FYEAR_LAST; i++)
        {
            label = period->start ? _(start_strings[i]) : _(end_strings[i]);
            gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(period->selector), label);
        }
    }
    else
    {
        for (i = GNC_ACCOUNTING_PERIOD_FYEAR_LAST - 1; i >= GNC_ACCOUNTING_PERIOD_FYEAR_LAST; i--)
        {
            gtk_combo_box_text_remove(GTK_COMBO_BOX_TEXT(period->selector), i);
        }
    }
}

gnc_period_select_set_show_date()

void gnc_period_select_set_show_date	(	GncPeriodSelect *	period,
		const gboolean	show_date
	)

Set the "show sample" setting on a GncPeriodSelect widget.

If set to TRUE then a GtkLabel will be used to show the date corresponding to the selected time period.

Definition at line 346 of file gnc-period-select.c.

{
    GDate date;
 
    g_return_if_fail(period != NULL);
    g_return_if_fail(GNC_IS_PERIOD_SELECT(period));
 
    if (show_date)
    {
        g_date_clear(&date, 1);
        gnc_gdate_set_time64(&date, gnc_time (NULL));
        gnc_period_select_set_date_common(period, &date);
    }
    else
    {
        gnc_period_select_set_date_common(period, NULL);
    }
}

gnc_tree_view_add_numeric_column()

GtkTreeViewColumn * gnc_tree_view_add_numeric_column	(	GncTreeView *	view,
		const gchar *	column_title,
		const gchar *	pref_name,
		const gchar *	sizing_text,
		gint	model_data_column,
		gint	model_color_column,
		gint	model_visibility_column,
		GtkTreeIterCompareFunc	column_sort_fn
	)

This function adds a new numeric column to a GncTreeView base view.

It takes all the parameters necessary to hook a GtkTreeModel column to a GtkTreeViewColumn. A numeric column is nothing more then a text column with a few extra attributes.

Parameters

view	A pointer to a generic GncTreeView.
column_title	The title for this column.
pref_name	The internal name of this column. This name is used in several functions to look up the column, and it is also used when saving/restoring the view's state.
sizing_text	A string used to compute the default width of the column. This text is never displayed.
model_data_column	The index of the GtkTreeModel data column used to determine the data that will be displayed in this column for each row in the view. Use GNC_TREE_VIEW_COLUMN_DATA_NONE if you plan on using an non-model data source for this column.
model_color_column	The index of the GtkTreeModel data column used to determine the foreground color of any text in this column. It should be used to display negative numbers in red. Use GNC_TREE_VIEW_COLUMN_COLOR_NONE if the text in this column should always be displayed in the default theme color for text.
model_visibility_column	The index of the GtkTreeModel data column used to determine whether or not a checkbox for each row will be displayed at all. Use GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS if the checkbox should be displayed in all rows.
column_sort_fn	The function that GtkTreeModelSort will call to compare two rows to determine their displayed order.

Returns

The newly created GtkTreeViewColumn.

It takes all the parameters necessary to hook a GtkTreeModel column to a GtkTreeViewColumn. If the tree has a state section associated with it, this function also wires up the column so that its visibility and width are remembered. A numeric column is nothing more then a text column with a few extra attributes.

Parameters are defined in gnc-tree-view.h

Definition at line 2061 of file gnc-tree-view.c.

{
    GtkTreeViewColumn *column;
    GtkCellRenderer *renderer;
    gfloat alignment = 1.0;
 
    /* Use GncCellRendererLabel so the user can click a cell and select
     * its text (e.g. to copy it to the clipboard), without being able
     * to modify the underlying data. */
    renderer = gnc_cell_renderer_label_new ();
    column = add_text_column_variant (view, renderer, column_title, pref_name,
                                      NULL, sizing_text, model_data_column,
                                      model_visibility_column, column_sort_fn);
 
    /* Right align the column title and data for both ltr and rtl */
    if (gtk_widget_get_direction (GTK_WIDGET(view)) == GTK_TEXT_DIR_RTL)
        alignment = 0.0;
 
    g_object_set (G_OBJECT(column), "alignment", alignment, NULL);
    g_object_set (G_OBJECT(renderer), "xalign", alignment, NULL);
 
    /* Change the text color */
    if (model_color_column != GNC_TREE_VIEW_COLUMN_COLOR_NONE)
        gtk_tree_view_column_add_attribute (column, renderer,
                                            "foreground", model_color_column);
 
    return column;
}

gnc_tree_view_add_pix_column()

GtkTreeViewColumn * gnc_tree_view_add_pix_column	(	GncTreeView *	view,
		const gchar *	column_title,
		const gchar *	pref_name,
		const gchar *	sizing_text,
		gint	model_data_column,
		gint	model_visibility_column,
		GtkTreeIterCompareFunc	column_sort_fn
	)

This function adds a pixbuf view column to a GncTreeView base view.

It takes all the parameters necessary to hook a GtkTreeModel column to a GtkTreeViewColumn.

Parameters

view	A pointer to a generic GncTreeView.
column_title	The title for this column.
pref_name	The internal name of this column. This name is used in several functions to look up the column, and it is also used when saving/restoring the view's state.
sizing_text	A string used to compute the default width of the column. This text is never displayed.
model_data_column	The index of the GtkTreeModel data column used to determine the data that will be displayed in this column for each row in the view. Use GNC_TREE_VIEW_COLUMN_DATA_NONE if you plan on using a non-model data source for this column. This index is connected to the "icon-name" attribute of the cell renderer.
model_visibility_column	The index of the GtkTreeModel data column used to determine whether or not a checkbox for each row will be displayed at all. Use GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS if the checkbox should be displayed in all rows.
column_sort_fn	The function that GtkTreeModelSort will call to compare two rows to determine their displayed order.

Returns

The newly created GtkTreeViewColumn.

This function adds a pixbuf view column to a GncTreeView base view.

It takes all the parameters necessary to hook a GtkTreeModel column to a GtkTreeViewColumn. If the tree has a state section associated with it, this function also wires up the column so that its visibility and width are remembered.

Parameters are defined in gnc-tree-view.h

Definition at line 1985 of file gnc-tree-view.c.

{
    GtkTreeViewColumn *column;
    PangoLayout* layout;
    int default_width, title_width;
    GtkCellRenderer *renderer;
 
    g_return_val_if_fail (GNC_IS_TREE_VIEW(view), NULL);
 
    renderer = gtk_cell_renderer_pixbuf_new ();
 
    column = gtk_tree_view_column_new ();
    gtk_tree_view_column_set_title (column, column_title);
 
    /* Set up a text renderer and attributes */
    gtk_tree_view_column_pack_start (column, renderer, TRUE);
 
    /* Set renderer attributes controlled by the model */
    if (model_data_column != GNC_TREE_VIEW_COLUMN_DATA_NONE)
        gtk_tree_view_column_add_attribute (column, renderer,
                                            "icon-name", model_data_column);
    if (model_visibility_column != GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS)
        gtk_tree_view_column_add_attribute (column, renderer,
                                            "visible", model_visibility_column);
 
    /* Default size is the larger of the column title and the sizing text */
    layout = gtk_widget_create_pango_layout (GTK_WIDGET(view), column_title);
    pango_layout_get_pixel_size (layout, &title_width, NULL);
    g_object_unref (layout);
    layout = gtk_widget_create_pango_layout (GTK_WIDGET(view), sizing_text);
    pango_layout_get_pixel_size (layout, &default_width, NULL);
    g_object_unref (layout);
    default_width = MAX(default_width, title_width);
    if (default_width)
        default_width += 10; /* padding on either side */
    gnc_tree_view_column_properties (view, column, pref_name, model_data_column,
                                     default_width, TRUE, column_sort_fn);
 
    gnc_tree_view_append_column (view, column);
    return column;
}

gnc_tree_view_add_text_column()

GtkTreeViewColumn * gnc_tree_view_add_text_column	(	GncTreeView *	view,
		const gchar *	column_title,
		const gchar *	pref_name,
		const gchar *	icon_name,
		const gchar *	sizing_text,
		gint	model_data_column,
		gint	model_visibility_column,
		GtkTreeIterCompareFunc	column_sort_fn
	)

This function adds a new text column to a GncTreeView base view.

It takes all the parameters necessary to hook a GtkTreeModel column to a GtkTreeViewColumn.

Parameters

view	A pointer to a generic GncTreeView.
column_title	The title for this column.
pref_name	The internal name of this column. This name is used in several functions to look up the column, and it is also used when saving/restoring the view's state.
icon_name	The name of the icon to display to the left of the text in this column. Used for adding icons like the "account" icon to a view. This must be a registered icon, not a filename.
sizing_text	A string used to compute the default width of the column. This text is never displayed.
model_data_column	The index of the GtkTreeModel data column used to determine the data that will be displayed in this column for each row in the view. Use GNC_TREE_VIEW_COLUMN_DATA_NONE if you plan on using a non-model data source for this column. This index is connected to the "text" attribute of the cell renderer.
model_visibility_column	The index of the GtkTreeModel data column used to determine whether or not a checkbox for each row will be displayed at all. Use GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS if the checkbox should be displayed in all rows.
column_sort_fn	The function that GtkTreeModelSort will call to compare two rows to determine their displayed order.

Returns

The newly created GtkTreeViewColumn.

It takes all the parameters necessary to hook a GtkTreeModel column to a GtkTreeViewColumn. If the tree has a state section associated with it, this function also wires up the column so that its visibility and width are remembered.

Parameters are defined in gnc-tree-view.h

Definition at line 1921 of file gnc-tree-view.c.

{
    GtkCellRenderer *renderer;
 
    g_return_val_if_fail (GNC_IS_TREE_VIEW(view), NULL);
 
    renderer = gtk_cell_renderer_text_new ();
 
    return add_text_column_variant (view, renderer,
                                    column_title, pref_name,
                                    icon_name, sizing_text,
                                    model_data_column,
                                    model_visibility_column,
                                    column_sort_fn);
}

gnc_tree_view_add_text_view_column()

GtkTreeViewColumn * gnc_tree_view_add_text_view_column	(	GncTreeView *	view,
		const gchar *	column_title,
		const gchar *	pref_name,
		const gchar *	icon_name,
		const gchar *	sizing_text,
		gint	model_data_column,
		gint	model_visibility_column,
		GtkTreeIterCompareFunc	column_sort_fn
	)

This function adds a new text view column to a GncTreeView base view.

It takes all the parameters necessary to hook a GtkTreeModel column to a GtkTreeViewColumn.

Parameters

view	A pointer to a generic GncTreeView.
column_title	The title for this column.
pref_name	The internal name of this column. This name is used in several functions to look up the column, and it is also used when saving/restoring the view's state.
icon_name	The name of the icon to display to the left of the text in this column. Used for adding icons like the "account" icon to a view. This must be a registered icon, not a filename.
sizing_text	A string used to compute the default width of the column. This text is never displayed.
model_data_column	The index of the GtkTreeModel data column used to determine the data that will be displayed in this column for each row in the view. Use GNC_TREE_VIEW_COLUMN_DATA_NONE if you plan on using a non-model data source for this column. This index is connected to the "text" attribute of the cell renderer.
model_visibility_column	The index of the GtkTreeModel data column used to determine whether or not a checkbox for each row will be displayed at all. Use GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS if the checkbox should be displayed in all rows.
column_sort_fn	The function that GtkTreeModelSort will call to compare two rows to determine their displayed order.

Returns

The newly created GtkTreeViewColumn.

It takes all the parameters necessary to hook a GtkTreeModel column to a GtkTreeViewColumn. If the tree has a state section associated with it, this function also wires up the column so that its visibility and width are remembered.

Parameters are defined in gnc-tree-view.h

Definition at line 1953 of file gnc-tree-view.c.

{
    GtkCellRenderer *renderer;
 
    g_return_val_if_fail (GNC_IS_TREE_VIEW(view), NULL);
 
    renderer = gnc_cell_renderer_text_view_new ();
 
    return add_text_column_variant (view, renderer,
                                    column_title, pref_name,
                                    icon_name, sizing_text,
                                    model_data_column,
                                    model_visibility_column,
                                    column_sort_fn);
}

gnc_tree_view_add_toggle_column()

GtkTreeViewColumn * gnc_tree_view_add_toggle_column	(	GncTreeView *	view,
		const gchar *	column_title,
		const gchar *	column_short_title,
		const gchar *	pref_name,
		gint	model_data_column,
		gint	model_visibility_column,
		GtkTreeIterCompareFunc	column_sort_fn,
		renderer_toggled	toggle_edited_cb
	)

This function adds a new toggle column to a GncTreeView base view.

It takes all the parameters necessary to hook a GtkTreeModel column to a GtkTreeViewColumn. It handles creating a tooltip to show the full title name, and setting the sort and edit callback functions.

Parameters

view	A pointer to a generic GncTreeView.
column_title	The full title for this column. This will be added as a tooltip what will be displayed when the mouse is hovered over the column title button.
column_short_title	This is what will actually be displayed as the title of the column. This should be a single character, as anything more will unnecessarily expand the width of the column.
pref_name	The internal name of this column. This name is used in several functions to look up the column, and it is also used when saving/restoring the view's state.
model_data_column	The index of the GtkTreeModel data column used to determine whether the displayed checkbox for each row will be show as checked or empty. Use GNC_TREE_VIEW_COLUMN_DATA_NONE if you plan on using an non-model data source for this column.
model_visibility_column	The index of the GtkTreeModel data column used to determine whether or not a checkbox for each row will be displayed at all. Use GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS if the checkbox should be displayed in all rows.
column_sort_fn	The function that GtkTreeModelSort will call to compare two rows to determine their displayed order.
toggle_edited_cb	The function to call when the user toggles the state of a checkbox.

Returns

The newly created GtkTreeViewColumn.

It takes all the parameters necessary to hook a GtkTreeModel column to a GtkTreeViewColumn. It handles creating a tooltip to show the full title name, and setting the sort and edit callback functions. If the tree has a state section associated with it, this function also wires up the column so that its visibility and width are remembered.

Parameters are defined in gnc-tree-view.h

Definition at line 1768 of file gnc-tree-view.c.

{
    GtkTreeViewColumn *column;
    GtkCellRenderer *renderer;
 
    g_return_val_if_fail (GNC_IS_TREE_VIEW(view), NULL);
 
    renderer = gtk_cell_renderer_toggle_new ();
    if (!toggle_edited_cb)
    {
        gtk_cell_renderer_toggle_set_activatable (GTK_CELL_RENDERER_TOGGLE(renderer), FALSE);
    }
    column =
        gtk_tree_view_column_new_with_attributes (column_short_title,
                renderer,
                "active", model_data_column,
                NULL);
 
    /* Add the full title to the object for menu creation */
    g_object_set_data_full (G_OBJECT(column), REAL_TITLE,
                            g_strdup(column_title), g_free);
    if (toggle_edited_cb)
        g_signal_connect (G_OBJECT(renderer), "toggled",
                          G_CALLBACK(toggle_edited_cb), view);
 
    if (model_visibility_column != GNC_TREE_VIEW_COLUMN_VISIBLE_ALWAYS)
        gtk_tree_view_column_add_attribute (column, renderer,
                                            "visible", model_visibility_column);
 
 
    gnc_tree_view_column_properties (view, column, pref_name, model_data_column,
                                     0, FALSE, column_sort_fn);
 
    gnc_tree_view_append_column (view, column);
 
    /* Also add the full title to the object as a tooltip */
    gtk_widget_set_tooltip_text (gtk_tree_view_column_get_button (column), column_title);
 
    return column;
}

gnc_tree_view_append_column()

gint gnc_tree_view_append_column	(	GncTreeView *	view,
		GtkTreeViewColumn *	column
	)

Add a column to a view based upon a GncTreeView.

This function knows about the two special columns on the right side of this type of view, and adds the new column before these two columns. You could say that it appends to the data columns and ignores the infrastructure columns.

Parameters

view	A pointer to a generic GncTreeView.
column	The column to append.

Returns

The index of the newly added column.

This function knows about the two special columns on the right side of this type of view, and adds the new column before these two columns. You could say that it appends to the data columns and ignores the infrastructure columns.

Parameters are defined in gnc-tree-view.h

Definition at line 2106 of file gnc-tree-view.c.

{
    int n = gtk_tree_view_get_n_columns (GTK_TREE_VIEW(view));
 
    /* Ignore the initial column, the selection menu */
    if (n >= 1)
        n -= 1;
    return gtk_tree_view_insert_column (GTK_TREE_VIEW(view), column, n);
}

gnc_tree_view_column_get_renderer()

GtkCellRenderer * gnc_tree_view_column_get_renderer

(

GtkTreeViewColumn *

column

)

Return the "main" cell renderer from a GtkTreeViewColumn added to a GncTreeView my one of the convenience routines.

Parameters

column

The tree view column that was added to the GncTreeView

Returns

The cell renderer in use in the column.

Definition at line 2034 of file gnc-tree-view.c.

{
    GList *renderers;
    GtkCellRenderer *cr = NULL;
 
    g_return_val_if_fail (GTK_TREE_VIEW_COLUMN(column), NULL);
 
    /* Get the list of one renderer */
    renderers = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT(column));
    if (g_list_length (renderers) > 0)
        cr = GTK_CELL_RENDERER(renderers->data);
    g_list_free (renderers);
 
    return cr;
}

gnc_tree_view_configure_columns()

void gnc_tree_view_configure_columns

(

GncTreeView *

view

)

Make all the correct columns visible, respecting their default visibility setting, their "always" visibility setting, and the last saved state if available.

Parameters

view	A pointer to an gnc tree view.

Definition at line 1598 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
    GtkTreeViewColumn *column;
    GList *columns;
    gboolean hide_menu_column;
 
    g_return_if_fail (GNC_IS_TREE_VIEW(view));
 
    ENTER(" ");
 
    /* Update the view and saved state */
    columns = gtk_tree_view_get_columns (GTK_TREE_VIEW(view));
    g_list_foreach (columns, (GFunc)gnc_tree_view_update_visibility, view);
    g_list_free (columns);
 
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
    if (priv->state_section)
        priv->seen_state_visibility = TRUE;
 
    /* If only the first column is visible, hide the spacer and make that
     * column expand. */
    hide_menu_column = (gnc_tree_view_count_visible_columns (view) == 1);
    column = gtk_tree_view_get_column (GTK_TREE_VIEW(view), 0);
    gtk_tree_view_column_set_expand (column, hide_menu_column);
    gtk_tree_view_column_set_visible (priv->column_menu_column, !hide_menu_column);
 
    LEAVE(" ");
}

gnc_tree_view_expand_columns()

void gnc_tree_view_expand_columns	(	GncTreeView *	view,
		gchar *	first_column_name,
			...
	)

This function set the columns that will be allocated the free space in the view.

Parameters

view	The tree view.
list	of column names.

Definition at line 1433 of file gnc-tree-view.c.

{
    GtkTreeViewColumn *column;
    GList *columns, *tmp;
    gchar *name, *pref_name;
    va_list args;
 
    g_return_if_fail (GNC_IS_TREE_VIEW(view));
    ENTER(" ");
    va_start (args, first_column_name);
    name = first_column_name;
 
    /* First disable the expand property on all (non-infrastructure) columns. */
    columns = gtk_tree_view_get_columns (GTK_TREE_VIEW(view));
    for (tmp = columns; tmp; tmp = g_list_next (tmp))
    {
        column = tmp->data;
        pref_name = g_object_get_data (G_OBJECT(column), PREF_NAME);
        if (pref_name != NULL)
            gtk_tree_view_column_set_expand (column, FALSE);
    }
    g_list_free(columns);
 
    /* Now enable it on the requested columns. */
    while (name != NULL)
    {
        column = gnc_tree_view_find_column_by_name (view, name);
        if (column != NULL)
        {
            gtk_tree_view_column_set_expand (column, TRUE);
        }
        name = va_arg (args, gchar*);
    }
    va_end (args);
 
    LEAVE(" ");
}

gnc_tree_view_find_column_by_name()

GtkTreeViewColumn * gnc_tree_view_find_column_by_name	(	GncTreeView *	view,
		const gchar *	wanted
	)

Find a tree column given the "pref name".

This function simply runs the list of all (visible and invisible) columns looking for a match. Column names were attached to each column at the time the column was created.

Parameters

view	The visible tree widget.
wanted	The "pref name" to find.

Find a tree column given the "pref name".

This function simply runs the list of all (visible and invisible) columns looking for a match. Column names were attached to each column at the time the column was created.

Parameters

view	The visible tree widget.
wanted	The "pref name" to find.

Definition at line 538 of file gnc-tree-view.c.

{
    GtkTreeViewColumn *column, *found = NULL;
    GList *column_list, *tmp;
    const gchar *name;
 
    // ENTER("view %p, wanted %s", view, wanted);
    column_list = gtk_tree_view_get_columns(GTK_TREE_VIEW(view));
    for (tmp = column_list; tmp; tmp = g_list_next (tmp))
    {
        column = tmp->data;
        name = g_object_get_data (G_OBJECT(column), PREF_NAME);
        if (!name || (strcmp(name, wanted) != 0))
            continue;
        found = column;
        break;
    }
    g_list_free (column_list);
 
    // LEAVE("column %p", found);
    return found;
}

gnc_tree_view_get_show_column_menu()

gboolean gnc_tree_view_get_show_column_menu

(

GncTreeView *

view

)

This function is called to get the current value of the "show-column-menu" property.

It returns the same value passed to gnc_tree_view_set_show_menu_column().

Parameters

view	The tree view.

Returns

Whether or not the column selection menu should be shown.

It returns the same value passed to gnc_tree_view_set_show_menu_column().

Parameters are defined in gnc-tree-view.h

Definition at line 1562 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
 
    g_return_val_if_fail (GNC_IS_TREE_VIEW(view), FALSE);
 
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
    return (priv->show_column_menu);
}

gnc_tree_view_get_state_section()

const gchar * gnc_tree_view_get_state_section

(

GncTreeView *

view

)

This function is called to get the current association between a saved state section and the display of a view.

It returns the same value passed to gnc_tree_view_set_state_section().

Parameters

view	The tree view.

Returns

The current state section.

This function is called to get the current association between a saved state section and the display of a view.

It returns the same value passed to gnc_tree_view_set_state_section(); i.e. a string like "dialogs/edit_prices".

Parameters are defined in gnc-tree-view.h

Definition at line 1124 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
 
    g_return_val_if_fail (GNC_IS_TREE_VIEW(view), NULL);
 
    priv = GNC_TREE_VIEW_GET_PRIVATE (view);
    return priv->state_section;
}

gnc_tree_view_keynav()

void gnc_tree_view_keynav	(	GncTreeView *	view,
		GtkTreeViewColumn **	col,
		GtkTreePath *	path,
		GdkEventKey *	event
	)

Definition at line 2162 of file gnc-tree-view.c.

{
    GtkTreeView *tv = GTK_TREE_VIEW(view);
    gint depth;
    gboolean shifted;
 
    if (event->type != GDK_KEY_PRESS) return;
 
    switch (event->keyval)
    {
    case GDK_KEY_Tab:
    case GDK_KEY_ISO_Left_Tab:
    case GDK_KEY_KP_Tab:
        shifted = event->state & GDK_SHIFT_MASK;
        if (get_column_next_to (tv, col, shifted))
        {
            /* This is the end (or beginning) of the line, buddy. */
            depth = gtk_tree_path_get_depth (path);
            if (shifted)
            {
                if (!gtk_tree_path_prev (path) && depth > 1)
                {
                    gtk_tree_path_up (path);
                }
            }
            else if (gtk_tree_view_row_expanded (tv, path))
            {
                gtk_tree_path_down (path);
            }
            else
            {
                gtk_tree_path_next (path);
                if (!gnc_tree_view_path_is_valid (view, path) && depth > 2)
                {
                    gtk_tree_path_prev (path);
                    gtk_tree_path_up (path);
                    gtk_tree_path_next (path);
                }
                if (!gnc_tree_view_path_is_valid (view, path) && depth > 1)
                {
                    gtk_tree_path_prev (path);
                    gtk_tree_path_up (path);
                    gtk_tree_path_next (path);
                }
            }
        }
        break;
 
    case GDK_KEY_Return:
    case GDK_KEY_KP_Enter:
        if (gtk_tree_view_row_expanded (tv, path))
        {
            gtk_tree_path_down (path);
        }
        else
        {
            depth = gtk_tree_path_get_depth (path);
            gtk_tree_path_next (path);
            if (!gnc_tree_view_path_is_valid (view, path) && depth > 1)
            {
                gtk_tree_path_prev (path);
                gtk_tree_path_up (path);
                gtk_tree_path_next (path);
            }
        }
        break;
    }
    return;
}

gnc_tree_view_path_is_valid()

gboolean gnc_tree_view_path_is_valid	(	GncTreeView *	view,
		GtkTreePath *	path
	)

Definition at line 2151 of file gnc-tree-view.c.

{
    GtkTreeView *tv = GTK_TREE_VIEW(view);
    GtkTreeModel *s_model;
    GtkTreeIter iter;
 
    s_model = gtk_tree_view_get_model (tv);
    return gtk_tree_model_get_iter (s_model, &iter, path);
}

gnc_tree_view_remove_state_information()

void gnc_tree_view_remove_state_information

(

GncTreeView *

view

)

This function is called to completely wipe the treeview's state information (column visibility, width, sorting order,..).

This function may be called at any time; either when the user wants to disconnect or when the view object is being destroyed.

Parameters

view	The tree view.

This function is called to completely wipe the treeview's state information (column visibility, width, sorting order,..).

This function may be called at any time; either when the user wants to disconnect or when the view object is being destroyed.

Parameters

view	The tree view.

Definition at line 982 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
    GKeyFile *state_file = gnc_state_get_current ();
 
    ENTER(" ");
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
    if (!priv->state_section)
    {
        LEAVE("no state section");
        return;
    }
 
    g_key_file_remove_group (state_file, priv->state_section, NULL);
    g_free (priv->state_section);
    priv->state_section = NULL;
    LEAVE(" ");
}

gnc_tree_view_save_state()

void gnc_tree_view_save_state

(

GncTreeView *

view

)

This function is called to write the treeview's state information (column visibility, width, sorting order,..) to the state file.

Parameters

view	The tree view.

Definition at line 1134 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
 
    ENTER("view %p", view);
    g_return_if_fail (view != NULL);
    g_return_if_fail (GNC_IS_TREE_VIEW(view));
 
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
 
    if (priv->state_section)
    {
        /* Save state. Only store non-default values when possible. */
        GList *column_list, *tmp;
        GKeyFile *state_file = gnc_state_get_current();
        gsize num_cols = 0;
        gchar *sort_column = gnc_tree_view_get_sort_column (view);
        gchar *sort_order = gnc_tree_view_get_sort_order (view);
        gchar **col_order = gnc_tree_view_get_column_order (view, &num_cols);
 
        /* Default sort column is the name column */
        if (sort_column && (g_strcmp0 (sort_column, "name") != 0))
            g_key_file_set_string (state_file, priv->state_section, STATE_KEY_SORT_COLUMN, sort_column);
        else if (g_key_file_has_key (state_file, priv->state_section, STATE_KEY_SORT_COLUMN, NULL))
            g_key_file_remove_key (state_file, priv->state_section, STATE_KEY_SORT_COLUMN, NULL);
        g_free (sort_column);
 
 
        /* Default sort order is "ascending" */
        if (g_strcmp0 (sort_order, "descending") == 0)
            g_key_file_set_string (state_file, priv->state_section, STATE_KEY_SORT_ORDER, sort_order);
        else if (g_key_file_has_key (state_file, priv->state_section, STATE_KEY_SORT_ORDER, NULL))
            g_key_file_remove_key (state_file, priv->state_section, STATE_KEY_SORT_ORDER, NULL);
        g_free (sort_order);
 
        if (col_order && (num_cols > 0))
            g_key_file_set_string_list (state_file, priv->state_section, STATE_KEY_COLUMN_ORDER,
                                        (const gchar**) col_order, num_cols);
        else if (g_key_file_has_key (state_file, priv->state_section, STATE_KEY_COLUMN_ORDER, NULL))
            g_key_file_remove_key (state_file, priv->state_section, STATE_KEY_COLUMN_ORDER, NULL);
 
        g_strfreev (col_order);
 
 
        // ENTER("view %p, wanted %s", view, wanted);
        column_list = gtk_tree_view_get_columns (GTK_TREE_VIEW(view));
        for (tmp = column_list; tmp; tmp = g_list_next (tmp))
        {
            GtkTreeViewColumn *column = tmp->data;
            gchar *key=NULL;
            const gchar *name = g_object_get_data (G_OBJECT(column), PREF_NAME);
            if (!name)
                continue;
 
            if (!g_object_get_data (G_OBJECT(column), ALWAYS_VISIBLE))
            {
                key = g_strjoin ("_", name, STATE_KEY_SUFF_VISIBLE, NULL);
                g_key_file_set_boolean (state_file, priv->state_section, key,
                                        gtk_tree_view_column_get_visible (column));
                g_free (key);
            }
 
            key = g_strjoin ("_", name, STATE_KEY_SUFF_WIDTH, NULL);
            if (g_object_get_data (G_OBJECT(column), "default-width") &&
                (GPOINTER_TO_INT((g_object_get_data (G_OBJECT(column), "default-width")))
                    != gtk_tree_view_column_get_width (column)))
            {
                g_key_file_set_integer (state_file, priv->state_section, key,
                                        gtk_tree_view_column_get_width (column));
            }
            else if (g_key_file_has_key (state_file, priv->state_section, key, NULL))
                g_key_file_remove_key (state_file, priv->state_section, key, NULL);
            g_free (key);
        }
        g_list_free (column_list);
    }
 
    LEAVE(" ");
}

gnc_tree_view_set_control_column_background()

void gnc_tree_view_set_control_column_background	(	GncTreeView *	view,
		gint	column,
		GtkTreeCellDataFunc	func
	)

This function links the cell backgrounds of the two control columns to a column in the model that has color strings or a cell data function that sets the "cell-background" property.

Parameters

view	The tree view.
column	The column in the model containing color strings.
func	This is a cell data function that sets the "cell-background".

Definition at line 1502 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
 
    g_return_if_fail (GNC_IS_TREE_VIEW(view));
 
    ENTER("view %p, column %d, func %p", view, column, func);
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
 
    update_control_cell_renderers_background (view, priv->column_menu_column, column, func);
 
    LEAVE(" ");
}

gnc_tree_view_set_editing_finished_cb()

void gnc_tree_view_set_editing_finished_cb	(	GncTreeView *	view,
		GFunc	editing_finished_cb,
		gpointer	editing_cb_data
	)

Setup a callback for when the user finishes editing so appropriate actions can be taken like enable the actions delete menu option.

Definition at line 2248 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
 
    if (!view && !editing_finished_cb)
        return;
 
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
 
    priv->editing_finished_cb = editing_finished_cb;
    priv->editing_cb_data = editing_cb_data;
}

gnc_tree_view_set_editing_started_cb()

void gnc_tree_view_set_editing_started_cb	(	GncTreeView *	view,
		GFunc	editing_started_cb,
		gpointer	editing_cb_data
	)

Setup a callback for when the user starts editing so appropriate actions can be taken like disable the actions delete menu option.

Definition at line 2234 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
 
    if (!view && !editing_started_cb)
        return;
 
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
 
    priv->editing_started_cb = editing_started_cb;
    priv->editing_cb_data = editing_cb_data;
}

gnc_tree_view_set_show_column_menu()

void gnc_tree_view_set_show_column_menu	(	GncTreeView *	view,
		gboolean	visible
	)

This function is called to set the "show-column-menu" property on this view.

This function has no visible effect if the "state-section" property has not been set.

Parameters

view	The tree view.
visible	Create the column selection menu if TRUE.

This function has no visible effect if the "state-section" property has not been set.

Parameters are defined in gnc-tree-view.h

Definition at line 1541 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
 
    g_return_if_fail (GNC_IS_TREE_VIEW(view));
 
    ENTER("view %p, show menu %d", view, visible);
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
    priv->show_column_menu = visible;
    gnc_tree_view_build_column_menu (view);
    LEAVE(" ");
}

gnc_tree_view_set_sort_user_data()

void gnc_tree_view_set_sort_user_data	(	GncTreeView *	view,
		GtkTreeModel *	s_model
	)

This allows the columns to be setup without the model connected.

Parameters

view	The tree view.
sort	model.

Definition at line 1520 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
 
    g_return_if_fail (GNC_IS_TREE_VIEW(view));
 
    ENTER("view %p, sort_model %p", view, s_model);
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
 
    priv->sort_model = s_model;
    LEAVE(" ");
}

gnc_tree_view_set_state_section()

void gnc_tree_view_set_state_section	(	GncTreeView *	view,
		const gchar *	section
	)

This function is called to set up or remove an association between a saved state section and the display of a view.

It will first remove any existing association, and then install the new one.

Note

This function currently marks the first column as autosized and all other columns as fixed size. This may change in the future. It must change if we want to take advantage of the "fixed row height" performance enhancements added to GtkTreeView in gtk-2.4

Parameters

view	The tree view.
section	Link the view to this saved state section. Use NULL to disconnect saved state association.

This function is called to set up or remove an association between a saved state section and the display of a view.

It will first remove any existing association, and then install the new one. If the new section has state information, update the view with this information.

Parameters are defined in gnc-tree-view.h

Definition at line 1009 of file gnc-tree-view.c.

{
    GncTreeViewPrivate *priv;
    GKeyFile *state_file;
 
    g_return_if_fail (GNC_IS_TREE_VIEW(view));
 
    ENTER("view %p, section %s", view, section);
 
    priv = GNC_TREE_VIEW_GET_PRIVATE(view);
 
    /* Drop any previous state section */
    if (priv->state_section)
        gnc_tree_view_remove_state_information (view);
 
    if (!section)
    {
        LEAVE("cleared state section");
        return;
    }
 
    /* Catch changes in state. Propagate to view. */
    priv->state_section = g_strdup (section);
 
    state_file = gnc_state_get_current ();
    if (g_key_file_has_group (state_file, priv->state_section))
    {
        gsize num_keys, idx;
        gchar **keys = g_key_file_get_keys (state_file, priv->state_section, &num_keys, NULL);
        for (idx = 0; idx < num_keys; idx++)
        {
            gchar *key = keys[idx];
            if (g_strcmp0 (key, STATE_KEY_SORT_COLUMN) == 0)
            {
                gchar *name = g_key_file_get_string (state_file, priv->state_section,
                                                     key, NULL);
                gnc_tree_view_set_sort_column (view, name);
                g_free (name);
            }
            else if (g_strcmp0 (key, STATE_KEY_SORT_ORDER) == 0)
            {
                gchar *name = g_key_file_get_string (state_file, priv->state_section,
                                                     key, NULL);
                gnc_tree_view_set_sort_order (view, name);
                g_free (name);
            }
            else if (g_strcmp0 (key, STATE_KEY_COLUMN_ORDER) == 0)
            {
                gsize length;
                gchar **columns = g_key_file_get_string_list (state_file, priv->state_section,
                                                              key, &length, NULL);
                gnc_tree_view_set_column_order (view, columns, length);
                g_strfreev (columns);
            }
            else
            {
                /* Make a copy of the local part of the key so it can be split
                 * into column name and key type */
                gboolean known = FALSE;
                gchar *column_name = g_strdup (key);
                gchar *type_name = g_strrstr (column_name, "_");
 
                if (type_name != NULL) //guard against not finding '_'
                {
                    *type_name++ = '\0';
 
                    if (g_strcmp0 (type_name, STATE_KEY_SUFF_VISIBLE) == 0)
                    {
                        GtkTreeViewColumn *column = gnc_tree_view_find_column_by_name (view, column_name);
                        if (column)
                        {
                            known = TRUE;
                            if (!g_object_get_data (G_OBJECT (column), ALWAYS_VISIBLE))
                            {
                                gtk_tree_view_column_set_visible (column,
                                                                  g_key_file_get_boolean (state_file, priv->state_section, key, NULL));
                            }
                        }
                    }
                    else if (g_strcmp0 (type_name, STATE_KEY_SUFF_WIDTH) == 0)
                    {
                        gint width = g_key_file_get_integer (state_file, priv->state_section, key, NULL);
                        GtkTreeViewColumn *column = gnc_tree_view_find_column_by_name (view, column_name);
                        if (column)
                        {
                            known = TRUE;
                            if (width && (width != gtk_tree_view_column_get_width (column)))
                            {
                                gtk_tree_view_column_set_fixed_width (column, width);
                            }
                        }
                    }
                    if (!known)
                        DEBUG ("Ignored key %s", key);
 
                    g_free (column_name);
                }
            }
        }
        g_strfreev (keys);
    }
 
    /* Rebuild the column visibility menu */
    gnc_tree_view_build_column_menu (view);
    LEAVE ("set state section");
}

gnc_tree_view_sx_list_get_sx_from_path()

SchedXaction * gnc_tree_view_sx_list_get_sx_from_path	(	GncTreeViewSxList *	view,
		GtkTreePath *	path
	)

Definition at line 242 of file gnc-tree-view-sx-list.c.

{
    GtkTreeIter iter;
    gtk_tree_model_get_iter (GTK_TREE_MODEL(view->tree_model), &iter, path);
    return gnc_sx_list_tree_model_adapter_get_sx_instances(
               GNC_SX_LIST_TREE_MODEL_ADAPTER(view->tree_model), &iter)->sx;
}

gnc_ui_close_book()

void gnc_ui_close_book	(	QofBook *	book,
		GtkWindow *	parent
	)

Create and run the dialog to close the book.

Parameters

book	This parameter specifies the book whose data will be closed.
parent	This parameter specifies the parent window

Definition at line 318 of file dialog-book-close.c.

{
    struct CloseBookWindow *cbw;
    GtkBuilder* builder;
    GtkWidget* box;
    GList* equity_list = NULL;
 
    g_return_if_fail(book);
 
    cbw = g_new0(struct CloseBookWindow, 1);
    g_return_if_fail(cbw);
    cbw->book = book;
 
    /* Open the dialog */
    builder = gtk_builder_new();
    gnc_builder_add_from_file (builder, "dialog-book-close.glade", "close_book_dialog");
    cbw->dialog = GTK_WIDGET(gtk_builder_get_object (builder,  "close_book_dialog"));
 
    // Set the name for this dialog so it can be easily manipulated with css
    gtk_widget_set_name (GTK_WIDGET(cbw->dialog), "gnc-id-book-close");
 
    /* parent */
    if (parent != NULL)
        gtk_window_set_transient_for (GTK_WINDOW(cbw->dialog), GTK_WINDOW(parent));
 
    PINFO("Closed Book Window is %p, Dialog is %p", cbw, cbw->dialog);
 
    /* close date */
    box = GTK_WIDGET(gtk_builder_get_object (builder,  "date_box"));
    cbw->close_date_widget = gnc_date_edit_new(gnc_time (NULL), FALSE, FALSE);
    gtk_box_pack_start(GTK_BOX(box), cbw->close_date_widget, TRUE, TRUE, 0);
 
    /* income acct */
    equity_list = g_list_prepend(equity_list, GINT_TO_POINTER(ACCT_TYPE_EQUITY));
    box = GTK_WIDGET(gtk_builder_get_object (builder, "income_acct_box"));
    cbw->income_acct_widget = gnc_account_sel_new();
    gnc_account_sel_set_acct_filters(GNC_ACCOUNT_SEL(cbw->income_acct_widget),
                                     equity_list, NULL);
    gnc_account_sel_set_new_account_ability(GNC_ACCOUNT_SEL(cbw->income_acct_widget), TRUE);
    gtk_box_pack_start(GTK_BOX(box), cbw->income_acct_widget, TRUE, TRUE, 0);
 
    /* expense acct */
    box = GTK_WIDGET(gtk_builder_get_object (builder, "expense_acct_box"));
    cbw->expense_acct_widget = gnc_account_sel_new();
    gnc_account_sel_set_acct_filters(GNC_ACCOUNT_SEL(cbw->expense_acct_widget),
                                     equity_list, NULL);
    gnc_account_sel_set_new_account_ability(GNC_ACCOUNT_SEL(cbw->expense_acct_widget), TRUE);
    gtk_box_pack_start(GTK_BOX(box), cbw->expense_acct_widget, TRUE, TRUE, 0);
 
    /* desc */
    cbw->desc_widget = GTK_WIDGET(gtk_builder_get_object (builder, "desc_entry"));
 
    /* Autoconnect signals */
    gtk_builder_connect_signals_full (builder, gnc_builder_connect_full_func, cbw->dialog);
 
    /* Register dialog with component manager */
    cbw->component_manager_id =
        gnc_register_gui_component(DIALOG_BOOK_CLOSE_CM_CLASS, NULL, close_handler,
                                   cbw->dialog);
    gnc_gui_component_set_session(cbw->component_manager_id,
                                  gnc_get_current_session());
    g_signal_connect(cbw->dialog, "destroy", G_CALLBACK(destroy_cb), NULL);
 
    /* Clean up the data structure when the dialog is destroyed */
    g_object_set_data_full(G_OBJECT(cbw->dialog), "CloseBookWindow", cbw, g_free);
 
    g_object_unref(G_OBJECT(builder));
 
    /* Run the dialog */
    gtk_widget_show_all(cbw->dialog);
 
    g_list_free(equity_list);
}

gnc_ui_file_access_for_export()

void gnc_ui_file_access_for_export

(

GtkWindow *

parent

)

Definition at line 515 of file dialog-file-access.c.

{
    gnc_ui_file_access (parent, FILE_ACCESS_EXPORT);
}

gnc_ui_file_access_for_open()

void gnc_ui_file_access_for_open

(

GtkWindow *

parent

)

Definition at line 501 of file dialog-file-access.c.

{
    gnc_ui_file_access (parent, FILE_ACCESS_OPEN);
}

gnc_ui_file_access_for_save_as()

void gnc_ui_file_access_for_save_as

(

GtkWindow *

parent

)

Definition at line 508 of file dialog-file-access.c.

{
    gnc_ui_file_access (parent, FILE_ACCESS_SAVE_AS);
}

gnc_ui_object_references_show()

void gnc_ui_object_references_show	(	const gchar *	explanation,
		GList *	objlist
	)

Definition at line 38 of file dialog-object-references.c.

{
    GtkWidget* dialog;
    GtkBuilder* builder;
    GtkWidget* box;
    GList* node;
    GtkLabel* explanation;
    GtkListStore* store;
    GtkWidget* listview;
    GtkTreeViewColumn* column;
    GtkCellRenderer* renderer;
 
    ENTER("");
 
    /* Open the dialog */
    builder = gtk_builder_new();
    gnc_builder_add_from_file (builder, "dialog-object-references.glade", "object_references_dialog" );
    dialog = GTK_WIDGET(gtk_builder_get_object (builder, "object_references_dialog" ));
 
    // Set the name for this dialog so it can be easily manipulated with css
    gtk_widget_set_name (GTK_WIDGET(dialog), "gnc-id-object-reference");
 
    explanation = GTK_LABEL(gtk_builder_get_object (builder, "lbl_explanation" ));
    gtk_label_set_text( explanation, explanation_text );
 
    /* Set up the list store */
    store = gtk_list_store_new( 1, G_TYPE_STRING );
    for ( node = objlist; node != NULL; node = node->next )
    {
        QofInstance* inst = node->data;
        GtkTreeIter iter;
 
        gtk_list_store_append( store, &iter );
        gtk_list_store_set( store, &iter, 0, qof_instance_get_display_name( inst ), -1 );
    }
 
    /* Set up the list view */
    listview = gtk_tree_view_new_with_model( GTK_TREE_MODEL(store) );
    renderer = gtk_cell_renderer_text_new();
    column = gtk_tree_view_column_new_with_attributes( "Object", renderer, "text", 0, NULL );
    gtk_tree_view_append_column( GTK_TREE_VIEW(listview), column );
 
    box = GTK_WIDGET(gtk_builder_get_object (builder, "hbox_list" ));
    gtk_container_add( GTK_CONTAINER(box), listview );
 
    /* Autoconnect signals */
    gtk_builder_connect_signals_full (builder, gnc_builder_connect_full_func, dialog);
 
    /* Run the dialog */
    gtk_widget_show_all( dialog );
    gtk_dialog_run( GTK_DIALOG(dialog) );
    g_object_unref(G_OBJECT(builder));
    g_object_unref (store);
    gtk_widget_destroy( dialog );
 
    LEAVE("");
}

GncOptionsDialog() [1/2]

GncOptionsDialog::GncOptionsDialog	(	bool	modal,
		const char *	title,
		const char *	component_class,
		GtkWindow *	parent
	)

Constructs a GncOptionsDialog.

Based on the description in the GtkBuilder file. Initializes signals. Two component classes might be used, DIALOG_BOOK_OPTIONS_CM_CLASS or DIALOG_OPTIONS_CM_CLASS of which the latter is the default.

Parameters

modal	If true the "Apply" button is hidden. It doesn't make the dialog run in its own event loop so it's not truly modal.
title	The title that will appear in the dialog's title bar.
component_class	For registering the dialog in the component manager.
parent	The widget for which the dialog will be transient-for.

Definition at line 534 of file dialog-options.cpp.

                                              :
    m_component_class{component_class ? component_class : DIALOG_OPTIONS_CM_CLASS}
{
    auto builder = gtk_builder_new();
    gnc_builder_add_from_file (builder, "dialog-options.glade", "gnucash_options_window");
    m_window = GTK_WIDGET(gtk_builder_get_object (builder, "gnucash_options_window"));
    g_object_ref(m_window);
    m_page_list = GTK_WIDGET(gtk_builder_get_object (builder, "page_list_scroll"));
    g_object_set_data(G_OBJECT(m_window), "optionwin", this);
 
    // Set the name for this dialog so it can be easily manipulated with css
    gtk_widget_set_name (GTK_WIDGET(m_window), "gnc-id-options");
 
    /* Page List */
 
    m_page_list_view = GTK_WIDGET(gtk_builder_get_object (builder, "page_list_treeview"));
 
    auto view = GTK_TREE_VIEW(m_page_list_view);
 
    auto store = gtk_list_store_new(NUM_COLUMNS, G_TYPE_INT, G_TYPE_STRING);
    gtk_tree_view_set_model(view, GTK_TREE_MODEL(store));
    g_object_unref(store);
 
    auto renderer = gtk_cell_renderer_text_new();
    auto column =
        gtk_tree_view_column_new_with_attributes(_("Page"), renderer,
                                                 "text", PAGE_NAME,
                                                 nullptr);
    gtk_tree_view_append_column(view, column);
 
    gtk_tree_view_column_set_alignment(column, 0.5);
 
    auto selection = gtk_tree_view_get_selection(view);
    gtk_tree_selection_set_mode(selection, GTK_SELECTION_BROWSE);
    g_signal_connect (selection, "changed",
                      G_CALLBACK (dialog_list_select_cb), this);
 
    m_help_button = GTK_BUTTON(gtk_builder_get_object (builder, "helpbutton"));
    g_signal_connect(m_help_button, "clicked",
                     G_CALLBACK(dialog_help_button_cb), this);
    m_cancel_button = GTK_BUTTON(gtk_builder_get_object (builder, "cancelbutton"));
    g_signal_connect(m_cancel_button, "clicked",
                     G_CALLBACK(dialog_cancel_button_cb), this);
    m_apply_button = GTK_BUTTON(gtk_builder_get_object (builder, "applybutton"));
    g_signal_connect(m_apply_button, "clicked",
                     G_CALLBACK(dialog_apply_button_cb), this);
    m_ok_button = GTK_BUTTON(gtk_builder_get_object (builder, "okbutton"));
    g_signal_connect(m_ok_button, "clicked",
                     G_CALLBACK(dialog_ok_button_cb), this);
 
    gtk_builder_connect_signals_full (builder, gnc_builder_connect_full_func,
                                      this);
 
    // when added to a page of the hierarchy assistant there will be no parent
    if (parent)
        gnc_restore_window_size (GNC_PREFS_GROUP, GTK_WINDOW(m_window),
                                 parent);
 
    if (title)
        gtk_window_set_title(GTK_WINDOW(m_window), title);
 
    /* modal */
    if (modal)
        gtk_widget_hide (GTK_WIDGET(m_apply_button));
 
    /* glade doesn't support a notebook with zero pages */
    auto hbox = GTK_WIDGET(gtk_builder_get_object (builder,
                                                   "notebook_placeholder"));
    m_notebook = gtk_notebook_new();
 
    gtk_widget_set_vexpand (m_notebook, TRUE);
 
    gtk_widget_show(m_notebook);
    gtk_box_pack_start(GTK_BOX(hbox), m_notebook, TRUE, TRUE, 5);
 
    auto component_id = gnc_register_gui_component (m_component_class,
                                                    nullptr,
                                                    component_close_handler,
                                                    this);
    gnc_gui_component_set_session (component_id, gnc_get_current_session());
 
    g_signal_connect (m_window, "destroy", G_CALLBACK(dialog_destroy_cb), this);
 
    g_signal_connect (m_window, "key_press_event",
                      G_CALLBACK(dialog_window_key_press_cb), this);
 
    g_object_unref(G_OBJECT(builder));
}

GncOptionsDialog() [2/2]

GncOptionsDialog::GncOptionsDialog ( const char *  title, GtkWindow *  parent  )

inline

Definition at line 74 of file dialog-options.hpp.

                                                           :
        GncOptionsDialog(false, title, nullptr, parent) {}

set_apply_cb()

void GncOptionsDialog::set_apply_cb ( GncOptionsDialogCallback  , void *  cb_data  )

noexcept

Definition at line 644 of file dialog-options.cpp.

{
    m_apply_cb = cb;
    m_apply_cb_data = data;
}

set_book_help_cb()

void GncOptionsDialog::set_book_help_cb ( )

noexcept

Definition at line 672 of file dialog-options.cpp.

{
    set_help_cb((GncOptionsDialogCallback)gnc_book_options_help_cb, nullptr);
}

set_close_cb()

void GncOptionsDialog::set_close_cb ( GncOptionsDialogCallback  , void *  cb_data  )

noexcept

Definition at line 658 of file dialog-options.cpp.

{
    m_close_cb = cb;
    m_close_cb_data = data;
}

set_help_cb()

void GncOptionsDialog::set_help_cb ( GncOptionsDialogCallback  , void *  cb_data  )

noexcept

Definition at line 651 of file dialog-options.cpp.

{
    m_help_cb = cb;
    m_help_cb_data = data;
}

set_sensitive()

void GncOptionsDialog::set_sensitive ( bool  sensitive )

noexcept

Definition at line 109 of file dialog-options.cpp.

{
    gtk_widget_set_sensitive (GTK_WIDGET(m_apply_button), sensitive);
    gtk_widget_set_sensitive (GTK_WIDGET(m_ok_button), sensitive);
    gtk_button_set_label (m_cancel_button,
                          sensitive ? _("_Cancel") : _("_Close"));
}

set_style_sheet_help_cb()

void GncOptionsDialog::set_style_sheet_help_cb ( )

noexcept

Definition at line 684 of file dialog-options.cpp.

{
    set_help_cb ((GncOptionsDialogCallback)gnc_style_sheet_options_help_cb,
                 nullptr);
}

~GncOptionsDialog()

GncOptionsDialog::~GncOptionsDialog

(

)

Definition at line 625 of file dialog-options.cpp.

{
    if (m_destroying)
        return;
    m_destroying = true;
    gnc_unregister_gui_component_by_data(m_component_class, this);
    g_signal_handlers_disconnect_by_func(m_window, (gpointer)dialog_destroy_cb, this);
    g_signal_handlers_disconnect_by_func(m_window, (gpointer)dialog_window_key_press_cb, this);
    m_option_db->foreach_section([](GncOptionSectionPtr& section)
    {
        section->foreach_option([](GncOption& option)
        {
            option.set_ui_item(std::unique_ptr<GncOptionUIItem>(nullptr));
        });
    });
    g_object_unref(m_window);
}

Variable Documentation

end_strings

const gchar* end_strings[GNC_ACCOUNTING_PERIOD_LAST]

Initial value:

=
{
    
    N_("Today"),
    N_("End of this month"),
    N_("End of previous month"),
    N_("End of this quarter"),
    N_("End of previous quarter"),
    N_("End of this year"),
    N_("End of previous year"),
 
    
    N_("End of this accounting period"),
    N_("End of previous accounting period"),
}

Definition at line 78 of file gnc-period-select.c.

{
    /* CY (current year) Strings */
    N_("Today"),
    N_("End of this month"),
    N_("End of previous month"),
    N_("End of this quarter"),
    N_("End of previous quarter"),
    N_("End of this year"),
    N_("End of previous year"),
 
    /* FY (fiscal year) Strings */
    N_("End of this accounting period"),
    N_("End of previous accounting period"),
};

start_strings

const gchar* start_strings[GNC_ACCOUNTING_PERIOD_LAST]

Initial value:

=
{
    
    N_("Today"),
    N_("Start of this month"),
    N_("Start of previous month"),
    N_("Start of this quarter"),
    N_("Start of previous quarter"),
    N_("Start of this year"),
    N_("Start of previous year"),
 
    
    N_("Start of this accounting period"),
    N_("Start of previous accounting period"),
}

Definition at line 62 of file gnc-period-select.c.

{
    /* CY (current year) Strings */
    N_("Today"),
    N_("Start of this month"),
    N_("Start of previous month"),
    N_("Start of this quarter"),
    N_("Start of previous quarter"),
    N_("Start of this year"),
    N_("Start of previous year"),
 
    /* FY (fiscal year) Strings */
    N_("Start of this accounting period"),
    N_("Start of previous accounting period"),
};