aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/table/e-table-memory-callbacks.c
blob: 8cbbc3a0b4a0c38af418b09bdb45043d607ce402 (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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* 
 * e-table-memory-callbacks.c
 * Copyright 2000, 2001, Ximian, Inc.
 *
 * Authors:
 *   Chris Lahey <clahey@ximian.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License, version 2, as published by the Free Software Foundation.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#include <config.h>
#include "e-table-memory-callbacks.h"

enum {
    ARG_0,
    ARG_APPEND_ROW,
};

#define PARENT_TYPE e_table_memory_get_type ()

static int
etmc_column_count (ETableModel *etm)
{
    ETableMemoryCalbacks *etmc = E_TABLE_MEMORY_CALLBACKS(etm);

    if (etmc->col_count)
        return etmc->col_count (etm, etmc->data);
    else
        return 0;
}

static void *
etmc_value_at (ETableModel *etm, int col, int row)
{
    ETableMemoryCalbacks *etmc = E_TABLE_MEMORY_CALLBACKS(etm);

    if (etmc->value_at)
        return etmc->value_at (etm, col, row, etmc->data);
    else
        return NULL;
}

static void
etmc_set_value_at (ETableModel *etm, int col, int row, const void *val)
{
    ETableMemoryCalbacks *etmc = E_TABLE_MEMORY_CALLBACKS(etm);

    if (etmc->set_value_at)
        etmc->set_value_at (etm, col, row, val, etmc->data);
}

static gboolean
etmc_is_cell_editable (ETableModel *etm, int col, int row)
{
    ETableMemoryCalbacks *etmc = E_TABLE_MEMORY_CALLBACKS(etm);

    if (etmc->is_cell_editable)
        return etmc->is_cell_editable (etm, col, row, etmc->data);
    else
        return FALSE;
}

/* The default for etmc_duplicate_value is to return the raw value. */
static void *
etmc_duplicate_value (ETableModel *etm, int col, const void *value)
{
    ETableMemoryCalbacks *etmc = E_TABLE_MEMORY_CALLBACKS(etm);

    if (etmc->duplicate_value)
        return etmc->duplicate_value (etm, col, value, etmc->data);
    else
        return (void *)value;
}

static void
etmc_free_value (ETableModel *etm, int col, void *value)
{
    ETableMemoryCalbacks *etmc = E_TABLE_MEMORY_CALLBACKS(etm);

    if (etmc->free_value)
        etmc->free_value (etm, col, value, etmc->data);
}

static void *
etmc_initialize_value (ETableModel *etm, int col)
{
    ETableMemoryCalbacks *etmc = E_TABLE_MEMORY_CALLBACKS(etm);
    
    if (etmc->initialize_value)
        return etmc->initialize_value (etm, col, etmc->data);
    else
        return NULL;
}

static gboolean
etmc_value_is_empty (ETableModel *etm, int col, const void *value)
{
    ETableMemoryCalbacks *etmc = E_TABLE_MEMORY_CALLBACKS(etm);
    
    if (etmc->value_is_empty)
        return etmc->value_is_empty (etm, col, value, etmc->data);
    else
        return FALSE;
}

static char *
etmc_value_to_string (ETableModel *etm, int col, const void *value)
{
    ETableMemoryCalbacks *etmc = E_TABLE_MEMORY_CALLBACKS(etm);
    
    if (etmc->value_to_string)
        return etmc->value_to_string (etm, col, value, etmc->data);
    else
        return g_strdup ("");
}

static void
etmc_append_row (ETableModel *etm, ETableModel *source, int row)
{
    ETableMemoryCalbacks *etmc = E_TABLE_MEMORY_CALLBACKS(etm);
    
    if (etmc->append_row)
        etmc->append_row (etm, source, row, etmc->data);
}

static void
etmc_get_arg (GtkObject *o, GtkArg *arg, guint arg_id)
{
    ETableMemoryCalbacks *etmc = E_TABLE_MEMORY_CALLBACKS (o);

    switch (arg_id){
    case ARG_APPEND_ROW:
        GTK_VALUE_POINTER(*arg) = etmc->append_row;
        break;
    }
}

static void
etmc_set_arg (GtkObject *o, GtkArg *arg, guint arg_id)
{
    ETableMemoryCalbacks *etmc = E_TABLE_MEMORY_CALLBACKS (o);
    
    switch (arg_id){
    case ARG_APPEND_ROW:
        etmc->append_row = GTK_VALUE_POINTER(*arg);
        break;
    default:
        arg->type = GTK_TYPE_INVALID;
    }
}

static void
e_table_memory_callbacks_class_init (GtkObjectClass *object_class)
{
    ETableModelClass *model_class = (ETableModelClass *) object_class;

    object_class->set_arg         = etmc_set_arg;
    object_class->get_arg         = etmc_get_arg;

    model_class->column_count     = etmc_column_count;
    model_class->value_at         = etmc_value_at;
    model_class->set_value_at     = etmc_set_value_at;
    model_class->is_cell_editable = etmc_is_cell_editable;
    model_class->duplicate_value  = etmc_duplicate_value;
    model_class->free_value       = etmc_free_value;
    model_class->initialize_value = etmc_initialize_value;
    model_class->value_is_empty   = etmc_value_is_empty;
    model_class->value_to_string  = etmc_value_to_string;
    model_class->append_row       = etmc_append_row;

    gtk_object_add_arg_type ("ETableMemoryCalbacks::append_row", GTK_TYPE_POINTER,
                 GTK_ARG_READWRITE, ARG_APPEND_ROW);
}

GtkType
e_table_memory_callbacks_get_type (void)
{
    static GtkType type = 0;

    if (!type){
        GtkTypeInfo info = {
            "ETableMemoryCalbacks",
            sizeof (ETableMemoryCalbacks),
            sizeof (ETableMemoryCalbacksClass),
            (GtkClassInitFunc) e_table_memory_callbacks_class_init,
            (GtkObjectInitFunc) NULL,
            NULL, /* reserved 1 */
            NULL, /* reserved 2 */
            (GtkClassInitFunc) NULL
        };

        type = gtk_type_unique (PARENT_TYPE, &info);
    }

    return type;
}

/**
 * e_table_memory_callbacks_new:
 * @col_count:
 * @value_at:
 * @set_value_at:
 * @is_cell_editable:
 * @duplicate_value:
 * @free_value:
 * @initialize_value:
 * @value_is_empty:
 * @value_to_string:
 * @data: closure pointer.
 *
 * This initializes a new ETableMemoryCalbacksModel object.  ETableMemoryCalbacksModel is
 * an implementaiton of the abstract class ETableModel.  The ETableMemoryCalbacksModel
 * is designed to allow people to easily create ETableModels without having
 * to create a new GtkType derived from ETableModel every time they need one.
 *
 * Instead, ETableMemoryCalbacksModel uses a setup based in callback functions, every
 * callback function signature mimics the signature of each ETableModel method
 * and passes the extra @data pointer to each one of the method to provide them
 * with any context they might want to use. 
 *
 * Returns: An ETableMemoryCalbacksModel object (which is also an ETableModel
 * object).
 */
ETableModel *
e_table_memory_callbacks_new (ETableMemoryCalbacksColumnCountFn col_count,
                  ETableMemoryCalbacksValueAtFn value_at,
                  ETableMemoryCalbacksSetValueAtFn set_value_at,
                  ETableMemoryCalbacksIsCellEditableFn is_cell_editable,
                  ETableMemoryCalbacksDuplicateValueFn duplicate_value,
                  ETableMemoryCalbacksFreeValueFn free_value,
                  ETableMemoryCalbacksInitializeValueFn initialize_value,
                  ETableMemoryCalbacksValueIsEmptyFn value_is_empty,
                  ETableMemoryCalbacksValueToStringFn value_to_string,
                  void *data)
{
    ETableMemoryCalbacks *et;

    et                   = gtk_type_new (e_table_memory_callbacks_get_type ());

    et->col_count        = col_count;
    et->value_at         = value_at;
    et->set_value_at     = set_value_at;
    et->is_cell_editable = is_cell_editable;
    et->duplicate_value  = duplicate_value;
    et->free_value       = free_value;
    et->initialize_value = initialize_value;
    et->value_is_empty   = value_is_empty;
    et->value_to_string  = value_to_string;
    et->data             = data;
    
    return (ETableModel *) et;
 }