GnuCash 2.3.0
Data Fields
GncPluginClass Struct Reference

#include <gnc-plugin.h>

Data Fields

GObjectClass gobject
const gchar * plugin_name
const gchar * actions_name
GtkActionEntry * actions
guint n_actions
GtkToggleActionEntry * toggle_actions
guint n_toggle_actions
const gchar ** important_actions
const gchar * ui_filename
const gchar * gconf_section
void(* gconf_notifications )(GConfClient *client, guint cnxn_id, GConfEntry *entry, gpointer user_data)
void(* add_to_window )(GncPlugin *plugin, GncMainWindow *window, GQuark type)
void(* remove_from_window )(GncPlugin *plugin, GncMainWindow *window, GQuark type)

Detailed Description

The class data structure for a menu-only plugin.

Definition at line 108 of file gnc-plugin.h.


Field Documentation

GtkActionEntry* GncPluginClass::actions

An array of actions that should automatically be added to any GnuCash "main" content window that is opened.

Definition at line 123 of file gnc-plugin.h.

A name for the set of actions that will be added by this plugin. The actual name is irrelevant, as long as it is unique within GnuCash.

Definition at line 120 of file gnc-plugin.h.

void(* GncPluginClass::add_to_window)(GncPlugin *plugin, GncMainWindow *window, GQuark type)

A callback that will be invoked when this plugin is added to a window. This allows the plugin to perform any special actions at insertion time.

Parameters:
user_dataA pointer to the this GncPlugin data structure.
windowA pointer to the window in which this plugin has just been installed.
typeAn identifier for the type of window specified. Currently the only type is a "main" content window.

Definition at line 178 of file gnc-plugin.h.

void(* GncPluginClass::gconf_notifications)(GConfClient *client, guint cnxn_id, GConfEntry *entry, gpointer user_data)

A callback that will be invoked when any key in the specified GConf section is changed.

Parameters:
clientA pointer to the gconf client instance.
cnxn_idThe id number for this callback function.
entryA pointer to the changed data.
user_dataA pointer to the GncWindow where the plugin is installed.

Definition at line 160 of file gnc-plugin.h.

The partial section name that will be used in GConf for any preferences that are automatically stored for this page. This will be converted to a full section name by prefixing the string "/apps/gnucash/" to whatever is here.

Definition at line 147 of file gnc-plugin.h.

The parent class for this widget.

Definition at line 111 of file gnc-plugin.h.

A NULL terminated list of actions that should be considered important. In the toolbar, these actions will display the action name when the toolbar is in "text beside icons" mode.

Definition at line 135 of file gnc-plugin.h.

The number of actions in the actions array.

Definition at line 125 of file gnc-plugin.h.

The number of toggle actions in the toggle actions array.

Definition at line 130 of file gnc-plugin.h.

The textual name of this plugin.

Definition at line 113 of file gnc-plugin.h.

void(* GncPluginClass::remove_from_window)(GncPlugin *plugin, GncMainWindow *window, GQuark type)

A callback that will be invoked when this plugin is removed from a window. This allows the plugin to perform any special actions at removal time.

Parameters:
user_dataA pointer to the this GncPlugin data structure.
windowA pointer to the window from which this plugin is about to be removed.
typeAn identifier for the type of window specified. Currently the only type is a "main" content window.

Definition at line 194 of file gnc-plugin.h.

GtkToggleActionEntry* GncPluginClass::toggle_actions

An array of toggle actions that should automatically be added to any GnuCash "main" content window that is opened.

Definition at line 128 of file gnc-plugin.h.

The relative name of the XML file describing the menu/toolbar action items.

Definition at line 138 of file gnc-plugin.h.


The documentation for this struct was generated from the following file:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines