Embedded Window Functions

Files
file	gnc-embedded-window.h
	Functions that are supported by all types of windows.

Macros
#define	GNC_TYPE_EMBEDDED_WINDOW   (gnc_embedded_window_get_type ())

Functions
GncEmbeddedWindow *	gnc_embedded_window_new (const gchar *action_group_name, GActionEntry *action_entries, gint n_action_entries, const gchar *ui_filename, GtkWidget *enclosing_win, gboolean add_accelerators, gpointer user_data)
	Create a new gnc embedded window plugin.
void	gnc_embedded_window_open_page (GncEmbeddedWindow *window, GncPluginPage *page)
	Display a data plugin page in a window.
void	gnc_embedded_window_close_page (GncEmbeddedWindow *window, GncPluginPage *page)
	Remove a data plugin page from a window.
GncPluginPage *	gnc_embedded_window_get_page (GncEmbeddedWindow *window)
	Retrieve the plugin that is embedded in the specified window.

Detailed Description

Macro Definition Documentation

GNC_TYPE_EMBEDDED_WINDOW

#define GNC_TYPE_EMBEDDED_WINDOW   (gnc_embedded_window_get_type ())

Definition at line 46 of file gnc-embedded-window.h.

Function Documentation

gnc_embedded_window_close_page()

void gnc_embedded_window_close_page	(	GncEmbeddedWindow *	window,
		GncPluginPage *	page
	)

Remove a data plugin page from a window.

Parameters

window	The window whose plugin is to be removed.
page	The page of data to be removed.

Definition at line 135 of file gnc-embedded-window.c.

{
    g_return_if_fail (GNC_IS_EMBEDDED_WINDOW (window));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE (page));
    g_return_if_fail (window->page == page);
 
    ENTER("window %p, page %p", window, page);
 
    if (!page->notebook_page)
    {
        LEAVE("no displayed widget");
        return;
    }
 
    gtk_container_remove (GTK_CONTAINER(window), GTK_WIDGET(page->notebook_page));
    window->page = NULL;
    gnc_plugin_page_removed (page);
 
    gnc_plugin_page_destroy_widget (page);
    g_object_unref(page);
    LEAVE(" ");
}

gnc_embedded_window_get_page()

GncPluginPage * gnc_embedded_window_get_page

(

GncEmbeddedWindow *

window

)

Retrieve the plugin that is embedded in the specified window.

Parameters

window

The window whose plugin is desired.

Returns

A pointer to a GncPluginPage.

Definition at line 162 of file gnc-embedded-window.c.

{
    return window->page;
}

gnc_embedded_window_new()

GncEmbeddedWindow * gnc_embedded_window_new	(	const gchar *	action_group_name,
		GActionEntry *	action_entries,
		gint	n_action_entries,
		const gchar *	ui_filename,
		GtkWidget *	enclosing_win,
		gboolean	add_accelerators,
		gpointer	user_data
	)

Create a new gnc embedded window plugin.

Returns

A pointer to the new object.

Definition at line 315 of file gnc-embedded-window.c.

{
    GncEmbeddedWindow *window;
    gchar *ui_fullname;
    GError *error = NULL;
    GtkBuilder *builder;
 
    ENTER("group %s, first %p, num %d, ui file %s, parent %p, add accelerators %d, user data %p",
          action_group_name, action_entries, n_action_entries, ui_filename,
          enclosing_win, add_accelerators, user_data);
 
    window = g_object_new (GNC_TYPE_EMBEDDED_WINDOW, NULL);
 
    builder = gtk_builder_new ();
    gtk_builder_set_translation_domain (builder, PROJECT_NAME);
 
    ui_fullname = g_strconcat (GNUCASH_RESOURCE_PREFIX "/", ui_filename, NULL);
 
    gtk_builder_add_from_resource (builder, ui_fullname, &error);
 
    if (error)
    {
        g_critical ("Failed to load, Error %s", error->message);
        g_error_free (error);
        return NULL;
    }
 
    window->menubar_model = (GMenuModel *)gtk_builder_get_object (builder, "embeddedwin-menu");
 
    window->menubar = gtk_menu_bar_new_from_model (window->menubar_model);
    gtk_container_add (GTK_CONTAINER(window->menu_dock), window->menubar);
    gtk_widget_show (GTK_WIDGET(window->menubar));
 
    window->toolbar = (GtkWidget *)gtk_builder_get_object (builder, "embeddedwin-toolbar");
    g_object_set (window->toolbar, "toolbar-style", GTK_TOOLBAR_BOTH, NULL);
    gtk_container_add (GTK_CONTAINER(window->menu_dock), GTK_WIDGET(window->toolbar));
    gtk_widget_show (GTK_WIDGET(window->toolbar));
 
    g_object_unref (builder);
 
    window->simple_action_group = g_simple_action_group_new ();
 
    g_action_map_add_action_entries (G_ACTION_MAP(window->simple_action_group),
                                     action_entries,
                                     n_action_entries,
                                     user_data);
 
    gtk_widget_insert_action_group (GTK_WIDGET(window), "embeddedwin",
                                    G_ACTION_GROUP(window->simple_action_group));
 
    window->parent_window = enclosing_win;
 
    // need to add the accelerator keys
    window->accel_group = gtk_accel_group_new ();
    gtk_window_add_accel_group (GTK_WINDOW(enclosing_win), window->accel_group);
    gnc_add_accelerator_keys_for_menu (GTK_WIDGET(window->menubar), window->menubar_model, window->accel_group);
 
    g_free (ui_fullname);
    LEAVE("window %p", window);
    return window;
}

gnc_embedded_window_open_page()

void gnc_embedded_window_open_page	(	GncEmbeddedWindow *	window,
		GncPluginPage *	page
	)

Display a data plugin page in a window.

Parameters

window	The window to display a new page in.
page	The new page of data to be displayed.

Definition at line 115 of file gnc-embedded-window.c.

{
    g_return_if_fail (GNC_IS_EMBEDDED_WINDOW (window));
    g_return_if_fail (GNC_IS_PLUGIN_PAGE (page));
    g_return_if_fail (window->page == NULL);
 
    ENTER("window %p, page %p", window, page);
    window->page = page;
    page->window = GTK_WIDGET(window);
    page->notebook_page = gnc_plugin_page_create_widget (page);
 
    gtk_box_pack_end(GTK_BOX(window), page->notebook_page, TRUE, TRUE, 2);
    gnc_plugin_page_inserted (page);
    LEAVE(" ");
}