aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/table/e-cell-popup.c
blob: dfc9526885609275acb4ae2436e69d5e03340923 (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
/*
 * e-cell-popup.c: Popup cell renderer
 *
 * 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:
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

/*
 * ECellPopup - an abstract ECell class used to support popup selections like
 * a GtkCombo widget. It contains a child ECell, e.g. an ECellText, but when
 * selected it displays an arrow on the right edge which the user can click to
 * show a popup. Subclasses implement the popup class function to show the
 * popup.
 */

#include <config.h>

#include <gdk/gdkkeysyms.h>

#include "gal-a11y-e-cell-popup.h"
#include "gal-a11y-e-cell-registry.h"
#include "e-util/e-util.h"

#include "e-cell-popup.h"
#include "e-table-item.h"
#include <gtk/gtk.h>

#define E_CELL_POPUP_ARROW_WIDTH    16
#define E_CELL_POPUP_ARROW_XPAD     3
#define E_CELL_POPUP_ARROW_YPAD     3

static void e_cell_popup_dispose    (GObject    *object);

static ECellView* ecp_new_view      (ECell      *ecell,
                     ETableModel    *table_model,
                     void       *e_table_item_view);
static void ecp_kill_view       (ECellView  *ecv);
static void ecp_realize     (ECellView  *ecv);
static void ecp_unrealize       (ECellView  *ecv);
static void ecp_draw        (ECellView  *ecv,
                     GdkDrawable    *drawable,
                     gint        model_col,
                     gint        view_col,
                     gint        row,
                     ECellFlags  flags,
                     gint        x1,
                     gint        y1,
                     gint        x2,
                     gint        y2);
static gint ecp_event       (ECellView  *ecv,
                     GdkEvent   *event,
                     gint        model_col,
                     gint        view_col,
                     gint        row,
                     ECellFlags  flags,
                     ECellActions   *actions);
static gint ecp_height      (ECellView  *ecv,
                     gint        model_col,
                     gint        view_col,
                     gint        row);
static gpointer ecp_enter_edit      (ECellView  *ecv,
                     gint        model_col,
                     gint        view_col,
                     gint        row);
static void ecp_leave_edit      (ECellView  *ecv,
                     gint        model_col,
                     gint        view_col,
                     gint        row,
                     void       *edit_context);
static void ecp_print       (ECellView  *ecv,
                     GtkPrintContext *context,
                     gint        model_col,
                     gint        view_col,
                     gint        row,
                     gdouble         width,
                     gdouble         height);
static gdouble  ecp_print_height    (ECellView  *ecv,
                     GtkPrintContext *context,
                     gint        model_col,
                     gint        view_col,
                     gint        row,
                     gdouble         width);
static gint ecp_max_width       (ECellView  *ecv,
                     gint        model_col,
                     gint        view_col);
static gchar *ecp_get_bg_color (ECellView *ecell_view, gint row);

static gint e_cell_popup_do_popup   (ECellPopupView *ecp_view,
                     GdkEvent   *event,
                     gint             row,
                     gint             model_col);

G_DEFINE_TYPE (ECellPopup, e_cell_popup, E_TYPE_CELL)

static void
e_cell_popup_class_init     (ECellPopupClass    *class)
{
    ECellClass *ecc = E_CELL_CLASS (class);

    G_OBJECT_CLASS (class)->dispose = e_cell_popup_dispose;

    ecc->new_view     = ecp_new_view;
    ecc->kill_view    = ecp_kill_view;
    ecc->realize      = ecp_realize;
    ecc->unrealize    = ecp_unrealize;
    ecc->draw         = ecp_draw;
    ecc->event        = ecp_event;
    ecc->height       = ecp_height;
    ecc->enter_edit   = ecp_enter_edit;
    ecc->leave_edit   = ecp_leave_edit;
    ecc->print        = ecp_print;
    ecc->print_height = ecp_print_height;
    ecc->max_width    = ecp_max_width;
    ecc->get_bg_color = ecp_get_bg_color;

    gal_a11y_e_cell_registry_add_cell_type (NULL,
                                                E_TYPE_CELL_POPUP,
                                                gal_a11y_e_cell_popup_new);
}

static void
e_cell_popup_init       (ECellPopup *ecp)
{
    ecp->popup_shown = FALSE;
    ecp->popup_model = NULL;
}

/**
 * e_cell_popup_new:
 *
 * Creates a new ECellPopup renderer.
 *
 * Returns: an ECellPopup object.
 */
ECell *
e_cell_popup_new (void)
{
    return g_object_new (E_TYPE_CELL_POPUP, NULL);
}

static void
e_cell_popup_dispose (GObject *object)
{
    ECellPopup *ecp = E_CELL_POPUP (object);

    if (ecp->child)
        g_object_unref (ecp->child);
    ecp->child = NULL;

    G_OBJECT_CLASS (e_cell_popup_parent_class)->dispose (object);
}

/*
 * ECell::new_view method
 */
static ECellView *
ecp_new_view (ECell *ecell, ETableModel *table_model, gpointer e_table_item_view)
{
    ECellPopup *ecp = E_CELL_POPUP (ecell);
    ECellPopupView *ecp_view;

    /* We must have a child ECell before we create any views. */
    g_return_val_if_fail (ecp->child != NULL, NULL);

    ecp_view = g_new0 (ECellPopupView, 1);

    ecp_view->cell_view.ecell = ecell;
    ecp_view->cell_view.e_table_model = table_model;
    ecp_view->cell_view.e_table_item_view = e_table_item_view;
        ecp_view->cell_view.kill_view_cb = NULL;
        ecp_view->cell_view.kill_view_cb_data = NULL;

    ecp_view->child_view = e_cell_new_view (ecp->child, table_model,
                        e_table_item_view);

    return (ECellView*) ecp_view;
}

/*
 * ECell::kill_view method
 */
static void
ecp_kill_view (ECellView *ecv)
{
    ECellPopupView *ecp_view = (ECellPopupView *) ecv;

    if (ecp_view->cell_view.kill_view_cb)
        ecp_view->cell_view.kill_view_cb (
            ecv, ecp_view->cell_view.kill_view_cb_data);

    if (ecp_view->cell_view.kill_view_cb_data)
        g_list_free (ecp_view->cell_view.kill_view_cb_data);

    if (ecp_view->child_view)
        e_cell_kill_view (ecp_view->child_view);

    g_free (ecp_view);
}

/*
 * ECell::realize method
 */
static void
ecp_realize (ECellView *ecv)
{
    ECellPopupView *ecp_view = (ECellPopupView *) ecv;

    e_cell_realize (ecp_view->child_view);

    if (E_CELL_CLASS (e_cell_popup_parent_class)->realize)
        (* E_CELL_CLASS (e_cell_popup_parent_class)->realize) (ecv);
}

/*
 * ECell::unrealize method
 */
static void
ecp_unrealize (ECellView *ecv)
{
    ECellPopupView *ecp_view = (ECellPopupView *) ecv;

    e_cell_unrealize (ecp_view->child_view);

    if (E_CELL_CLASS (e_cell_popup_parent_class)->unrealize)
        (* E_CELL_CLASS (e_cell_popup_parent_class)->unrealize) (ecv);
}

/*
 * ECell::draw method
 */
static void
ecp_draw (ECellView *ecv, GdkDrawable *drawable,
      gint model_col, gint view_col, gint row, ECellFlags flags,
      gint x1, gint y1, gint x2, gint y2)
{
    ECellPopup *ecp = E_CELL_POPUP (ecv->ecell);
    ECellPopupView *ecp_view = (ECellPopupView *) ecv;
    GtkWidget *canvas;
    GtkShadowType shadow;
    GdkRectangle rect;
    gboolean show_popup_arrow;

    canvas = GTK_WIDGET (GNOME_CANVAS_ITEM (ecv->e_table_item_view)->canvas);

    /* Display the popup arrow if we are the cursor cell, or the popup
       is shown for this cell. */
    show_popup_arrow =
        e_table_model_is_cell_editable (
            ecv->e_table_model, model_col, row) &&
        (flags & E_CELL_CURSOR ||
         (ecp->popup_shown && ecp->popup_view_col == view_col
          && ecp->popup_row == row
          && ecp->popup_model == ((ECellView *) ecp_view)->e_table_model));

    if (flags & E_CELL_CURSOR)
        ecp->popup_arrow_shown = show_popup_arrow;

    if (show_popup_arrow) {
        GtkStyle *style;

        e_cell_draw (ecp_view->child_view, drawable, model_col,
                 view_col, row, flags,
                 x1, y1, x2 - E_CELL_POPUP_ARROW_WIDTH, y2);

        rect.x = x2 - E_CELL_POPUP_ARROW_WIDTH;
        rect.y = y1 + 1;
        rect.width = E_CELL_POPUP_ARROW_WIDTH;
        rect.height = y2 - y1 - 2;

        if (ecp->popup_shown)
            shadow = GTK_SHADOW_IN;
        else
            shadow = GTK_SHADOW_OUT;

        style = gtk_widget_get_style (canvas);

        gtk_paint_box (style, drawable,
                   GTK_STATE_NORMAL, shadow,
                   &rect, canvas, "ecellpopup",
                   rect.x, rect.y, rect.width, rect.height);
        gtk_paint_arrow (style, drawable,
                 GTK_STATE_NORMAL, GTK_SHADOW_NONE,
                 &rect, canvas, NULL,
                 GTK_ARROW_DOWN, TRUE,
                 rect.x + E_CELL_POPUP_ARROW_XPAD,
                 rect.y + E_CELL_POPUP_ARROW_YPAD,
                 rect.width - E_CELL_POPUP_ARROW_XPAD * 2,
                 rect.height - E_CELL_POPUP_ARROW_YPAD * 2);
    } else {
        e_cell_draw (ecp_view->child_view, drawable, model_col,
                 view_col, row, flags, x1, y1, x2, y2);
    }
}

/*
 * ECell::event method
 */
static gint
ecp_event (ECellView *ecv, GdkEvent *event, gint model_col, gint view_col,
       gint row, ECellFlags flags, ECellActions *actions)
{
    ECellPopupView *ecp_view = (ECellPopupView *) ecv;
    ECellPopup *ecp = E_CELL_POPUP (ecp_view->cell_view.ecell);
    ETableItem *eti = E_TABLE_ITEM (ecv->e_table_item_view);
    gint width;

    switch (event->type) {
    case GDK_BUTTON_PRESS:
        if (e_table_model_is_cell_editable (ecv->e_table_model, model_col, row) &&
            flags & E_CELL_CURSOR
            && ecp->popup_arrow_shown) {
            width = e_table_header_col_diff (eti->header, view_col,
                             view_col + 1);

            /* FIXME: The event coords seem to be relative to the
               text within the cell, so we have to add 4. */
            if (event->button.x + 4 >= width - E_CELL_POPUP_ARROW_WIDTH) {
                return e_cell_popup_do_popup (ecp_view, event, row, view_col);
            }
        }
        break;
    case GDK_KEY_PRESS:
        if (e_table_model_is_cell_editable (ecv->e_table_model, model_col, row) &&
            event->key.state & GDK_MOD1_MASK
            && event->key.keyval == GDK_KEY_Down) {
            return e_cell_popup_do_popup (ecp_view, event, row, view_col);
        }
        break;
    default:
        break;
    }

    return e_cell_event (ecp_view->child_view, event, model_col, view_col,
                 row, flags, actions);
}

/*
 * ECell::height method
 */
static gint
ecp_height (ECellView *ecv, gint model_col, gint view_col, gint row)
{
    ECellPopupView *ecp_view = (ECellPopupView *) ecv;

    return e_cell_height (ecp_view->child_view, model_col, view_col, row);
}

/*
 * ECellView::enter_edit method
 */
static gpointer
ecp_enter_edit (ECellView *ecv, gint model_col, gint view_col, gint row)
{
    ECellPopupView *ecp_view = (ECellPopupView *) ecv;

    return e_cell_enter_edit (ecp_view->child_view, model_col, view_col, row);
}

/*
 * ECellView::leave_edit method
 */
static void
ecp_leave_edit (ECellView *ecv, gint model_col, gint view_col, gint row,
        gpointer edit_context)
{
    ECellPopupView *ecp_view = (ECellPopupView *) ecv;

    e_cell_leave_edit (ecp_view->child_view, model_col, view_col, row,
               edit_context);
}

static void
ecp_print (ECellView *ecv, GtkPrintContext *context,
       gint model_col, gint view_col, gint row, gdouble width, gdouble height)
{
    ECellPopupView *ecp_view = (ECellPopupView *) ecv;

    e_cell_print (ecp_view->child_view, context, model_col, view_col, row,
              width, height);
}

static gdouble
ecp_print_height (ECellView *ecv, GtkPrintContext *context,
          gint model_col, gint view_col, gint row,
          gdouble width)
{
    ECellPopupView *ecp_view = (ECellPopupView *) ecv;

    return e_cell_print_height (ecp_view->child_view, context, model_col,
                    view_col, row, width);
}

static gint
ecp_max_width (ECellView *ecv,
           gint model_col,
           gint view_col)
{
    ECellPopupView *ecp_view = (ECellPopupView *) ecv;

    return e_cell_max_width (ecp_view->child_view, model_col, view_col);
}

static gchar *
ecp_get_bg_color (ECellView *ecell_view, gint row)
{
    ECellPopupView *ecp_view = (ECellPopupView *) ecell_view;

    return e_cell_get_bg_color (ecp_view->child_view, row);
}

ECell*
e_cell_popup_get_child          (ECellPopup *ecp)
{
    g_return_val_if_fail (E_IS_CELL_POPUP (ecp), NULL);

    return ecp->child;
}

void
e_cell_popup_set_child          (ECellPopup *ecp,
                     ECell      *child)
{
    g_return_if_fail (E_IS_CELL_POPUP (ecp));

    if (ecp->child)
        g_object_unref (ecp->child);

    ecp->child = child;
    g_object_ref (child);
}

static gint
e_cell_popup_do_popup           (ECellPopupView *ecp_view,
                     GdkEvent   *event,
                     gint             row,
                     gint             view_col)
{
    ECellPopup *ecp = E_CELL_POPUP (ecp_view->cell_view.ecell);
    gint (*popup_func) (ECellPopup *ecp, GdkEvent *event, gint row, gint view_col);

    ecp->popup_cell_view = ecp_view;

    popup_func = E_CELL_POPUP_CLASS (G_OBJECT_GET_CLASS (ecp))->popup;

    ecp->popup_view_col = view_col;
    ecp->popup_row = row;
    ecp->popup_model = ((ECellView *) ecp_view)->e_table_model;

    return popup_func ? popup_func (ecp, event, row, view_col) : FALSE;
}

/* This redraws the popup cell. Only use this if you know popup_view_col and
   popup_row are valid. */
void
e_cell_popup_queue_cell_redraw (ECellPopup *ecp)
{
    ETableItem *eti;

    eti = E_TABLE_ITEM (ecp->popup_cell_view->cell_view.e_table_item_view);

    e_table_item_redraw_range (
        eti, ecp->popup_view_col, ecp->popup_row,
        ecp->popup_view_col, ecp->popup_row);
}

void
e_cell_popup_set_shown  (ECellPopup *ecp,
             gboolean    shown)
{
    ecp->popup_shown = shown;
    e_cell_popup_queue_cell_redraw (ecp);
}