gnc-main-window.h

Go to the documentation of this file.

/*
 * gnc-main-window.h -- GtkWindow which represents 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_MAIN_WINDOW_H
#define __GNC_MAIN_WINDOW_H

#include <gtk/gtk.h>
#include "gnc-plugin-page.h"

#ifdef __cplusplus
extern "C"
{
#endif

/* type macros */
#define GNC_TYPE_MAIN_WINDOW            (gnc_main_window_get_type ())
#define GNC_MAIN_WINDOW(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_MAIN_WINDOW, GncMainWindow))
#define GNC_MAIN_WINDOW_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_MAIN_WINDOW, GncMainWindowClass))
#define GNC_IS_MAIN_WINDOW(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GNC_TYPE_MAIN_WINDOW))
#define GNC_IS_MAIN_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_MAIN_WINDOW))
#define GNC_MAIN_WINDOW_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_TYPE_MAIN_WINDOW, GncMainWindowClass))

#define PLUGIN_PAGE_IMMUTABLE    "page-immutable"

/* typedefs & structures */

typedef struct
{
    const gchar *actions;
    const gchar *update_type;
} GncMenuUpdate;

typedef struct _GncMainWindow GncMainWindow;

typedef struct
{
    GtkApplicationWindowClass gtk_application_window; 
    /* callbacks */
    void (*page_added)   (GncMainWindow *window,
                          GncPluginPage *page);
    void (*page_changed) (GncMainWindow *window,
                          GncPluginPage *page);
    void (*menu_changed) (GncMainWindow *window,
                          GncPluginPage *page);
} GncMainWindowClass;

typedef struct
{
    GncMainWindow *window;
    gpointer data;
} GncMainWindowActionData;

typedef void (*GncMainWindowFunc) (GncMainWindow *window, GncPluginPage *page);
typedef void (*GncMainWindowPageFunc) (GncPluginPage *page, gpointer user_data);

/* function prototypes */

GType gnc_main_window_get_type (void);


GncMainWindow *gnc_main_window_new (void);


void gnc_main_window_display_page (GncPluginPage *page);


void gnc_main_window_open_page (GncMainWindow *window,
                                GncPluginPage *page);


void gnc_main_window_close_page (GncPluginPage *page);


void gnc_main_window_foreach_page (GncMainWindowPageFunc fn,
                                   gpointer user_data);


GncPluginPage *gnc_main_window_get_current_page (GncMainWindow *window);

void
main_window_update_page_name (GncPluginPage *page,
                              const gchar *name_in);

void
main_window_update_page_long_name (GncPluginPage *page,
                                   const gchar *long_name_in);

void
main_window_update_page_color (GncPluginPage *page,
                               const gchar *color_in);

void
main_window_update_page_set_read_only_icon (GncPluginPage *page,
                                            gboolean read_only);

void gnc_main_window_manual_merge_actions (GncMainWindow *window,
                                           const gchar *group_name,
                                           GSimpleActionGroup *group);


void gnc_main_window_merge_actions (GncMainWindow *window,
                                    const gchar *group_name,
                                    GActionEntry *entries,
                                    guint n_entries,
                                    const gchar **ui_updates,
                                    const gchar *ui_filename,
                                    gpointer user_data);


void gnc_main_window_unmerge_actions (GncMainWindow *window,
                                      const gchar *group_name);

void gnc_main_window_set_vis_of_items_by_action (GncMainWindow *window,
                                                 const gchar **action_names,
                                                 gboolean vis);

GtkWidget *gnc_main_window_menu_find_menu_item (GncMainWindow *window,
                                                const gchar *action_name);

GtkWidget * gnc_main_window_toolbar_find_tool_item (GncMainWindow *window,
                                                    const gchar *action_name);

gboolean gnc_main_window_update_menu_for_action (GncMainWindow *window,
                                                 const gchar *action_name,
                                                 const gchar *label,
                                                 const gchar *tooltip);

void gnc_main_window_menu_add_accelerator_keys (GncMainWindow *window);

typedef struct
{
    const char *action_name;
    const char *short_label;
} GncToolBarShortNames;


void gnc_main_window_init_short_names (GncMainWindow *window,
                                       GncToolBarShortNames *toolbar_labels);


GSimpleActionGroup *gnc_main_window_get_action_group (GncMainWindow *window,
                                                      const gchar *group_name);


void gnc_main_window_set_progressbar_window( GncMainWindow *window );


gboolean gnc_main_window_button_press_cb (GtkWidget *whatever,
        GdkEventButton *event,
        GncPluginPage *page);

gboolean gnc_main_window_popup_menu_cb (GtkWidget *widget,
        GncPluginPage *page);


void gnc_main_window_restore_all_windows(const GKeyFile *keyfile);

gboolean gnc_main_window_is_restoring_pages (GncMainWindow *window);

void gnc_main_window_save_all_windows(GKeyFile *keyfile);

void gnc_main_window_restore_default_state(GncMainWindow *window);


gboolean gnc_main_window_finish_pending (GncMainWindow *window);


gboolean gnc_main_window_all_finish_pending (void);

void gnc_main_window_all_action_set_sensitive (const gchar *action_name, gboolean sensitive);

GAction *gnc_main_window_find_action (GncMainWindow *window,
                                      const gchar *action_name);

GAction *gnc_main_window_find_action_in_group (GncMainWindow *window,
                                               const gchar *group_name,
                                               const gchar *action_name);

GMenuModel *gnc_main_window_get_menu_model (GncMainWindow *window);

void gnc_main_window_update_menu_and_toolbar (GncMainWindow *window,
                                              GncPluginPage *page,
                                              const gchar **ui_updates);

void gnc_main_window_show_all_windows(void);

gboolean gnc_main_window_just_plugin_prefs (GncMainWindow* window);

GtkWidget *gnc_book_options_dialog_cb (gboolean modal, gchar *title,
                                       GtkWindow *parent);

gboolean gnc_book_options_dialog_apply_helper(GncOptionDB * options);

#ifdef __cplusplus
}
#endif
#endif /* __GNC_MAIN_WINDOW_H */