aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/table/e-table-model.c
blob: 9a0b3561dd6ce01893d365be106cf8c4ca1576d2 (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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * e-table-model.c: a Table Model
 *
 * Authors:
 *   Miguel de Icaza (miguel@gnu.org)
 *   Chris Lahey (clahey@ximian.com)
 *
 * (C) 1999, 2000 Ximian, Inc.
 */
#include <config.h>
#include <gtk/gtksignal.h>
#include "e-table-model.h"

#define ETM_CLASS(e) ((ETableModelClass *)((GtkObject *)e)->klass)

#define PARENT_TYPE gtk_object_get_type ()

#define d(x)

d(static gint depth = 0);


static GtkObjectClass *e_table_model_parent_class;

enum {
    MODEL_CHANGED,
    MODEL_PRE_CHANGE,
    MODEL_ROW_CHANGED,
    MODEL_CELL_CHANGED,
    MODEL_ROWS_INSERTED,
    MODEL_ROWS_DELETED,
    ROW_SELECTION,
    LAST_SIGNAL
};

static guint e_table_model_signals [LAST_SIGNAL] = { 0, };

/**
 * e_table_model_column_count:
 * @e_table_model: The e-table-model to operate on
 *
 * Returns: the number of columns in the table model.
 */
int
e_table_model_column_count (ETableModel *e_table_model)
{
    g_return_val_if_fail (e_table_model != NULL, 0);
    g_return_val_if_fail (E_IS_TABLE_MODEL (e_table_model), 0);

    return ETM_CLASS (e_table_model)->column_count (e_table_model);
}


/**
 * e_table_model_row_count:
 * @e_table_model: the e-table-model to operate on
 *
 * Returns: the number of rows in the Table model.
 */
int
e_table_model_row_count (ETableModel *e_table_model)
{
    g_return_val_if_fail (e_table_model != NULL, 0);
    g_return_val_if_fail (E_IS_TABLE_MODEL (e_table_model), 0);

    return ETM_CLASS (e_table_model)->row_count (e_table_model);
}

/**
 * e_table_model_append_row:
 * @e_table_model: the table model to append the a row to.
 * @source:
 * @row:
 *
 */
void
e_table_model_append_row (ETableModel *e_table_model, ETableModel *source, int row)
{
    g_return_if_fail (e_table_model != NULL);
    g_return_if_fail (E_IS_TABLE_MODEL (e_table_model));

    if (ETM_CLASS (e_table_model)->append_row)
        ETM_CLASS (e_table_model)->append_row (e_table_model, source, row);
}

/**
 * e_table_value_at:
 * @e_table_model: the e-table-model to operate on
 * @col: column in the model to pull data from.
 * @row: row in the model to pull data from.
 *
 * Return value: This function returns the value that is stored
 * by the @e_table_model in column @col and row @row.  The data
 * returned can be a pointer or any data value that can be stored
 * inside a pointer.
 *
 * The data returned is typically used by an ECell renderer
 */
void *
e_table_model_value_at (ETableModel *e_table_model, int col, int row)
{
    g_return_val_if_fail (e_table_model != NULL, NULL);
    g_return_val_if_fail (E_IS_TABLE_MODEL (e_table_model), NULL);

    return ETM_CLASS (e_table_model)->value_at (e_table_model, col, row);
}

/**
 * e_table_model_set_value_at:
 * @e_table_model: the table model to operate on.
 * @col: the column where the data will be stored in the model.
 * @row: the row where the data will be stored in the model. 
 * @value: the data to be stored.
 *
 * This function instructs the model to store the value in @data in the
 * the @e_table_model at column @col and row @row.  The @data typically
 * comes from one of the ECell rendering objects.
 *
 * There should be an agreement between the Table Model and the user
 * of this function about the data being stored.  Typically it will
 * be a pointer to a set of data, or a datum that fits inside a void *.
 */
void
e_table_model_set_value_at (ETableModel *e_table_model, int col, int row, const void *value)
{
    g_return_if_fail (e_table_model != NULL);
    g_return_if_fail (E_IS_TABLE_MODEL (e_table_model));

    ETM_CLASS (e_table_model)->set_value_at (e_table_model, col, row, value);
}

/**
 * e_table_model_is_cell_editable:
 * @e_table_model: the table model to query.
 * @col: column to query.
 * @row: row to query.
 *
 * Returns: %TRUE if the cell in @e_table_model at @col,@row can be
 * edited, %FALSE otherwise
 */
gboolean
e_table_model_is_cell_editable (ETableModel *e_table_model, int col, int row)
{
    g_return_val_if_fail (e_table_model != NULL, FALSE);
    g_return_val_if_fail (E_IS_TABLE_MODEL (e_table_model), FALSE);

    return ETM_CLASS (e_table_model)->is_cell_editable (e_table_model, col, row);
}


void *
e_table_model_duplicate_value (ETableModel *e_table_model, int col, const void *value)
{
    g_return_val_if_fail (e_table_model != NULL, NULL);
    g_return_val_if_fail (E_IS_TABLE_MODEL (e_table_model), NULL);

    if (ETM_CLASS (e_table_model)->duplicate_value)
        return ETM_CLASS (e_table_model)->duplicate_value (e_table_model, col, value);
    else
        return NULL;
}

void
e_table_model_free_value (ETableModel *e_table_model, int col, void *value)
{
    g_return_if_fail (e_table_model != NULL);
    g_return_if_fail (E_IS_TABLE_MODEL (e_table_model));

    if (ETM_CLASS (e_table_model)->free_value)
        ETM_CLASS (e_table_model)->free_value (e_table_model, col, value);
}

gboolean
e_table_model_has_save_id (ETableModel *e_table_model)
{
    g_return_val_if_fail (e_table_model != NULL, FALSE);
    g_return_val_if_fail (E_IS_TABLE_MODEL (e_table_model), FALSE);

    if (ETM_CLASS (e_table_model)->has_save_id)
        return ETM_CLASS (e_table_model)->has_save_id (e_table_model);
    else
        return FALSE;
}

char *
e_table_model_get_save_id (ETableModel *e_table_model, int row)
{
    g_return_val_if_fail (e_table_model != NULL, "/");
    g_return_val_if_fail (E_IS_TABLE_MODEL (e_table_model), "/");

    if (ETM_CLASS (e_table_model)->get_save_id)
        return ETM_CLASS (e_table_model)->get_save_id (e_table_model, row);
    else
        return NULL;
}

gboolean
e_table_model_has_change_pending(ETableModel *e_table_model)
{
    g_return_val_if_fail (e_table_model != NULL, FALSE);
    g_return_val_if_fail (E_IS_TABLE_MODEL (e_table_model), FALSE);

    if (ETM_CLASS (e_table_model)->has_change_pending)
        return ETM_CLASS (e_table_model)->has_change_pending (e_table_model);
    else
        return FALSE;
}

void *
e_table_model_initialize_value (ETableModel *e_table_model, int col)
{
    g_return_val_if_fail (e_table_model != NULL, NULL);
    g_return_val_if_fail (E_IS_TABLE_MODEL (e_table_model), NULL);

    if (ETM_CLASS (e_table_model)->initialize_value)
        return ETM_CLASS (e_table_model)->initialize_value (e_table_model, col);
    else
        return NULL;
}

gboolean
e_table_model_value_is_empty (ETableModel *e_table_model, int col, const void *value)
{
    g_return_val_if_fail (e_table_model != NULL, FALSE);
    g_return_val_if_fail (E_IS_TABLE_MODEL (e_table_model), FALSE);

    if (ETM_CLASS (e_table_model)->value_is_empty)
        return ETM_CLASS (e_table_model)->value_is_empty (e_table_model, col, value);
    else
        return FALSE;
}

char *
e_table_model_value_to_string (ETableModel *e_table_model, int col, const void *value)
{
    g_return_val_if_fail (e_table_model != NULL, NULL);
    g_return_val_if_fail (E_IS_TABLE_MODEL (e_table_model), NULL);

    if (ETM_CLASS (e_table_model)->value_to_string)
        return ETM_CLASS (e_table_model)->value_to_string (e_table_model, col, value);
    else
        return g_strdup("");
}

static void
e_table_model_destroy (GtkObject *object)
{
    if (e_table_model_parent_class->destroy)
        (*e_table_model_parent_class->destroy)(object);
}

static void
e_table_model_class_init (GtkObjectClass *object_class)
{
    ETableModelClass *klass = E_TABLE_MODEL_CLASS(object_class);
    e_table_model_parent_class = gtk_type_class (PARENT_TYPE);
    
    object_class->destroy = e_table_model_destroy;

    e_table_model_signals [MODEL_CHANGED] =
        gtk_signal_new ("model_changed",
                GTK_RUN_LAST,
                object_class->type,
                GTK_SIGNAL_OFFSET (ETableModelClass, model_changed),
                gtk_marshal_NONE__NONE,
                GTK_TYPE_NONE, 0);

    e_table_model_signals [MODEL_PRE_CHANGE] =
        gtk_signal_new ("model_pre_change",
                GTK_RUN_LAST,
                object_class->type,
                GTK_SIGNAL_OFFSET (ETableModelClass, model_pre_change),
                gtk_marshal_NONE__NONE,
                GTK_TYPE_NONE, 0);

    e_table_model_signals [MODEL_ROW_CHANGED] =
        gtk_signal_new ("model_row_changed",
                GTK_RUN_LAST,
                object_class->type,
                GTK_SIGNAL_OFFSET (ETableModelClass, model_row_changed),
                gtk_marshal_NONE__INT,
                GTK_TYPE_NONE, 1, GTK_TYPE_INT);

    e_table_model_signals [MODEL_CELL_CHANGED] =
        gtk_signal_new ("model_cell_changed",
                GTK_RUN_LAST,
                object_class->type,
                GTK_SIGNAL_OFFSET (ETableModelClass, model_cell_changed),
                gtk_marshal_NONE__INT_INT,
                GTK_TYPE_NONE, 2, GTK_TYPE_INT, GTK_TYPE_INT);

    e_table_model_signals [MODEL_ROWS_INSERTED] =
        gtk_signal_new ("model_rows_inserted",
                GTK_RUN_LAST,
                object_class->type,
                GTK_SIGNAL_OFFSET (ETableModelClass, model_rows_inserted),
                gtk_marshal_NONE__INT_INT,
                GTK_TYPE_NONE, 2, GTK_TYPE_INT, GTK_TYPE_INT);

    e_table_model_signals [MODEL_ROWS_DELETED] =
        gtk_signal_new ("model_rows_deleted",
                GTK_RUN_LAST,
                object_class->type,
                GTK_SIGNAL_OFFSET (ETableModelClass, model_rows_deleted),
                gtk_marshal_NONE__INT_INT,
                GTK_TYPE_NONE, 2, GTK_TYPE_INT, GTK_TYPE_INT);

    gtk_object_class_add_signals (object_class, e_table_model_signals, LAST_SIGNAL);

    klass->column_count        = NULL;     
    klass->row_count           = NULL;        
    klass->append_row          = NULL;

    klass->value_at            = NULL;         
    klass->set_value_at        = NULL;     
    klass->is_cell_editable    = NULL; 

    klass->has_save_id         = NULL;
    klass->get_save_id         = NULL;

    klass->has_change_pending  = NULL;

    klass->duplicate_value     = NULL;  
    klass->free_value          = NULL;       
    klass->initialize_value    = NULL; 
    klass->value_is_empty      = NULL;   
    klass->value_to_string     = NULL;

    klass->model_changed       = NULL;    
    klass->model_row_changed   = NULL;
    klass->model_cell_changed  = NULL;
    klass->model_rows_inserted = NULL;
    klass->model_rows_deleted  = NULL;
}


guint
e_table_model_get_type (void)
{
    static guint type = 0;
    
    if (!type)
    {
        GtkTypeInfo info =
        {
            "ETableModel",
            sizeof (ETableModel),
            sizeof (ETableModelClass),
            (GtkClassInitFunc) e_table_model_class_init,
            NULL,
            /* reserved_1 */ NULL,
            /* reserved_2 */ NULL,
            (GtkClassInitFunc) NULL,
        };
        
        type = gtk_type_unique (PARENT_TYPE, &info);
    }

  return type;
}

#if d(!)0
static void
print_tabs (void)
{
    int i;
    for (i = 0; i < depth; i++)
        g_print("\t");
}
#endif

void
e_table_model_pre_change (ETableModel *e_table_model)
{
    g_return_if_fail (e_table_model != NULL);
    g_return_if_fail (E_IS_TABLE_MODEL (e_table_model));
    
    d(print_tabs());
    d(g_print("Emitting pre_change on model 0x%p.\n", e_table_model));
    d(depth++);
    gtk_signal_emit (GTK_OBJECT (e_table_model),
             e_table_model_signals [MODEL_PRE_CHANGE]);
    d(depth--);
}

/**
 * e_table_model_changed:
 * @e_table_model: the table model to notify of the change
 *
 * Use this function to notify any views of this table model that
 * the contents of the table model have changed.  This will emit
 * the signal "model_changed" on the @e_table_model object.
 *
 * It is preferable to use the e_table_model_row_changed() and
 * the e_table_model_cell_changed() to notify of smaller changes
 * than to invalidate the entire model, as the views might have
 * ways of caching the information they render from the model.
 */
void
e_table_model_changed (ETableModel *e_table_model)
{
    g_return_if_fail (e_table_model != NULL);
    g_return_if_fail (E_IS_TABLE_MODEL (e_table_model));
    
    d(print_tabs());
    d(g_print("Emitting model_changed on model 0x%p.\n", e_table_model));
    d(depth++);
    gtk_signal_emit (GTK_OBJECT (e_table_model),
             e_table_model_signals [MODEL_CHANGED]);
    d(depth--);
}

/**
 * e_table_model_row_changed:
 * @e_table_model: the table model to notify of the change
 * @row: the row that was changed in the model.
 *
 * Use this function to notify any views of the table model that
 * the contents of row @row have changed in model.  This function
 * will emit the "model_row_changed" signal on the @e_table_model
 * object
 */
void
e_table_model_row_changed (ETableModel *e_table_model, int row)
{
    g_return_if_fail (e_table_model != NULL);
    g_return_if_fail (E_IS_TABLE_MODEL (e_table_model));

    d(print_tabs());
    d(g_print("Emitting row_changed on model 0x%p, row %d.\n", e_table_model, row));
    d(depth++);
    gtk_signal_emit (GTK_OBJECT (e_table_model),
             e_table_model_signals [MODEL_ROW_CHANGED], row);
    d(depth--);
}

/**
 * e_table_model_cell_changed:
 * @e_table_model: the table model to notify of the change
 * @col: the column.
 * @row: the row
 *
 * Use this function to notify any views of the table model that
 * contents of the cell at @col,@row has changed. This will emit
 * the "model_cell_changed" signal on the @e_table_model
 * object
 */
void
e_table_model_cell_changed (ETableModel *e_table_model, int col, int row)
{
    g_return_if_fail (e_table_model != NULL);
    g_return_if_fail (E_IS_TABLE_MODEL (e_table_model));

    d(print_tabs());
    d(g_print("Emitting cell_changed on model 0x%p, row %d, col %d.\n", e_table_model, row, col));
    d(depth++);
    gtk_signal_emit (GTK_OBJECT (e_table_model),
             e_table_model_signals [MODEL_CELL_CHANGED], col, row);
    d(depth--);
}

/**
 * e_table_model_rows_inserted:
 * @e_table_model: the table model to notify of the change
 * @row: the row that was inserted into the model.
 * @count: The number of rows that were inserted.
 *
 * Use this function to notify any views of the table model that
 * @count rows at row @row have been inserted into the model.  This
 * function will emit the "model_rows_inserted" signal on the
 * @e_table_model object
 */
void
e_table_model_rows_inserted (ETableModel *e_table_model, int row, int count)
{
    g_return_if_fail (e_table_model != NULL);
    g_return_if_fail (E_IS_TABLE_MODEL (e_table_model));

    d(print_tabs());
    d(g_print("Emitting row_inserted on model 0x%p, row %d.\n", e_table_model, row));
    d(depth++);
    gtk_signal_emit (GTK_OBJECT (e_table_model),
             e_table_model_signals [MODEL_ROWS_INSERTED], row, count);
    d(depth--);
}

/**
 * e_table_model_row_inserted:
 * @e_table_model: the table model to notify of the change
 * @row: the row that was inserted into the model.
 *
 * Use this function to notify any views of the table model that the
 * row @row has been inserted into the model.  This function will emit
 * the "model_rows_inserted" signal on the @e_table_model object
 */
void
e_table_model_row_inserted (ETableModel *e_table_model, int row)
{
    e_table_model_rows_inserted(e_table_model, row, 1);
}

/**
 * e_table_model_row_deleted:
 * @e_table_model: the table model to notify of the change
 * @row: the row that was deleted
 * @count: The number of rows deleted
 *
 * Use this function to notify any views of the table model that
 * @count rows at row @row have been deleted from the model.  This
 * function will emit the "model_rows_deleted" signal on the
 * @e_table_model object
 */
void
e_table_model_rows_deleted (ETableModel *e_table_model, int row, int count)
{
    g_return_if_fail (e_table_model != NULL);
    g_return_if_fail (E_IS_TABLE_MODEL (e_table_model));

    d(print_tabs());
    d(g_print("Emitting row_deleted on model 0x%p, row %d.\n", e_table_model, row));
    d(depth++);
    gtk_signal_emit (GTK_OBJECT (e_table_model),
             e_table_model_signals [MODEL_ROWS_DELETED], row, count);
    d(depth--);
}

/**
 * e_table_model_row_deleted:
 * @e_table_model: the table model to notify of the change
 * @row: the row that was deleted
 *
 * Use this function to notify any views of the table model that the
 * row @row has been deleted from the model.  This function will emit
 * the "model_rows_deleted" signal on the @e_table_model object
 */
void
e_table_model_row_deleted (ETableModel *e_table_model, int row)
{
    e_table_model_rows_deleted(e_table_model, row, 1);
}