Main Window functions.

Files
file	gnc-main-window.h
	Functions for adding content to a window.

Data Structures
struct	GncMainWindowPrivate
	The instance private data structure for an embedded window object. More...
struct	GncMainWindowSaveData
struct	menu_update
	This data structure is used to describe the requested state of a GAction, and is used to pass data among several functions. More...
struct	TabWidth
	This data structure allows the passing of the tab width and whether the tab layout is on the left or right. More...
struct	GncMenuUpdate
struct	GncMainWindow
	The instance data structure for a main window object. More...
struct	GncMainWindowClass
	The class data structure for a main window object. More...
struct	GncMainWindowActionData
struct	GncToolBarShortNames
	A structure for defining alternate action names for use in the toolbar. More...

Macros
#define	PLUGIN_PAGE_LABEL   "plugin-page"
	This label is used to provide a mapping from a visible page widget back to the corresponding GncPluginPage object. More...
#define	PLUGIN_PAGE_CLOSE_BUTTON   "close-button"
#define	PLUGIN_PAGE_TAB_LABEL   "label"
#define	GNC_PREF_SHOW_CLOSE_BUTTON   "tab-close-buttons"
#define	GNC_PREF_TAB_NEXT_RECENT   "tab-next-recent"
#define	GNC_PREF_TAB_POSITION_TOP   "tab-position-top"
#define	GNC_PREF_TAB_POSITION_BOTTOM   "tab-position-bottom"
#define	GNC_PREF_TAB_POSITION_LEFT   "tab-position-left"
#define	GNC_PREF_TAB_POSITION_RIGHT   "tab-position-right"
#define	GNC_PREF_TAB_WIDTH   "tab-width"
#define	GNC_PREF_TAB_COLOR   "show-account-color-tabs"
#define	GNC_PREF_SAVE_CLOSE_EXPIRES   "save-on-close-expires"
#define	GNC_PREF_SAVE_CLOSE_WAIT_TIME   "save-on-close-wait-time"
#define	GNC_PREF_TAB_OPEN_ADJACENT   "tab-open-adjacent"
#define	GNC_MAIN_WINDOW_NAME   "GncMainWindow"
#define	DIALOG_BOOK_OPTIONS_CM_CLASS   "dialog-book-options"
#define	MSG_AUTO_SAVE   _("Changes will be saved automatically in %u seconds")
#define	WINDOW_COUNT   "WindowCount"
#define	WINDOW_STRING   "Window %d"
#define	WINDOW_GEOMETRY   "WindowGeometry"
#define	WINDOW_POSITION   "WindowPosition"
#define	WINDOW_MAXIMIZED   "WindowMaximized"
#define	TOOLBAR_VISIBLE   "ToolbarVisible"
#define	STATUSBAR_VISIBLE   "StatusbarVisible"
#define	SUMMARYBAR_VISIBLE   "SummarybarVisible"
#define	WINDOW_FIRSTPAGE   "FirstPage"
#define	WINDOW_PAGECOUNT   "PageCount"
#define	WINDOW_PAGEORDER   "PageOrder"
#define	PAGE_TYPE   "PageType"
#define	PAGE_NAME   "PageName"
#define	PAGE_STRING   "Page %d"
#define	GNC_TYPE_MAIN_WINDOW   (gnc_main_window_get_type ())
#define	GNC_MAIN_WINDOW(obj)   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_MAIN_WINDOW, GncMainWindow))
#define	GNC_MAIN_WINDOW_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_MAIN_WINDOW, GncMainWindowClass))
#define	GNC_IS_MAIN_WINDOW(obj)   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GNC_TYPE_MAIN_WINDOW))
#define	GNC_IS_MAIN_WINDOW_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_MAIN_WINDOW))
#define	GNC_MAIN_WINDOW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_TYPE_MAIN_WINDOW, GncMainWindowClass))
#define	PLUGIN_PAGE_IMMUTABLE   "page-immutable"

Typedefs
typedef void(*	GncMainWindowFunc) (GncMainWindow *window, GncPluginPage *page)
typedef void(*	GncMainWindowPageFunc) (GncPluginPage *page, gpointer user_data)

Enumerations
enum	{ PAGE_ADDED, PAGE_CHANGED, MENU_CHANGED, LAST_SIGNAL }
	Names of signals generated by the main window. More...

Functions
gboolean	gnc_book_options_dialog_apply_helper (GncOptionDB *options)
	Processes selected options in the Book Options dialog: checks book_currency and use_split_action_for_num to see if features kvp should be set. More...
	G_DEFINE_TYPE_WITH_CODE (GncMainWindow, gnc_main_window, GTK_TYPE_APPLICATION_WINDOW, G_IMPLEMENT_INTERFACE(GNC_TYPE_WINDOW, gnc_window_main_window_init)) static guint main_window_signals[LAST_SIGNAL]
	A holding place for all the signals generated by the main window code. More...
gboolean	gnc_main_window_is_restoring_pages (GncMainWindow *window)
	Check if the main window is restoring the plugin pages. More...
void	gnc_main_window_foreach_page (GncMainWindowPageFunc fn, gpointer user_data)
	Iterator function to walk all pages in all windows, calling the specified function for each page. More...
void	gnc_main_window_restore_all_windows (const GKeyFile *keyfile)
	Restore the persistent state of all windows. More...
void	gnc_main_window_restore_default_state (GncMainWindow *window)
	Restore the persistent state of one window to a sane default.
void	gnc_main_window_save_all_windows (GKeyFile *keyfile)
	Save the persistent state of all windows. More...
gboolean	gnc_main_window_finish_pending (GncMainWindow *window)
	Tell a window to finish any outstanding activities. More...
gboolean	gnc_main_window_all_finish_pending (void)
	Tell all pages in all windows to finish any outstanding activities. More...
void	main_window_update_page_long_name (GncPluginPage *page, const gchar *long_name_in)
	Update the long name of the page in the main window. More...
void	main_window_update_page_name (GncPluginPage *page, const gchar *name_in)
	Update the name of the page in the main window. More...
void	main_window_update_page_color (GncPluginPage *page, const gchar *color_in)
	Update the color on the page tabs in the main window. More...
void	main_window_update_page_set_read_only_icon (GncPluginPage *page, gboolean read_only)
	Update the icon on the page tabs in the main window. More...
GncMainWindow *	gnc_main_window_new (void)
	Create a new gnc main window plugin. More...
void	gnc_main_window_display_page (GncPluginPage *page)
	Bring the window containing the specified page to the top of the window stack, then switch the notebook to show the specified page. More...
void	gnc_main_window_open_page (GncMainWindow *window, GncPluginPage *page)
	Display a data plugin page in a window. More...
void	gnc_main_window_close_page (GncPluginPage *page)
	Remove a data plugin page from a window and display the previous page. More...
GncPluginPage *	gnc_main_window_get_current_page (GncMainWindow *window)
	Retrieve a pointer to the page that is currently at the front of the specified window. More...
void	gnc_main_window_manual_merge_actions (GncMainWindow *window, const gchar *group_name, GSimpleActionGroup *group)
	Manually add a set of actions to the specified window. More...
void	gnc_main_window_merge_actions (GncMainWindow *window, const gchar *group_name, GActionEntry *entries, guint n_entries, const gchar **ui_updates, const gchar *ui_filename, gpointer user_data)
	Add a set of actions to the specified window. More...
void	gnc_main_window_unmerge_actions (GncMainWindow *window, const gchar *group_name)
	Remove a set of actions from the specified window. More...
GAction *	gnc_main_window_find_action (GncMainWindow *window, const gchar *action_name)
	Find the GAction in the main window. More...
GAction *	gnc_main_window_find_action_in_group (GncMainWindow *window, const gchar *group_name, const gchar *action_name)
	Find the GAction in a specific action group for window. More...
GSimpleActionGroup *	gnc_main_window_get_action_group (GncMainWindow *window, const gchar *group_name)
	Retrieve a specific set of user interface actions from a window. More...
GtkWidget *	gnc_main_window_toolbar_find_tool_item (GncMainWindow *window, const gchar *action_name)
	Find the toolbar item with the given action name for the window specified. More...
GtkWidget *	gnc_main_window_menu_find_menu_item (GncMainWindow *window, const gchar *action_name)
	Find the menu item with the given action name for the window specified. More...
void	gnc_main_window_menu_add_accelerator_keys (GncMainWindow *window)
	Scan the main window menu and add accelerator keys to main window accelerator group. More...
gboolean	gnc_main_window_update_menu_for_action (GncMainWindow *window, const gchar *action_name, const gchar *label, const gchar *tooltip)
	Find the GMenuModel item given the action name for the window specified. More...
void	gnc_main_window_set_vis_of_items_by_action (GncMainWindow *window, const gchar **action_names, gboolean vis)
	Show or hide menu and toolbar items based on a NULL terminated list of action names. More...
void	gnc_main_window_init_short_names (GncMainWindow *window, GncToolBarShortNames *toolbar_labels)
	Update the labels of the toolbar items with short names. More...
void	gnc_main_window_update_menu_and_toolbar (GncMainWindow *window, GncPluginPage *page, const gchar **ui_updates)
	Update the main window menu with the placeholders listed in ui_updates and load the page specific toolbar. More...
void	gnc_book_option_num_field_source_change_cb (gboolean num_action)
	Calls gnc_book_option_num_field_source_change to initiate registered callbacks when num_field_source book option changes so that registers/reports can update themselves; sets feature flag.
GtkWidget *	gnc_book_options_dialog_cb (gboolean modal, gchar *title, GtkWindow *parent)
	Opens the Book Options dialog. More...
void	gnc_main_window_show_all_windows (void)
	Shows all main windows.
GtkWindow *	gnc_ui_get_gtk_window (GtkWidget *widget)
	Get a pointer to the widget's immediate top level GtkWindow. More...
GtkWindow *	gnc_ui_get_main_window (GtkWidget *widget)
	Get a pointer to the final GncMainWindow widget is rooted in. More...
void	gnc_main_window_set_progressbar_window (GncMainWindow *window)
	Set the window where all progressbar updates should occur. More...
gboolean	gnc_main_window_popup_menu_cb (GtkWidget *widget, GncPluginPage *page)
	Callback function invoked when the user requests that Gnucash popup the contextual menu via the keyboard context-menu request key combination (Shift-F10 by default). More...
gboolean	gnc_main_window_button_press_cb (GtkWidget *whatever, GdkEventButton *event, GncPluginPage *page)
	Callback function invoked when the user clicks in the content of any Gnucash window. More...
void	gnc_main_window_all_action_set_sensitive (const gchar *action_name, gboolean sensitive)
	Change the sensitivity of a command in all windows. More...
GMenuModel *	gnc_main_window_get_menu_model (GncMainWindow *window)
	Return the GMenuModel for the main window menu bar. More...
GType	gnc_main_window_get_type (void)
	Get the type of a gnc main window. More...

Variables
constexpr auto	gnc_main_window_max_number {10}
	Max number of windows allowed.

Detailed Description

Macro Definition Documentation

PLUGIN_PAGE_LABEL

#define PLUGIN_PAGE_LABEL   "plugin-page"

This label is used to provide a mapping from a visible page widget back to the corresponding GncPluginPage object.

Definition at line 101 of file gnc-main-window.cpp.

Enumeration Type Documentation

anonymous enum

anonymous enum

Names of signals generated by the main window.

Definition at line 91 of file gnc-main-window.cpp.

{
    PAGE_ADDED,
    PAGE_CHANGED,
    MENU_CHANGED,
    LAST_SIGNAL
};

Function Documentation

G_DEFINE_TYPE_WITH_CODE()

G_DEFINE_TYPE_WITH_CODE	(	GncMainWindow	,
		gnc_main_window	,
		GTK_TYPE_APPLICATION_WINDOW	,
		G_IMPLEMENT_INTERFACE(GNC_TYPE_WINDOW, gnc_window_main_window_init)
	)

A holding place for all the signals generated by the main window code.

gnc_book_options_dialog_apply_helper()

gboolean gnc_book_options_dialog_apply_helper

(

GncOptionDB *

options

)

Processes selected options in the Book Options dialog: checks book_currency and use_split_action_for_num to see if features kvp should be set.

To be used where ever a new book situation requires book option selection (e.g., not just in Book Options dialog opened from main window but also in new-file assistant).

Parameters

GncOptionDB

* options.

Returns

TRUE if gnc_gui_refresh_all should be called; otherwise FALSE.

Definition at line 4542 of file gnc-main-window.cpp.

{
    QofBook *book = gnc_get_current_book ();
    gboolean use_split_action_for_num_before =
        qof_book_use_split_action_for_num_field (book);
    gint use_read_only_threshold_before =
        qof_book_get_num_days_autoreadonly (book);
    gboolean use_split_action_for_num_after;
    gint use_read_only_threshold_after;
    gboolean return_val = FALSE;
    GList *results = nullptr, *iter;

    if (!options) return return_val;

    results = gnc_option_db_commit (options);
    for (iter = results; iter; iter = iter->next)
    {
        GtkWidget *dialog = gtk_message_dialog_new(gnc_ui_get_main_window (nullptr),
                                                   (GtkDialogFlags)0,
                                                   GTK_MESSAGE_ERROR,
                                                   GTK_BUTTONS_OK,
                                                   "%s",
                                                   (char*)iter->data);
        gtk_dialog_run(GTK_DIALOG(dialog));
        gtk_widget_destroy(dialog);
        g_free (iter->data);
    }
    g_list_free (results);
    qof_book_begin_edit (book);
    qof_book_save_options (book, gnc_option_db_save, options, TRUE);
    use_split_action_for_num_after =
        qof_book_use_split_action_for_num_field (book);

    // mark cached value as invalid so we get new value
    book->cached_num_days_autoreadonly_isvalid = FALSE;
    use_read_only_threshold_after = qof_book_get_num_days_autoreadonly (book);

    if (use_split_action_for_num_before != use_split_action_for_num_after)
    {
        gnc_book_option_num_field_source_change_cb (
                                                use_split_action_for_num_after);
        return_val = TRUE;
    }
    if (use_read_only_threshold_before != use_read_only_threshold_after)
        return_val = TRUE;

    qof_book_commit_edit (book);
    return return_val;
}

gnc_book_options_dialog_cb()

GtkWidget * gnc_book_options_dialog_cb	(	gboolean	modal,
		gchar *	title,
		GtkWindow *	parent
	)

Opens the Book Options dialog.

Parameters

modal	True to open in modal mode, false otherwise.
title	Title of the dialog; "Book Options" if NULL.
parent	The toplevel GdkWindow with which the dialog will be transient for.

Returns

A pointer to the GtkWidget for the dialog that can be used when started in modal mode.

Definition at line 4648 of file gnc-main-window.cpp.

{
    auto book = gnc_get_current_book ();

    auto options = gnc_option_db_new();
    gnc_option_db_book_options(options);
    qof_book_load_options (book, gnc_option_db_load, options);
    gnc_option_db_clean (options);

    /* Only allow one Book Options dialog if called from file->properties
       menu */
    if (gnc_forall_gui_components(DIALOG_BOOK_OPTIONS_CM_CLASS,
                                  show_handler, nullptr))
    {
        return nullptr;
    }
    auto optionwin = new GncOptionsDialog (modal,
                                           (title ? title : _( "Book Options")),
                                           DIALOG_BOOK_OPTIONS_CM_CLASS, parent);
    optionwin->build_contents(options);
    optionwin->set_book_help_cb();
    optionwin->set_apply_cb(gnc_book_options_dialog_apply_cb,
                            (gpointer)options);
    optionwin->set_close_cb ( gnc_book_options_dialog_close_cb,
                              (gpointer)options);
    if (modal)
        gnc_options_dialog_set_new_book_option_values (options);
    return optionwin->get_widget();
}

gnc_main_window_all_action_set_sensitive()

void gnc_main_window_all_action_set_sensitive	(	const gchar *	action_name,
		gboolean	sensitive
	)

Change the sensitivity of a command in all windows.

This can be used to serialize access to a command so that in cannot be reinvoked until the current invocation is finished.

Parameters

action_name	The name of the command to modity.
sensitive	Whether or not the user should be able to invoke this action.

Definition at line 5647 of file gnc-main-window.cpp.

{
    for (auto tmp = active_windows; tmp; tmp = g_list_next(tmp))
    {
        auto action{gnc_main_window_find_action (static_cast<GncMainWindow*>(tmp->data), action_name)};
        g_simple_action_set_enabled (G_SIMPLE_ACTION(action), sensitive);
    }
}

gnc_main_window_all_finish_pending()

gboolean gnc_main_window_all_finish_pending

(

void

)

Tell all pages in all windows to finish any outstanding activities.

This function will call gnc_plugin_page_finish_pending for each installed page. If any page returns a failure indication, then the function stops walking pages and immediately returns a failure.

Returns

FALSE if any page could not or would not comply, which should cancel the pending operation. TRUE otherwise

Definition at line 1090 of file gnc-main-window.cpp.

{
    const GList *windows, *item;

    windows = gnc_gobject_tracking_get_list(GNC_MAIN_WINDOW_NAME);
    for (item = windows; item; item = g_list_next(item))
    {
        if (!gnc_main_window_finish_pending(static_cast<GncMainWindow*>(item->data)))
        {
            return FALSE;
        }
    }
    if (gnc_gui_refresh_suspended ())
    {
        gnc_warning_dialog (nullptr, "%s", "An operation is still running, wait for it to complete before quitting.");
        return FALSE;
    }
    return TRUE;
}

gnc_main_window_button_press_cb()

gboolean gnc_main_window_button_press_cb	(	GtkWidget *	whatever,
		GdkEventButton *	event,
		GncPluginPage *	page
	)

Callback function invoked when the user clicks in the content of any Gnucash window.

If this was a "right-click" then Gnucash will popup the contextual menu.

Parameters

whatever	Whatever widget had focus when the user issued the keyboard context-menu request.
event	The event parameter describing where on the screen the mouse was pointing when clicked, type of click, modifiers, etc.
page	This is the GncPluginPage corresponding to the visible page.

Returns

Returns TRUE if this was a right-click, meaning Gnucash handled the click.

Definition at line 5627 of file gnc-main-window.cpp.

{
    g_return_val_if_fail(GNC_IS_PLUGIN_PAGE(page), FALSE);

    ENTER("widget %p, event %p, page %p", whatever, event, page);
    /* Ignore double-clicks and triple-clicks */
    if (event->button == 3 && event->type == GDK_BUTTON_PRESS)
    {
        do_popup_menu(page, event);
        LEAVE("menu shown");
        return TRUE;
    }

    LEAVE("other click");
    return FALSE;
}

gnc_main_window_close_page()

void gnc_main_window_close_page

(

GncPluginPage *

page

)

Remove a data plugin page from a window and display the previous page.

If the page removed was the last page in the window, and there is more than one window open, then the entire window will be destroyed.

Parameters

page	The page of data to be removed.

Definition at line 3361 of file gnc-main-window.cpp.

{
    GncMainWindow *window;
    GncMainWindowPrivate *priv;

    if (!page || !page->notebook_page)
        return;

    if (!gnc_plugin_page_finish_pending(page))
        return;

    if (!GNC_IS_MAIN_WINDOW (page->window))
        return;

    window = GNC_MAIN_WINDOW (page->window);
    if (!window)
    {
        g_warning("Page is not in a window.");
        return;
    }

    gnc_main_window_disconnect(window, page);
    gnc_plugin_page_destroy_widget (page);
    g_object_unref(page);

    /* If this isn't the last window, go ahead and destroy the window. */
    priv = GNC_MAIN_WINDOW_GET_PRIVATE(window);
    if (priv->installed_pages == nullptr)
    {
        if (window->window_quitting)
        {
            GncPluginManager *manager = gnc_plugin_manager_get ();
            GList *plugins = gnc_plugin_manager_get_plugins (manager);

            /* remove only the preference callbacks from the window plugins */
            window->just_plugin_prefs = TRUE;
            g_list_foreach (plugins, gnc_main_window_remove_plugin, window);
            window->just_plugin_prefs = FALSE;
            g_list_free (plugins);

            /* remove the preference callbacks from the main window */
            gnc_main_window_remove_prefs (window);
        }
        if (window && (gnc_list_length_cmp (active_windows, 1) > 0))
            gtk_widget_destroy (GTK_WIDGET(window));
    }
}

gnc_main_window_display_page()

void gnc_main_window_display_page

(

GncPluginPage *

page

)

Bring the window containing the specified page to the top of the window stack, then switch the notebook to show the specified page.

Parameters

page	The existing page to be displayed.

Definition at line 3184 of file gnc-main-window.cpp.

{
    GncMainWindow *window;
    GncMainWindowPrivate *priv;
    GtkNotebook *notebook;
    gint page_num;

    window = GNC_MAIN_WINDOW (page->window);
    priv = GNC_MAIN_WINDOW_GET_PRIVATE(window);
    notebook = GTK_NOTEBOOK (priv->notebook);
    page_num = gtk_notebook_page_num(notebook, page->notebook_page);
    gtk_notebook_set_current_page (notebook, page_num);
    gtk_window_present(GTK_WINDOW(window));
}

gnc_main_window_find_action()

GAction * gnc_main_window_find_action	(	GncMainWindow *	window,
		const gchar *	action_name
	)

Find the GAction in the main window.

Parameters

window	The window which should be checked for the action.
action_name	The name of the command to be retrieved.

Returns

A pointer to a GAction that was added with the specified name. If the name cannot be found, then NULL will be returned.

Definition at line 3552 of file gnc-main-window.cpp.

{
    GAction *action = nullptr;

    g_return_val_if_fail (GNC_IS_MAIN_WINDOW(window), nullptr);
    g_return_val_if_fail (action_name != nullptr, nullptr);

    action = g_action_map_lookup_action (G_ACTION_MAP(window),
                                         action_name);

    return action;
}

gnc_main_window_find_action_in_group()

GAction * gnc_main_window_find_action_in_group	(	GncMainWindow *	window,
		const gchar *	group_name,
		const gchar *	action_name
	)

Find the GAction in a specific action group for window.

Parameters

window	The window which should be checked for the action.
group_name	The name of the action group to search.
name	The name of the command to be retrieved.

Returns

A pointer to the GAction if found or NULL will be returned.

Definition at line 3566 of file gnc-main-window.cpp.

{
    GAction *action = nullptr;

    g_return_val_if_fail (GNC_IS_MAIN_WINDOW(window), nullptr);
    g_return_val_if_fail (group_name != nullptr, nullptr);
    g_return_val_if_fail (action_name != nullptr, nullptr);

    auto action_group = gtk_widget_get_action_group (GTK_WIDGET(window), group_name);

    if (action_group)
        action = g_action_map_lookup_action (G_ACTION_MAP(action_group), action_name);

    return action;
}

gnc_main_window_finish_pending()

gboolean gnc_main_window_finish_pending

(

GncMainWindow *

window

)

Tell a window to finish any outstanding activities.

This function will call gnc_plugin_page_finish_pending for each installed page. If any page returns a failure indication, then the function stops walking pages and immediately returns a failure.

Parameters

window

The window whose pages should be checked.

Returns

FALSE if any page could not or would not comply, which should cancel the pending operation. TRUE otherwise

Definition at line 1070 of file gnc-main-window.cpp.

{
    GncMainWindowPrivate *priv;
    GList *item;

    g_return_val_if_fail(GNC_IS_MAIN_WINDOW(window), TRUE);

    priv = GNC_MAIN_WINDOW_GET_PRIVATE(window);
    for (item = priv->installed_pages; item; item = g_list_next(item))
    {
        if (!gnc_plugin_page_finish_pending(static_cast<GncPluginPage*>(item->data)))
        {
            return FALSE;
        }
    }
    return TRUE;
}

gnc_main_window_foreach_page()

void gnc_main_window_foreach_page	(	GncMainWindowPageFunc	fn,
		gpointer	user_data
	)

Iterator function to walk all pages in all windows, calling the specified function for each page.

Parameters

entry	A pointer to the function to be called.
user_data	A data pointer passed to each call of the function.

Definition at line 411 of file gnc-main-window.cpp.

{
    ENTER(" ");
    for (auto w = active_windows; w; w = g_list_next(w))
    {
        auto window{static_cast<GncMainWindow*>(w->data)};
        auto priv = GNC_MAIN_WINDOW_GET_PRIVATE(window);
        for (auto p = priv->installed_pages; p; p = g_list_next(p))
        {
            auto page{static_cast<GncPluginPage*>(p->data)};
            fn(page, user_data);
        }
    }
    LEAVE(" ");
}

gnc_main_window_get_action_group()

GSimpleActionGroup * gnc_main_window_get_action_group	(	GncMainWindow *	window,
		const gchar *	group_name
	)

Retrieve a specific set of user interface actions from a window.

This function can be used to get an group of action to be manipulated when the front page of a window has changed.

Parameters

window	The window to check when looking for the action group.
group_name	The name of a set of actions. This must be a name provided when the actions were installed.

Returns

A pointer to a GSimpleActionGroup that was added with the specified name. If the name cannot be found, then NULL will be returned.

Definition at line 3590 of file gnc-main-window.cpp.

{
    g_return_val_if_fail (GNC_IS_MAIN_WINDOW(window), nullptr);
    g_return_val_if_fail (group_name != nullptr, nullptr);

    auto action_group = gtk_widget_get_action_group (GTK_WIDGET(window), group_name);
    return (GSimpleActionGroup*)action_group;
}

gnc_main_window_get_current_page()

GncPluginPage * gnc_main_window_get_current_page

(

GncMainWindow *

window

)

Retrieve a pointer to the page that is currently at the front of the specified window.

Any plugin that needs to manipulate its menus based upon the currently selected menu page should connect to the "page_changed" signal on a window. The callback function from that signal can then call this function to obtain a pointer to the current page.

Parameters

window

A pointer to the window whose front page should be returned.

Returns

A pointer to the GncPluginPage currently at the front of the specified window. If the window pointer is invalid or the window is empty, this function will return NULL.

Definition at line 3418 of file gnc-main-window.cpp.

{
    GncMainWindowPrivate *priv;

    priv = GNC_MAIN_WINDOW_GET_PRIVATE(window);
    return priv->current_page;
}

gnc_main_window_get_menu_model()

GMenuModel * gnc_main_window_get_menu_model

(

GncMainWindow *

window

)

Return the GMenuModel for the main window menu bar.

Parameters

window

The window for the menu bar.

Returns

The GMenuModel or NULL.

Definition at line 5658 of file gnc-main-window.cpp.

{
    GncMainWindowPrivate *priv;

    g_return_val_if_fail (GNC_IS_MAIN_WINDOW(window), nullptr);

    priv = GNC_MAIN_WINDOW_GET_PRIVATE(window);

    return priv->menubar_model;
}

gnc_main_window_get_type()

GType gnc_main_window_get_type

(

void

)

Get the type of a gnc main window.

Returns

A GType.

gnc_main_window_init_short_names()

void gnc_main_window_init_short_names	(	GncMainWindow *	window,
		GncToolBarShortNames *	toolbar_labels
	)

Update the labels of the toolbar items with short names.

Parameters

window	The window that conatins a tool bar to update.
toolbar_labels	A pointer to a NULL terminated array of data GncToolBarShortNames items.

Definition at line 3715 of file gnc-main-window.cpp.

{
    GncMainWindowPrivate *priv;

    g_return_if_fail (GNC_IS_MAIN_WINDOW(window));
    g_return_if_fail (toolbar_labels != nullptr);

    priv = GNC_MAIN_WINDOW_GET_PRIVATE(window);

    gnc_plugin_init_short_names (priv->toolbar, toolbar_labels);
}

gnc_main_window_is_restoring_pages()

gboolean gnc_main_window_is_restoring_pages

(

GncMainWindow *

window

)

Check if the main window is restoring the plugin pages.

This is used on report pages to delay the creation of the report till the page is focused.

Parameters

window

The window whose pages should be checked.

Returns

TRUE if pages are being restored

Definition at line 401 of file gnc-main-window.cpp.

{
    GncMainWindowPrivate *priv = GNC_MAIN_WINDOW_GET_PRIVATE(window);
    return priv->restoring_pages;
}

gnc_main_window_manual_merge_actions()

void gnc_main_window_manual_merge_actions	(	GncMainWindow *	window,
		const gchar *	group_name,
		GSimpleActionGroup *	group
	)

Manually add a set of actions to the specified window.

Plugins whose user interface is not hard coded (e.g. the menu-additions * plugin) must create their actions at run time, then use this * function to install them into the window.

Parameters

window	A pointer to the window whose user interface should be updated.
group_name	The name for this set of actions. This name should be unique among all groups added to the window, and will be needed to remove the actions from this window.
group	A pointer to the GSimpleActionGroup.

Definition at line 3433 of file gnc-main-window.cpp.

{
    g_return_if_fail (GNC_IS_MAIN_WINDOW(window));
    g_return_if_fail (group_name != nullptr);
    g_return_if_fail (G_IS_SIMPLE_ACTION_GROUP(group));

    gtk_widget_insert_action_group (GTK_WIDGET(window), group_name,
                                    G_ACTION_GROUP(group));
}

gnc_main_window_menu_add_accelerator_keys()

void gnc_main_window_menu_add_accelerator_keys

(

GncMainWindow *

window

)

Scan the main window menu and add accelerator keys to main window accelerator group.

Parameters

window

A pointer to the window whose user interface should be updated.

Definition at line 3637 of file gnc-main-window.cpp.

{
    GncMainWindowPrivate *priv;

    g_return_if_fail (GNC_IS_MAIN_WINDOW(window));

    priv = GNC_MAIN_WINDOW_GET_PRIVATE(window);

    gnc_add_accelerator_keys_for_menu (priv->menubar, priv->menubar_model, priv->accel_group);
}

gnc_main_window_menu_find_menu_item()

GtkWidget * gnc_main_window_menu_find_menu_item	(	GncMainWindow *	window,
		const gchar *	action_name
	)

Find the menu item with the given action name for the window specified.

Parameters

window	A pointer to the window whose user interface should be updated.
action_name	The action name of the tool item to find.

Returns

The found menu item widget or NULL.

Definition at line 3614 of file gnc-main-window.cpp.

{
    GncMainWindowPrivate *priv;
    GtkWidget *menu_item;

    g_return_val_if_fail (GNC_IS_MAIN_WINDOW(window), nullptr);
    g_return_val_if_fail (action_name != nullptr, nullptr);

    priv = GNC_MAIN_WINDOW_GET_PRIVATE(window);

    menu_item = GTK_WIDGET(g_hash_table_lookup (priv->display_item_hash, action_name));

    if (!menu_item)
    {
        menu_item = gnc_menubar_model_find_menu_item (priv->menubar_model, priv->menubar, action_name);

        g_hash_table_insert (priv->display_item_hash, g_strdup (action_name), menu_item);
    }
    return menu_item;
}

gnc_main_window_merge_actions()

void gnc_main_window_merge_actions	(	GncMainWindow *	window,
		const gchar *	group_name,
		GActionEntry *	entries,
		guint	n_entries,
		const gchar **	ui_updates,
		const gchar *	ui_filename,
		gpointer	user_data
	)

Add a set of actions to the specified window.

This function should not need to be called directly by plugin implementors. Correctly assigning values to the GncPluginClass fields during plugin initialization will cause this routine to be automatically called.

Parameters

window	A pointer to the window whose user interface should be updated.
group_name	The name for this set of actions. This name should be unique among all groups added to the window, and will be needed to remove the actions from this window.
entries	A pointer to an array of GActionEntry. These are the actions that will be added to the user interface.
n_entries	The number of actions in the array.
filename	The filename containing the user interface definition that goes with this set of actions.
user_data	The data to be provided to all callback functions.

Definition at line 3501 of file gnc-main-window.cpp.

{
    GncMainWindowActionData *data;
    GSimpleActionGroup *simple_action_group;

    g_return_if_fail (GNC_IS_MAIN_WINDOW(window));
    g_return_if_fail (group_name != nullptr);
    g_return_if_fail (actions != nullptr);
    g_return_if_fail (n_actions > 0);

    data = g_new0 (GncMainWindowActionData, 1);
    data->window = window;
    data->data = user_data;

    simple_action_group = g_simple_action_group_new ();

    g_action_map_add_action_entries (G_ACTION_MAP(simple_action_group),
                                     actions,
                                     n_actions,
                                     data);

    gtk_widget_insert_action_group (GTK_WIDGET(window), group_name,
                                    G_ACTION_GROUP(simple_action_group));

    if (ui_filename)
        update_menu_model (window, ui_filename, ui_updates);
}

gnc_main_window_new()

GncMainWindow * gnc_main_window_new

(

void

)

Create a new gnc main window plugin.

Returns

A pointer to the new object.

Definition at line 2982 of file gnc-main-window.cpp.

{
    auto window{static_cast<GncMainWindow*>(g_object_new (GNC_TYPE_MAIN_WINDOW, nullptr))};
    gtk_window_set_default_size(GTK_WINDOW(window), 800, 600);

    auto old_window = gnc_ui_get_main_window (nullptr);
    if (old_window)
    {
        gint width, height;
        gtk_window_get_size (old_window, &width, &height);
        gtk_window_resize (GTK_WINDOW (window), width, height);
        if ((gdk_window_get_state((gtk_widget_get_window (GTK_WIDGET(old_window))))
                & GDK_WINDOW_STATE_MAXIMIZED) != 0)
        {
            gtk_window_maximize (GTK_WINDOW (window));
        }
    }
    active_windows = g_list_append (active_windows, window);
    gnc_main_window_update_title(window);
    window->window_quitting = FALSE;
    window->just_plugin_prefs = FALSE;
#ifdef MAC_INTEGRATION
    gnc_quartz_set_menu(window);
#else
    gnc_main_window_update_all_menu_items();
#endif
    gnc_engine_add_commit_error_callback( gnc_main_window_engine_commit_error_callback, window );

    // set up a callback for notebook navigation
    g_signal_connect (G_OBJECT(window), "key-press-event",
                      G_CALLBACK(gnc_main_window_key_press_event),
                      NULL);

    return window;
}

gnc_main_window_open_page()

void gnc_main_window_open_page	(	GncMainWindow *	window,
		GncPluginPage *	page
	)

Display a data plugin page in a window.

If the page already exists in any window, then that window will be brought to the front and the notebook switch to display the specified page. If the page is new then it will be added to the specified window (unless the page itself requests otherwise.). If the window is NULL, the new page will be added to the first window.

Parameters

window	The window to display a new page in.
page	The new page of data to be displayed, or the existing page of data the should be brought to the top and displayed.

Definition at line 3208 of file gnc-main-window.cpp.

{
    GncMainWindowPrivate *priv;
    GtkWidget *tab_hbox;
    GtkWidget *label, *entry;
    const gchar *icon, *text, *color_string, *lab_text;
    GtkWidget *image;
    GList *tmp;
    TabWidth *tw;

    ENTER("window %p, page %p", window, page);
    if (window)
        g_return_if_fail (GNC_IS_MAIN_WINDOW (window));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE (page));
    g_return_if_fail (gnc_plugin_page_has_books(page));

    if (gnc_main_window_page_exists(page))
    {
        gnc_main_window_display_page (page);
        return;
    }

    /* Does the page want to be in a new window? */
    if (gnc_plugin_page_get_use_new_window(page))
    {
        /* See if there's a blank window. If so, use that. */
        for (tmp = active_windows; tmp; tmp = g_list_next(tmp))
        {
            window = GNC_MAIN_WINDOW(tmp->data);
            priv = GNC_MAIN_WINDOW_GET_PRIVATE(window);
            if (priv->installed_pages == nullptr)
            {
                break;
            }
        }
        if (tmp == nullptr)
            window = gnc_main_window_new ();
        gtk_widget_show(GTK_WIDGET(window));
    }
    else if ((window == nullptr) && active_windows)
    {
        window = static_cast<GncMainWindow*>(active_windows->data);
    }

    page->window = GTK_WIDGET(window);
    page->notebook_page = gnc_plugin_page_create_widget (page);
    g_object_set_data (G_OBJECT (page->notebook_page),
                       PLUGIN_PAGE_LABEL, page);

    /*
     * The page tab.
     */
    icon = GNC_PLUGIN_PAGE_GET_CLASS(page)->tab_icon;
    lab_text = gnc_plugin_page_get_page_name(page);
    label = gtk_label_new (lab_text);
    g_object_set_data (G_OBJECT (page), PLUGIN_PAGE_TAB_LABEL, label);

    tw = populate_tab_width_struct ();
    gnc_main_window_update_tab_width_one_page (page, tw);
    g_free (tw);

    gtk_widget_show (label);

    tab_hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 6);

    if (g_strcmp0 (gnc_plugin_page_get_plugin_name (page), "GncPluginPageAccountTree") == 0)
        gtk_widget_set_name (GTK_WIDGET(tab_hbox), "gnc-id-account-page-tab-box");

    gtk_box_set_homogeneous (GTK_BOX (tab_hbox), FALSE);
    gtk_widget_show (tab_hbox);

    if (icon != nullptr)
    {
        image = gtk_image_new_from_icon_name (icon, GTK_ICON_SIZE_MENU);
        gtk_widget_show (image);
        gtk_box_pack_start (GTK_BOX (tab_hbox), image, FALSE, FALSE, 0);
        gtk_widget_set_margin_start (GTK_WIDGET(image), 5);
        gtk_box_pack_start (GTK_BOX (tab_hbox), label, TRUE, TRUE, 0);
    }
    else
        gtk_box_pack_start (GTK_BOX (tab_hbox), label, TRUE, TRUE, 0);

    text = gnc_plugin_page_get_page_long_name(page);
    if (text)
    {
        gtk_widget_set_tooltip_text(tab_hbox, text);
    }

    entry = gtk_entry_new();
    gtk_widget_hide (entry);
    gtk_box_pack_start (GTK_BOX (tab_hbox), entry, TRUE, TRUE, 0);
    g_signal_connect(G_OBJECT(entry), "activate",
                     G_CALLBACK(gnc_main_window_tab_entry_activate), page);
    g_signal_connect(G_OBJECT(entry), "focus-out-event",
                     G_CALLBACK(gnc_main_window_tab_entry_focus_out_event),
                     page);
    g_signal_connect(G_OBJECT(entry), "key-press-event",
                     G_CALLBACK(gnc_main_window_tab_entry_key_press_event),
                     page);
    g_signal_connect(G_OBJECT(entry), "editing-done",
                     G_CALLBACK(gnc_main_window_tab_entry_editing_done),
                     page);

    /* Add close button - Not for immutable pages */
    if (!g_object_get_data (G_OBJECT (page), PLUGIN_PAGE_IMMUTABLE))
    {
        GtkWidget *close_image, *close_button;
        GtkRequisition requisition;

        close_button = gtk_button_new();
        gtk_button_set_relief(GTK_BUTTON(close_button), GTK_RELIEF_NONE);
        close_image = gtk_image_new_from_icon_name ("window-close", GTK_ICON_SIZE_MENU);
        gtk_widget_show(close_image);
        gtk_widget_get_preferred_size (close_image, &requisition, nullptr);
        gtk_widget_set_size_request(close_button, requisition.width + 4,
                                    requisition.height + 2);
        gtk_container_add(GTK_CONTAINER(close_button), close_image);
        if (gnc_prefs_get_bool(GNC_PREFS_GROUP_GENERAL, GNC_PREF_SHOW_CLOSE_BUTTON))
            gtk_widget_show (close_button);
        else
            gtk_widget_hide (close_button);

        g_signal_connect_swapped (G_OBJECT (close_button), "clicked",
                                  G_CALLBACK(gnc_main_window_close_page), page);

        gtk_box_pack_start (GTK_BOX (tab_hbox), close_button, FALSE, FALSE, 0);
        gtk_widget_set_margin_end (GTK_WIDGET(close_button), 5);
        g_object_set_data (G_OBJECT (page), PLUGIN_PAGE_CLOSE_BUTTON, close_button);
    }

    /*
     * The popup menu
     */
    label = gtk_label_new (gnc_plugin_page_get_page_name(page));

    /*
     * Now install it all in the window.
     */
    gnc_main_window_connect(window, page, tab_hbox, label);

    color_string = gnc_plugin_page_get_page_color(page);
    main_window_update_page_color (page, color_string);
    LEAVE("");
}

gnc_main_window_popup_menu_cb()

gboolean gnc_main_window_popup_menu_cb	(	GtkWidget *	widget,
		GncPluginPage *	page
	)

Callback function invoked when the user requests that Gnucash popup the contextual menu via the keyboard context-menu request key combination (Shift-F10 by default).

Parameters

page	This is the GncPluginPage corresponding to the visible page.
widget	Whatever widget had focus when the user issued the keyboard context-menu request.

Returns

Always returns TRUE to indicate that the menu request was handled.

Definition at line 5612 of file gnc-main-window.cpp.

{
    ENTER("widget %p, page %p", widget, page);
    do_popup_menu(page, nullptr);
    LEAVE(" ");
    return TRUE;
}

gnc_main_window_restore_all_windows()

void gnc_main_window_restore_all_windows

(

const GKeyFile *

keyfile

)

Restore the persistent state of all windows.

Parameters

keyfile

The GKeyFile containing persistent window state.

Definition at line 853 of file gnc-main-window.cpp.

{
    gint i, window_count;
    GError *error = nullptr;
    GncMainWindowSaveData data;

    /* We use the same struct for reading and for writing, so we cast
       away the const. */
    data.key_file = (GKeyFile *) keyfile;
    window_count = g_key_file_get_integer(data.key_file, STATE_FILE_TOP,
                                          WINDOW_COUNT, &error);
    if (error)
    {
        g_warning("error reading group %s key %s: %s",
                  STATE_FILE_TOP, WINDOW_COUNT, error->message);
        g_error_free(error);
        LEAVE("can't read count");
        return;
    }

    /* Restore all state information on the open windows.  Window
       numbers in state file are 1-based. GList indices are 0-based. */
    gnc_set_busy_cursor (nullptr, TRUE);
    for (i = 0; i < window_count; i++)
    {
        data.window_num = i;
        auto window{static_cast<GncMainWindow*>(g_list_nth_data(active_windows,
                                                                i))};
        gnc_main_window_restore_window(window, &data);
    }
    gnc_unset_busy_cursor (nullptr);

    statusbar_notification_lastmodified();
}

gnc_main_window_save_all_windows()

void gnc_main_window_save_all_windows

(

GKeyFile *

keyfile

)

Save the persistent state of all windows.

Parameters

keyfile

The GKeyFile to contain persistent window state.

Definition at line 1052 of file gnc-main-window.cpp.

{
    GncMainWindowSaveData data;

    /* Set up the iterator data structures */
    data.key_file = keyfile;
    data.window_num = 1;
    data.page_num = 1;

    g_key_file_set_integer(data.key_file,
                           STATE_FILE_TOP, WINDOW_COUNT,
                           g_list_length(active_windows));
    /* Dump all state information on the open windows */
    g_list_foreach(active_windows, (GFunc)gnc_main_window_save_window, &data);
}

gnc_main_window_set_progressbar_window()

void gnc_main_window_set_progressbar_window

(

GncMainWindow *

window

)

Set the window where all progressbar updates should occur.

This is a wrapper around the gnc_window_set_progressbar_window() function.

Parameters

window

The window to use for all progressbar updates.

Definition at line 5516 of file gnc-main-window.cpp.

{
    GncWindow *gncwin;
    gncwin = GNC_WINDOW(window);
    gnc_window_set_progressbar_window(gncwin);
}

gnc_main_window_set_vis_of_items_by_action()

void gnc_main_window_set_vis_of_items_by_action	(	GncMainWindow *	window,
		const gchar **	action_names,
		gboolean	vis
	)

Show or hide menu and toolbar items based on a NULL terminated list of action names.

Parameters

window	A pointer to the window whose user interface should be updated.
action_names	A NULL terminated list of actions names that should be modified.
vis	Whether to show or hide the widget items

Definition at line 3676 of file gnc-main-window.cpp.

{
    GncMainWindowPrivate *priv;

    g_return_if_fail (GNC_IS_MAIN_WINDOW(window));

    priv = GNC_MAIN_WINDOW_GET_PRIVATE(window);

    for (gint i = 0; action_names[i]; i++)
    {
        GtkWidget *tool_item = gnc_find_toolbar_item (priv->toolbar, action_names[i]);
        GtkWidget *menu_item = gnc_main_window_menu_find_menu_item (window, action_names[i]);

        if (menu_item)
        {
            PINFO("Found menu_item %p with action name '%s', seting vis to '%s'",
                    menu_item, action_names[i], vis ? "true" : "false");
            gtk_widget_set_visible (menu_item, vis);
        }
        else
            PINFO("Did not find menu_item with action name '%s' to set vis '%s'",
                   action_names[i], vis ? "true" : "false");

        if (tool_item)
        {
            PINFO("Found tool_item %p with action name '%s', seting vis to '%s'",
                    tool_item, action_names[i], vis ? "true" : "false");
            gtk_widget_set_visible (tool_item, vis);
        }
        else
             PINFO("Did not find tool_item with action name '%s' to set vis '%s'",
                    action_names[i], vis ? "true" : "false");
    }
}

gnc_main_window_toolbar_find_tool_item()

GtkWidget * gnc_main_window_toolbar_find_tool_item	(	GncMainWindow *	window,
		const gchar *	action_name
	)

Find the toolbar item with the given action name for the window specified.

Parameters

window	A pointer to the window whose user interface should be updated.
action_name	The action name of the tool item to find.

Returns

The found tool item widget or NULL.

Definition at line 3601 of file gnc-main-window.cpp.

{
    GncMainWindowPrivate *priv;

    g_return_val_if_fail (GNC_IS_MAIN_WINDOW(window), nullptr);
    g_return_val_if_fail (action_name != nullptr, nullptr);

    priv = GNC_MAIN_WINDOW_GET_PRIVATE(window);

    return gnc_find_toolbar_item (priv->toolbar, action_name);
}

gnc_main_window_unmerge_actions()

void gnc_main_window_unmerge_actions	(	GncMainWindow *	window,
		const gchar *	group_name
	)

Remove a set of actions from the specified window.

This function should not need to be called directly by plugin implementors. It will automatically be called when a plugin is removed from a window.

Parameters

window	A pointer to the window whose user interface should be updated.
group_name	The name for this set of actions. This must be the same name provided when the actions were installed.

Definition at line 3542 of file gnc-main-window.cpp.

{
    g_return_if_fail (GNC_IS_MAIN_WINDOW (window));
    g_return_if_fail (group_name != nullptr);

    gtk_widget_insert_action_group (GTK_WIDGET(window), group_name, nullptr);
}

gnc_main_window_update_menu_and_toolbar()

void gnc_main_window_update_menu_and_toolbar	(	GncMainWindow *	window,
		GncPluginPage *	page,
		const gchar **	ui_updates
	)

Update the main window menu with the placeholders listed in ui_updates and load the page specific toolbar.

Parameters

window	The window which should be checked for the action.
page	The plugin page calling this function.
ui_updates	A NULL terminated list of placeholders to load

Definition at line 3779 of file gnc-main-window.cpp.

{
    GncMainWindowPrivate *priv;
    const gchar *plugin_page_actions_group_name;
    GtkBuilder *builder;
    const gchar *menu_qualifier;

    GMenuModel *menu_model_part;
#ifdef MAC_INTEGRATION
    auto theApp{static_cast<GtkosxApplication *>(g_object_new(GTKOSX_TYPE_APPLICATION, nullptr))};
#endif
    g_return_if_fail (GNC_IS_MAIN_WINDOW(window));
    g_return_if_fail (page != nullptr);
    g_return_if_fail (ui_updates != nullptr);

    priv = GNC_MAIN_WINDOW_GET_PRIVATE(window);

    builder = gnc_plugin_page_get_builder (page);

    if (!builder)
        return;

    menu_qualifier = gnc_plugin_page_get_menu_qualifier (page);

    plugin_page_actions_group_name = gnc_plugin_page_get_simple_action_group_name (page);

    if (!plugin_page_actions_group_name)
        return;

    gtk_widget_insert_action_group (GTK_WIDGET(window), gnc_plugin_page_get_simple_action_group_name (page),
                                    G_ACTION_GROUP(gnc_plugin_page_get_action_group (page)));

    if ((g_strcmp0 (priv->previous_plugin_page_name,
                    plugin_page_actions_group_name) == 0) &&
        (g_strcmp0 (priv->previous_menu_qualifier,
                    menu_qualifier) == 0))
        return;

    priv->previous_plugin_page_name = plugin_page_actions_group_name;
    priv->previous_menu_qualifier = menu_qualifier;

    gnc_main_window_update_toolbar (window, page, menu_qualifier);

    // reset hash table and remove added menu items
    g_hash_table_remove_all (priv->display_item_hash);
    gnc_menubar_model_remove_items_with_attrib (priv->menubar_model,
                                                GNC_MENU_ATTRIBUTE_TEMPORARY);

    GncMenuModelSearch *gsm = g_new0 (GncMenuModelSearch, 1);
    for (gint i = 0; ui_updates[i]; i++)
    {
        gchar *menu_name;

        if (menu_qualifier)
            menu_name = g_strconcat (ui_updates[i], "-", menu_qualifier, nullptr);
        else
            menu_name = g_strdup (ui_updates[i]);

        menu_model_part = (GMenuModel *)gtk_builder_get_object (builder, menu_name);

        if (!menu_model_part)
            menu_model_part = (GMenuModel *)gtk_builder_get_object (builder, ui_updates[i]);

        gsm->search_action_label = nullptr;
        gsm->search_action_name = ui_updates[i];
        gsm->search_action_target = nullptr;

        if (gnc_menubar_model_find_item (priv->menubar_model, gsm))
            g_menu_insert_section (G_MENU(gsm->model), gsm->index,
                                   nullptr, G_MENU_MODEL(menu_model_part));
        else
            PERR("Could not find '%s' in menu model", ui_updates[i]);

        g_free (menu_name);
    }

    // add tooltip redirect call backs
    gnc_plugin_add_menu_tooltip_callbacks (priv->menubar, priv->menubar_model, priv->statusbar);

    // need to add the accelerator keys
    gnc_add_accelerator_keys_for_menu (priv->menubar, priv->menubar_model, priv->accel_group);
#ifdef MAC_INTEGRATION
    gtkosx_application_sync_menubar (theApp);
    g_object_unref (theApp);
#endif
    // need to signal menu has been changed
    g_signal_emit_by_name (window, "menu_changed", page);

    g_free (gsm);
}

gnc_main_window_update_menu_for_action()

gboolean gnc_main_window_update_menu_for_action	(	GncMainWindow *	window,
		const gchar *	action_name,
		const gchar *	label,
		const gchar *	tooltip
	)

Find the GMenuModel item given the action name for the window specified.

Parameters

window	A pointer to the window whose user interface should be updated.
action_name	The action name of the menu item to find.
label	The new label for the menu item.
tooltip	The new tooltip for the menu item, optional.

Returns

TRUE if menu item found and updated or FALSE.

Definition at line 3650 of file gnc-main-window.cpp.

{
    GncMainWindowPrivate *priv;
    gboolean found = false;

    g_return_val_if_fail (GNC_IS_MAIN_WINDOW(window), false);
    g_return_val_if_fail (action_name != nullptr, false);
    g_return_val_if_fail (label != nullptr, false);

    priv = GNC_MAIN_WINDOW_GET_PRIVATE(window);

    found =  gnc_menubar_model_update_item (priv->menubar_model, action_name,
                                            nullptr, _(label), nullptr, _(tooltip));

    // add tooltip redirect call backs
    gnc_plugin_add_menu_tooltip_callbacks (priv->menubar,
                                           priv->menubar_model,
                                           priv->statusbar);

    return found;
}

gnc_ui_get_gtk_window()

GtkWindow* gnc_ui_get_gtk_window

(

GtkWidget *

widget

)

Get a pointer to the widget's immediate top level GtkWindow.

This can be a dialog window or a GncMainWindow. If the widget is not a child of a GtkWindow (yet), NULL is returned.

Parameters

widget

the widget to find a GtkWindow for.

Returns

A pointer to a GtkWindow object or NULL if no toplevel was found.

Definition at line 5337 of file gnc-main-window.cpp.

{
    GtkWidget *toplevel;

    if (!widget)
        return nullptr;

    toplevel = gtk_widget_get_toplevel (widget);
    if (toplevel && GTK_IS_WINDOW (toplevel))
        return GTK_WINDOW (toplevel);
    else
        return nullptr;
}

gnc_ui_get_main_window()

GtkWindow* gnc_ui_get_main_window

(

GtkWidget *

widget

)

Get a pointer to the final GncMainWindow widget is rooted in.

If widget is a child of a GncMainWindow return that window. If it's a child of a dialog window recursively query the dialog's transient parent until the first parent that's a GncMainWindow and return that. If widget is NULL or not part of any GtkWindow, get a pointer to the first active top level window. If there is none, return the first mapped window. If there's no mapped window return NULL.

An example of why searching for a GncMainWindow makes sense: suppose a user has opened a search dialog for vendors and in that dialog has clicked "View vendor invoices". This opens another search window in which the user can click "View/Edit bill". Clicking that button should open a new tab in the GncMainWindow from which the first search dialog was opened.

Parameters

widget

the widget to find a GncMainWindow for.

Returns

A pointer to a GtkWindow object.

Definition at line 5352 of file gnc-main-window.cpp.

{
    GList *window;

    GtkWindow *toplevel = gnc_ui_get_gtk_window (widget);
    while (toplevel && !GNC_IS_MAIN_WINDOW (toplevel))
        toplevel = gtk_window_get_transient_for(toplevel);

    if (toplevel)
        return toplevel;

    for (window = active_windows; window; window = window->next)
        if (gtk_window_is_active (GTK_WINDOW (window->data)))
            return static_cast<GtkWindow*>(window->data);

    for (window = active_windows; window; window = window->next)
        if (gtk_widget_get_mapped (GTK_WIDGET(window->data)))
            return static_cast<GtkWindow*>(window->data);

    return nullptr;
}

main_window_update_page_color()

void main_window_update_page_color	(	GncPluginPage *	page,
		const gchar *	color_in
	)

Update the color on the page tabs in the main window.

Parameters

page	The page to be updated.
color_in	The new color string for the page tab.

Definition at line 2415 of file gnc-main-window.cpp.

{
    GncMainWindow *window;
    GncMainWindowPrivate *priv;
    GtkWidget *tab_widget;
    GdkRGBA tab_color;
    gchar *color_string = nullptr;
    gboolean want_color = FALSE;

    ENTER(" ");
    if (color_in)
        color_string = g_strstrip(g_strdup(color_in));

    if (color_string && *color_string != '\0')
        want_color = TRUE;

    /* Update the plugin */
    window = GNC_MAIN_WINDOW(page->window);
    if (want_color)
        gnc_plugin_page_set_page_color(page, color_string);
    else
        gnc_plugin_page_set_page_color(page, nullptr);

    /* Update the notebook tab */
    main_window_find_tab_widget (window, page, &tab_widget);
    priv = GNC_MAIN_WINDOW_GET_PRIVATE(window);

    if (want_color && gdk_rgba_parse(&tab_color, color_string) && priv->show_color_tabs)
    {
        GtkCssProvider *provider = gtk_css_provider_new();
        GtkStyleContext *stylectxt;
        gchar *col_str, *widget_css;

        if (!GTK_IS_EVENT_BOX (tab_widget))
        {
            GtkWidget *event_box = gtk_event_box_new ();
            g_object_ref (tab_widget);
            gtk_notebook_set_tab_label (GTK_NOTEBOOK(priv->notebook),
                                        page->notebook_page, event_box);
            gtk_container_add (GTK_CONTAINER(event_box), tab_widget);
            g_object_unref (tab_widget);
            tab_widget = event_box;
        }

        stylectxt = gtk_widget_get_style_context (GTK_WIDGET (tab_widget));
        col_str = gdk_rgba_to_string (&tab_color);
        widget_css = g_strconcat ("*{\n  background-color:", col_str, ";\n}\n", nullptr);

        gtk_css_provider_load_from_data (provider, widget_css, -1, nullptr);
        gtk_style_context_add_provider (stylectxt, GTK_STYLE_PROVIDER (provider),
                                        GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);
        g_object_unref (provider);
        g_free (col_str);
        g_free (widget_css);
    }
    else
    {
        if (GTK_IS_EVENT_BOX (tab_widget))
        {
            GtkWidget *tab_hbox = gtk_bin_get_child(GTK_BIN(tab_widget));
            g_object_ref (tab_hbox);
            gtk_container_remove (GTK_CONTAINER(tab_widget), tab_hbox);
            gtk_notebook_set_tab_label (GTK_NOTEBOOK(priv->notebook),
                                        page->notebook_page, tab_hbox);
            g_object_unref (tab_hbox);
        }
    }
    g_free(color_string);
    LEAVE("done");
}

main_window_update_page_long_name()

void main_window_update_page_long_name	(	GncPluginPage *	page,
		const gchar *	long_name_in
	)

Update the long name of the page in the main window.

Parameters

page	The page to be updated.
long_name_in	The new long name for the page.

Definition at line 2310 of file gnc-main-window.cpp.

{
    GtkWidget *tab_widget;

    ENTER(" ");

    if ((long_name_in == nullptr) || (*long_name_in == '\0'))
    {
        LEAVE("no string");
        return;
    }
    gchar *long_name = g_strstrip (g_strdup (long_name_in));
    const gchar *old_long_name = gnc_plugin_page_get_page_long_name (page);

    /* Optimization, if the long_name hasn't changed, don't update X. */
    if (*long_name == '\0' || strcmp (long_name, old_long_name) == 0)
    {
        g_free (long_name);
        LEAVE("empty string or name unchanged");
        return;
    }

    gnc_plugin_page_set_page_long_name (page, long_name);

    GncMainWindow *window = GNC_MAIN_WINDOW(page->window);
    if (!window)
    {
        g_free (long_name);
        LEAVE("no window widget available");
        return;
    }

    /* Update the notebook tab tooltip */
    if (main_window_find_tab_widget (window, page, &tab_widget))
        gtk_widget_set_tooltip_text (tab_widget, long_name);

    g_free (long_name);
    LEAVE("");
}

main_window_update_page_name()

void main_window_update_page_name	(	GncPluginPage *	page,
		const gchar *	name_in
	)

Update the name of the page in the main window.

Parameters

page	The page to be updated.
name_in	The new name for the page.

Definition at line 2352 of file gnc-main-window.cpp.

{
    GncMainWindow *window;
    GncMainWindowPrivate *priv;
    GtkWidget *label, *entry;
    gchar *name;
    TabWidth *tw;

    ENTER(" ");

    if ((name_in == nullptr) || (*name_in == '\0'))
    {
        LEAVE("no string");
        return;
    }
    name = g_strstrip(g_strdup(name_in));

    /* Optimization, if the name hasn't changed, don't update X. */
    if (*name == '\0' || 0 == strcmp(name, gnc_plugin_page_get_page_name(page)))
    {
        g_free(name);
        LEAVE("empty string or name unchanged");
        return;
    }

    /* Update the plugin */
    gnc_plugin_page_set_page_name(page, name);

    /* Update the notebook tab */
    window = GNC_MAIN_WINDOW(page->window);
    if (!window)
    {
        g_free(name);
        LEAVE("no window widget available");
        return;
    }

    if (main_window_find_tab_items(window, page, &label, &entry))
        gtk_label_set_text(GTK_LABEL(label), name);

    /* Adjust the label width for new text */
    tw = populate_tab_width_struct ();
    gnc_main_window_update_tab_width_one_page (page, tw);
    g_free (tw);

    /* Update the notebook menu */
    if (page->notebook_page)
    {
        priv = GNC_MAIN_WINDOW_GET_PRIVATE(window);
        label = gtk_notebook_get_menu_label (GTK_NOTEBOOK(priv->notebook),
                                             page->notebook_page);
        gtk_label_set_text(GTK_LABEL(label), name);
    }

    /* Force an update of the window title */
    gnc_main_window_update_title(window);
    g_free(name);
    LEAVE("done");
}

main_window_update_page_set_read_only_icon()

void main_window_update_page_set_read_only_icon	(	GncPluginPage *	page,
		gboolean	read_only
	)

Update the icon on the page tabs in the main window.

Parameters

page	The page to be updated.
read_only	If set a padlock icon will be displayed for the page tab icon if it had one.

Definition at line 2489 of file gnc-main-window.cpp.

{
    GncMainWindow *window;
    GtkWidget *tab_widget;
    GtkWidget *image = NULL;
    GList *children;
    gchar *image_name = NULL;
    const gchar *icon_name;

    ENTER(" ");

    g_return_if_fail (page && page->window);

    if (!GNC_IS_MAIN_WINDOW (page->window))
        return;

    window = GNC_MAIN_WINDOW(page->window);

    /* Get the notebook tab widget */
    main_window_find_tab_widget (window, page, &tab_widget);

    if (!tab_widget)
    {
        LEAVE("no tab widget");
        return;
    }

    if (GTK_IS_EVENT_BOX(tab_widget))
        tab_widget = gtk_bin_get_child (GTK_BIN(tab_widget));

    children = gtk_container_get_children (GTK_CONTAINER(tab_widget));
    /* For each, walk the list of container children to get image widget */
    for (GList *child = children; child; child = g_list_next (child))
    {
        GtkWidget *widget = static_cast<GtkWidget*>(child->data);
        if (GTK_IS_IMAGE(widget))
            image = widget;
    }
    g_list_free (children);

    if (!image)
    {
        LEAVE("no image to replace");
        return;
    }

    g_object_get (image, "icon-name", &image_name, NULL);

    if (read_only)
        icon_name = "changes-prevent-symbolic";
    else
        icon_name = GNC_PLUGIN_PAGE_GET_CLASS(page)->tab_icon;

    if (g_strcmp0 (icon_name, image_name) == 0)
    {
        LEAVE("page icon the same, no need to replace");
        g_free (image_name);
        return;
    }
    gtk_container_remove (GTK_CONTAINER(tab_widget), image);
    image = gtk_image_new_from_icon_name (icon_name, GTK_ICON_SIZE_MENU);
    gtk_widget_show (image);

    gtk_container_add (GTK_CONTAINER(tab_widget), image);
    gtk_widget_set_margin_start (GTK_WIDGET(image), 5);
    gtk_box_reorder_child (GTK_BOX(tab_widget), image, 0);

    g_free (image_name);
    LEAVE("done");
}