GnuCash  4.11-6-gd65b1226c7+
Data Structures | Macros | Functions

Functions for adding plugins to a GnuCash window. More...

#include <glib.h>
#include "qof.h"

Go to the source code of this file.

Data Structures

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))
 

Functions

GType gnc_plugin_page_get_type (void)
 Get the type of a content plugin. More...
 
GtkWidget * gnc_plugin_page_create_widget (GncPluginPage *plugin_page)
 Create the display widget that corresponds to this plugin. More...
 
void gnc_plugin_page_destroy_widget (GncPluginPage *plugin_page)
 Destroy the display widget that corresponds to this plugin. More...
 
void gnc_plugin_page_show_summarybar (GncPluginPage *page, gboolean visible)
 Show/hide the summarybar associated with this page. More...
 
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. More...
 
GncPluginPagegnc_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. More...
 
void gnc_plugin_page_merge_actions (GncPluginPage *plugin_page, GtkUIManager *merge)
 Add the actions for a content page to the specified window. More...
 
void gnc_plugin_page_unmerge_actions (GncPluginPage *plugin_page, GtkUIManager *merge)
 Remove the actions for a content page from the specified window. More...
 
const gchar * gnc_plugin_page_get_plugin_name (GncPluginPage *plugin_page)
 Retrieve the textual name of a plugin. More...
 
void gnc_plugin_page_add_book (GncPluginPage *page, QofBook *book)
 Add a book reference to the specified page. More...
 
gboolean gnc_plugin_page_has_book (GncPluginPage *page, QofBook *book)
 Query a page to see if it has a reference to a given book. More...
 
gboolean gnc_plugin_page_has_books (GncPluginPage *page)
 Query a page to see if it has a reference to any book. More...
 
GtkWidget * gnc_plugin_page_get_window (GncPluginPage *page)
 Retrieve a pointer to the GncMainWindow (GtkWindow) containing this page. More...
 
const gchar * gnc_plugin_page_get_page_name (GncPluginPage *page)
 Retrieve the name of this page. More...
 
void gnc_plugin_page_set_page_name (GncPluginPage *page, const char *name)
 Set the name of this page. More...
 
const gchar * gnc_plugin_page_get_page_long_name (GncPluginPage *page)
 Retrieve the long name of this page. More...
 
void gnc_plugin_page_set_page_long_name (GncPluginPage *page, const char *name)
 Set the long name of this page. More...
 
const gchar * gnc_plugin_page_get_page_color (GncPluginPage *page)
 Retrieve the color of this page. More...
 
void gnc_plugin_page_set_page_color (GncPluginPage *page, const char *color)
 Set the color of this page. More...
 
void gnc_plugin_page_inserted_cb (GncPluginPage *page, gpointer user_data)
 Set up the page_changed callback for when the current page is changed. More...
 
void gnc_plugin_page_disconnect_page_changed (GncPluginPage *page)
 Disconnect the page_changed_id signal callback. More...
 
const gchar * gnc_plugin_page_get_uri (GncPluginPage *page)
 Retrieve the Uniform Resource Identifier for this page. More...
 
void gnc_plugin_page_set_uri (GncPluginPage *page, const char *name)
 Set the Uniform Resource Identifier for this page. More...
 
const gchar * gnc_plugin_page_get_statusbar_text (GncPluginPage *page)
 Retrieve the statusbar text associated with this page. More...
 
void gnc_plugin_page_set_statusbar_text (GncPluginPage *page, const char *name)
 Set the statusbar text associated with this page. More...
 
gboolean gnc_plugin_page_get_use_new_window (GncPluginPage *page)
 Retrieve the "use new window" setting associated with this page. More...
 
void gnc_plugin_page_set_use_new_window (GncPluginPage *page, gboolean use_new)
 Set the "use new window" setting associated with this page. More...
 
const gchar * gnc_plugin_page_get_ui_description (GncPluginPage *page)
 Retrieve the name of the XML UI file associated with this page. More...
 
void gnc_plugin_page_set_ui_description (GncPluginPage *page, const char *ui_filename)
 Set an alternate UI for the specified page. More...
 
GtkUIManager * gnc_plugin_page_get_ui_merge (GncPluginPage *page)
 Retrieve the GtkUIManager object associated with this page. More...
 
GtkActionGroup * gnc_plugin_page_get_action_group (GncPluginPage *page)
 Retrieve the GtkActionGroup object associated with this page. More...
 
GtkActionGroup * gnc_plugin_page_create_action_group (GncPluginPage *page, const gchar *group_name)
 Create the GtkActionGroup object associated with this page. More...
 
GtkAction * gnc_plugin_page_get_action (GncPluginPage *page, const gchar *name)
 Retrieve a GtkAction object associated with this page. More...
 
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)
 
gboolean gnc_plugin_page_finish_pending (GncPluginPage *plugin_page)
 Tell a page to finish any outstanding activities. More...
 

Detailed Description

Functions for adding plugins to a GnuCash window.

Author
Copyright (C) 2003 Jan Arne Petersen
Copyright (C) 2003,2005 David Hampton hampt.nosp@m.on@e.nosp@m.mploy.nosp@m.ees..nosp@m.org

Definition in file gnc-plugin-page.h.