aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-reflow-model.c
blob: 6af3c46f06ff3644d6b9920d2bce19022483b0cf (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
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 *
 * 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.
 *
 * 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 General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 *
 *
 * Authors:
 *      Chris Lahey <clahey@ximian.com>
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include "e-reflow-model.h"

#include "e-misc-utils.h"

G_DEFINE_TYPE (EReflowModel, e_reflow_model, G_TYPE_OBJECT)

#define d(x)

d (static gint depth = 0;)

enum {
    MODEL_CHANGED,
    COMPARISON_CHANGED,
    MODEL_ITEMS_INSERTED,
    MODEL_ITEM_CHANGED,
    MODEL_ITEM_REMOVED,
    LAST_SIGNAL
};

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

/**
 * e_reflow_model_set_width:
 * @reflow_model: The e-reflow-model to operate on
 * @width: The new value for the width of each item.
 */
void
e_reflow_model_set_width (EReflowModel *reflow_model,
                          gint width)
{
    EReflowModelClass *class;

    g_return_if_fail (E_IS_REFLOW_MODEL (reflow_model));

    class = E_REFLOW_MODEL_GET_CLASS (reflow_model);
    g_return_if_fail (class->set_width != NULL);

    class->set_width (reflow_model, width);
}

/**
 * e_reflow_model_count:
 * @reflow_model: The e-reflow-model to operate on
 *
 * Returns: the number of items in the reflow model.
 */
gint
e_reflow_model_count (EReflowModel *reflow_model)
{
    EReflowModelClass *class;

    g_return_val_if_fail (E_IS_REFLOW_MODEL (reflow_model), 0);

    class = E_REFLOW_MODEL_GET_CLASS (reflow_model);
    g_return_val_if_fail (class->count != NULL, 0);

    return class->count (reflow_model);
}

/**
 * e_reflow_model_height:
 * @reflow_model: The e-reflow-model to operate on
 * @n: The item number to get the height of.
 * @parent: The parent GnomeCanvasItem.
 *
 * Returns: the height of the nth item.
 */
gint
e_reflow_model_height (EReflowModel *reflow_model,
                       gint n,
                       GnomeCanvasGroup *parent)
{
    EReflowModelClass *class;

    g_return_val_if_fail (E_IS_REFLOW_MODEL (reflow_model), 0);

    class = E_REFLOW_MODEL_GET_CLASS (reflow_model);
    g_return_val_if_fail (class->height != NULL, 0);

    return class->height (reflow_model, n, parent);
}

/**
 * e_reflow_model_incarnate:
 * @reflow_model: The e-reflow-model to operate on
 * @n: The item to create.
 * @parent: The parent GnomeCanvasItem to create a child of.
 *
 * Create a GnomeCanvasItem to represent the nth piece of data.
 *
 * Returns: the new GnomeCanvasItem.
 */
GnomeCanvasItem *
e_reflow_model_incarnate (EReflowModel *reflow_model,
                          gint n,
                          GnomeCanvasGroup *parent)
{
    EReflowModelClass *class;

    g_return_val_if_fail (E_IS_REFLOW_MODEL (reflow_model), NULL);

    class = E_REFLOW_MODEL_GET_CLASS (reflow_model);
    g_return_val_if_fail (class->incarnate != NULL, NULL);

    return class->incarnate (reflow_model, n, parent);
}

/**
 * e_reflow_model_create_cmp_cache:
 * @reflow_model: The e-reflow-model to operate on
 *
 * Creates a compare cache for quicker sorting. The sorting function
 * may not depend on the cache, but it should benefit from it if available.
 *
 * Returns: Newly created GHashTable with cached compare values. This will be
 * automatically freed with g_hash_table_destroy() when no longer needed.
 **/
GHashTable *
e_reflow_model_create_cmp_cache (EReflowModel *reflow_model)
{
    EReflowModelClass *class;

    g_return_val_if_fail (E_IS_REFLOW_MODEL (reflow_model), NULL);

    class = E_REFLOW_MODEL_GET_CLASS (reflow_model);

    if (class->create_cmp_cache == NULL)
        return NULL;

    return class->create_cmp_cache (reflow_model);
}

/**
 * e_reflow_model_compare:
 * @reflow_model: The e-reflow-model to operate on
 * @n1: The first item to compare
 * @n2: The second item to compare
 * @cmp_cache: #GHashTable of cached compare values, created by
 *    e_reflow_model_create_cmp_cache(). This can be NULL, when
 *    caching is not available, even when @reflow_model defines
 *    the create_cmp_cache function.
 *
 * Compares item n1 and item n2 to see which should come first.
 *
 * Returns: strcmp like semantics for the comparison value.
 */
gint
e_reflow_model_compare (EReflowModel *reflow_model,
                        gint n1,
                        gint n2,
                        GHashTable *cmp_cache)
{
    EReflowModelClass *class;

    g_return_val_if_fail (E_IS_REFLOW_MODEL (reflow_model), 0);

    class = E_REFLOW_MODEL_GET_CLASS (reflow_model);
    g_return_val_if_fail (class->compare != NULL, 0);

    return class->compare (reflow_model, n1, n2, cmp_cache);
}

/**
 * e_reflow_model_reincarnate:
 * @reflow_model: The e-reflow-model to operate on
 * @n: The item to create.
 * @item: The item to reuse.
 *
 * Update item to represent the nth piece of data.
 */
void
e_reflow_model_reincarnate (EReflowModel *reflow_model,
                            gint n,
                            GnomeCanvasItem *item)
{
    EReflowModelClass *class;

    g_return_if_fail (E_IS_REFLOW_MODEL (reflow_model));

    class = E_REFLOW_MODEL_GET_CLASS (reflow_model);
    g_return_if_fail (class->reincarnate != NULL);

    class->reincarnate (reflow_model, n, item);
}

static void
e_reflow_model_class_init (EReflowModelClass *class)
{
    GObjectClass *object_class = G_OBJECT_CLASS (class);

    class->set_width = NULL;
    class->count = NULL;
    class->height = NULL;
    class->incarnate = NULL;
    class->reincarnate = NULL;

    class->model_changed = NULL;
    class->comparison_changed = NULL;
    class->model_items_inserted = NULL;
    class->model_item_removed = NULL;
    class->model_item_changed = NULL;

    signals[MODEL_CHANGED] = g_signal_new (
        "model_changed",
        G_OBJECT_CLASS_TYPE (object_class),
        G_SIGNAL_RUN_LAST,
        G_STRUCT_OFFSET (EReflowModelClass, model_changed),
        NULL, NULL,
        g_cclosure_marshal_VOID__VOID,
        G_TYPE_NONE, 0);

    signals[COMPARISON_CHANGED] = g_signal_new (
        "comparison_changed",
        G_OBJECT_CLASS_TYPE (object_class),
        G_SIGNAL_RUN_LAST,
        G_STRUCT_OFFSET (EReflowModelClass, comparison_changed),
        NULL, NULL,
        g_cclosure_marshal_VOID__VOID,
        G_TYPE_NONE, 0);

    signals[MODEL_ITEMS_INSERTED] = g_signal_new (
        "model_items_inserted",
        G_OBJECT_CLASS_TYPE (object_class),
        G_SIGNAL_RUN_LAST,
        G_STRUCT_OFFSET (EReflowModelClass, model_items_inserted),
        NULL, NULL,
        e_marshal_NONE__INT_INT,
        G_TYPE_NONE, 2, G_TYPE_INT, G_TYPE_INT);

    signals[MODEL_ITEM_CHANGED] = g_signal_new (
        "model_item_changed",
        G_OBJECT_CLASS_TYPE (object_class),
        G_SIGNAL_RUN_LAST,
        G_STRUCT_OFFSET (EReflowModelClass, model_item_changed),
        NULL, NULL,
        g_cclosure_marshal_VOID__INT,
        G_TYPE_NONE, 1, G_TYPE_INT);

    signals[MODEL_ITEM_REMOVED] = g_signal_new (
        "model_item_removed",
        G_OBJECT_CLASS_TYPE (object_class),
        G_SIGNAL_RUN_LAST,
        G_STRUCT_OFFSET (EReflowModelClass, model_item_removed),
        NULL, NULL,
        g_cclosure_marshal_VOID__INT,
        G_TYPE_NONE, 1, G_TYPE_INT);
}

static void
e_reflow_model_init (EReflowModel *e_reflow_model)
{
}

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

/**
 * e_reflow_model_changed:
 * @reflow_model: the reflow model to notify of the change
 *
 * Use this function to notify any views of this reflow model that
 * the contents of the reflow model have changed.  This will emit
 * the signal "model_changed" on the @reflow_model object.
 *
 * It is preferable to use the e_reflow_model_item_changed() signal 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_reflow_model_changed (EReflowModel *reflow_model)
{
    g_return_if_fail (E_IS_REFLOW_MODEL (reflow_model));

    d (print_tabs ());
    d (g_print ("Emitting model_changed on model 0x%p.\n", reflow_model));
    d (depth++);
    g_signal_emit (reflow_model, signals[MODEL_CHANGED], 0);
    d (depth--);
}

/**
 * e_reflow_model_comparison_changed:
 * @reflow_model: the reflow model to notify of the change
 *
 * Use this function to notify any views of this reflow model that the
 * sorting has changed.  The actual contents of the items hasn't, so
 * there's no need to re-query the model for the heights of the
 * individual items.
 */
void
e_reflow_model_comparison_changed (EReflowModel *reflow_model)
{
    g_return_if_fail (E_IS_REFLOW_MODEL (reflow_model));

    d (print_tabs ());
    d (g_print (
        "Emitting comparison_changed on model 0x%p.\n",
        reflow_model));
    d (depth++);
    g_signal_emit (reflow_model, signals[COMPARISON_CHANGED], 0);
    d (depth--);
}

/**
 * e_reflow_model_items_inserted:
 * @reflow_model: The model changed.
 * @position: The position the items were insert in.
 * @count: The number of items inserted.
 *
 * Use this function to notify any views of the reflow model that a number
 * of items have been inserted.
 **/
void
e_reflow_model_items_inserted (EReflowModel *reflow_model,
                               gint position,
                               gint count)
{
    g_return_if_fail (E_IS_REFLOW_MODEL (reflow_model));

    d (print_tabs ());
    d (depth++);
    g_signal_emit (
        reflow_model,
        signals[MODEL_ITEMS_INSERTED], 0,
        position, count);
    d (depth--);
}

/**
 * e_reflow_model_item_removed:
 * @reflow_model: The model changed.
 * @n: The position from which the items were removed.
 *
 * Use this function to notify any views of the reflow model that an
 * item has been removed.
 **/
void
e_reflow_model_item_removed (EReflowModel *reflow_model,
                             gint n)
{
    g_return_if_fail (E_IS_REFLOW_MODEL (reflow_model));

    d (print_tabs ());
    d (depth++);
    g_signal_emit (reflow_model, signals[MODEL_ITEM_REMOVED], 0, n);
    d (depth--);
}

/**
 * e_reflow_model_item_changed:
 * @reflow_model: the reflow model to notify of the change
 * @n: the item that was changed in the model.
 *
 * Use this function to notify any views of the reflow model that the
 * contents of item @item have changed in model such that the height
 * has changed or the item needs to be reincarnated.  This function
 * will emit the "model_item_changed" signal on the @reflow_model
 * object
 */
void
e_reflow_model_item_changed (EReflowModel *reflow_model,
                             gint n)
{
    g_return_if_fail (E_IS_REFLOW_MODEL (reflow_model));

    d (print_tabs ());
    d (g_print ("Emitting item_changed on model 0x%p, n=%d.\n", reflow_model, n));
    d (depth++);
    g_signal_emit (reflow_model, signals[MODEL_ITEM_CHANGED], 0, n);
    d (depth--);
}