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"

G_BEGIN_DECLS

/* type macros */
#define GNC_TYPE_PLUGIN            (gnc_plugin_get_type ())
G_DECLARE_DERIVABLE_TYPE (GncPlugin, gnc_plugin, GNC, PLUGIN, GObject)

#define GNC_PLUGIN_NAME "GncPlugin"

/* typedefs & structures */

struct _GncPluginClass
{
    GObjectClass gobject;
    const gchar *plugin_name;

    /*  Actions section */

    const gchar *actions_name;
    GActionEntry   *actions;
    guint           n_actions;

    const gchar **ui_updates;

    const gchar *ui_filename;

    /*  Virtual Table */

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

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

/* function prototypes */

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;
    const char *tooltip;
} action_toolbar_labels;


void gnc_plugin_init_short_names (GtkWidget *toolbar,
                                  GncToolBarShortNames *toolbar_labels);


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

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

void gnc_plugin_add_toolbar_tooltip_callbacks (GtkWidget *toolbar,
                                               GtkWidget *statusbar);

G_END_DECLS

#endif /* __GNC_PLUGIN_H */