GnuCash  4.12-68-g5dc52459a1+
gnc-plugin-page-register.h
Go to the documentation of this file.
1 /**********************************************************************
2  * gnc-plugin-page-register.h -- register page functions *
3  * *
4  * Copyright (C) 2003 Jan Arne Petersen <jpetersen@uni-bonn.de> *
5  * Copyright (C) 2003,2005,2006 David Hampton <hampton@employees.org> *
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 
35 #ifndef __GNC_PLUGIN_PAGE_REGISTER_H
36 #define __GNC_PLUGIN_PAGE_REGISTER_H
37 
38 #include <gtk/gtk.h>
39 
40 #include "Account.h"
41 #include "gnc-ledger-display.h"
42 #include "gnc-plugin-page.h"
43 #include "gnc-split-reg.h"
44 #include "Query.h"
45 
46 G_BEGIN_DECLS
47 
48 /* type macros */
49 #define GNC_TYPE_PLUGIN_PAGE_REGISTER (gnc_plugin_page_register_get_type ())
50 #define GNC_PLUGIN_PAGE_REGISTER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_PLUGIN_PAGE_REGISTER, GncPluginPageRegister))
51 #define GNC_PLUGIN_PAGE_REGISTER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_PLUGIN_PAGE_REGISTER, GncPluginPageRegisterClass))
52 #define GNC_IS_PLUGIN_PAGE_REGISTER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GNC_TYPE_PLUGIN_PAGE_REGISTER))
53 #define GNC_IS_PLUGIN_PAGE_REGISTER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_PLUGIN_PAGE_REGISTER))
54 #define GNC_PLUGIN_PAGE_REGISTER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_TYPE_PLUGIN_PAGE_REGISTER, GncPluginPageRegisterClass))
55 #define GNC_PLUGIN_PAGE_REGISTER_NAME "GncPluginPageRegister"
56 
57 /* typedefs & structures */
58 typedef struct
59 {
60  GncPluginPage gnc_plugin_page;
62 
63 typedef struct
64 {
65  GncPluginPageClass gnc_plugin_page;
67 
68 /* function prototypes */
69 
75 
76 
89 gnc_plugin_page_register_new (Account *account, gboolean subaccounts);
90 
91 
103 gnc_plugin_page_register_new_ledger (GNCLedgerDisplay *ledger);
104 
105 
112 
113 
123 void
125  gint lines_default,
126  gboolean read_only);
127 
128 
133 GNCSplitReg *
135 
136 
143 Query *
145 
153 Account *
155 
163 Transaction *
165 
172 void
174 
175 
176 G_END_DECLS
180 #endif /* __GNC_PLUGIN_PAGE_REGISTER_H */
181 
GncPluginPage * gnc_plugin_page_register_new(Account *account, gboolean subaccounts)
Create a new "register" plugin page, given a pointer to an account.
Public declarations for GncLedgerDisplay class.
The instance data structure for a content plugin.
GType gnc_plugin_page_register_get_type(void)
Retrieve the type number for the plugin page.
GncPluginPage * gnc_plugin_page_register_new_ledger(GNCLedgerDisplay *ledger)
Create a new "register" plugin page, given a pointer to an already created ledger.
Account handling public routines.
The class data structure for a content plugin.
Transaction * gnc_plugin_page_register_get_current_txn(GncPluginPageRegister *page)
Get the currently selected transaction in this register page.
Functions for adding plugins to a GnuCash window.
Query * gnc_plugin_page_register_get_query(GncPluginPage *plugin_page)
This function is called to get the query associated with this plugin page.
GncPluginPage * gnc_plugin_page_register_new_gl(void)
Create a new "register" plugin page containing a general journal.
Account * gnc_plugin_page_register_get_account(GncPluginPageRegister *page)
Get the Account associated with this register page.
void gnc_plugin_page_register_clear_current_filter(GncPluginPage *plugin_page)
This function clears the registers current filter.
GNCSplitReg * gnc_plugin_page_register_get_gsr(GncPluginPage *plugin_page)
Get the GNCSplitReg data structure associated with this register page.
void gnc_plugin_page_register_set_options(GncPluginPage *plugin_page, gint lines_default, gboolean read_only)
Set various register options on a newly created "register" plugin page.