GncPluginPageClass Struct Reference
[Common object and functions]

#include <gnc-plugin-page.h>

---

Detailed Description

The class data structure for a content plugin.

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

Data Fields
GObjectClass	gobject
const gchar *	tab_icon
const gchar *	plugin_name
void(*	inserted )(GncPluginPage *plugin_page)
void(*	removed )(GncPluginPage *plugin_page)
void(*	selected )(GncPluginPage *plugin_page)
void(*	unselected )(GncPluginPage *plugin_page)
GtkWidget *(*	create_widget )(GncPluginPage *plugin_page)
void(*	destroy_widget )(GncPluginPage *plugin_page)
void(*	save_page )(GncPluginPage *page, GKeyFile *file, const gchar *group)
GncPluginPage *(*	recreate_page )(GtkWidget *window, GKeyFile *file, const gchar *group)
void(*	window_changed )(GncPluginPage *plugin_page, GtkWidget *window)
void(*	page_name_changed )(GncPluginPage *plugin_page, const gchar *name)
void(*	update_edit_menu_actions )(GncPluginPage *plugin_page, gboolean hide)
gboolean(*	finish_pending )(GncPluginPage *plugin_page)

---

Field Documentation

const gchar* GncPluginPageClass::tab_icon

The relative name of the icon that should be shown on the tab for this page.

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

const gchar* GncPluginPageClass::plugin_name

The textual name of this plugin.

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

GtkWidget*(* GncPluginPageClass::create_widget)(GncPluginPage *plugin_page)

Function called to create the display widget for a particular type of plugin. 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.

void(* GncPluginPageClass::destroy_widget)(GncPluginPage *plugin_page)

Function called to destroy the display widget for a particular type of plugin.

Parameters:

plugin_page

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

void(* GncPluginPageClass::save_page)(GncPluginPage *page, GKeyFile *file, const gchar *group)

Save enough information about this page so 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 writing data. The name is specific to this page instance.

GncPluginPage*(* GncPluginPageClass::recreate_page)(GtkWidget *window, GKeyFile *file, const gchar *group)

Create a new page based on the information saved during a previous instantiation of gnucash. This function may or may not install the new page in the window as it sees fit. Generally the function will install the page int the window in order to manipulate the menu items that are created at install time.

Parameters:

	window	The window where this new page will be installed.
	key_file	A pointer to the GKeyFile data structure where the page information should be retrieved.
	group_name	The group name to use when retrieving data. The name is specific to this page instance.

Returns:

A pointer to the new page.

void(* GncPluginPageClass::window_changed)(GncPluginPage *plugin_page, GtkWidget *window)

Perform plugin specific actions when a page is added to a window (or has been removed from one window and added to a new window). This function is called after the page is installed in the window, just before the window's PAGE_ADDED signal is generated.

Parameters:

	page	The page that was added to a window.
	window	The window where the page was added.

void(* GncPluginPageClass::page_name_changed)(GncPluginPage *plugin_page, const gchar *name)

This function vector allows page specific actions to occur when the page name is changed.

Parameters:

	page	The page to update.
	name	The new name for this page.

void(* GncPluginPageClass::update_edit_menu_actions)(GncPluginPage *plugin_page, gboolean hide)

This function vector allows page specific actions to override the generic code for setting the sensitivity of items in the Edit menu.

Parameters:

	page	The front page in a main window..
	hide	Whether the widgets should be shown or hidden.

gboolean(* GncPluginPageClass::finish_pending)(GncPluginPage *plugin_page)

This function vector is called to finish any outstanding activities. It will be called for such things as closing a page, saving the data file, etc.

Parameters:

page

The page in a main window.

Returns:

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

---

The documentation for this struct was generated from the following file:

• gnc-plugin-page.h

---