path: root/e-util/e-online-button.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.
 *
 * 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 Lesser General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include "e-online-button.h"

#include <glib/gi18n.h>

#include "e-misc-utils.h"

#define E_ONLINE_BUTTON_GET_PRIVATE(obj) \
    (G_TYPE_INSTANCE_GET_PRIVATE \
    ((obj), E_TYPE_ONLINE_BUTTON, EOnlineButtonPrivate))

#define ONLINE_TOOLTIP \
    _("Evolution is currently online.  Click this button to work offline.")

#define OFFLINE_TOOLTIP \
    _("Evolution is currently offline.  Click this button to work online.")

#define NETWORK_UNAVAILABLE_TOOLTIP \
    _("Evolution is currently offline because the network is unavailable.")

struct _EOnlineButtonPrivate {
    GtkWidget *image;
    gboolean online;
};

enum {
    PROP_0,
    PROP_ONLINE
};

G_DEFINE_TYPE (
    EOnlineButton,
    e_online_button,
    GTK_TYPE_BUTTON)

static void
online_button_update_tooltip (EOnlineButton *button)
{
    const gchar *tooltip;

    if (e_online_button_get_online (button))
        tooltip = ONLINE_TOOLTIP;
    else if (gtk_widget_get_sensitive (GTK_WIDGET (button)))
        tooltip = OFFLINE_TOOLTIP;
    else
        tooltip = NETWORK_UNAVAILABLE_TOOLTIP;

    gtk_widget_set_tooltip_text (GTK_WIDGET (button), tooltip);
}

static void
online_button_set_property (GObject *object,
                             guint property_id,
                             const GValue *value,
                             GParamSpec *pspec)
{
    switch (property_id) {
        case PROP_ONLINE:
            e_online_button_set_online (
                E_ONLINE_BUTTON (object),
                g_value_get_boolean (value));
            return;
    }

    G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}

static void
online_button_get_property (GObject *object,
                             guint property_id,
                             GValue *value,
                             GParamSpec *pspec)
{
    switch (property_id) {
        case PROP_ONLINE:
            g_value_set_boolean (
                value, e_online_button_get_online (
                E_ONLINE_BUTTON (object)));
            return;
    }

    G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}

static void
online_button_dispose (GObject *object)
{
    EOnlineButtonPrivate *priv;

    priv = E_ONLINE_BUTTON_GET_PRIVATE (object);

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

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

static void
e_online_button_class_init (EOnlineButtonClass *class)
{
    GObjectClass *object_class;

    g_type_class_add_private (class, sizeof (EOnlineButtonPrivate));

    object_class = G_OBJECT_CLASS (class);
    object_class->set_property = online_button_set_property;
    object_class->get_property = online_button_get_property;
    object_class->dispose = online_button_dispose;

    g_object_class_install_property (
        object_class,
        PROP_ONLINE,
        g_param_spec_boolean (
            "online",
            "Online",
            "The button state is online",
            TRUE,
            G_PARAM_READWRITE |
            G_PARAM_CONSTRUCT));
}

static void
e_online_button_init (EOnlineButton *button)
{
    GtkWidget *widget;

    button->priv = E_ONLINE_BUTTON_GET_PRIVATE (button);

    gtk_widget_set_can_focus (GTK_WIDGET (button), FALSE);
    gtk_button_set_relief (GTK_BUTTON (button), GTK_RELIEF_NONE);

    widget = gtk_image_new ();
    gtk_container_add (GTK_CONTAINER (button), widget);
    button->priv->image = g_object_ref (widget);
    gtk_widget_show (widget);

    e_signal_connect_notify (
        button, "notify::online",
        G_CALLBACK (online_button_update_tooltip), NULL);

    e_signal_connect_notify (
        button, "notify::sensitive",
        G_CALLBACK (online_button_update_tooltip), NULL);
}

GtkWidget *
e_online_button_new (void)
{
    return g_object_new (E_TYPE_ONLINE_BUTTON, NULL);
}

gboolean
e_online_button_get_online (EOnlineButton *button)
{
    g_return_val_if_fail (E_IS_ONLINE_BUTTON (button), FALSE);

    return button->priv->online;
}

void
e_online_button_set_online (EOnlineButton *button,
                            gboolean online)
{
    GtkImage *image;
    GtkIconInfo *icon_info;
    GtkIconTheme *icon_theme;
    const gchar *filename;
    const gchar *icon_name;

    g_return_if_fail (E_IS_ONLINE_BUTTON (button));

    if (button->priv->online == online)
        return;

    button->priv->online = online;

    image = GTK_IMAGE (button->priv->image);
    icon_name = online ? "online" : "offline";
    icon_theme = gtk_icon_theme_get_default ();

    /* Prevent GTK+ from scaling these rectangular icons. */
    icon_info = gtk_icon_theme_lookup_icon (
        icon_theme, icon_name, GTK_ICON_SIZE_BUTTON, 0);
    filename = gtk_icon_info_get_filename (icon_info);
    gtk_image_set_from_file (image, filename);
    gtk_icon_info_free (icon_info);

    g_object_notify (G_OBJECT (button), "online");
}