gnc-plugin.h

Go to the documentation of this file.

/*
 * gnc-plugin.h -- A module or plugin which can add more
 *      functionality to GnuCash.
 * Copyright (C) 2003 Jan Arne Petersen <jpetersen@uni-bonn.de>
 * Copyright (C) 2003,2005 David Hampton <hampton@employees.org>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, contact:
 *
 * Free Software Foundation           Voice:  +1-617-542-5942
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652
 * Boston, MA  02110-1301,  USA       gnu@gnu.org
 */

#ifndef __GNC_PLUGIN_H
#define __GNC_PLUGIN_H

#include "gnc-main-window.h"
#include "gnc-plugin-page.h"
#include <gconf/gconf-client.h>

G_BEGIN_DECLS

/* type macros */
#define GNC_TYPE_PLUGIN            (gnc_plugin_get_type ())
#define GNC_PLUGIN(o)              (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_PLUGIN, GncPlugin))
#define GNC_PLUGIN_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_PLUGIN, GncPluginClass))
#define GNC_IS_PLUGIN(o)           (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_PLUGIN))
#define GNC_IS_PLUGIN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_PLUGIN))
#define GNC_PLUGIN_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_PLUGIN, GncPluginClass))

#define GNC_PLUGIN_NAME "GncPlugin"

/* typedefs & structures */

typedef struct
{
    GObject gobject;
} GncPlugin;

typedef struct
{
    GObjectClass gobject;
    const gchar *plugin_name;

    /*  Actions section */

    const gchar *actions_name;
    GtkActionEntry *actions;
    guint n_actions;
    GtkToggleActionEntry *toggle_actions;
    guint n_toggle_actions;
    const gchar **important_actions;
    const gchar *ui_filename;

    /*  GConf section */

    const gchar* gconf_section;
    void (* gconf_notifications)
    (GConfClient *client, guint cnxn_id, GConfEntry *entry, gpointer user_data);

    /*  Virtual Table */

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

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

/* function prototypes */

GType gnc_plugin_get_type (void);


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


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


const gchar *gnc_plugin_get_name (GncPlugin *plugin);


typedef struct
{
    const char *action_name;
    const char *label;
} action_toolbar_labels;


void gnc_plugin_init_short_names (GtkActionGroup *action_group,
                                  action_toolbar_labels *toolbar_labels);


void gnc_plugin_set_important_actions (GtkActionGroup *action_group,
                                       const gchar **names);


void gnc_plugin_update_actions (GtkActionGroup *action_group,
                                const gchar **action_names,
                                const gchar *property_name,
                                gboolean value);


gint gnc_plugin_add_actions (GtkUIManager *ui_merge,
                             GtkActionGroup *action_group,
                             const gchar *filename);
G_END_DECLS

#endif /* __GNC_PLUGIN_H */