GnuCash  4.12-527-g05ffd3d4eb
gnc-optiondb.h
Go to the documentation of this file.
1 /********************************************************************\
2  * gnc-optiondb.h -- Collection of GncOption objects C interface *
3  * Copyright (C) 2019 John Ralls <jralls@ceridwen.us> *
4  * *
5  * This program is free software; you can redistribute it and/or *
6  * modify it under the terms of the GNU General Public License as *
7  * published by the Free Software Foundation; either version 2 of *
8  * the License, or (at your option) any later version. *
9  * *
10  * This program is distributed in the hope that it will be useful, *
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13  * GNU General Public License for more details. *
14  * *
15  * You should have received a copy of the GNU General Public License*
16  * along with this program; if not, contact: *
17  * *
18  * Free Software Foundation Voice: +1-617-542-5942 *
19  * 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 *
20  * Boston, MA 02110-1301, USA gnu@gnu.org *
21  * *
22 \********************************************************************/
54 #ifndef GNC_OPTIONDB_H_
55 #define GNC_OPTIONDB_H_
56 
57 #ifdef __cplusplus
58 class GncOption;
59 class GncOptionDB;
60 #else
61 // It's a class in C++ but the C compiler can't tell.
62 typedef struct GncOption GncOption;
63 typedef struct GncOptionDB GncOptionDB;
64 #endif
65 
66 #ifdef __cplusplus
67 extern "C"
68 {
69 #endif
70 #include <config.h>
71 #include "Account.h"
72 #include "gnc-budget.h"
73 #include "gnc-commodity.h"
74 #include "gncInvoice.h"
75 #include "gncTaxTable.h"
76 
83 
89 
97 
103 
109 void gnc_option_db_load(GncOptionDB* odb, QofBook* book);
110 
117 void gnc_option_db_save(GncOptionDB* odb, QofBook* book,
118  gboolean clear_options);
119 
126 
136 const char* gnc_option_db_lookup_string_value(GncOptionDB*, const char*,
137  const char*);
138 
151  const char*, const char*);
152 
164  const char*,
165  const char*);
166 
167 #ifdef __cplusplus
168 }
169 #endif
170 #endif //GNC_OPTIONDB_H_
171 
Holds all of the options for a book, report, or stylesheet, organized by GncOptionSections.
void gnc_option_db_clean(GncOptionDB *odb)
Reset all ui_items to the option value.
const QofInstance * gnc_option_db_lookup_qofinstance_value(GncOptionDB *, const char *, const char *)
Retrieve the string value of an option in the GncOptionDB.
GnuCash Budgets.
void gnc_option_db_set_string_value(GncOptionDB *, const char *, const char *, const char *)
Set the string value of an option in the GncOptionDB.
void gnc_option_db_save(GncOptionDB *odb, QofBook *book, gboolean clear_options)
Save the GncOptionDB contents into a book&#39;s options store.
Represents the public interface for an option.
Definition: gnc-option.hpp:130
Account handling public routines.
void gnc_option_db_load(GncOptionDB *odb, QofBook *book)
Load a book&#39;s options into the GncOptionDB.
void gnc_option_db_destroy(GncOptionDB *odb)
Destruct and release a GncOptionDB.
Tax Table programming interface.
Business Invoice Interface.
GList * gnc_option_db_commit(GncOptionDB *odb)
Write all changed ui_item values to their options.
const char * gnc_option_db_lookup_string_value(GncOptionDB *, const char *, const char *)
Retrieve the string value of an option in the GncOptionDB.
void gnc_option_db_book_options(GncOptionDB *)
Register the standard option set for a QofBook.
Commodity handling public routines.
GncOptionDB * gnc_option_db_new(void)
Create an empty option database.