aboutsummaryrefslogtreecommitdiffstats
path: root/shell/e-shell-taskbar.c
blob: 2129d518be4b49c1222c3d1806dfc1d9f52d2dab (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
/*
 * e-shell-taskbar.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)
 *
 */

#include "e-shell-taskbar.h"

#include <e-shell-view.h>

#include <e-util/e-extensible.h>
#include <misc/e-activity-proxy.h>

#define E_SHELL_TASKBAR_GET_PRIVATE(obj) \
    (G_TYPE_INSTANCE_GET_PRIVATE \
    ((obj), E_TYPE_SHELL_TASKBAR, EShellTaskbarPrivate))

struct _EShellTaskbarPrivate {

    gpointer shell_view;  /* weak pointer */

    /* Keep a reference to the shell backend since
     * we connect to its "activity-added" signal. */
    EShellBackend *shell_backend;

    GtkWidget *label;
    GtkWidget *hbox;

    GHashTable *proxy_table;
};

enum {
    PROP_0,
    PROP_MESSAGE,
    PROP_SHELL_VIEW
};

G_DEFINE_TYPE_WITH_CODE (
    EShellTaskbar, e_shell_taskbar, GTK_TYPE_HBOX,
    G_IMPLEMENT_INTERFACE (E_TYPE_EXTENSIBLE, NULL))

static void
shell_taskbar_activity_remove (EShellTaskbar *shell_taskbar,
                               EActivity *activity)
{
    GtkBox *box;
    GtkWidget *proxy;
    GHashTable *proxy_table;

    box = GTK_BOX (shell_taskbar->priv->hbox);
    proxy_table = shell_taskbar->priv->proxy_table;
    proxy = g_hash_table_lookup (proxy_table, activity);
    g_return_if_fail (proxy != NULL);

    g_hash_table_remove (proxy_table, activity);
    gtk_container_remove (GTK_CONTAINER (box), proxy);

    if (box->children == NULL)
        gtk_widget_hide (GTK_WIDGET (box));
}

static void
shell_taskbar_activity_add (EShellTaskbar *shell_taskbar,
                            EActivity *activity)
{
    GtkBox *box;
    GtkWidget *proxy;

    proxy = e_activity_proxy_new (activity);
    box = GTK_BOX (shell_taskbar->priv->hbox);
    gtk_box_pack_start (box, proxy, TRUE, TRUE, 0);
    gtk_box_reorder_child (box, proxy, 0);
    gtk_widget_show (GTK_WIDGET (box));
    gtk_widget_show (proxy);

    g_hash_table_insert (
        shell_taskbar->priv->proxy_table,
        g_object_ref (activity), g_object_ref (proxy));

    g_signal_connect_swapped (
        activity, "cancelled",
        G_CALLBACK (shell_taskbar_activity_remove), shell_taskbar);

    g_signal_connect_swapped (
        activity, "completed",
        G_CALLBACK (shell_taskbar_activity_remove), shell_taskbar);
}

static void
shell_taskbar_set_shell_view (EShellTaskbar *shell_taskbar,
                              EShellView *shell_view)
{
    g_return_if_fail (shell_taskbar->priv->shell_view == NULL);

    shell_taskbar->priv->shell_view = shell_view;

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

static void
shell_taskbar_set_property (GObject *object,
                            guint property_id,
                            const GValue *value,
                            GParamSpec *pspec)
{
    switch (property_id) {
        case PROP_MESSAGE:
            e_shell_taskbar_set_message (
                E_SHELL_TASKBAR (object),
                g_value_get_string (value));
            return;

        case PROP_SHELL_VIEW:
            shell_taskbar_set_shell_view (
                E_SHELL_TASKBAR (object),
                g_value_get_object (value));
            return;
    }

    G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}

static void
shell_taskbar_get_property (GObject *object,
                            guint property_id,
                            GValue *value,
                            GParamSpec *pspec)
{
    switch (property_id) {
        case PROP_MESSAGE:
            g_value_set_string (
                value, e_shell_taskbar_get_message (
                E_SHELL_TASKBAR (object)));
            return;

        case PROP_SHELL_VIEW:
            g_value_set_object (
                value, e_shell_taskbar_get_shell_view (
                E_SHELL_TASKBAR (object)));
            return;
    }

    G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}

static gboolean
disconnect_remove (EActivity      *activity,
           EActivityProxy *proxy,
           EShellTaskbar  *shell_taskbar)
{
    g_signal_handlers_disconnect_matched
        (activity, G_SIGNAL_MATCH_DATA,
         0, 0, NULL, NULL, shell_taskbar);
    return TRUE;
}

static void
shell_taskbar_dispose (GObject *object)
{
    EShellTaskbarPrivate *priv;

    priv = E_SHELL_TASKBAR_GET_PRIVATE (object);

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

    if (priv->shell_backend != NULL) {
        g_signal_handlers_disconnect_matched (
            priv->shell_backend, G_SIGNAL_MATCH_DATA,
            0, 0, NULL, NULL, object);
        g_object_unref (priv->shell_backend);
        priv->shell_backend = NULL;
    }

    if (priv->label != NULL) {
        g_object_unref (priv->label);
        priv->label = NULL;
    }

    if (priv->hbox != NULL) {
        g_object_unref (priv->hbox);
        priv->hbox = NULL;
    }

    g_hash_table_foreach_remove (priv->proxy_table,
                     (GHRFunc) disconnect_remove,
                     object);

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

static void
shell_taskbar_finalize (GObject *object)
{
    EShellTaskbarPrivate *priv;

    priv = E_SHELL_TASKBAR_GET_PRIVATE (object);

    g_hash_table_destroy (priv->proxy_table);

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

static void
shell_taskbar_constructed (GObject *object)
{
    EShellView *shell_view;
    EShellBackend *shell_backend;
    EShellTaskbar *shell_taskbar;

    shell_taskbar = E_SHELL_TASKBAR (object);
    shell_view = e_shell_taskbar_get_shell_view (shell_taskbar);
    shell_backend = e_shell_view_get_shell_backend (shell_view);

    /* Keep a reference to the shell backend so we can
     * disconnect the signal handler during dispose(). */
    shell_taskbar->priv->shell_backend = g_object_ref (shell_backend);

    g_signal_connect_swapped (
        shell_backend, "activity-added",
        G_CALLBACK (shell_taskbar_activity_add), shell_taskbar);

    /* Do not enlarge window width on new activities. */
    gtk_widget_set_size_request (GTK_WIDGET (shell_taskbar), 0, -1);

    e_extensible_load_extensions (E_EXTENSIBLE (object));
}

static void
e_shell_taskbar_class_init (EShellTaskbarClass *class)
{
    GObjectClass *object_class;

    g_type_class_add_private (class, sizeof (EShellTaskbarPrivate));

    object_class = G_OBJECT_CLASS (class);
    object_class->set_property = shell_taskbar_set_property;
    object_class->get_property = shell_taskbar_get_property;
    object_class->dispose = shell_taskbar_dispose;
    object_class->finalize = shell_taskbar_finalize;
    object_class->constructed = shell_taskbar_constructed;

    /**
     * EShellTaskbar:message
     *
     * The message to display in the taskbar.
     **/
    g_object_class_install_property (
        object_class,
        PROP_MESSAGE,
        g_param_spec_string (
            "message",
            NULL,
            NULL,
            NULL,
            G_PARAM_READWRITE |
            G_PARAM_CONSTRUCT));

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

static void
e_shell_taskbar_init (EShellTaskbar *shell_taskbar)
{
    GtkWidget *widget;
    GHashTable *proxy_table;
    gint height;

    proxy_table = g_hash_table_new_full (
        g_direct_hash, g_direct_equal,
        (GDestroyNotify) g_object_unref,
        (GDestroyNotify) g_object_unref);

    shell_taskbar->priv = E_SHELL_TASKBAR_GET_PRIVATE (shell_taskbar);
    shell_taskbar->priv->proxy_table = proxy_table;

    gtk_box_set_spacing (GTK_BOX (shell_taskbar), 12);

    widget = gtk_label_new (NULL);
    gtk_label_set_ellipsize (GTK_LABEL (widget), PANGO_ELLIPSIZE_END);
    gtk_box_pack_start (GTK_BOX (shell_taskbar), widget, TRUE, TRUE, 0);
    gtk_misc_set_alignment (GTK_MISC (widget), 0.0, 0.5);
    shell_taskbar->priv->label = g_object_ref (widget);
    gtk_widget_hide (widget);

    widget = gtk_hbox_new (FALSE, 3);
    gtk_box_pack_start (GTK_BOX (shell_taskbar), widget, TRUE, TRUE, 0);
    shell_taskbar->priv->hbox = g_object_ref (widget);
    gtk_widget_hide (widget);

    /* Make the taskbar large enough to accomodate a small icon.
     * XXX The "* 2" is a fudge factor to allow for some padding
     *     The true value is probably buried in a style property. */
    gtk_icon_size_lookup (GTK_ICON_SIZE_MENU, NULL, &height);
    gtk_widget_set_size_request (
        GTK_WIDGET (shell_taskbar), -1, (height * 2));
}

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

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

/**
 * e_shell_taskbar_get_shell_view:
 * @shell_taskbar: an #EShellTaskbar
 *
 * Returns the #EShellView that was passed to e_shell_taskbar_new().
 *
 * Returns: the #EShellView to which @shell_taskbar belongs
 **/
EShellView *
e_shell_taskbar_get_shell_view (EShellTaskbar *shell_taskbar)
{
    g_return_val_if_fail (E_IS_SHELL_TASKBAR (shell_taskbar), NULL);

    return shell_taskbar->priv->shell_view;
}

/**
 * e_shell_taskbar_get_message:
 * @shell_taskbar: an #EShellTaskbar
 *
 * Returns the message currently shown in the taskbar, or an empty string
 * if no message is shown.  Taskbar messages are used primarily for menu
 * tooltips.
 *
 * Returns: the current taskbar message
 **/
const gchar *
e_shell_taskbar_get_message (EShellTaskbar *shell_taskbar)
{
    GtkWidget *label;

    g_return_val_if_fail (E_IS_SHELL_TASKBAR (shell_taskbar), NULL);

    label = shell_taskbar->priv->label;

    return gtk_label_get_text (GTK_LABEL (label));
}

/**
 * e_shell_taskbar_set_message:
 * @shell_taskbar: an #EShellTaskbar
 * @message: the message to show
 *
 * Shows a message in the taskbar.  If @message is %NULL or an empty string,
 * the taskbar message is cleared.  Taskbar messages are used primarily for
 * menu tooltips.
 **/
void
e_shell_taskbar_set_message (EShellTaskbar *shell_taskbar,
                             const gchar *message)
{
    GtkWidget *label;

    g_return_if_fail (E_IS_SHELL_TASKBAR (shell_taskbar));

    label = shell_taskbar->priv->label;
    gtk_label_set_text (GTK_LABEL (label), message);

    if (message != NULL && *message != '\0')
        gtk_widget_show (label);
    else
        gtk_widget_hide (label);

    g_object_notify (G_OBJECT (shell_taskbar), "message");
}

/**
 * e_shell_taskbar_unset_message:
 * @shell_taskbar: an #EShellTaskbar
 *
 * This is equivalent to passing a %NULL message to
 * e_shell_taskbar_set_message().
 **/
void
e_shell_taskbar_unset_message (EShellTaskbar *shell_taskbar)
{
    g_return_if_fail (E_IS_SHELL_TASKBAR (shell_taskbar));

    e_shell_taskbar_set_message (shell_taskbar, NULL);
}

/**
 * e_shell_taskbar_get_activity_count:
 * @shell_taskbar: an #EShellTaskbar
 *
 * Returns the number of active #EActivity instances being tracked.
 *
 * Returns: the number of #EActivity instances
 **/
guint
e_shell_taskbar_get_activity_count (EShellTaskbar *shell_taskbar)
{
    g_return_val_if_fail (E_IS_SHELL_TASKBAR (shell_taskbar), 0);

    return g_hash_table_size (shell_taskbar->priv->proxy_table);
}