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
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 107 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 122 of file gnc-plugin.h.

const gchar* GncPluginClass::actions_name

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 119 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_data	A pointer to the this GncPlugin data structure.
window	A pointer to the window in which this plugin has just been installed.
type	An identifier for the type of window specified. Currently the only type is a "main" content window.

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

GObjectClass GncPluginClass::gobject

The parent class for this widget.

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

const gchar** GncPluginClass::important_actions

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 134 of file gnc-plugin.h.

guint GncPluginClass::n_actions

The number of actions in the actions array.

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

guint GncPluginClass::n_toggle_actions

The number of toggle actions in the toggle actions array.

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

const gchar* GncPluginClass::plugin_name

The textual name of this plugin.

Definition at line 112 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_data	A pointer to the this GncPlugin data structure.
window	A pointer to the window from which this plugin is about to be removed.
type	An identifier for the type of window specified. Currently the only type is a "main" content window.

Definition at line 171 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 127 of file gnc-plugin.h.

const gchar* GncPluginClass::ui_filename

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

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

---

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

• gnc-plugin.h