aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/misc/e-selection-model.c
blob: 49b42f1b19bf137e9489392fd0941d30580eb728 (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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * e-selection-model.c: a Selection Model
 *
 * Author:
 *   Christopher James Lahey <clahey@ximian.com>
 *
 * (C) 2000, 2001 Ximian, Inc.
 */
#include <config.h>
#include <gtk/gtksignal.h>
#include "e-selection-model.h"
#include "gal/util/e-util.h"
#include <gdk/gdkkeysyms.h>

#define ESM_CLASS(e) ((ESelectionModelClass *)((GtkObject *)e)->klass)

#define PARENT_TYPE gtk_object_get_type ()

static GtkObjectClass *e_selection_model_parent_class;

enum {
    CURSOR_CHANGED,
    CURSOR_ACTIVATED,
    SELECTION_CHANGED,
    LAST_SIGNAL
};

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

enum {
    ARG_0,
    ARG_SORTER,
    ARG_SELECTION_MODE,
    ARG_CURSOR_MODE,
};

inline static void
add_sorter(ESelectionModel *esm, ESorter *sorter)
{
    esm->sorter = sorter;
    if (sorter) {
        gtk_object_ref(GTK_OBJECT(sorter));
    }
}

inline static void
drop_sorter(ESelectionModel *esm)
{
    if (esm->sorter) {
        gtk_object_unref(GTK_OBJECT(esm->sorter));
    }
    esm->sorter = NULL;
}

static void
esm_destroy (GtkObject *object)
{
    ESelectionModel *esm;

    esm = E_SELECTION_MODEL (object);

    drop_sorter(esm);
}

static void
esm_get_arg (GtkObject *o, GtkArg *arg, guint arg_id)
{
    ESelectionModel *esm = E_SELECTION_MODEL (o);

    switch (arg_id){
    case ARG_SORTER:
        GTK_VALUE_OBJECT (*arg) = GTK_OBJECT(esm->sorter);
        break;

    case ARG_SELECTION_MODE:
        GTK_VALUE_ENUM(*arg) = esm->mode;
        break;

    case ARG_CURSOR_MODE:
        GTK_VALUE_ENUM(*arg) = esm->cursor_mode;
        break;
    }
}

static void
esm_set_arg (GtkObject *o, GtkArg *arg, guint arg_id)
{
    ESelectionModel *esm = E_SELECTION_MODEL (o);
    
    switch (arg_id){
    case ARG_SORTER:
        drop_sorter(esm);
        add_sorter(esm, GTK_VALUE_OBJECT (*arg) ? E_SORTER(GTK_VALUE_OBJECT (*arg)) : NULL);
        break;

    case ARG_SELECTION_MODE:
        esm->mode = GTK_VALUE_ENUM(*arg);
        if (esm->mode == GTK_SELECTION_SINGLE) {
            int cursor_row = e_selection_model_cursor_row(esm);
            int cursor_col = e_selection_model_cursor_col(esm);
            e_selection_model_do_something(esm, cursor_row, cursor_col, 0);
        }
        break;

    case ARG_CURSOR_MODE:
        esm->cursor_mode = GTK_VALUE_ENUM(*arg);
        break;
    }
}

static void
e_selection_model_init (ESelectionModel *selection)
{
    selection->mode = GTK_SELECTION_MULTIPLE;
    selection->cursor_mode = E_CURSOR_SIMPLE;
}

static void
e_selection_model_class_init (ESelectionModelClass *klass)
{
    GtkObjectClass *object_class;

    e_selection_model_parent_class = gtk_type_class (gtk_object_get_type ());

    object_class = GTK_OBJECT_CLASS(klass);

    object_class->destroy = esm_destroy;
    object_class->get_arg = esm_get_arg;
    object_class->set_arg = esm_set_arg;

    e_selection_model_signals [CURSOR_CHANGED] =
        gtk_signal_new ("cursor_changed",
                GTK_RUN_LAST,
                object_class->type,
                GTK_SIGNAL_OFFSET (ESelectionModelClass, cursor_changed),
                gtk_marshal_NONE__INT_INT,
                GTK_TYPE_NONE, 2, GTK_TYPE_INT, GTK_TYPE_INT);

    e_selection_model_signals [CURSOR_ACTIVATED] =
        gtk_signal_new ("cursor_activated",
                GTK_RUN_LAST,
                object_class->type,
                GTK_SIGNAL_OFFSET (ESelectionModelClass, cursor_activated),
                gtk_marshal_NONE__INT_INT,
                GTK_TYPE_NONE, 2, GTK_TYPE_INT, GTK_TYPE_INT);

    e_selection_model_signals [SELECTION_CHANGED] =
        gtk_signal_new ("selection_changed",
                GTK_RUN_LAST,
                object_class->type,
                GTK_SIGNAL_OFFSET (ESelectionModelClass, selection_changed),
                gtk_marshal_NONE__NONE,
                GTK_TYPE_NONE, 0);

    klass->cursor_changed     = NULL;
    klass->cursor_activated   = NULL;
    klass->selection_changed  = NULL;

    klass->is_row_selected    = NULL;
    klass->foreach            = NULL;
    klass->clear              = NULL;
    klass->selected_count     = NULL;
    klass->select_all         = NULL;
    klass->invert_selection   = NULL;
    klass->row_count          = NULL;

    klass->change_one_row     = NULL;
    klass->change_cursor      = NULL;
    klass->cursor_row         = NULL;
    klass->cursor_col         = NULL;

    klass->select_single_row  = NULL;
    klass->toggle_single_row  = NULL;
    klass->move_selection_end = NULL;
    klass->set_selection_end  = NULL;


    gtk_object_class_add_signals (object_class, e_selection_model_signals, LAST_SIGNAL);

    gtk_object_add_arg_type ("ESelectionModel::sorter", GTK_TYPE_OBJECT,
                 GTK_ARG_READWRITE, ARG_SORTER);
    gtk_object_add_arg_type ("ESelectionModel::selection_mode", GTK_TYPE_ENUM,
                 GTK_ARG_READWRITE, ARG_SELECTION_MODE);
    gtk_object_add_arg_type ("ESelectionModel::cursor_mode", GTK_TYPE_ENUM,
                 GTK_ARG_READWRITE, ARG_CURSOR_MODE);
}

E_MAKE_TYPE(e_selection_model, "ESelectionModel", ESelectionModel,
        e_selection_model_class_init, e_selection_model_init, PARENT_TYPE);

/** 
 * e_selection_model_is_row_selected
 * @selection: #ESelectionModel to check
 * @n: The row to check
 *
 * This routine calculates whether the given row is selected.
 *
 * Returns: %TRUE if the given row is selected
 */
gboolean
e_selection_model_is_row_selected (ESelectionModel *selection,
                   gint                 n)
{
    if (ESM_CLASS(selection)->is_row_selected)
        return ESM_CLASS(selection)->is_row_selected (selection, n);
    else
        return FALSE;
}

/** 
 * e_selection_model_foreach
 * @selection: #ESelectionModel to traverse
 * @callback: The callback function to call back.
 * @closure: The closure
 *
 * This routine calls the given callback function once for each
 * selected row, passing closure as the closure.
 */
void 
e_selection_model_foreach     (ESelectionModel *selection,
                   EForeachFunc callback,
                   gpointer closure)
{
    if (ESM_CLASS(selection)->foreach)
        ESM_CLASS(selection)->foreach (selection, callback, closure);
}

/** 
 * e_selection_model_clear
 * @selection: #ESelectionModel to clear
 *
 * This routine clears the selection to no rows selected.
 */
void
e_selection_model_clear(ESelectionModel *selection)
{
    if (ESM_CLASS(selection)->clear)
        ESM_CLASS(selection)->clear (selection);
}

/** 
 * e_selection_model_selected_count
 * @selection: #ESelectionModel to count
 *
 * This routine calculates the number of rows selected.
 *
 * Returns: The number of rows selected in the given model.
 */
gint
e_selection_model_selected_count (ESelectionModel *selection)
{
    if (ESM_CLASS(selection)->selected_count)
        return ESM_CLASS(selection)->selected_count (selection);
    else
        return 0;
}

/** 
 * e_selection_model_select_all
 * @selection: #ESelectionModel to select all
 *
 * This routine selects all the rows in the given
 * #ESelectionModel.
 */
void
e_selection_model_select_all (ESelectionModel *selection)
{
    if (ESM_CLASS(selection)->select_all)
        ESM_CLASS(selection)->select_all (selection);
}

/** 
 * e_selection_model_invert_selection
 * @selection: #ESelectionModel to invert
 *
 * This routine inverts all the rows in the given
 * #ESelectionModel.
 */
void
e_selection_model_invert_selection (ESelectionModel *selection)
{
    if (ESM_CLASS(selection)->invert_selection)
        ESM_CLASS(selection)->invert_selection (selection);
}

int
e_selection_model_row_count (ESelectionModel *selection)
{
    if (ESM_CLASS(selection)->row_count)
        return ESM_CLASS(selection)->row_count (selection);
    else
        return 0;
}

void
e_selection_model_change_one_row(ESelectionModel *selection, int row, gboolean grow)
{
    if (ESM_CLASS(selection)->change_one_row)
        ESM_CLASS(selection)->change_one_row (selection, row, grow);
}

void
e_selection_model_change_cursor (ESelectionModel *selection, int row, int col)
{
    if (ESM_CLASS(selection)->change_cursor)
        ESM_CLASS(selection)->change_cursor (selection, row, col);
}

int
e_selection_model_cursor_row (ESelectionModel *selection)
{
    if (ESM_CLASS(selection)->cursor_row)
        return ESM_CLASS(selection)->cursor_row (selection);
    else
        return -1;
}

int
e_selection_model_cursor_col (ESelectionModel *selection)
{
    if (ESM_CLASS(selection)->cursor_col)
        return ESM_CLASS(selection)->cursor_col (selection);
    else
        return -1;
}

void
e_selection_model_select_single_row (ESelectionModel *selection, int row)
{
    if (ESM_CLASS(selection)->select_single_row)
        ESM_CLASS(selection)->select_single_row (selection, row);
}

void
e_selection_model_toggle_single_row (ESelectionModel *selection, int row)
{
    if (ESM_CLASS(selection)->toggle_single_row)
        ESM_CLASS(selection)->toggle_single_row (selection, row);
}

void
e_selection_model_move_selection_end (ESelectionModel *selection, int row)
{
    if (ESM_CLASS(selection)->move_selection_end)
        ESM_CLASS(selection)->move_selection_end (selection, row);
}

void
e_selection_model_set_selection_end (ESelectionModel *selection, int row)
{
    if (ESM_CLASS(selection)->set_selection_end)
        ESM_CLASS(selection)->set_selection_end (selection, row);
}

/** 
 * e_selection_model_do_something
 * @selection: #ESelectionModel to do something to.
 * @row: The row to do something in.
 * @col: The col to do something in.
 * @state: The state in which to do something.
 *
 * This routine does whatever is appropriate as if the user clicked
 * the mouse in the given row and column.
 */
void
e_selection_model_do_something (ESelectionModel *selection,
                guint                 row,
                guint                 col,
                GdkModifierType       state)
{
    gint shift_p = state & GDK_SHIFT_MASK;
    gint ctrl_p = state & GDK_CONTROL_MASK;
    int row_count;

    if (row == -1 && col != -1)
        row = 0;
    if (col == -1 && row != -1)
        col = 0;

    row_count = e_selection_model_row_count(selection);
    if (row_count >= 0 && row < row_count) {
        switch (selection->mode) {
        case GTK_SELECTION_SINGLE:
            e_selection_model_select_single_row (selection, row);
            break;
        case GTK_SELECTION_BROWSE:
        case GTK_SELECTION_MULTIPLE:
        case GTK_SELECTION_EXTENDED:
            if (shift_p) {
                e_selection_model_set_selection_end (selection, row);
            } else {
                if (ctrl_p) {
                    e_selection_model_toggle_single_row (selection, row);
                } else {
                    e_selection_model_select_single_row (selection, row);
                }
            }
            break;
        }
        if (e_selection_model_cursor_row(selection) != row ||
            e_selection_model_cursor_col(selection) != col) {
            e_selection_model_change_cursor(selection, row, col);
            gtk_signal_emit(GTK_OBJECT(selection),
                    e_selection_model_signals[CURSOR_CHANGED], row, col);
            gtk_signal_emit(GTK_OBJECT(selection),
                    e_selection_model_signals[CURSOR_ACTIVATED], row, col);
        }
    }
}

/** 
 * e_selection_model_maybe_do_something
 * @selection: #ESelectionModel to do something to.
 * @row: The row to do something in.
 * @col: The col to do something in.
 * @state: The state in which to do something.
 *
 * If this row is selected, this routine just moves the cursor row and
 * column.  Otherwise, it does the same thing as
 * e_selection_model_do_something().  This is for being used on
 * right clicks and other events where if the user hit the selection,
 * they don't want it to change.
 */
void
e_selection_model_maybe_do_something      (ESelectionModel *selection,
                       guint            row,
                       guint            col,
                       GdkModifierType  state)
{
    if (e_selection_model_is_row_selected(selection, row)) {
        e_selection_model_change_cursor(selection, row, col);
        gtk_signal_emit(GTK_OBJECT(selection),
                e_selection_model_signals[CURSOR_CHANGED], row, col);
    } else {
        e_selection_model_do_something(selection, row, col, state);
    }
}

static gint
move_selection (ESelectionModel *selection,
        gboolean              up,
        GdkModifierType       state)
{
    int row = e_selection_model_cursor_row(selection);
    int col = e_selection_model_cursor_col(selection);
    int cursor_activated = TRUE;
    int row_count;

    gint shift_p = state & GDK_SHIFT_MASK;
    gint ctrl_p = state & GDK_CONTROL_MASK;

    row = e_sorter_model_to_sorted(selection->sorter, row);
    if (up)
        row--;
    else
        row++;
    if (row < 0)
        row = 0;
    row_count = e_selection_model_row_count(selection);
    if (row >= row_count)
        row = row_count - 1;
    row = e_sorter_sorted_to_model(selection->sorter, row);

    switch (selection->mode) {
    case GTK_SELECTION_BROWSE:
        if (shift_p) {
            e_selection_model_set_selection_end (selection, row);
        } else if (!ctrl_p) {
            e_selection_model_select_single_row (selection, row);
        } else
            cursor_activated = FALSE;
        break;
    case GTK_SELECTION_SINGLE:
    case GTK_SELECTION_MULTIPLE:
    case GTK_SELECTION_EXTENDED:
        e_selection_model_select_single_row (selection, row);
        break;
    }
    if (row != -1) {
        e_selection_model_change_cursor(selection, row, col);
        gtk_signal_emit(GTK_OBJECT(selection),
                e_selection_model_signals[CURSOR_CHANGED], row, col);
        if (cursor_activated)
            gtk_signal_emit(GTK_OBJECT(selection),
                    e_selection_model_signals[CURSOR_ACTIVATED], row, col);
    }
    return TRUE;
}

/** 
 * e_selection_model_key_press
 * @selection: #ESelectionModel to affect.
 * @key: The event.
 *
 * This routine does whatever is appropriate as if the user pressed
 * the given key.
 *
 * Returns: %TRUE if the #ESelectionModel used the key.
 */
gint
e_selection_model_key_press      (ESelectionModel *selection,
                  GdkEventKey          *key)
{
    switch (key->keyval) {
    case GDK_Up:
        return move_selection(selection, TRUE, key->state);
        break;
    case GDK_Down:
        return move_selection(selection, FALSE, key->state);
        break;
    case GDK_space:
    case GDK_KP_Space:
        if (selection->mode != GTK_SELECTION_SINGLE) {
            int row = e_selection_model_cursor_row(selection);
            int col = e_selection_model_cursor_col(selection);
            e_selection_model_toggle_single_row (selection, row);
            gtk_signal_emit(GTK_OBJECT(selection),
                    e_selection_model_signals[CURSOR_ACTIVATED], row, col);
            return TRUE;
        }
        break;
    case GDK_Return:
    case GDK_KP_Enter:
        if (selection->mode != GTK_SELECTION_SINGLE) {
            int row = e_selection_model_cursor_row(selection);
            int col = e_selection_model_cursor_col(selection);
            e_selection_model_select_single_row (selection, row);
            gtk_signal_emit(GTK_OBJECT(selection),
                    e_selection_model_signals[CURSOR_ACTIVATED], row, col);
            return TRUE;
        }
        break;
    case GDK_Home:
    case GDK_KP_Home:
        if (selection->cursor_mode == E_CURSOR_LINE) {
            int row = 0;
            int cursor_col = e_selection_model_cursor_col(selection);

            row = e_sorter_sorted_to_model(selection->sorter, row);
            e_selection_model_change_cursor(selection, row, cursor_col);

            e_selection_model_select_single_row (selection, row);
            gtk_signal_emit(GTK_OBJECT(selection),
                    e_selection_model_signals[CURSOR_CHANGED], row, cursor_col);
            gtk_signal_emit(GTK_OBJECT(selection),
                    e_selection_model_signals[CURSOR_ACTIVATED], row, cursor_col);
            return TRUE;
        }
        break;
    case GDK_End:
    case GDK_KP_End:
        if (selection->cursor_mode == E_CURSOR_LINE) {
            int row = e_selection_model_row_count(selection) - 1;
            int cursor_col = e_selection_model_cursor_col(selection);

            row = e_sorter_sorted_to_model(selection->sorter, row);
            e_selection_model_change_cursor(selection, row, cursor_col);

            e_selection_model_select_single_row (selection, row);
            gtk_signal_emit(GTK_OBJECT(selection),
                    e_selection_model_signals[CURSOR_CHANGED], row, cursor_col);
            gtk_signal_emit(GTK_OBJECT(selection),
                    e_selection_model_signals[CURSOR_ACTIVATED], row, cursor_col);
            return TRUE;
        }
        break;
    }
    return FALSE;
}

void
e_selection_model_cursor_changed      (ESelectionModel *selection,
                       int              row,
                       int              col)
{
    gtk_signal_emit(GTK_OBJECT(selection),
            e_selection_model_signals[CURSOR_CHANGED], row, col);
}

void
e_selection_model_selection_changed   (ESelectionModel *selection)
{
    gtk_signal_emit(GTK_OBJECT(selection),
            e_selection_model_signals[SELECTION_CHANGED]);
}