Common object and functions

Files
file	gnc-plugin.c
	Functions for adding plugins to a Gnucash window.
file	gnc-plugin.h
	Functions for adding plugins to a GnuCash window.

Data Structures
struct	GncPluginPrivate
	The instance private data for a menu-only plugin. More...
struct	_GncPluginClass
	The class data structure for a menu-only plugin. More...
struct	action_toolbar_labels
	A structure for defining alternate action names for use in the toolbar. More...

Macros
#define	GNC_TYPE_PLUGIN   (gnc_plugin_get_type ())
#define	GNC_PLUGIN_NAME   "GncPlugin"

Functions
	G_DEFINE_TYPE_WITH_CODE (GncPlugin, gnc_plugin, G_TYPE_OBJECT, G_ADD_PRIVATE(GncPlugin))
	Initialize the class for the new gnucash plugin object.
void	gnc_plugin_add_to_window (GncPlugin *plugin, GncMainWindow *window, GQuark type)
	Add the specified plugin from the specified window.
void	gnc_plugin_remove_from_window (GncPlugin *plugin, GncMainWindow *window, GQuark type)
	Remove the specified plugin from the specified window.
const gchar *	gnc_plugin_get_name (GncPlugin *plugin)
	Retrieve the textual name of a plugin.
void	gnc_plugin_init_short_names (GtkWidget *toolbar, GncToolBarShortNames *toolbar_labels)
	Add "short" labels to existing actions.
void	gnc_plugin_set_actions_enabled (GActionMap *action_map, const gchar **action_names, gboolean enable)
	This function sets the sensitivity of a GAction in a specific group.
void	gnc_plugin_add_menu_tooltip_callbacks (GtkWidget *menubar, GMenuModel *menubar_model, GtkWidget *statusbar)
	This function adds the tooltip callbacks to make the tooltips appear in the status bar.
void	gnc_plugin_add_toolbar_tooltip_callbacks (GtkWidget *toolbar, GtkWidget *statusbar)
	This function adds the tooltip callbacks to make the tooltips appear in the status bar.

Detailed Description

Macro Definition Documentation

GNC_PLUGIN_NAME

#define GNC_PLUGIN_NAME   "GncPlugin"

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

GNC_TYPE_PLUGIN

#define GNC_TYPE_PLUGIN   (gnc_plugin_get_type ())

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

Function Documentation

G_DEFINE_TYPE_WITH_CODE()

G_DEFINE_TYPE_WITH_CODE	(	GncPlugin	,
		gnc_plugin	,
		G_TYPE_OBJECT	,
		G_ADD_PRIVATE(GncPlugin)
	)

Initialize the class for the new gnucash plugin object.

This will set up any function pointers that override functions in the parent class, and also installs the proprieties that are unique to this class.

Parameters

klass

The new class structure created by the object system.

Definition at line 61 of file gnc-plugin.c.

{
    GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 
    gobject_class->constructed = gnc_plugin_constructed;
    gobject_class->finalize = gnc_plugin_finalize;
}

gnc_plugin_add_menu_tooltip_callbacks()

void gnc_plugin_add_menu_tooltip_callbacks	(	GtkWidget *	menubar,
		GMenuModel *	menubar_model,
		GtkWidget *	statusbar
	)

This function adds the tooltip callbacks to make the tooltips appear in the status bar.

Parameters

menubar	The main window menu bar widget.
menubar_model	The GMenuModel used to create the menubar.
statusbar	The status bar widget in the main window.

Definition at line 268 of file gnc-plugin.c.

{
    GList *menu_item_list;
 
    g_return_if_fail (G_IS_MENU_MODEL(menubar_model));
    g_return_if_fail (GTK_IS_STATUSBAR(statusbar));
 
    menu_item_list = gnc_menu_get_items (menubar);
 
    for (GList *node = menu_item_list; node; node = node->next)
    {
        GtkWidget *menu_item = node->data;
 
        gnc_menu_item_setup_tooltip_to_statusbar_callback (menu_item, statusbar);
    }
    g_object_set_data (G_OBJECT(statusbar), "menu-model", menubar_model);
    g_list_free (menu_item_list);
}

gnc_plugin_add_to_window()

void gnc_plugin_add_to_window	(	GncPlugin *	plugin,
		GncMainWindow *	window,
		GQuark	type
	)

Add the specified plugin from the specified window.

Add the specified plugin to the specified window.

This function will add the page's user interface from the window and call the plugin to perform any plugin specific actions.

See gnc-plugin.h for documentation on the function arguments.

This function will add the page's user interface from the window and call the plugin to perform any plugin specific actions.

Parameters

plugin	The plugin to be added.
window	Add the plugin to this window.
type	An identifier for the type of window specified.

Definition at line 133 of file gnc-plugin.c.

{
    GncPluginClass *klass;
 
    g_return_if_fail (GNC_IS_PLUGIN (plugin));
    klass = GNC_PLUGIN_GET_CLASS (plugin);
    ENTER (": plugin %s(%p), window %p", gnc_plugin_get_name(plugin),
           plugin, window);
 
    /*
     * Update window with additional UI items
     */
    if (klass->actions_name)
    {
        DEBUG ("%s: %d actions to merge with gui from %s",
               klass->actions_name, klass->n_actions, klass->ui_filename);
        gnc_main_window_merge_actions (window, klass->actions_name,
                                       klass->actions, klass->n_actions,
                                       klass->ui_updates,
                                       klass->ui_filename, plugin);
    }
 
    /*
     * Do plugin specific actions.
     */
    if (GNC_PLUGIN_GET_CLASS (plugin)->add_to_window)
    {
        DEBUG ("Calling child class function %p", GNC_PLUGIN_GET_CLASS (plugin)->add_to_window);
        GNC_PLUGIN_GET_CLASS (plugin)->add_to_window (plugin, window, type);
    }
    LEAVE ("");
}

gnc_plugin_add_toolbar_tooltip_callbacks()

void gnc_plugin_add_toolbar_tooltip_callbacks	(	GtkWidget *	toolbar,
		GtkWidget *	statusbar
	)

This function adds the tooltip callbacks to make the tooltips appear in the status bar.

Parameters

toolbar	The main window tool bar widget.
statusbar	The status bar widget in the main window.

Definition at line 299 of file gnc-plugin.c.

{
    g_return_if_fail (GTK_IS_TOOLBAR(toolbar));
    g_return_if_fail (GTK_IS_STATUSBAR(statusbar));
 
    gtk_container_foreach (GTK_CONTAINER(toolbar), for_each_tool_action, statusbar);
}

gnc_plugin_get_name()

const gchar * gnc_plugin_get_name

(

GncPlugin *

plugin

)

Retrieve the textual name of a plugin.

Parameters

plugin

The plugin whose name should be returned.

Returns

A string containing the name of this plugin

Definition at line 212 of file gnc-plugin.c.

{
    g_return_val_if_fail (GNC_IS_PLUGIN (plugin), NULL);
    return (GNC_PLUGIN_GET_CLASS(plugin)->plugin_name);
}

gnc_plugin_init_short_names()

void gnc_plugin_init_short_names	(	GtkWidget *	toolbar,
		GncToolBarShortNames *	toolbar_labels
	)

Add "short" labels to existing actions.

The "short" label is the string used on toolbar buttons when the action is visible.

See gnc-plugin.h for documentation on the function arguments.

The "short" label is the string used on toolbar buttons when the action is visible. All toolbar buttons are homogeneous in size and are sized to fit the longest label. Therefore, this structure should be used if an action name is more than one word. This way the menu can have the label "Whizzy Feature", while the toolbar button only has the label "Whizzy".

Parameters

action_group	The group of all actions associated with a plugin or plugin page. All actions to me modified must be in this group.
toolbar_labels	A pointer to a NULL terminated array of data GncToolBarShortNames items.

Definition at line 229 of file gnc-plugin.c.

{
    g_return_if_fail (toolbar != NULL);
    g_return_if_fail (toolbar_labels != NULL);
 
    for (gint i = 0; (toolbar_labels[i].action_name); i++)
    {
        GtkWidget *tool_item = gnc_find_toolbar_item (toolbar, toolbar_labels[i].action_name);
 
        if (!tool_item)
            continue;
 
        gtk_tool_button_set_label (GTK_TOOL_BUTTON(tool_item), _(toolbar_labels[i].short_label));
        gtk_tool_button_set_use_underline (GTK_TOOL_BUTTON(tool_item), TRUE);
    }
}

gnc_plugin_remove_from_window()

void gnc_plugin_remove_from_window	(	GncPlugin *	plugin,
		GncMainWindow *	window,
		GQuark	type
	)

Remove the specified plugin from the specified window.

This function will call the plugin to perform any plugin specific actions and remove the page's user interface from the window.

Parameters

plugin	The plugin to be removed.
window	The window the plugin should be removed from.
type	An identifier for the type of window specified.

Definition at line 175 of file gnc-plugin.c.

{
    GncPluginClass *klass;
 
    g_return_if_fail (GNC_IS_PLUGIN (plugin));
    klass = GNC_PLUGIN_GET_CLASS (plugin);
    ENTER (": plugin %s(%p), window %p", gnc_plugin_get_name(plugin),
           plugin, window);
 
    /*
     * Do plugin specific actions.
     */
    if (GNC_PLUGIN_GET_CLASS (plugin)->remove_from_window)
    {
        DEBUG ("Calling child class function %p",
               GNC_PLUGIN_GET_CLASS (plugin)->remove_from_window);
        GNC_PLUGIN_GET_CLASS (plugin)->remove_from_window (plugin, window, type);
    }
 
    /*
     * Update window to remove UI items
     */
    if (klass->actions_name && !gnc_main_window_just_plugin_prefs (window))
    {
        DEBUG ("%s: %d actions to unmerge",
               klass->actions_name, (klass->n_actions));
        gnc_main_window_unmerge_actions (window, klass->actions_name);
    }
    LEAVE ("");
}

gnc_plugin_set_actions_enabled()

void gnc_plugin_set_actions_enabled	(	GActionMap *	action_map,
		const gchar **	action_names,
		gboolean	enable
	)

This function sets the sensitivity of a GAction in a specific group.

Parameters

action_map	The action map associated with the window.
action_names	A NULL terminated list of actions names that should be modified.
enable	A boolean specifying the new state for the specified property.

Definition at line 250 of file gnc-plugin.c.

{
    g_return_if_fail (action_map != NULL);
 
    for (gint i = 0; action_names[i]; i++)
    {
        GAction *action = g_action_map_lookup_action (G_ACTION_MAP(action_map),
                                                      action_names[i]);
        if (action)
             g_simple_action_set_enabled (G_SIMPLE_ACTION(action), enable);
        else
            PERR("No such action with name '%s' in action group %p)",
                  action_names[i], action_map);
    }
}