gnc-plugin-page.h

Go to the documentation of this file.

/*
 * gnc-plugin-page.h -- A page, which can be added to the
 *  GnuCash main window.
 *
 * 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_PAGE_H
#define __GNC_PLUGIN_PAGE_H

#include <glib.h>
#include "qof.h"

G_BEGIN_DECLS

#define GNC_PREF_SUMMARYBAR_POSITION_TOP    "summarybar-position-top"
#define GNC_PREF_SUMMARYBAR_POSITION_BOTTOM "summarybar-position-bottom"

/* type macros */
#define GNC_TYPE_PLUGIN_PAGE            (gnc_plugin_page_get_type ())
#define GNC_PLUGIN_PAGE(o)              (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_PLUGIN_PAGE, GncPluginPage))
#define GNC_PLUGIN_PAGE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_PLUGIN_PAGE, GncPluginPageClass))
#define GNC_IS_PLUGIN_PAGE(o)           (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_PLUGIN_PAGE))
#define GNC_IS_PLUGIN_PAGE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_PLUGIN_PAGE))
#define GNC_PLUGIN_PAGE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_PLUGIN_PAGE, GncPluginPageClass))

/* typedefs & structures */

typedef struct GncPluginPage
{
    GObject gobject;            
    GtkWidget *window;          
    GtkWidget *notebook_page;   
    GtkWidget *summarybar;      
} GncPluginPage;


typedef struct
{
    GObjectClass gobject;

    const gchar *tab_icon;
    const gchar *plugin_name;

    /* Signals */
    void (* inserted) (GncPluginPage *plugin_page);
    void (* removed) (GncPluginPage *plugin_page);
    void (* selected) (GncPluginPage *plugin_page);
    void (* unselected) (GncPluginPage *plugin_page);

    /* Virtual Table */

    GtkWidget *(* create_widget) (GncPluginPage *plugin_page);

    void (* destroy_widget) (GncPluginPage *plugin_page);

    void (* save_page) (GncPluginPage *page, GKeyFile *file,
                        const gchar *group);

    GncPluginPage * (* recreate_page) (GtkWidget *window, GKeyFile *file,
                                       const gchar *group);

    void (* window_changed) (GncPluginPage *plugin_page, GtkWidget *window);

    void (* focus_page) (GncPluginPage *plugin_page, gboolean on_current_page);

    gboolean (* focus_page_function) (GncPluginPage *plugin_page);

    void (* page_name_changed) (GncPluginPage *plugin_page,
                                const gchar *name);

    void (* update_edit_menu_actions) (GncPluginPage *plugin_page, gboolean hide);

    gboolean (* finish_pending) (GncPluginPage *plugin_page);
} GncPluginPageClass;


GType gnc_plugin_page_get_type (void);


GtkWidget *gnc_plugin_page_create_widget (GncPluginPage *plugin_page);


void gnc_plugin_page_destroy_widget (GncPluginPage *plugin_page);


void gnc_plugin_page_show_summarybar (GncPluginPage *page, gboolean visible);


void gnc_plugin_page_save_page (GncPluginPage *page,
                                GKeyFile *key_file,
                                const gchar *group_name);


GncPluginPage *gnc_plugin_page_recreate_page (GtkWidget *window,
                                              const gchar *page_type,
                                              GKeyFile *key_file,
                                              const gchar *group_name);


void gnc_plugin_page_merge_actions (GncPluginPage *plugin_page,
                                    GtkUIManager *merge);


void gnc_plugin_page_unmerge_actions (GncPluginPage *plugin_page,
                                      GtkUIManager *merge);


const gchar *gnc_plugin_page_get_plugin_name (GncPluginPage *plugin_page);


void gnc_plugin_page_add_book (GncPluginPage *page, QofBook *book);


gboolean gnc_plugin_page_has_book (GncPluginPage *page, QofBook *book);


gboolean gnc_plugin_page_has_books (GncPluginPage *page);


GtkWidget *gnc_plugin_page_get_window (GncPluginPage *page);


const gchar *gnc_plugin_page_get_page_name (GncPluginPage *page);


void gnc_plugin_page_set_page_name (GncPluginPage *page, const char *name);


const gchar *gnc_plugin_page_get_page_long_name (GncPluginPage *page);


void gnc_plugin_page_set_page_long_name (GncPluginPage *page, const char *name);


const gchar *gnc_plugin_page_get_page_color (GncPluginPage *page);


void gnc_plugin_page_set_page_color (GncPluginPage *page, const char *color);


void gnc_plugin_page_inserted_cb (GncPluginPage *page, gpointer user_data);


void gnc_plugin_page_disconnect_page_changed (GncPluginPage *page);


const gchar *gnc_plugin_page_get_uri (GncPluginPage *page);


void gnc_plugin_page_set_uri (GncPluginPage *page, const char *name);


const gchar *gnc_plugin_page_get_statusbar_text (GncPluginPage *page);


void gnc_plugin_page_set_statusbar_text (GncPluginPage *page,
        const char *name);


gboolean gnc_plugin_page_get_use_new_window (GncPluginPage *page);


void gnc_plugin_page_set_use_new_window (GncPluginPage *page,
        gboolean use_new);


const char *gnc_plugin_page_get_ui_description (GncPluginPage *page);


void gnc_plugin_page_set_ui_description (GncPluginPage *page,
        const char *ui_filename);


GtkUIManager *gnc_plugin_page_get_ui_merge (GncPluginPage *page);


GtkActionGroup *gnc_plugin_page_get_action_group (GncPluginPage *page);


GtkActionGroup * gnc_plugin_page_create_action_group (GncPluginPage *page,
                                                      const gchar *group_name);

GtkAction *gnc_plugin_page_get_action (GncPluginPage *page, const gchar *name);

/* Signals */
void gnc_plugin_page_inserted (GncPluginPage *plugin_page);
void gnc_plugin_page_removed (GncPluginPage *plugin_page);
void gnc_plugin_page_selected (GncPluginPage *plugin_page);
void gnc_plugin_page_unselected (GncPluginPage *plugin_page);

gboolean gnc_plugin_page_finish_pending (GncPluginPage *plugin_page);

G_END_DECLS

#endif /* __GNC_PLUGIN_PAGE_H */