GnuCash  4.12-68-g5dc52459a1+
Data Fields
GncPluginPageClass Struct Reference

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

#include <gnc-plugin-page.h>

Data Fields

GObjectClass gobject
 
const gchar * tab_icon
 The relative name of the icon that should be shown on the tab for this page. More...
 
const gchar * plugin_name
 The textual name of this plugin. More...
 
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)
 Function called to create the display widget for a particular type of plugin. More...
 
void(* destroy_widget )(GncPluginPage *plugin_page)
 Function called to destroy the display widget for a particular type of plugin. More...
 
void(* 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. More...
 
GncPluginPage *(* recreate_page )(GtkWidget *window, GKeyFile *file, const gchar *group)
 Create a new page based on the information saved during a previous instantiation of gnucash. More...
 
void(* 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). More...
 
void(* focus_page )(GncPluginPage *plugin_page, gboolean on_current_page)
 Perform plugin specific actions to set the focus. More...
 
gboolean(* focus_page_function )(GncPluginPage *plugin_page)
 This function performs specific actions to set the focus on a specific widget. More...
 
void(* page_name_changed )(GncPluginPage *plugin_page, const gchar *name)
 This function vector allows page specific actions to occur when the page name is changed. More...
 
void(* 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. More...
 
gboolean(* finish_pending )(GncPluginPage *plugin_page)
 This function vector is called to finish any outstanding activities. More...
 

Detailed Description

The class data structure for a content plugin.

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

Field Documentation

◆ create_widget

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_pageA pointer to the plugin for which a display widget should be created.
Returns
A displayable gtk widget.

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

◆ destroy_widget

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

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

Parameters
plugin_pageA pointer to the plugin whose display widget should be destroyed.

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

◆ finish_pending

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
pageThe page in a main window.
Returns
FALSE if the page could not or would not comply, which should cancel the pending operation. TRUE otherwise

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

◆ focus_page

void(* GncPluginPageClass::focus_page) (GncPluginPage *plugin_page, gboolean on_current_page)

Perform plugin specific actions to set the focus.

Parameters
pageThe page that was added to a window.
on_current_pgaeWhether this page is the currentone.

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

◆ focus_page_function

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

This function performs specific actions to set the focus on a specific widget.

Parameters
pageThe page that was added to a window.
Returns
FALSE to remove idle

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

◆ page_name_changed

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
pageThe page to update.
nameThe new name for this page.

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

◆ plugin_name

const gchar* GncPluginPageClass::plugin_name

The textual name of this plugin.

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

◆ recreate_page

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
windowThe window where this new page will be installed.
key_fileA pointer to the GKeyFile data structure where the page information should be retrieved.
group_nameThe group name to use when retrieving data. The name is specific to this page instance.
Returns
A pointer to the new page.

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

◆ save_page

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
pageThe page to save.
key_fileA pointer to the GKeyFile data structure where the page information should be written.
group_nameThe group name to use when writing data. The name is specific to this page instance.

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

◆ tab_icon

const gchar* GncPluginPageClass::tab_icon

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

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

◆ update_edit_menu_actions

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
pageThe front page in a main window..
hideWhether the widgets should be shown or hidden.

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

◆ window_changed

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
pageThe page that was added to a window.
windowThe window where the page was added.

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


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