aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/table/e-table-memory-store.h
blob: f197e11fe611877b3492f0c32fac91cd436b49af (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/*
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) version 3.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>
 *
 *
 * Authors:
 *      Chris Lahey <clahey@ximian.com>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#ifndef _E_TABLE_MEMORY_STORE_H_
#define _E_TABLE_MEMORY_STORE_H_

#include <table/e-table-memory.h>
#include <table/e-table-memory-callbacks.h>

G_BEGIN_DECLS

#define E_TABLE_MEMORY_STORE_TYPE        (e_table_memory_store_get_type ())
#define E_TABLE_MEMORY_STORE(o)          (G_TYPE_CHECK_INSTANCE_CAST ((o), E_TABLE_MEMORY_STORE_TYPE, ETableMemoryStore))
#define E_TABLE_MEMORY_STORE_CLASS(k)    (G_TYPE_CHECK_CLASS_CAST((k), E_TABLE_MEMORY_STORE_TYPE, ETableMemoryStoreClass))
#define E_IS_TABLE_MEMORY_STORE(o)       (G_TYPE_CHECK_INSTANCE_TYPE ((o), E_TABLE_MEMORY_STORE_TYPE))
#define E_IS_TABLE_MEMORY_STORE_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), E_TABLE_MEMORY_STORE_TYPE))
#define E_TABLE_MEMORY_STORE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((obj), E_TABLE_MEMORY_STORE_TYPE, ETableMemoryStoreClass))

typedef enum {
    E_TABLE_MEMORY_STORE_COLUMN_TYPE_TERMINATOR,
    E_TABLE_MEMORY_STORE_COLUMN_TYPE_INTEGER,
    E_TABLE_MEMORY_STORE_COLUMN_TYPE_STRING,
    E_TABLE_MEMORY_STORE_COLUMN_TYPE_PIXBUF,
    E_TABLE_MEMORY_STORE_COLUMN_TYPE_OBJECT,
    E_TABLE_MEMORY_STORE_COLUMN_TYPE_CUSTOM
} ETableMemoryStoreColumnType;

typedef struct {
    ETableMemoryCalbacksDuplicateValueFn  duplicate_value;
    ETableMemoryCalbacksFreeValueFn       free_value;
    ETableMemoryCalbacksInitializeValueFn initialize_value;
    ETableMemoryCalbacksValueIsEmptyFn    value_is_empty;
    ETableMemoryCalbacksValueToStringFn   value_to_string;
} ETableMemoryStoreCustomColumn;

typedef struct {
    ETableMemoryStoreColumnType   type;
    ETableMemoryStoreCustomColumn custom;
    guint                         editable : 1;
} ETableMemoryStoreColumnInfo;

#define E_TABLE_MEMORY_STORE_TERMINATOR { E_TABLE_MEMORY_STORE_COLUMN_TYPE_TERMINATOR, { NULL }, FALSE }
#define E_TABLE_MEMORY_STORE_INTEGER { E_TABLE_MEMORY_STORE_COLUMN_TYPE_INTEGER, { NULL }, FALSE }
#define E_TABLE_MEMORY_STORE_STRING { E_TABLE_MEMORY_STORE_COLUMN_TYPE_STRING, { NULL }, FALSE }
#define E_TABLE_MEMORY_STORE_PIXBUF { E_TABLE_MEMORY_STORE_COLUMN_TYPE_PIXBUF, { NULL }, FALSE }
#define E_TABLE_MEMORY_STORE_EDITABLE_STRING { E_TABLE_MEMORY_STORE_COLUMN_TYPE_STRING, { NULL }, TRUE }
#define E_TABLE_MEMORY_STORE_CUSTOM(editable, duplicate, free, initialize, empty, string) \
        { E_TABLE_MEMORY_STORE_COLUMN_TYPE_CUSTOM, \
             { (duplicate), (free), (initialize), (empty), (string) }, editable }
#define E_TABLE_MEMORY_STORE_OBJECT(editable, initialize, empty, string) \
        { E_TABLE_MEMORY_STORE_COLUMN_TYPE_CUSTOM, \
             { NULL, NULL, (initialize), (empty), (string) }, editable }

typedef struct _ETableMemoryStorePrivate ETableMemoryStorePrivate;

typedef struct {
    ETableMemory parent;

    ETableMemoryStorePrivate *priv;
} ETableMemoryStore;

typedef struct {
    ETableMemoryClass parent_class;
} ETableMemoryStoreClass;

GType        e_table_memory_store_get_type            (void);

/* Object Creation */
ETableModel *e_table_memory_store_new                 (ETableMemoryStoreColumnInfo  *columns);
ETableModel *e_table_memory_store_construct           (ETableMemoryStore            *store,
                               ETableMemoryStoreColumnInfo  *columns);

/* Adopt a value instead of copying it. */
void         e_table_memory_store_adopt_value_at      (ETableMemoryStore            *etms,
                               int                           col,
                               int                           row,
                               void                         *value);

/* The size of these arrays is the number of columns. */
void         e_table_memory_store_insert_array        (ETableMemoryStore            *etms,
                               int                           row,
                               void                        **store,
                               gpointer                      data);
void         e_table_memory_store_insert              (ETableMemoryStore            *etms,
                               int                           row,
                               gpointer                      data,
                               ...);
void         e_table_memory_store_insert_adopt        (ETableMemoryStore            *etms,
                               int                           row,
                               gpointer                      data,
                               ...);
void         e_table_memory_store_insert_adopt_array  (ETableMemoryStore            *etms,
                               int                           row,
                               void                        **store,
                               gpointer                      data);
void         e_table_memory_store_change_array        (ETableMemoryStore            *etms,
                               int                           row,
                               void                        **store,
                               gpointer                      data);
void         e_table_memory_store_change              (ETableMemoryStore            *etms,
                               int                           row,
                               gpointer                      data,
                               ...);
void         e_table_memory_store_change_adopt        (ETableMemoryStore            *etms,
                               int                           row,
                               gpointer                      data,
                               ...);
void         e_table_memory_store_change_adopt_array  (ETableMemoryStore            *etms,
                               int                           row,
                               void                        **store,
                               gpointer                      data);
void         e_table_memory_store_remove              (ETableMemoryStore            *etms,
                               int                           row);
void         e_table_memory_store_clear               (ETableMemoryStore            *etms);

G_END_DECLS

#endif /* _E_TABLE_MEMORY_STORE_H_ */