aboutsummaryrefslogtreecommitdiffstats
path: root/src/ephy-statusbar.c
blob: b7fac950d4fa8caa2e079cfcf7c162fce5447384 (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
/*
 *  Copyright © 2002 Jorn Baayen
 *  Copyright © 2003, 2004 Marco Pesenti Gritti
 *  Copyright © 2004, 2007 Christian Persch
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2, or (at your option)
 *  any later version.
 *
 *  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 General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *  $Id$
 */

#include "config.h"

#include "ephy-statusbar.h"
#include "ephy-stock-icons.h"

#include <string.h>
#include <glib/gi18n.h>
#include <gtk/gtklabel.h>   
#include <gtk/gtkvbox.h>
#include <gtk/gtkprogressbar.h>
#include <gtk/gtkeventbox.h>
#include <gtk/gtkimage.h>
#include <gtk/gtkwidget.h>
#include <gtk/gtkvseparator.h>

static void ephy_statusbar_class_init   (EphyStatusbarClass *klass);
static void ephy_statusbar_init     (EphyStatusbar *t);

#define EPHY_STATUSBAR_GET_PRIVATE(object)(G_TYPE_INSTANCE_GET_PRIVATE ((object), EPHY_TYPE_STATUSBAR, EphyStatusbarPrivate))

struct _EphyStatusbarPrivate
{
    GtkWidget *hbox;
    GtkWidget *icon_container;

    GtkWidget *caret_indicator;
    GtkWidget *security_icon;
    GtkWidget *progressbar;
    GtkWidget *security_evbox;
    GtkWidget *popups_manager_icon;
    GtkWidget *popups_manager_evbox;
};

enum
{
    LOCK_CLICKED,
    LAST_SIGNAL
};

static guint signals[LAST_SIGNAL];
static GObjectClass *parent_class;

GType
ephy_statusbar_get_type (void)
{
    static GType type = 0;

    if (G_UNLIKELY (type == 0))
    {
        const GTypeInfo our_info =
        {
            sizeof (EphyStatusbarClass),
            NULL, /* base_init */
            NULL, /* base_finalize */
            (GClassInitFunc) ephy_statusbar_class_init,
            NULL,
            NULL, /* class_data */
            sizeof (EphyStatusbar),
            0, /* n_preallocs */
            (GInstanceInitFunc) ephy_statusbar_init
        };

        type = g_type_register_static (GTK_TYPE_STATUSBAR,
                           "EphyStatusbar",
                           &our_info, 0);
    }

    return type;
}

static void
ephy_statusbar_class_init (EphyStatusbarClass *klass)
{
    GObjectClass *object_class = G_OBJECT_CLASS (klass);

    parent_class = g_type_class_peek_parent (klass);

    signals[LOCK_CLICKED] =
        g_signal_new
            ("lock-clicked",
             EPHY_TYPE_STATUSBAR,
             G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
             G_STRUCT_OFFSET (EphyStatusbarClass, lock_clicked),
             NULL, NULL,
             g_cclosure_marshal_VOID__VOID,
             G_TYPE_NONE,
             0);

    g_type_class_add_private (object_class, sizeof (EphyStatusbarPrivate));
}

static void
create_caret_indicator (EphyStatusbar *statusbar)
{
    EphyStatusbarPrivate *priv = statusbar->priv;
    GtkWidget *label;

    priv->caret_indicator = label = gtk_label_new (_("Caret"));
    gtk_widget_show (label);

    gtk_widget_set_tooltip_text (label,
                     /* Translators: this is the tooltip on the "Caret" icon
                      * in the statusbar.
                      */
                     _("In keyboard selection mode, press F7 to exit"));

    ephy_statusbar_add_widget (statusbar, priv->caret_indicator);
}

static gboolean
padlock_button_press_cb (GtkWidget *ebox,
                         GdkEventButton *event,
             EphyStatusbar *statusbar)
{
        if (event->type == GDK_BUTTON_PRESS &&
        event->button == 1 /* left */ &&
        (event->state & gtk_accelerator_get_default_mod_mask ()) == 0)
        {
        g_signal_emit (statusbar, signals[LOCK_CLICKED], 0);

                return TRUE;
        }

        return FALSE;
}

static void
create_icon_frame (EphyStatusbar *statusbar,
           const char *stock_id,
           GCallback button_press_cb,
           GtkWidget **_evbox,
           GtkWidget **_icon)
{
    GtkWidget *evbox, *icon;

    evbox = gtk_event_box_new ();
    gtk_event_box_set_visible_window  (GTK_EVENT_BOX (evbox), FALSE);
    if (button_press_cb)
    {
        gtk_widget_add_events (evbox, GDK_BUTTON_PRESS_MASK);
        g_signal_connect (evbox, "button-press-event",
                  G_CALLBACK (padlock_button_press_cb), statusbar);
    }

    icon = gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);
    gtk_container_add (GTK_CONTAINER (evbox), icon);
    gtk_widget_show (icon);

    ephy_statusbar_add_widget (statusbar, evbox);

    *_evbox = evbox;
    *_icon = icon;
}

static void
create_statusbar_progress (EphyStatusbar *s)
{
    EphyStatusbarPrivate *priv = s->priv;
    GtkWidget *vbox;

    vbox = gtk_vbox_new (FALSE, 0);
    gtk_box_pack_end (GTK_BOX (priv->hbox), vbox, FALSE, FALSE, 0);

    priv->progressbar = gtk_progress_bar_new ();
    gtk_box_pack_start (GTK_BOX (vbox),
                GTK_WIDGET (priv->progressbar),
                TRUE, TRUE, 1);

        /* We need to set the vertical size request to a small value here,
         * because the progressbar's default size request is taller than the whole
         * statusbar. Packing it with expand&fill in the vbox above will nevertheless
         * make it use the greatest available height.
         */
    gtk_widget_set_size_request (priv->progressbar, -1, 10);

    gtk_widget_show_all (vbox);
}

static void
ephy_statusbar_init (EphyStatusbar *t)
{
    GtkStatusbar *gstatusbar = GTK_STATUSBAR (t);
    EphyStatusbarPrivate *priv;

    priv = t->priv = EPHY_STATUSBAR_GET_PRIVATE (t);

    gtk_statusbar_set_has_resize_grip (gstatusbar, TRUE);

    priv->hbox = gtk_hbox_new (FALSE, 4);

    priv->icon_container = gtk_hbox_new (FALSE, 4);
    gtk_box_pack_start (GTK_BOX (priv->hbox), priv->icon_container,
                FALSE, FALSE, 0);
    gtk_widget_show (priv->icon_container);

    /* Put the label in the hbox, and substitute the hbox into the frame */
    g_object_ref (gstatusbar->label);
    gtk_container_remove (GTK_CONTAINER (gstatusbar->frame), gstatusbar->label);
    gtk_box_pack_start (GTK_BOX (priv->hbox), gstatusbar->label, TRUE, TRUE, 0);
    g_object_unref (gstatusbar->label);
    gtk_container_add (GTK_CONTAINER (gstatusbar->frame), priv->hbox);
    gtk_widget_show (priv->hbox);

    /* Create security icon */
    create_icon_frame (t,
               NULL,
               G_CALLBACK (padlock_button_press_cb),
               &priv->security_evbox,
               &priv->security_icon);
    gtk_widget_show (priv->security_evbox);

    /* Create popup-blocked icon */
    create_icon_frame (t,
               EPHY_STOCK_POPUPS,
               NULL,
               &priv->popups_manager_evbox,
               &priv->popups_manager_icon);
    /* don't show priv->popups_manager_evbox yet */

    create_caret_indicator (t);
    create_statusbar_progress (t);
}

/**
 * ephy_statusbar_new:
 * 
 * Creates a new #EphyStatusbar.
 * 
 * Return value: the new #EphyStatusbar object
 **/
GtkWidget *
ephy_statusbar_new (void)
{
    return GTK_WIDGET (g_object_new (EPHY_TYPE_STATUSBAR, NULL));
}

/**
 * ephy_statusbar_set_caret_mode:
 * @statusbar: an #EphyStatusbar
 * @enabled:
 * 
 * Sets the statusbar's caret browsing mode indicator.
 **/
void
ephy_statusbar_set_caret_mode (EphyStatusbar *statusbar,
                   gboolean enabled)
{
    EphyStatusbarPrivate *priv = statusbar->priv;

    enabled = enabled != FALSE;

    g_object_set (priv->caret_indicator, "visible", enabled, NULL);
}

/**
 * ephy_statusbar_set_security_state:
 * @statusbar: an #EphyStatusbar
 * @stock_id: stock-id of the icon showing the security state
 * @tooltip: a string detailing the security state
 * 
 * Sets the statusbar's security icon and its tooltip.
 **/
void
ephy_statusbar_set_security_state (EphyStatusbar *statusbar,
                   const char *stock_id,
                   const char *tooltip)
{
    EphyStatusbarPrivate *priv = statusbar->priv;

    gtk_image_set_from_stock (GTK_IMAGE (priv->security_icon),
                  stock_id, GTK_ICON_SIZE_MENU);

    gtk_widget_set_tooltip_text (priv->security_icon, tooltip);
}

/**
 * ephy_statusbar_set_popups_state:
 * @statusbar: an #EphyStatusbar
 * @hidden: %TRUE if popups have been hidden
 * @tooltip: a string to display as tooltip, or %NULL
 *
 * Sets the statusbar's popup-blocker icon's tooltip and visibility.
 **/
void
ephy_statusbar_set_popups_state (EphyStatusbar *statusbar,
                 gboolean hidden,
                 const char *tooltip)
{
    EphyStatusbarPrivate *priv = statusbar->priv;

    if (hidden)
    {
        gtk_widget_hide (priv->popups_manager_evbox);
    }
    else
    {
        gtk_widget_set_tooltip_text (priv->popups_manager_icon, tooltip);

        gtk_widget_show (priv->popups_manager_evbox);
    }
}

/**
 * ephy_statusbar_set_progress:
 * @statusbar: a #EphyStatusbar
 * @progress: the progress as an integer between 0 and 100 per cent.
 * 
 * Sets the statusbar's progress.
 **/
void
ephy_statusbar_set_progress (EphyStatusbar *statusbar,
                 int progress)
{
    gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (statusbar->priv->progressbar),
                       (float) (progress) / 100.0);

    if (progress < 100)
    {
        gtk_widget_show (statusbar->priv->progressbar);
    }
    else
    {
        gtk_widget_hide (statusbar->priv->progressbar);
    }
}

static void
sync_visibility (GtkWidget *widget,
         GParamSpec *pspec,
         GtkWidget *separator)
{
    if (GTK_WIDGET_VISIBLE (widget))
    {
        gtk_widget_show (separator);
    }
    else
    {
        gtk_widget_hide (separator);
    }
}

/**
 * ephy_statusbar_add_widget:
 * @statusbar: an #EphyStatusbar
 * @widget: a #GtkWidget
 * 
 * Adds the @widget to the statusbar. Use this function whenever you want to
 * add a widget to the statusbar. You can remove the widget again with
 * ephy_statusbar_remove_widget().
 **/
void
ephy_statusbar_add_widget (EphyStatusbar *statusbar,
               GtkWidget *widget)
{
    EphyStatusbarPrivate *priv;
    GtkWidget *vsep;

    g_return_if_fail (EPHY_IS_STATUSBAR (statusbar));
    g_return_if_fail (GTK_IS_WIDGET (widget));

    priv = statusbar->priv;

    gtk_box_pack_start (GTK_BOX (priv->icon_container),
                widget, FALSE, FALSE, 0);

    vsep = gtk_vseparator_new ();
    gtk_box_pack_start (GTK_BOX (priv->icon_container),
                vsep, FALSE, FALSE, 0);
    sync_visibility (widget, NULL, vsep);
    g_object_set_data (G_OBJECT (widget), "EphyStatusbar::separator", vsep);
    g_signal_connect (widget, "notify::visible",
              G_CALLBACK (sync_visibility), vsep);
}

/**
 * ephy_statusbar_remove_widget:
 * @statusbar: an #EphyStatusbar
 * @widget: a #GtkWidget
 *
 * Removes @widget, which must have been added to @statusbar using
 * ephy_statusbar_add_widget ().
 */
void
ephy_statusbar_remove_widget (EphyStatusbar *statusbar,
                  GtkWidget *widget)
{
    EphyStatusbarPrivate *priv;
    GtkWidget *vsep;

    g_return_if_fail (EPHY_IS_STATUSBAR (statusbar));
    g_return_if_fail (GTK_IS_WIDGET (widget));

    priv = statusbar->priv;

    vsep = g_object_steal_data (G_OBJECT (widget), "EphyStatusbar::separator");
    g_return_if_fail (vsep != NULL);

    g_signal_handlers_disconnect_by_func
        (widget, G_CALLBACK (sync_visibility), vsep);

    gtk_container_remove (GTK_CONTAINER (priv->icon_container), vsep);
    gtk_container_remove (GTK_CONTAINER (priv->icon_container), widget);
}

/**
 * ephy_statusbar_get_security_frame:
 * @statusbar: an #EphyStatusbar
 *
 * Return value: the statusbar's lock icon frame
 */
GtkWidget *
ephy_statusbar_get_security_frame (EphyStatusbar *statusbar)
{
    g_return_val_if_fail (EPHY_IS_STATUSBAR (statusbar), NULL);

    return statusbar->priv->security_evbox;
}