GnuCash  4.11-148-gc20d717b33+
gnc-tree-view-owner.h
Go to the documentation of this file.
1 /********************************************************************\
2  * gnc-tree-view-owner.h -- GtkTreeView implementation to display *
3  * owners in a GtkTreeView. *
4  * Copyright (C) 2011 Geert Janssens <geert@kobaltwit.be> *
5  * *
6  * This program is free software; you can redistribute it and/or *
7  * modify it under the terms of the GNU General Public License as *
8  * published by the Free Software Foundation; either version 2 of *
9  * the License, or (at your option) any later version. *
10  * *
11  * This program is distributed in the hope that it will be useful, *
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14  * GNU General Public License for more details. *
15  * *
16  * You should have received a copy of the GNU General Public License*
17  * along with this program; if not, contact: *
18  * *
19  * Free Software Foundation Voice: +1-617-542-5942 *
20  * 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 *
21  * Boston, MA 02110-1301, USA gnu@gnu.org *
22  * *
23 \********************************************************************/
24 
34 #ifndef __GNC_TREE_VIEW_OWNER_H
35 #define __GNC_TREE_VIEW_OWNER_H
36 
37 #include <gtk/gtk.h>
38 #include "gncOwner.h"
39 #include "gnc-tree-view.h"
40 
41 #include "gnc-ui-util.h"
42 #include "gnc-plugin-page.h"
43 
44 G_BEGIN_DECLS
45 
46 /* type macros */
47 #define GNC_TYPE_TREE_VIEW_OWNER (gnc_tree_view_owner_get_type ())
48 #define GNC_TREE_VIEW_OWNER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_TREE_VIEW_OWNER, GncTreeViewOwner))
49 #define GNC_TREE_VIEW_OWNER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_TREE_VIEW_OWNER, GncTreeViewOwnerClass))
50 #define GNC_IS_TREE_VIEW_OWNER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GNC_TYPE_TREE_VIEW_OWNER))
51 #define GNC_IS_TREE_VIEW_OWNER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_TREE_VIEW_OWNER))
52 #define GNC_TREE_VIEW_OWNER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_TYPE_TREE_VIEW_OWNER, GncTreeViewOwnerClass))
53 #define GNC_TREE_VIEW_OWNER_NAME "GncTreeViewOwner"
54 
55 /* typedefs & structures */
56 typedef struct OwnerViewInfo_s OwnerViewInfo;
57 
58 
60 {
61  gboolean show_inactive;
62 };
63 
64 
65 typedef struct
66 {
67  GncTreeView gnc_tree_view;
68  int stamp;
70 
71 typedef struct
72 {
73  GncTreeViewClass gnc_tree_view;
75 
76 typedef struct
77 {
78  GtkWidget *dialog;
79  GncTreeViewOwner *tree_view;
80  gboolean show_inactive;
81  gboolean original_show_inactive;
82  gboolean show_zero_total;
83  gboolean original_show_zero_total;
85 
86 #define GNC_OWNER_TREE_NAME_COL "name"
87 #define GNC_OWNER_TREE_TYPE_COL "type"
88 #define GNC_OWNER_TREE_ID_COL "owner-id"
89 #define GNC_OWNER_TREE_CURRENCY_COL "currency"
90 #define GNC_OWNER_TREE_ADDRESS_NAME_COL "address-name"
91 #define GNC_OWNER_TREE_ADDRESS_1_COL "address-1"
92 #define GNC_OWNER_TREE_ADDRESS_2_COL "address-2"
93 #define GNC_OWNER_TREE_ADDRESS_3_COL "address-3"
94 #define GNC_OWNER_TREE_ADDRESS_4_COL "address-4"
95 #define GNC_OWNER_TREE_PHONE_COL "phone"
96 #define GNC_OWNER_TREE_FAX_COL "fax"
97 #define GNC_OWNER_TREE_EMAIL_COL "email"
98 #define GNC_OWNER_TREE_BALANCE_COL "balance"
99 #define GNC_OWNER_TREE_BALANCE_REPORT_COL "balance-report"
100 #define GNC_OWNER_TREE_BALANCE_PERIOD_COL "balance-period"
101 #define GNC_OWNER_TREE_NOTES_COL "notes"
102 #define GNC_OWNER_TREE_ACTIVE_COL "active"
103 
104 
105 void owner_filter_dialog_create(OwnerFilterDialog *fd,
106  GncPluginPage *page);
107 
109  gpointer user_data);
110 
111 /* "Filter By" dialog callbacks */
112 void gppot_filter_show_inactive_toggled_cb (GtkToggleButton *togglebutton,
113  OwnerFilterDialog *fd);
114 void gppot_filter_show_zero_toggled_cb (GtkToggleButton *togglebutton,
115  OwnerFilterDialog *fd);
116 void gppot_filter_response_cb (GtkWidget *dialog, gint response,
117  OwnerFilterDialog *fd);
118 
119 /* Saving/Restoring */
120 void gnc_tree_view_owner_save(GncTreeViewOwner *tree_view,
121  OwnerFilterDialog *fd,
122  GKeyFile *key_file, const gchar *group_name);
123 void gnc_tree_view_owner_restore(GncTreeViewOwner *view,
124  OwnerFilterDialog *fd,
125  GKeyFile *key_file,
126  const gchar *group_name,
127  GncOwnerType owner_type);
128 
129 
130 /* Get the GType for an GncTreeViewOwner object. */
131 GType gnc_tree_view_owner_get_type (void);
132 
133 
143 GtkTreeView *gnc_tree_view_owner_new (GncOwnerType owner_type);
144 
151 typedef gchar * (*GncTreeViewOwnerColumnSource) (GncOwner *owner,
152  GtkTreeViewColumn *col,
153  GtkCellRenderer *cell);
154 
155 typedef void (*GncTreeViewOwnerColumnTextEdited) (GncOwner *owner,
156  GtkTreeViewColumn *col,
157  const gchar *new_text);
158 
173 typedef gboolean (*gnc_tree_view_owner_filter_func)(GncOwner *owner, gpointer data);
174 
175 
197  gpointer data,
198  GSourceFunc destroy);
199 
200 
229  GtkTreePath *path);
230 
231 
243  GtkTreeIter *iter);
244 
257 
258 
275  GncOwner *owner);
276 
277 
278 G_END_DECLS
279 
280 #endif /* __GNC_TREE_VIEW_OWNER_H */
void gnc_tree_view_owner_set_selected_owner(GncTreeViewOwner *view, GncOwner *owner)
This function selects an owner in the owner tree view.
GtkTreeView * gnc_tree_view_owner_new(GncOwnerType owner_type)
Create a new owner tree view for one type of owners.
Business Interface: Object OWNERs.
The instance data structure for a content plugin.
void gnc_tree_view_owner_set_filter(GncTreeViewOwner *owner_view, gnc_tree_view_owner_filter_func func, gpointer data, GSourceFunc destroy)
This function attaches a filter function to the given owner tree.
void gnc_tree_view_owner_refilter(GncTreeViewOwner *view)
This function forces the owner tree filter to be evaluated.
utility functions for the GnuCash UI
common utilities for manipulating a GtkTreeView within gnucash
GncOwner * gnc_tree_view_owner_get_owner_from_iter(GtkTreeModel *model, GtkTreeIter *iter)
This function returns the owner associated with the specified iter.
gboolean(* gnc_tree_view_owner_filter_func)(GncOwner *owner, gpointer data)
This is the description of a filter function used by the owner tree.
void gppot_filter_response_cb(GtkWidget *dialog, gint response, OwnerFilterDialog *fd)
The Filter dialog was closed.
Functions for adding plugins to a GnuCash window.
void gppot_filter_show_inactive_toggled_cb(GtkToggleButton *togglebutton, OwnerFilterDialog *fd)
The "only show active" button in the Filter dialog changed state.
void gppot_filter_show_zero_toggled_cb(GtkToggleButton *togglebutton, OwnerFilterDialog *fd)
The "show zero totals" button in the Filter dialog changed state.
GncOwner * gnc_tree_view_owner_get_selected_owner(GncTreeViewOwner *view)
This function returns the owner associated with the selected item in the owner tree view...
GncOwner * gnc_tree_view_owner_get_owner_from_path(GncTreeViewOwner *view, GtkTreePath *path)
This function returns the owner associated with the specified path.
gboolean gnc_plugin_page_owner_tree_filter_owners(GncOwner *owner, gpointer user_data)
This function tells the owner tree view whether or not to filter out a particular owner...