GnuCash  5.6-150-g038405b370+
gnc-report.h
1 /********************************************************************
2  * gnc-report.h -- C functions for reports. *
3  * *
4  * Copyright (C) 2001 Linux Developers Group *
5  * Copyright (C) 2006 Chris Shoemaker <c.shoemaker@cox.net> *
6  * *
7  * This program is free software; you can redistribute it and/or *
8  * modify it under the terms of the GNU General Public License as *
9  * published by the Free Software Foundation; either version 2 of *
10  * the License, or (at your option) any later version. *
11  * *
12  * This program is distributed in the hope that it will be useful, *
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
15  * GNU General Public License for more details. *
16  * *
17  * You should have received a copy of the GNU General Public License*
18  * along with this program; if not, contact: *
19  * *
20  * Free Software Foundation Voice: +1-617-542-5942 *
21  * 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 *
22  * Boston, MA 02110-1301, USA gnu@gnu.org *
23  ********************************************************************/
24 
25 #ifndef GNC_REPORT_H
26 #define GNC_REPORT_H
27 
28 #include <glib.h>
29 #include <libguile.h>
30 #ifdef __cplusplus
31 extern "C"
32 {
33 #endif
34 
35 #define SAVED_REPORTS_FILE "saved-reports-2.8"
36 #define SAVED_REPORTS_FILE_OLD_REV "saved-reports-2.4"
37 
42 void gnc_report_init(void);
43 
44 gint gnc_report_id_string_to_report_id (const char *id_string);
45 
46 gboolean gnc_run_report_with_error_handling(gint report_id,
47  gchar** data,
48  gchar** errmsg);
49 
50 gboolean gnc_run_report_id_string_with_error_handling(const char* id_string,
51  char** data,
52  gchar** errmsg);
53 
59 gchar* gnc_report_name(SCM report);
60 
61 /* returns #f if the report id cannot be found */
62 SCM gnc_report_find(gint id);
63 
64 void gnc_report_remove_by_id(gint id);
65 
66 gint gnc_report_add(SCM report);
67 
68 void gnc_reports_flush_global(void);
69 
70 void gnc_reports_foreach (GHFunc func, gpointer user_data);
71 
72 gchar* gnc_get_default_report_font_family(void);
73 
74 gboolean gnc_saved_reports_backup(void);
75 
76 gboolean gnc_saved_reports_write_to_file(const gchar* report_def, gboolean overwrite);
77 
78 #ifdef __cplusplus
79 } //extern "C"
91 GncOptionDB* gnc_get_optiondb_from_dispatcher(SCM dispatcher);
92 #endif
93 #endif
Holds all of the options for a book, report, or stylesheet, organized by GncOptionSections.