Files
file	gnc-plugin-page.c
	Functions for adding plugins to a GnuCash window.

file	gnc-plugin-page.h
	Functions for adding plugins to a GnuCash window.

Data Structures
struct	GncPluginPagePrivate
	The instance private data for a content plugin. More...

struct	GncPluginPage
	The instance data structure for a content plugin. More...

struct	GncPluginPageClass
	The class data structure for a content plugin. More...

Macros
#define	GNC_PREF_SUMMARYBAR_POSITION_TOP "summarybar-position-top"

#define	GNC_PREF_SUMMARYBAR_POSITION_BOTTOM "summarybar-position-bottom"

#define	GNC_TYPE_PLUGIN_PAGE (gnc_plugin_page_get_type ())

#define	GNC_PLUGIN_PAGE(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_PLUGIN_PAGE, GncPluginPage))

#define	GNC_PLUGIN_PAGE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_PLUGIN_PAGE, GncPluginPageClass))

#define	GNC_IS_PLUGIN_PAGE(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_PLUGIN_PAGE))

#define	GNC_IS_PLUGIN_PAGE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_PLUGIN_PAGE))

#define	GNC_PLUGIN_PAGE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_PLUGIN_PAGE, GncPluginPageClass))

Enumerations
enum	{ INSERTED , REMOVED , SELECTED , UNSELECTED , LAST_SIGNAL }

enum	{ PROP_0 , PROP_PAGE_NAME , PROP_PAGE_COLOR , PROP_BOOK , PROP_STATUSBAR_TEXT , PROP_USE_NEW_WINDOW , PROP_UI_DESCRIPTION }

Functions
	G_DEFINE_TYPE_WITH_CODE (GncPluginPage, gnc_plugin_page, G_TYPE_OBJECT, G_ADD_PRIVATE(GncPluginPage))

void	gnc_plugin_page_destroy_widget (GncPluginPage *plugin_page)
	Destroy the display widget that corresponds to this plugin.

void	gnc_plugin_page_show_summarybar (GncPluginPage *page, gboolean visible)
	Show/hide the summarybar associated with this page.

void	gnc_plugin_page_save_page (GncPluginPage page, GKeyFile key_file, const gchar *group_name)
	Call the plugin specific function that will save the state of a content page to a disk.

GncPluginPage *	gnc_plugin_page_recreate_page (GtkWidget window, const gchar page_type, GKeyFile key_file, const gchar group_name)
	This function looks up a specific plugin type by name, and then calls a plugin specific function to create a new page and restore its content to a previous state.

void	gnc_plugin_page_merge_actions (GncPluginPage *plugin_page)
	Add the actions for a content page to the specified window.

GAction *	gnc_plugin_page_get_action (GncPluginPage page, const gchar action_name)
	Retrieve a GAction object associated with this page.

const gchar *	gnc_plugin_page_get_plugin_name (GncPluginPage *plugin_page)
	Retrieve the textual name of a plugin.

void	gnc_plugin_page_inserted (GncPluginPage *plugin_page)

void	gnc_plugin_page_removed (GncPluginPage *plugin_page)

void	gnc_plugin_page_selected (GncPluginPage *plugin_page)

void	gnc_plugin_page_unselected (GncPluginPage *plugin_page)

void	gnc_plugin_page_add_book (GncPluginPage page, QofBook book)
	Add a book reference to the specified page.

gboolean	gnc_plugin_page_has_book (GncPluginPage page, QofBook book)
	Query a page to see if it has a reference to a given book.

gboolean	gnc_plugin_page_has_books (GncPluginPage *page)
	Query a page to see if it has a reference to any book.

GtkWidget *	gnc_plugin_page_get_window (GncPluginPage *page)
	Retrieve a pointer to the GncMainWindow (GtkWindow) containing this page.

const gchar *	gnc_plugin_page_get_page_name (GncPluginPage *page)
	Retrieve the name of this page.

void	gnc_plugin_page_set_page_name (GncPluginPage page, const gchar name)

const gchar *	gnc_plugin_page_get_page_long_name (GncPluginPage *page)
	Retrieve the long name of this page.

void	gnc_plugin_page_set_page_long_name (GncPluginPage page, const gchar name)

const gchar *	gnc_plugin_page_get_page_color (GncPluginPage *page)
	Retrieve the color of this page.

void	gnc_plugin_page_set_page_color (GncPluginPage page, const gchar color)

void	gnc_plugin_page_inserted_cb (GncPluginPage *page, gpointer user_data)
	Set up the page_changed callback for when the current page is changed.

void	gnc_plugin_page_disconnect_page_changed (GncPluginPage *page)
	Disconnect the page_changed_id signal callback.

const gchar *	gnc_plugin_page_get_statusbar_text (GncPluginPage *page)
	Retrieve the statusbar text associated with this page.

void	gnc_plugin_page_set_statusbar_text (GncPluginPage page, const gchar message)

gboolean	gnc_plugin_page_get_use_new_window (GncPluginPage *page)
	Retrieve the "use new window" setting associated with this page.

void	gnc_plugin_page_set_use_new_window (GncPluginPage *page, gboolean use_new)
	Set the "use new window" setting associated with this page.

const gchar *	gnc_plugin_page_get_ui_description (GncPluginPage *page)
	Retrieve the name of the XML UI file associated with this page.

void	gnc_plugin_page_set_ui_description (GncPluginPage page, const char ui_filename)
	Set an alternate UI for the specified page.

GtkBuilder *	gnc_plugin_page_get_builder (GncPluginPage *page)
	Retrieve the GtkBuilder object associated with this page.

const gchar *	gnc_plugin_page_get_menu_qualifier (GncPluginPage *page)
	Retrieve the menu qualifier for this page.

void	gnc_plugin_page_set_menu_qualifier (GncPluginPage page, const char menu_qualifier)
	Set a qualifier string for this page.

const gchar *	gnc_plugin_page_get_menu_popup_qualifier (GncPluginPage *page)
	Retrieve the menu popup qualifier for this page.

void	gnc_plugin_page_set_menu_popup_qualifier (GncPluginPage page, const char menu_qualifier)
	Set a qualifier string for this page.

GSimpleActionGroup *	gnc_plugin_page_get_action_group (GncPluginPage *page)
	Retrieve the GSimpleActionGroup object associated with this page.

GSimpleActionGroup *	gnc_plugin_page_create_action_group (GncPluginPage page, const gchar group_name)
	Create the GSimpleActionGroup object associated with this page.

const gchar *	gnc_plugin_page_get_simple_action_group_name (GncPluginPage *page)
	Retrieve the simple action group name associated with this plugin page.

gboolean	gnc_plugin_page_finish_pending (GncPluginPage *plugin_page)
	Tell a page to finish any outstanding activities.

GType	gnc_plugin_page_get_type (void)
	Get the type of a content plugin.

GtkWidget *	gnc_plugin_page_create_widget (GncPluginPage *plugin_page)
	Create the display widget that corresponds to this plugin.

void	gnc_plugin_page_set_page_name (GncPluginPage page, const char name)
	Set the name of this page.

void	gnc_plugin_page_set_page_long_name (GncPluginPage page, const char name)
	Set the long name of this page.

void	gnc_plugin_page_set_page_color (GncPluginPage page, const char color)
	Set the color of this page.

void	gnc_plugin_page_set_statusbar_text (GncPluginPage page, const char name)
	Set the statusbar text associated with this page.

Detailed Description

Macro Definition Documentation

◆ GNC_IS_PLUGIN_PAGE

#define GNC_IS_PLUGIN_PAGE ( o ) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_PLUGIN_PAGE))

Definition at line 51 of file gnc-plugin-page.h.

◆ GNC_IS_PLUGIN_PAGE_CLASS

#define GNC_IS_PLUGIN_PAGE_CLASS ( klass ) (G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_PLUGIN_PAGE))

Definition at line 52 of file gnc-plugin-page.h.

◆ GNC_PLUGIN_PAGE

#define GNC_PLUGIN_PAGE ( o ) (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_PLUGIN_PAGE, GncPluginPage))

Definition at line 49 of file gnc-plugin-page.h.

◆ GNC_PLUGIN_PAGE_CLASS

#define GNC_PLUGIN_PAGE_CLASS ( klass ) (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_PLUGIN_PAGE, GncPluginPageClass))

Definition at line 50 of file gnc-plugin-page.h.

◆ GNC_PLUGIN_PAGE_GET_CLASS

#define GNC_PLUGIN_PAGE_GET_CLASS ( obj ) (G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_PLUGIN_PAGE, GncPluginPageClass))

Definition at line 53 of file gnc-plugin-page.h.

◆ GNC_PREF_SUMMARYBAR_POSITION_BOTTOM

#define GNC_PREF_SUMMARYBAR_POSITION_BOTTOM "summarybar-position-bottom"

Definition at line 45 of file gnc-plugin-page.h.

◆ GNC_PREF_SUMMARYBAR_POSITION_TOP

#define GNC_PREF_SUMMARYBAR_POSITION_TOP "summarybar-position-top"

Definition at line 44 of file gnc-plugin-page.h.

◆ GNC_TYPE_PLUGIN_PAGE

#define GNC_TYPE_PLUGIN_PAGE (gnc_plugin_page_get_type ())

Definition at line 48 of file gnc-plugin-page.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Definition at line 61 of file gnc-plugin-page.c.

{
    INSERTED,
    REMOVED,
    SELECTED,
    UNSELECTED,
    LAST_SIGNAL
};

◆ anonymous enum

anonymous enum

Definition at line 70 of file gnc-plugin-page.c.

{
    PROP_0,
    PROP_PAGE_NAME,
    PROP_PAGE_COLOR,
    PROP_BOOK,
    PROP_STATUSBAR_TEXT,
    PROP_USE_NEW_WINDOW,
    PROP_UI_DESCRIPTION,
};

Function Documentation

◆ G_DEFINE_TYPE_WITH_CODE()

G_DEFINE_TYPE_WITH_CODE	(	GncPluginPage	,
		gnc_plugin_page	,
		G_TYPE_OBJECT	,
		G_ADD_PRIVATE(GncPluginPage)
	)

Definition at line 111 of file gnc-plugin-page.c.

{
    GncPluginPageClass *klass;
    GtkWidget *widget;
 
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE(plugin_page), NULL);
 
    klass = GNC_PLUGIN_PAGE_GET_CLASS(plugin_page);
    g_return_val_if_fail (klass != NULL, NULL);
    g_return_val_if_fail (klass->create_widget != NULL, NULL);
 
    widget = klass->create_widget (plugin_page);
 
    /*
     * If there is a destroy function, add a ref so that the
     * widgets will exists when the destroy function is called.
     * Otherwise it will be destroyed when it is removed from the
     * main notebook for the window.
     */
    if (klass->destroy_widget)
        g_object_ref (widget);
 
    return widget;
}

◆ gnc_plugin_page_add_book()

void gnc_plugin_page_add_book	(	GncPluginPage *	page,
		QofBook *	book
	)

Add a book reference to the specified page.

Parameters

page	The page to be modified.
book	The book referenced by this page.

Definition at line 657 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(page));
    g_return_if_fail (book != NULL);
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    priv->books = g_list_append (priv->books, book);
}

◆ gnc_plugin_page_create_action_group()

GSimpleActionGroup * gnc_plugin_page_create_action_group	(	GncPluginPage *	page,
		const gchar *	group_name
	)

Create the GSimpleActionGroup object associated with this page.

Parameters

page	The page whose menu/toolbar action group should be created.
group_name	The name associate with this action group. The name is used to associate key bindings with actions, so it should be consistent across all pages of the same type.

Returns: A pointer to the newly created GSimpleActionGroup object for this page.

Definition at line 1082 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
 
    priv->simple_action_group = g_simple_action_group_new ();
    priv->simple_action_group_name = group_name;
 
    return priv->simple_action_group;
}

◆ gnc_plugin_page_create_widget()

GtkWidget * gnc_plugin_page_create_widget ( GncPluginPage * plugin_page )

Create the display widget that corresponds to this plugin.

This function will be called by the main/embedded window manipulation code to create a widget that they can display. The returned widget should encompass all information that goes with this page, including scroll bars, a summary bar, etc.

Parameters

plugin_page A pointer to the plugin for which a display widget should be created.

Returns: A displayable gtk widget.

◆ gnc_plugin_page_destroy_widget()

void gnc_plugin_page_destroy_widget ( GncPluginPage * plugin_page )

Destroy the display widget that corresponds to this plugin.

This function will be called by the main/embedded window manipulation code when a page is closed.

Parameters

plugin_page A pointer to the plugin whose display widget should be destroyed.

Definition at line 153 of file gnc-plugin-page.c.

{
    GncPluginPageClass *klass;
 
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(plugin_page));
 
    klass = GNC_PLUGIN_PAGE_GET_CLASS(plugin_page);
    g_return_if_fail (klass != NULL);
    g_return_if_fail (klass->destroy_widget != NULL);
 
    klass->destroy_widget (plugin_page);
}

◆ gnc_plugin_page_disconnect_page_changed()

void gnc_plugin_page_disconnect_page_changed ( GncPluginPage * page )

Disconnect the page_changed_id signal callback.

Parameters

page	The page whose name should be retrieved.

Definition at line 902 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(page));
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
 
    if (priv->page_changed_id > 0)
    {
        g_signal_handler_disconnect (G_OBJECT(page->window), priv->page_changed_id);
        priv->page_changed_id = 0;
    }
}

◆ gnc_plugin_page_finish_pending()

gboolean gnc_plugin_page_finish_pending ( GncPluginPage * plugin_page )

Tell a page to finish any outstanding activities.

Parameters

plugin_page A page.

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

Definition at line 1105 of file gnc-plugin-page.c.

{
    if (!page)
        return TRUE;
 
    if (!GNC_IS_PLUGIN_PAGE(page))
        return TRUE;
 
    if (!GNC_PLUGIN_PAGE_GET_CLASS(page)->finish_pending)
        return TRUE;
 
    return (GNC_PLUGIN_PAGE_GET_CLASS(page)->finish_pending)(page);
}

◆ gnc_plugin_page_get_action()

GAction * gnc_plugin_page_get_action	(	GncPluginPage *	page,
		const gchar *	action_name
	)

Retrieve a GAction object associated with this page.

Parameters

page	The page whose menu/toolbar action group should be retrieved.
action_name	The name of the GAction to find.

Returns: A pointer to the requested GAction object or NULL.

Definition at line 282 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE(page), NULL);
    g_return_val_if_fail (name != NULL, NULL);
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    if (!priv->simple_action_group)
        return NULL;
    return g_action_map_lookup_action (G_ACTION_MAP(priv->simple_action_group), name);
}

◆ gnc_plugin_page_get_action_group()

GSimpleActionGroup * gnc_plugin_page_get_action_group ( GncPluginPage * page )

Retrieve the GSimpleActionGroup object associated with this page.

Parameters

page	The page whose menu/toolbar action group should be retrieved.

Returns: A pointer to the GSimpleActionGroup object for this page.

Definition at line 1071 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE(page), NULL);
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    return priv->simple_action_group;
}

◆ gnc_plugin_page_get_builder()

GtkBuilder * gnc_plugin_page_get_builder ( GncPluginPage * page )

Retrieve the GtkBuilder object associated with this page.

Parameters

page	The page whose UI information should be retrieved.

Returns: A pointer to the GtkBuilder object for this page.

Definition at line 1009 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE(page), NULL);
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    return priv->builder;
}

◆ gnc_plugin_page_get_menu_popup_qualifier()

const gchar * gnc_plugin_page_get_menu_popup_qualifier ( GncPluginPage * page )

Retrieve the menu popup qualifier for this page.

Parameters

page	The page whose quailifier string should be retrieved.

Returns: A qualifier string for this page.

Definition at line 1046 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE(page), NULL);
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    return priv->menu_popup_qualifier;
}

◆ gnc_plugin_page_get_menu_qualifier()

const gchar * gnc_plugin_page_get_menu_qualifier ( GncPluginPage * page )

Retrieve the menu qualifier for this page.

Parameters

page	The page whose quailifier string should be retrieved.

Returns: A qualifier string for this page.

Definition at line 1022 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE(page), NULL);
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    return priv->menu_qualifier;
}

◆ gnc_plugin_page_get_page_color()

const gchar * gnc_plugin_page_get_page_color ( GncPluginPage * page )

Retrieve the color of this page.

This is the color string used in the notebook tab.

Parameters

page	The page whose name should be retrieved.

Returns: The color for this page. This string is owned by the page and should not be freed by the caller.

Definition at line 788 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE(page), NULL);
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    return priv->page_color;
}

◆ gnc_plugin_page_get_page_long_name()

const gchar * gnc_plugin_page_get_page_long_name ( GncPluginPage * page )

Retrieve the long name of this page.

This is the string used in the tooltip that is attached to the page name in the notebook tab.

Parameters

page	The page whose name should be retrieved.

Returns: The page's name. This string is owned by the page and should not be freed by the caller.

Definition at line 758 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE(page), NULL);
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    return priv->page_long_name;
}

◆ gnc_plugin_page_get_page_name()

const gchar * gnc_plugin_page_get_page_name ( GncPluginPage * page )

Retrieve the name of this page.

This is the string used in the window title, and in the notebook tab and page selection menus.

Parameters

page	The page whose name should be retrieved.

Returns: The page's name. This string is owned by the page and should not be freed by the caller.

Definition at line 718 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE(page), NULL);
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    return priv->page_name;
}

◆ gnc_plugin_page_get_plugin_name()

const gchar * gnc_plugin_page_get_plugin_name ( GncPluginPage * plugin_page )

Retrieve the textual name of a plugin.

Parameters

plugin_page A pointer to the page whose actions name should be retrieved.

Returns: The name of this plugin. This string is owned by the plugin.

Definition at line 298 of file gnc-plugin-page.c.

{
    GncPluginPageClass *klass;
 
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE(plugin_page), NULL);
 
    klass = GNC_PLUGIN_PAGE_GET_CLASS(plugin_page);
    g_return_val_if_fail (klass != NULL, NULL);
 
    return (klass->plugin_name);
}

◆ gnc_plugin_page_get_simple_action_group_name()

const gchar * gnc_plugin_page_get_simple_action_group_name ( GncPluginPage * page )

Retrieve the simple action group name associated with this plugin page.

Parameters

page	The page whose simple action group should be retrieved.

Returns: The simple action group name associated with this plugin.

Definition at line 1093 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE(page), NULL);
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
 
    return priv->simple_action_group_name;
}

◆ gnc_plugin_page_get_statusbar_text()

const gchar * gnc_plugin_page_get_statusbar_text ( GncPluginPage * page )

Retrieve the statusbar text associated with this page.

Parameters

page	The page whose statusbar should text be retrieved.

Returns: A pointer to the statusbar text for this page. This string is owned by the page and should not be freed by the caller.

Definition at line 920 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE(page), NULL);
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    return priv->statusbar_text;
}

◆ gnc_plugin_page_get_type()

GType gnc_plugin_page_get_type ( void )

Get the type of a content plugin.

Returns: A GType.

◆ gnc_plugin_page_get_ui_description()

const char * gnc_plugin_page_get_ui_description ( GncPluginPage * page )

Retrieve the name of the XML UI file associated with this page.

Parameters

page	The page whose setting should be retrieved.

Returns: A pointer to the filename used for the UI. This string is owned by the page and should not be freed by the caller.

Definition at line 978 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE(page), FALSE);
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    return priv->ui_description;
}

◆ gnc_plugin_page_get_use_new_window()

gboolean gnc_plugin_page_get_use_new_window ( GncPluginPage * page )

Retrieve the "use new window" setting associated with this page.

Parameters

page	The page whose setting should be retrieved.

Returns: Whether this page should be created in a new window.

Definition at line 949 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE(page), FALSE);
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    return priv->use_new_window;
}

◆ gnc_plugin_page_get_window()

GtkWidget * gnc_plugin_page_get_window ( GncPluginPage * page )

Retrieve a pointer to the GncMainWindow (GtkWindow) containing this page.

Parameters

page	The page whose window should be retrieved.

Returns: A pointer to the window.

Definition at line 707 of file gnc-plugin-page.c.

{
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE(page), NULL);
 
    return page->window;
}

◆ gnc_plugin_page_has_book()

gboolean gnc_plugin_page_has_book	(	GncPluginPage *	page,
		QofBook *	book
	)

Query a page to see if it has a reference to a given book.

This function takes a guid instead of a QofBook because that's what the engine event mechanism provides.

Parameters

page	The page to query.
book	The guid of the book in question.

Returns: TRUE if the page refers to the specified book. FALSE otherwise.

Definition at line 671 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
    GList *item;
 
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE(page), FALSE);
    g_return_val_if_fail (book != NULL, FALSE);
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    for (item = priv->books; item; item = g_list_next (item))
    {
        if (item->data == book)
        {
            return TRUE;
        }
    }
    return FALSE;
}

◆ gnc_plugin_page_has_books()

gboolean gnc_plugin_page_has_books ( GncPluginPage * page )

Query a page to see if it has a reference to any book.

Parameters

page	The page to query.

Returns: TRUE if the page references any books. FALSE otherwise.

Definition at line 693 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_val_if_fail (GNC_IS_PLUGIN_PAGE(page), FALSE);
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    return (priv->books != NULL);
}

◆ gnc_plugin_page_inserted()

void gnc_plugin_page_inserted ( GncPluginPage * plugin_page )

Definition at line 313 of file gnc-plugin-page.c.

{
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(plugin_page));
 
    g_signal_emit (G_OBJECT(plugin_page), signals[INSERTED], 0);
}

◆ gnc_plugin_page_inserted_cb()

void gnc_plugin_page_inserted_cb	(	GncPluginPage *	page,
		gpointer	user_data
	)

Set up the page_changed callback for when the current page is changed.

This will store a pointer to the page focus function passed as a parameter so that it can be used in setting up the g_idle_add

Parameters

page	The page the callback is setup for.
user_data	The page focus function

Definition at line 882 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(page));
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
 
    priv->page_changed_id = g_signal_connect (G_OBJECT(page->window), "page_changed",
                                              G_CALLBACK(gnc_plugin_page_main_window_changed),
                                              page);
 
    // on initial load try and set the page focus
    if (!gnc_main_window_is_restoring_pages (GNC_MAIN_WINDOW (gnc_ui_get_main_window (page->window))))
        (GNC_PLUGIN_PAGE_GET_CLASS(page)->focus_page)(page, TRUE);
}

◆ gnc_plugin_page_merge_actions()

void gnc_plugin_page_merge_actions ( GncPluginPage * plugin_page )

Add the actions for a content page to the specified window.

Parameters

plugin_page A pointer to the page whose actions should be added to the user interface.

Definition at line 253 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
    GError *error = NULL;
    gchar *resource;
 
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(page));
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
 
    if (!priv->builder)
        priv->builder = gtk_builder_new ();
 
    resource = g_strconcat (GNUCASH_RESOURCE_PREFIX "/", priv->ui_description, NULL);
 
    gtk_builder_set_translation_domain (priv->builder, PROJECT_NAME);
 
    gtk_builder_add_from_resource (priv->builder, resource, &error);
 
    if (error)
    {
        g_critical ("Failed to load ui resource %s, Error %s", resource, error->message);
        g_error_free (error);
    }
    g_free (resource);
}

◆ gnc_plugin_page_recreate_page()

GncPluginPage * gnc_plugin_page_recreate_page	(	GtkWidget *	window,
		const gchar *	page_type,
		GKeyFile *	key_file,
		const gchar *	group_name
	)

This function looks up a specific plugin type by name, and then calls a plugin specific function to create a new page and restore its content to a previous state.

Parameters

window	The window where this page should be installed.
page_type	The name of the page type to create.
key_file	A pointer to the GKeyFile data structure where the page information should be read.
group_name	The group name to use when restoring data.

Definition at line 213 of file gnc-plugin-page.c.

{
    GncPluginPageClass *klass;
    GncPluginPage *page = NULL;
    GType type;
 
    ENTER("type %s, keyfile %p, group %s", page_type, key_file, page_group);
    type = g_type_from_name (page_type);
    if (type == 0)
    {
        LEAVE("Cannot find type named %s", page_type);
        return NULL;
    }
 
    klass = g_type_class_ref (type);
    if (klass == NULL)
    {
        const gchar *type_name = g_type_name (type);
        LEAVE("Cannot create class %s(%s)", page_type, type_name ? type_name : "invalid type");
        return NULL;
    }
 
    if (!klass->recreate_page)
    {
        LEAVE("Class %shas no recreate function.", page_type);
        g_type_class_unref (klass);
        return NULL;
    }
 
    page = (klass->recreate_page)(window, key_file, page_group);
    g_type_class_unref (klass);
    LEAVE(" ");
    return page;
}

◆ gnc_plugin_page_removed()

void gnc_plugin_page_removed ( GncPluginPage * plugin_page )

Definition at line 321 of file gnc-plugin-page.c.

{
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(plugin_page));
 
    g_signal_emit (G_OBJECT(plugin_page), signals[REMOVED], 0);
}

◆ gnc_plugin_page_save_page()

void gnc_plugin_page_save_page	(	GncPluginPage *	page,
		GKeyFile *	key_file,
		const gchar *	group_name
	)

Call the plugin specific function that will save the state of a content page to a disk.

That function must save enough information about the page that it can be recreated next time the user starts gnucash.

Parameters

page	The page to save.
key_file	A pointer to the GKeyFile data structure where the page information should be written.
group_name	The group name to use when saving data.

Definition at line 189 of file gnc-plugin-page.c.

{
    GncPluginPageClass *klass;
 
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(page));
    g_return_if_fail (key_file != NULL);
    g_return_if_fail (group_name != NULL);
 
    ENTER(" ");
    klass = GNC_PLUGIN_PAGE_GET_CLASS(page);
    g_return_if_fail (klass != NULL);
    g_return_if_fail (klass->save_page != NULL);
 
    klass->save_page (page, key_file, group_name);
    LEAVE(" ");
}

◆ gnc_plugin_page_selected()

void gnc_plugin_page_selected ( GncPluginPage * plugin_page )

Definition at line 329 of file gnc-plugin-page.c.

{
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(plugin_page));
 
    g_signal_emit (G_OBJECT(plugin_page), signals[SELECTED], 0);
}

◆ gnc_plugin_page_set_menu_popup_qualifier()

void gnc_plugin_page_set_menu_popup_qualifier	(	GncPluginPage *	page,
		const char *	menu_qualifier
	)

Set a qualifier string for this page.

This string is used when there is more than one popup menu associated with the page.

Parameters

page	The page whose qualifier string should be updated.
menu_qualifier	A string to be used as for the qualifier.

Definition at line 1057 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(page));
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
 
    priv->menu_popup_qualifier = menu_qualifier;
}

◆ gnc_plugin_page_set_menu_qualifier()

void gnc_plugin_page_set_menu_qualifier	(	GncPluginPage *	page,
		const char *	menu_qualifier
	)

Set a qualifier string for this page.

This string is used when there is more than one menu associated with the page.

Parameters

page	The page whose qualifier string should be updated.
menu_qualifier	A string to be used as for the qualifier.

Definition at line 1033 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(page));
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
 
    priv->menu_qualifier = menu_qualifier;
}

◆ gnc_plugin_page_set_page_color() [1/2]

void gnc_plugin_page_set_page_color	(	GncPluginPage *	page,
		const char *	color
	)

Set the color of this page.

This is the color string used in the notebook tab.

Parameters

page	The page whose name should be retrieved.
color	The color for this page. This string is owned by the page and should not be freed by the caller.

◆ gnc_plugin_page_set_page_color() [2/2]

void gnc_plugin_page_set_page_color	(	GncPluginPage *	page,
		const gchar *	color
	)

Definition at line 801 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(page));
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    if (priv->page_color)
        g_free (priv->page_color);
 
    if (color)
        priv->page_color = g_strdup (color);
}

◆ gnc_plugin_page_set_page_long_name() [1/2]

void gnc_plugin_page_set_page_long_name	(	GncPluginPage *	page,
		const char *	name
	)

Set the long name of this page.

This is the string used in the tooltip that is attached to the page name in the notebook tab.

Parameters

page	The page whose name should be set.
name	The new string for the name.

◆ gnc_plugin_page_set_page_long_name() [2/2]

void gnc_plugin_page_set_page_long_name	(	GncPluginPage *	page,
		const gchar *	name
	)

Definition at line 772 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(page));
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    if (priv->page_long_name)
        g_free (priv->page_long_name);
 
    priv->page_long_name = g_strdup (name);
}

◆ gnc_plugin_page_set_page_name() [1/2]

void gnc_plugin_page_set_page_name	(	GncPluginPage *	page,
		const char *	name
	)

Set the name of this page.

This is the string used in the window title, and in the notebook tab and page selection menus.

Parameters

page	The page whose name should be set.
name	The new string for the name.

◆ gnc_plugin_page_set_page_name() [2/2]

void gnc_plugin_page_set_page_name	(	GncPluginPage *	page,
		const gchar *	name
	)

Definition at line 732 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
    GncPluginPageClass *klass;
 
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(page));
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    if (priv->page_name)
        g_free (priv->page_name);
 
    priv->page_name = g_strdup (name);
 
    /* Perform page specific actions */
    klass = GNC_PLUGIN_PAGE_GET_CLASS (page);
    if (klass->page_name_changed)
    {
        klass->page_name_changed(page, name);
    }
}

◆ gnc_plugin_page_set_statusbar_text() [1/2]

void gnc_plugin_page_set_statusbar_text	(	GncPluginPage *	page,
		const char *	name
	)

Set the statusbar text associated with this page.

Parameters

page	The page whose statusbar text should be set.
name	The new statusbar text for the page.

◆ gnc_plugin_page_set_statusbar_text() [2/2]

void gnc_plugin_page_set_statusbar_text	(	GncPluginPage *	page,
		const gchar *	message
	)

Definition at line 933 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(page));
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    if (priv->statusbar_text)
        g_free (priv->statusbar_text);
 
    priv->statusbar_text = g_strdup (message);
}

◆ gnc_plugin_page_set_ui_description()

void gnc_plugin_page_set_ui_description	(	GncPluginPage *	page,
		const char *	ui_filename
	)

Set an alternate UI for the specified page.

This alternate ui may only use actions specified in the source for the page.

Note: This function must be called before the page is installed into a window.

Parameters

page	The page to modify.
ui_filename	The filename (no path) of the alternate UI.

Definition at line 992 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(page));
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    if (priv->ui_description)
        g_free (priv->ui_description);
 
    priv->ui_description = g_strdup (ui_filename);
}

◆ gnc_plugin_page_set_use_new_window()

void gnc_plugin_page_set_use_new_window	(	GncPluginPage *	page,
		gboolean	use_new
	)

Set the "use new window" setting associated with this page.

If this setting is TRUE, the page will be installed into a new window. Otherwise the page will be installed into an existing window.

Parameters

page	The page whose setting should be updated.
use_new	The new value for this setting.

Definition at line 965 of file gnc-plugin-page.c.

{
    GncPluginPagePrivate *priv;
 
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(page));
 
    priv = GNC_PLUGIN_PAGE_GET_PRIVATE(page);
    priv->use_new_window = use_new;
}

◆ gnc_plugin_page_show_summarybar()

void gnc_plugin_page_show_summarybar	(	GncPluginPage *	page,
		gboolean	visible
	)

Show/hide the summarybar associated with this page.

Parameters

page	The page whose summarybar visibility should be changed.
visible	Whether or not the summarybar should be shown..

Definition at line 169 of file gnc-plugin-page.c.

{
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(page));
 
    if (!page->summarybar)
        return;
 
    if (visible)
        gtk_widget_show (page->summarybar);
    else
        gtk_widget_hide (page->summarybar);
}

◆ gnc_plugin_page_unselected()

void gnc_plugin_page_unselected ( GncPluginPage * plugin_page )

Definition at line 337 of file gnc-plugin-page.c.

{
    g_return_if_fail (GNC_IS_PLUGIN_PAGE(plugin_page));
 
    g_signal_emit (G_OBJECT(plugin_page), signals[UNSELECTED], 0);
}

Files

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ GNC_IS_PLUGIN_PAGE

◆ GNC_IS_PLUGIN_PAGE_CLASS

◆ GNC_PLUGIN_PAGE

◆ GNC_PLUGIN_PAGE_CLASS

◆ GNC_PLUGIN_PAGE_GET_CLASS

◆ GNC_PREF_SUMMARYBAR_POSITION_BOTTOM

◆ GNC_PREF_SUMMARYBAR_POSITION_TOP

◆ GNC_TYPE_PLUGIN_PAGE

Enumeration Type Documentation

◆ anonymous enum

◆ anonymous enum

Function Documentation

◆ G_DEFINE_TYPE_WITH_CODE()

◆ gnc_plugin_page_add_book()

◆ gnc_plugin_page_create_action_group()

◆ gnc_plugin_page_create_widget()

◆ gnc_plugin_page_destroy_widget()

◆ gnc_plugin_page_disconnect_page_changed()

◆ gnc_plugin_page_finish_pending()

◆ gnc_plugin_page_get_action()

◆ gnc_plugin_page_get_action_group()

◆ gnc_plugin_page_get_builder()

◆ gnc_plugin_page_get_menu_popup_qualifier()

◆ gnc_plugin_page_get_menu_qualifier()

◆ gnc_plugin_page_get_page_color()

◆ gnc_plugin_page_get_page_long_name()

◆ gnc_plugin_page_get_page_name()

◆ gnc_plugin_page_get_plugin_name()

◆ gnc_plugin_page_get_simple_action_group_name()

◆ gnc_plugin_page_get_statusbar_text()

◆ gnc_plugin_page_get_type()

◆ gnc_plugin_page_get_ui_description()

◆ gnc_plugin_page_get_use_new_window()

◆ gnc_plugin_page_get_window()

◆ gnc_plugin_page_has_book()

◆ gnc_plugin_page_has_books()

◆ gnc_plugin_page_inserted()

◆ gnc_plugin_page_inserted_cb()

◆ gnc_plugin_page_merge_actions()

◆ gnc_plugin_page_recreate_page()

◆ gnc_plugin_page_removed()

◆ gnc_plugin_page_save_page()

◆ gnc_plugin_page_selected()

◆ gnc_plugin_page_set_menu_popup_qualifier()

◆ gnc_plugin_page_set_menu_qualifier()

◆ gnc_plugin_page_set_page_color() [1/2]

◆ gnc_plugin_page_set_page_color() [2/2]

◆ gnc_plugin_page_set_page_long_name() [1/2]

◆ gnc_plugin_page_set_page_long_name() [2/2]

◆ gnc_plugin_page_set_page_name() [1/2]

◆ gnc_plugin_page_set_page_name() [2/2]

◆ gnc_plugin_page_set_statusbar_text() [1/2]

◆ gnc_plugin_page_set_statusbar_text() [2/2]

◆ gnc_plugin_page_set_ui_description()

◆ gnc_plugin_page_set_use_new_window()

◆ gnc_plugin_page_show_summarybar()

◆ gnc_plugin_page_unselected()