aboutsummaryrefslogtreecommitdiffstats
path: root/shell/e-shell-sidebar.c
blob: 1a9f7d7c220a3f91278ceb7c69068fef8d983b71 (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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
/*
 * e-shell-sidebar.c
 *
 * 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/>
 *
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

/**
 * SECTION: e-shell-sidebar
 * @short_description: the left side of the main window
 * @include: shell/e-shell-sidebar.h
 **/

#include "e-shell-sidebar.h"

#include <e-util/e-extensible.h>
#include <e-util/e-unicode.h>
#include <shell/e-shell-view.h>

struct _EShellSidebarPrivate {

    gpointer shell_view;  /* weak pointer */

    GtkWidget *event_box;

    gchar *icon_name;
    gchar *primary_text;
    gchar *secondary_text;
};

enum {
    PROP_0,
    PROP_ICON_NAME,
    PROP_PRIMARY_TEXT,
    PROP_SECONDARY_TEXT,
    PROP_SHELL_VIEW
};

G_DEFINE_TYPE_WITH_CODE (
    EShellSidebar,
    e_shell_sidebar,
    GTK_TYPE_BIN,
    G_IMPLEMENT_INTERFACE (
        E_TYPE_EXTENSIBLE, NULL))

static void
shell_sidebar_set_shell_view (EShellSidebar *shell_sidebar,
                              EShellView *shell_view)
{
    g_return_if_fail (shell_sidebar->priv->shell_view == NULL);

    shell_sidebar->priv->shell_view = shell_view;

    g_object_add_weak_pointer (
        G_OBJECT (shell_view),
        &shell_sidebar->priv->shell_view);
}

static void
shell_sidebar_set_property (GObject *object,
                            guint property_id,
                            const GValue *value,
                            GParamSpec *pspec)
{
    switch (property_id) {
        case PROP_ICON_NAME:
            e_shell_sidebar_set_icon_name (
                E_SHELL_SIDEBAR (object),
                g_value_get_string (value));
            return;

        case PROP_PRIMARY_TEXT:
            e_shell_sidebar_set_primary_text (
                E_SHELL_SIDEBAR (object),
                g_value_get_string (value));
            return;

        case PROP_SECONDARY_TEXT:
            e_shell_sidebar_set_secondary_text (
                E_SHELL_SIDEBAR (object),
                g_value_get_string (value));
            return;

        case PROP_SHELL_VIEW:
            shell_sidebar_set_shell_view (
                E_SHELL_SIDEBAR (object),
                g_value_get_object (value));
            return;
    }

    G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}

static void
shell_sidebar_get_property (GObject *object,
                            guint property_id,
                            GValue *value,
                            GParamSpec *pspec)
{
    switch (property_id) {
        case PROP_ICON_NAME:
            g_value_set_string (
                value, e_shell_sidebar_get_icon_name (
                E_SHELL_SIDEBAR (object)));
            return;

        case PROP_PRIMARY_TEXT:
            g_value_set_string (
                value, e_shell_sidebar_get_primary_text (
                E_SHELL_SIDEBAR (object)));
            return;

        case PROP_SECONDARY_TEXT:
            g_value_set_string (
                value, e_shell_sidebar_get_secondary_text (
                E_SHELL_SIDEBAR (object)));
            return;

        case PROP_SHELL_VIEW:
            g_value_set_object (
                value, e_shell_sidebar_get_shell_view (
                E_SHELL_SIDEBAR (object)));
            return;
    }

    G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}

static void
shell_sidebar_dispose (GObject *object)
{
    EShellSidebarPrivate *priv;

    priv = E_SHELL_SIDEBAR (object)->priv;

    if (priv->shell_view != NULL) {
        g_object_remove_weak_pointer (
            G_OBJECT (priv->shell_view), &priv->shell_view);
        priv->shell_view = NULL;
    }

    /* Unparent the widget before destroying it to avoid
     * writing a custom GtkContainer::remove() method. */

    if (priv->event_box != NULL) {
        gtk_widget_unparent (priv->event_box);
        gtk_widget_destroy (priv->event_box);
        g_object_unref (priv->event_box);
        priv->event_box = NULL;
    }

    /* Chain up to parent's dispose() method. */
    G_OBJECT_CLASS (e_shell_sidebar_parent_class)->dispose (object);
}

static void
shell_sidebar_finalize (GObject *object)
{
    EShellSidebarPrivate *priv;

    priv = E_SHELL_SIDEBAR (object)->priv;

    g_free (priv->icon_name);
    g_free (priv->primary_text);
    g_free (priv->secondary_text);

    /* Chain up to parent's finalize() method. */
    G_OBJECT_CLASS (e_shell_sidebar_parent_class)->finalize (object);
}

static void
shell_sidebar_constructed (GObject *object)
{
    EShellView *shell_view;
    EShellSidebar *shell_sidebar;
    GtkSizeGroup *size_group;
    GtkAction *action;
    GtkWidget *widget;
    gchar *label;
    gchar *icon_name;

    shell_sidebar = E_SHELL_SIDEBAR (object);
    shell_view = e_shell_sidebar_get_shell_view (shell_sidebar);
    size_group = e_shell_view_get_size_group (shell_view);
    action = e_shell_view_get_action (shell_view);

    widget = shell_sidebar->priv->event_box;
    gtk_size_group_add_widget (size_group, widget);

    g_object_get (action, "icon-name", &icon_name, NULL);
    e_shell_sidebar_set_icon_name (shell_sidebar, icon_name);
    g_free (icon_name);

    g_object_get (action, "label", &label, NULL);
    e_shell_sidebar_set_primary_text (shell_sidebar, label);
    g_free (label);

    e_extensible_load_extensions (E_EXTENSIBLE (object));

    /* Chain up to parent's constructed() method. */
    G_OBJECT_CLASS (e_shell_sidebar_parent_class)->constructed (object);
}

static void
shell_sidebar_get_preferred_width (GtkWidget *widget,
                                   gint *minimum,
                                   gint *natural)
{
    GtkWidget *child;

    child = gtk_bin_get_child (GTK_BIN (widget));
    gtk_widget_get_preferred_width (child, minimum, natural);

    /* Do not use priv->event_box here, otherwise it won't ellipsize. */
}

static void
shell_sidebar_get_preferred_height (GtkWidget *widget,
                                    gint *minimum,
                                    gint *natural)
{
    EShellSidebarPrivate *priv;
    gint child_min, child_nat;
    GtkWidget *child;

    priv = E_SHELL_SIDEBAR (widget)->priv;

    child = gtk_bin_get_child (GTK_BIN (widget));
    gtk_widget_get_preferred_height (child, minimum, natural);

    child = priv->event_box;
    gtk_widget_get_preferred_height (child, &child_min, &child_nat);

    *minimum += child_min;
    *natural += child_nat;
}

static void
shell_sidebar_size_allocate (GtkWidget *widget,
                             GtkAllocation *allocation)
{
    EShellSidebarPrivate *priv;
    GtkAllocation child_allocation;
    GtkRequisition child_requisition;
    GtkWidget *child;

    priv = E_SHELL_SIDEBAR (widget)->priv;

    gtk_widget_set_allocation (widget, allocation);

    child = priv->event_box;
    gtk_widget_get_preferred_size (child, &child_requisition, NULL);

    child_allocation.x = allocation->x;
    child_allocation.y = allocation->y;
    child_allocation.width = allocation->width;
    child_allocation.height = child_requisition.height;

    gtk_widget_size_allocate (child, &child_allocation);

    child_allocation.y += child_requisition.height;
    child_allocation.height =
        allocation->height - child_requisition.height;

    child = gtk_bin_get_child (GTK_BIN (widget));
    if (child != NULL)
        gtk_widget_size_allocate (child, &child_allocation);
}

static void
shell_sidebar_forall (GtkContainer *container,
                      gboolean include_internals,
                      GtkCallback callback,
                      gpointer callback_data)
{
    EShellSidebarPrivate *priv;

    priv = E_SHELL_SIDEBAR (container)->priv;

    if (include_internals && callback && priv->event_box)
        callback (priv->event_box, callback_data);

    /* Chain up to parent's forall() method. */
    GTK_CONTAINER_CLASS (e_shell_sidebar_parent_class)->forall (
        container, include_internals, callback, callback_data);
}

static void
e_shell_sidebar_class_init (EShellSidebarClass *class)
{
    GObjectClass *object_class;
    GtkWidgetClass *widget_class;
    GtkContainerClass *container_class;

    g_type_class_add_private (class, sizeof (EShellSidebarPrivate));

    object_class = G_OBJECT_CLASS (class);
    object_class->set_property = shell_sidebar_set_property;
    object_class->get_property = shell_sidebar_get_property;
    object_class->dispose = shell_sidebar_dispose;
    object_class->finalize = shell_sidebar_finalize;
    object_class->constructed = shell_sidebar_constructed;

    widget_class = GTK_WIDGET_CLASS (class);
    widget_class->get_preferred_width = shell_sidebar_get_preferred_width;
    widget_class->get_preferred_height = shell_sidebar_get_preferred_height;
    widget_class->size_allocate = shell_sidebar_size_allocate;

    container_class = GTK_CONTAINER_CLASS (class);
    container_class->forall = shell_sidebar_forall;

    /**
     * EShellSidebar:icon-name
     *
     * The named icon is displayed at the top of the sidebar.
     **/
    g_object_class_install_property (
        object_class,
        PROP_ICON_NAME,
        g_param_spec_string (
            "icon-name",
            "Icon Name",
            NULL,
            NULL,
            G_PARAM_READWRITE));

    /**
     * EShellSidebar:primary-text
     *
     * The primary text is displayed in bold at the top of the sidebar.
     **/
    g_object_class_install_property (
        object_class,
        PROP_PRIMARY_TEXT,
        g_param_spec_string (
            "primary-text",
            "Primary Text",
            NULL,
            NULL,
            G_PARAM_READWRITE));

    /**
     * EShellSidebar:secondary-text
     *
     * The secondary text is displayed in a smaller font at the top of
     * the sidebar.
     **/
    g_object_class_install_property (
        object_class,
        PROP_SECONDARY_TEXT,
        g_param_spec_string (
            "secondary-text",
            "Secondary Text",
            NULL,
            NULL,
            G_PARAM_READWRITE));

    /**
     * EShellSidebar:shell-view
     *
     * The #EShellView to which the sidebar widget belongs.
     **/
    g_object_class_install_property (
        object_class,
        PROP_SHELL_VIEW,
        g_param_spec_object (
            "shell-view",
            "Shell View",
            NULL,
            E_TYPE_SHELL_VIEW,
            G_PARAM_READWRITE |
            G_PARAM_CONSTRUCT_ONLY));
}

static void
e_shell_sidebar_init (EShellSidebar *shell_sidebar)
{
    GtkStyle *style;
    GtkWidget *widget;
    GtkWidget *container;
    PangoAttribute *attribute;
    PangoAttrList *attribute_list;
    const GdkColor *color;
    const gchar *icon_name;

    shell_sidebar->priv = G_TYPE_INSTANCE_GET_PRIVATE (shell_sidebar, E_TYPE_SHELL_SIDEBAR, EShellSidebarPrivate);

    gtk_widget_set_has_window (GTK_WIDGET (shell_sidebar), FALSE);

    widget = gtk_event_box_new ();
    style = gtk_widget_get_style (widget);
    color = &style->bg[GTK_STATE_ACTIVE];
    gtk_widget_modify_bg (widget, GTK_STATE_NORMAL, color);
    gtk_widget_set_parent (widget, GTK_WIDGET (shell_sidebar));
    shell_sidebar->priv->event_box = g_object_ref (widget);
    gtk_widget_show (widget);

    container = widget;

    widget = gtk_hbox_new (FALSE, 6);
    gtk_container_set_border_width (GTK_CONTAINER (widget), 6);
    gtk_container_add (GTK_CONTAINER (container), widget);
    gtk_widget_show (widget);

    container = widget;

    /* Pick a bogus icon name just to get the storage type set. */
    icon_name = "evolution";
    e_shell_sidebar_set_icon_name (shell_sidebar, icon_name);
    widget = gtk_image_new_from_icon_name (icon_name, GTK_ICON_SIZE_MENU);
    gtk_box_pack_start (GTK_BOX (container), widget, FALSE, FALSE, 0);
    gtk_widget_show (widget);

    g_object_bind_property (
        shell_sidebar, "icon-name",
        widget, "icon-name",
        G_BINDING_SYNC_CREATE);

    widget = gtk_label_new (NULL);
    gtk_label_set_ellipsize (GTK_LABEL (widget), PANGO_ELLIPSIZE_END);
    gtk_misc_set_alignment (GTK_MISC (widget), 0.0, 0.5);
    gtk_box_pack_start (GTK_BOX (container), widget, TRUE, TRUE, 0);
    gtk_widget_show (widget);

    attribute_list = pango_attr_list_new ();
    attribute = pango_attr_weight_new (PANGO_WEIGHT_BOLD);
    pango_attr_list_insert (attribute_list, attribute);
    gtk_label_set_attributes (GTK_LABEL (widget), attribute_list);
    pango_attr_list_unref (attribute_list);

    g_object_bind_property (
        shell_sidebar, "primary-text",
        widget, "label",
        G_BINDING_SYNC_CREATE);

    widget = gtk_label_new (NULL);
    gtk_misc_set_alignment (GTK_MISC (widget), 1.0, 0.5);
    gtk_box_pack_start (GTK_BOX (container), widget, FALSE, FALSE, 0);
    gtk_widget_show (widget);

    attribute_list = pango_attr_list_new ();
    attribute = pango_attr_scale_new (PANGO_SCALE_SMALL);
    pango_attr_list_insert (attribute_list, attribute);
    gtk_label_set_attributes (GTK_LABEL (widget), attribute_list);
    pango_attr_list_unref (attribute_list);

    g_object_bind_property (
        shell_sidebar, "secondary-text",
        widget, "label",
        G_BINDING_SYNC_CREATE);
}

/**
 * e_shell_sidebar_new:
 * @shell_view: an #EShellView
 *
 * Creates a new #EShellSidebar instance belonging to @shell_view.
 *
 * Returns: a new #EShellSidebar instance
 **/
GtkWidget *
e_shell_sidebar_new (EShellView *shell_view)
{
    g_return_val_if_fail (E_IS_SHELL_VIEW (shell_view), NULL);

    return g_object_new (
        E_TYPE_SHELL_SIDEBAR,
        "shell-view", shell_view, NULL);
}

/**
 * e_shell_sidebar_check_state:
 * @shell_sidebar: an #EShellSidebar
 *
 * #EShellSidebar subclasses should implement the
 * <structfield>check_state</structfield> method in #EShellSidebarClass
 * to return a set of flags describing the current sidebar selection.
 * Subclasses are responsible for defining their own flags.  This is
 * primarily used to assist shell views with updating actions (see
 * e_shell_view_update_actions()).
 *
 * Returns: a set of flags describing the current @shell_sidebar selection
 **/
guint32
e_shell_sidebar_check_state (EShellSidebar *shell_sidebar)
{
    EShellSidebarClass *shell_sidebar_class;

    g_return_val_if_fail (E_IS_SHELL_SIDEBAR (shell_sidebar), 0);

    shell_sidebar_class = E_SHELL_SIDEBAR_GET_CLASS (shell_sidebar);
    g_return_val_if_fail (shell_sidebar_class->check_state != NULL, 0);

    return shell_sidebar_class->check_state (shell_sidebar);
}

/**
 * e_shell_sidebar_get_shell_view:
 * @shell_sidebar: an #EShellSidebar
 *
 * Returns the #EShellView that was passed to e_shell_sidebar_new().
 *
 * Returns: the #EShellView to which @shell_sidebar belongs
 **/
EShellView *
e_shell_sidebar_get_shell_view (EShellSidebar *shell_sidebar)
{
    g_return_val_if_fail (E_IS_SHELL_SIDEBAR (shell_sidebar), NULL);

    return E_SHELL_VIEW (shell_sidebar->priv->shell_view);
}

/**
 * e_shell_sidebar_get_icon_name:
 * @shell_sidebar: an #EShellSidebar
 *
 * Returns the icon name displayed at the top of the sidebar.
 *
 * Returns: the icon name for @shell_sidebar
 **/
const gchar *
e_shell_sidebar_get_icon_name (EShellSidebar *shell_sidebar)
{
    g_return_val_if_fail (E_IS_SHELL_SIDEBAR (shell_sidebar), NULL);

    return shell_sidebar->priv->icon_name;
}

/**
 * e_shell_sidebar_set_icon_name:
 * @shell_sidebar: an #EShellSidebar
 * @icon_name: a themed icon name
 *
 * Sets the icon name displayed at the top of the sidebar.
 **/
void
e_shell_sidebar_set_icon_name (EShellSidebar *shell_sidebar,
                               const gchar *icon_name)
{
    g_return_if_fail (E_IS_SHELL_SIDEBAR (shell_sidebar));

    g_free (shell_sidebar->priv->icon_name);
    shell_sidebar->priv->icon_name = g_strdup (icon_name);

    g_object_notify (G_OBJECT (shell_sidebar), "icon-name");
}

/**
 * e_shell_sidebar_get_primary_text:
 * @shell_sidebar: an #EShellSidebar
 *
 * Returns the primary text for @shell_sidebar.
 *
 * The primary text is displayed in bold at the top of the sidebar.  It
 * defaults to the shell view's label (as seen on the switcher button),
 * but typically shows the name of the selected item in the sidebar.
 *
 * Returns: the primary text for @shell_sidebar
 **/
const gchar *
e_shell_sidebar_get_primary_text (EShellSidebar *shell_sidebar)
{
    g_return_val_if_fail (E_IS_SHELL_SIDEBAR (shell_sidebar), NULL);

    return shell_sidebar->priv->primary_text;
}

/**
 * e_shell_sidebar_set_primary_text:
 * @shell_sidebar: an #EShellSidebar
 * @primary_text: text to be displayed in a bold font
 *
 * Sets the primary text for @shell_sidebar.
 *
 * The primary text is displayed in bold at the top of the sidebar.  It
 * defaults to the shell view's label (as seen on the switcher button),
 * but typically shows the name of the selected item in the sidebar.
 **/
void
e_shell_sidebar_set_primary_text (EShellSidebar *shell_sidebar,
                                  const gchar *primary_text)
{
    g_return_if_fail (E_IS_SHELL_SIDEBAR (shell_sidebar));

    g_free (shell_sidebar->priv->primary_text);
    shell_sidebar->priv->primary_text = e_utf8_ensure_valid (primary_text);

    gtk_widget_queue_resize (GTK_WIDGET (shell_sidebar));
    g_object_notify (G_OBJECT (shell_sidebar), "primary-text");
}

/**
 * e_shell_sidebar_get_secondary_text:
 * @shell_sidebar: an #EShellSidebar
 *
 * Returns the secondary text for @shell_sidebar.
 *
 * The secondary text is displayed in a smaller font at the top of the
 * sidebar.  It typically shows information about the contents of the
 * selected sidebar item, such as total number of items, number of
 * selected items, etc.
 *
 * Returns: the secondary text for @shell_sidebar
 **/
const gchar *
e_shell_sidebar_get_secondary_text (EShellSidebar *shell_sidebar)
{
    g_return_val_if_fail (E_IS_SHELL_SIDEBAR (shell_sidebar), NULL);

    return shell_sidebar->priv->secondary_text;
}

/**
 * e_shell_sidebar_set_secondary_text:
 * @shell_sidebar: an #EShellSidebar
 * @secondary_text: text to be displayed in a smaller font
 *
 * Sets the secondary text for @shell_sidebar.
 *
 * The secondary text is displayed in a smaller font at the top of the
 * sidebar.  It typically shows information about the contents of the
 * selected sidebar item, such as total number of items, number of
 * selected items, etc.
 **/
void
e_shell_sidebar_set_secondary_text (EShellSidebar *shell_sidebar,
                                    const gchar *secondary_text)
{
    g_return_if_fail (E_IS_SHELL_SIDEBAR (shell_sidebar));

    g_free (shell_sidebar->priv->secondary_text);
    shell_sidebar->priv->secondary_text = e_utf8_ensure_valid (secondary_text);

    gtk_widget_queue_resize (GTK_WIDGET (shell_sidebar));
    g_object_notify (G_OBJECT (shell_sidebar), "secondary-text");
}