path: root/shell/e-shell-folder-title-bar.c

/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
/* e-shell-folder-title-bar.c
 *
 * Copyright (C) 2000, 2001 Ximian, Inc.
 *
 * 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 of the
 * License, 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., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * Author: Ettore Perazzoli
 */

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

#include <gtk/gtkbox.h>
#include <gtk/gtkhbox.h>
#include <gtk/gtklabel.h>
#include <gtk/gtkpixmap.h>
#include <gtk/gtkrc.h>
#include <gtk/gtksignal.h>
#include <gtk/gtktogglebutton.h>
#include <libgnome/gnome-defs.h>
#include <libgnome/gnome-i18n.h>
#include <gdk-pixbuf/gdk-pixbuf.h>

#include <gal/util/e-util.h>

#include "widgets/misc/e-clipped-label.h"
#include "e-shell-constants.h"
#include "e-shell-folder-title-bar.h"


#define PARENT_TYPE GTK_TYPE_EVENT_BOX
static GtkEventBox *parent_class = NULL;

struct _EShellFolderTitleBarPrivate {
    GdkPixbuf *icon;
    GtkWidget *icon_widget;

    /* The hbox containing the button, the label, the extra label, and the icon on the right.  */
    GtkWidget *hbox;

    /* We have a label and a button.  When the button is enabled,
           the label is hidden; when the button is disable, only the
           label is visible.  */

    /* The label.  */
    GtkWidget *label;

    /* Holds extra information that is to be shown to the left of the icon */
    GtkWidget *folder_bar_label;

    /* The button.  */
    GtkWidget *button;
    GtkWidget *button_label;
    GtkWidget *button_arrow;

    gboolean clickable;
};

enum {
    TITLE_TOGGLED,
    LAST_SIGNAL
};

static guint signals[LAST_SIGNAL] = { 0 };


static char *arrow_xpm[] = {
    "11 5  2 1",
    "   c none",
    ".  c #ffffffffffff",
    " ......... ",
    "  .......  ",
    "   .....   ",
    "    ...    ",
    "     .     ",
};


/* Icon handling.  */

static unsigned int
rgb_from_gdk_color (GdkColor *color)
{
    return (((color->red >> 8) << 16)
        | ((color->green >> 8) << 8)
        | ((color->blue >> 8)));
}

static GdkPixmap *
make_icon_pixmap (EShellFolderTitleBar *folder_title_bar,
          const GdkPixbuf *pixbuf)
{
    GdkPixmap *pixmap;
    GtkWidget *widget;
    unsigned int depth;
    unsigned int rgb;

    widget = GTK_WIDGET (folder_title_bar);

    rgb = rgb_from_gdk_color (&widget->style->bg[GTK_STATE_NORMAL]);

    depth = gtk_widget_get_visual (widget)->depth;

    pixmap = gdk_pixmap_new (GTK_WIDGET (folder_title_bar)->window,
                 E_SHELL_MINI_ICON_SIZE, E_SHELL_MINI_ICON_SIZE,
                 depth);

    if (pixbuf == NULL) {
        gdk_draw_rectangle (pixmap, widget->style->bg_gc[GTK_STATE_NORMAL], TRUE,
                    0, 0, E_SHELL_MINI_ICON_SIZE, E_SHELL_MINI_ICON_SIZE);
    } else {
        GdkPixbuf *composited_pixbuf;

        composited_pixbuf = gdk_pixbuf_composite_color_simple
            (pixbuf, gdk_pixbuf_get_width (pixbuf), gdk_pixbuf_get_height (pixbuf),
             GDK_INTERP_NEAREST, 255, 32, rgb, rgb);

        gdk_pixbuf_render_to_drawable (composited_pixbuf,
                           pixmap, widget->style->fg_gc[GTK_STATE_NORMAL],
                           0, 0, 0, 0,
                           E_SHELL_MINI_ICON_SIZE, E_SHELL_MINI_ICON_SIZE,
                           GDK_RGB_DITHER_MAX, 0, 0);

        gdk_pixbuf_unref (composited_pixbuf);
    }

    return pixmap;
}


/* Icon pixmap.  */

static GtkWidget *
create_icon_pixmap (GtkWidget *parent)
{
    GtkWidget *gtk_pixmap;
    GdkPixmap *gdk_pixmap;
    GdkBitmap *gdk_mask;

    gdk_pixmap = gdk_pixmap_create_from_xpm_d (parent->window, &gdk_mask, NULL, arrow_xpm);
    gtk_pixmap = gtk_pixmap_new (gdk_pixmap, gdk_mask);

    gdk_pixmap_unref (gdk_pixmap);
    gdk_bitmap_unref (gdk_mask);

    return gtk_pixmap;
}

static void
title_button_box_realize_cb (GtkWidget *widget,
                 void *data)
{
    EShellFolderTitleBar *folder_title_bar;
    EShellFolderTitleBarPrivate *priv;
    GtkWidget *button_arrow;

    folder_title_bar = E_SHELL_FOLDER_TITLE_BAR (data);
    priv = folder_title_bar->priv;

    if (priv->button_arrow != NULL)
        return;

    button_arrow = create_icon_pixmap (widget);

    gtk_widget_show (button_arrow);
    gtk_box_pack_start (GTK_BOX (widget), button_arrow, FALSE, TRUE, 2);

    priv->button_arrow = button_arrow;
}


/* Style handling.  */

static void
endarken_style (GtkWidget *widget)
{
#ifndef E_USE_STYLES
    GtkStyle *style;
    GtkRcStyle *new_rc_style;
    int i;

    style = widget->style;

    new_rc_style = gtk_rc_style_new ();

    for (i = 0; i < 5; i++) {
        new_rc_style->bg[i].red      = style->bg[i].red * .8;
        new_rc_style->bg[i].green    = style->bg[i].green * .8;
        new_rc_style->bg[i].blue     = style->bg[i].blue * .8;
        new_rc_style->fg[i].red      = 0xffff;
        new_rc_style->fg[i].green    = 0xffff;
        new_rc_style->fg[i].blue     = 0xffff;

        new_rc_style->color_flags[i] = GTK_RC_BG | GTK_RC_FG;
    }

    gtk_widget_modify_style (widget, new_rc_style);

    gtk_rc_style_unref (new_rc_style);
#endif
}

static void
style_set_cb (GtkWidget *widget,
          GtkStyle *previous_style,
          void *data)
{
    EShellFolderTitleBar *folder_title_bar;

    folder_title_bar = E_SHELL_FOLDER_TITLE_BAR (widget);
    
    /* 
       This will cause a style_set signal to be emitted again, 
       so we need to do this to prevent infinite recursion.  
    */
    gtk_signal_handler_block_by_func (GTK_OBJECT (widget), GTK_SIGNAL_FUNC (style_set_cb), data);

    endarken_style (widget);
    gtk_signal_handler_unblock_by_func (GTK_OBJECT (widget), GTK_SIGNAL_FUNC (style_set_cb), data);

    if (folder_title_bar->priv->icon)
        e_shell_folder_title_bar_set_icon (folder_title_bar, folder_title_bar->priv->icon);
}


/* Popup button callback.  */

static void
title_button_toggled_cb (GtkToggleButton *button,
             void *data)
{
    EShellFolderTitleBar *folder_title_bar;

    folder_title_bar = E_SHELL_FOLDER_TITLE_BAR (data);
    gtk_signal_emit (GTK_OBJECT (folder_title_bar),
             signals[TITLE_TOGGLED],
             gtk_toggle_button_get_active (button));
}


/* GTkWidget methods. */

static void
realize (GtkWidget *widget)
{
    EShellFolderTitleBar *folder_title_bar;
    EShellFolderTitleBarPrivate *priv;
    GdkPixmap *pixmap;

    (* GTK_WIDGET_CLASS (parent_class)->realize) (widget);

    folder_title_bar = E_SHELL_FOLDER_TITLE_BAR (widget);
    priv = folder_title_bar->priv;

    pixmap = make_icon_pixmap (folder_title_bar, priv->icon);
    priv->icon_widget = gtk_pixmap_new (pixmap, NULL);
    gdk_pixmap_unref (pixmap);
    gtk_widget_show (priv->icon_widget);

    gtk_misc_set_alignment (GTK_MISC (priv->icon_widget), 1.0, .5);
    gtk_misc_set_padding (GTK_MISC (priv->icon_widget), 0, 0);
    gtk_box_pack_start (GTK_BOX (priv->hbox), priv->icon_widget, FALSE, FALSE, 2);
}

static void
unrealize (GtkWidget *widget)
{
    EShellFolderTitleBar *folder_title_bar;
    EShellFolderTitleBarPrivate *priv;

    (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);

    folder_title_bar = E_SHELL_FOLDER_TITLE_BAR (widget);
    priv = folder_title_bar->priv;

    gtk_widget_destroy (priv->icon_widget);
    priv->icon_widget = NULL;
}


/* GtkObject methods.  */

static void
destroy (GtkObject *object)
{
    EShellFolderTitleBar *folder_title_bar;
    EShellFolderTitleBarPrivate *priv;

    folder_title_bar = E_SHELL_FOLDER_TITLE_BAR (object);
    priv = folder_title_bar->priv;

    if (priv->icon)
        gdk_pixbuf_unref (priv->icon);
    g_free (priv);

    (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
}


static void
class_init (EShellFolderTitleBarClass *klass)
{
    GtkObjectClass *object_class;
    GtkWidgetClass *widget_class;

    object_class = GTK_OBJECT_CLASS (klass);
    object_class->destroy = destroy;

    widget_class = GTK_WIDGET_CLASS (klass);
    widget_class->realize   = realize;
    widget_class->unrealize = unrealize;

    parent_class = gtk_type_class (PARENT_TYPE);

    signals[TITLE_TOGGLED] = gtk_signal_new ("title_toggled",
                         GTK_RUN_FIRST,
                         object_class->type,
                         GTK_SIGNAL_OFFSET (EShellFolderTitleBarClass, title_toggled),
                         gtk_marshal_NONE__BOOL,
                         GTK_TYPE_NONE, 1,
                         GTK_TYPE_BOOL);

    gtk_object_class_add_signals (object_class, signals, LAST_SIGNAL);
}

static void
init (EShellFolderTitleBar *shell_folder_title_bar)
{
    EShellFolderTitleBarPrivate *priv;

    priv = g_new (EShellFolderTitleBarPrivate, 1);

    priv->icon         = NULL;
    priv->icon_widget  = NULL;
    priv->hbox         = NULL;
    priv->label        = NULL;
    priv->folder_bar_label  = NULL;
    priv->button_label = NULL;
    priv->button       = NULL;
    priv->button_arrow = NULL;

    priv->clickable    = TRUE;

    shell_folder_title_bar->priv = priv;
}


/**
 * e_shell_folder_title_bar_construct:
 * @folder_title_bar: 
 * 
 * Construct the folder title bar widget.
 **/
void
e_shell_folder_title_bar_construct (EShellFolderTitleBar *folder_title_bar)
{
    EShellFolderTitleBarPrivate *priv;
    GtkWidget *button_hbox;
    GtkWidget *widget;

    g_return_if_fail (folder_title_bar != NULL);
    g_return_if_fail (E_IS_SHELL_FOLDER_TITLE_BAR (folder_title_bar));

    priv = folder_title_bar->priv;
    widget = GTK_WIDGET (folder_title_bar);

    priv->label = gtk_label_new ("");
    gtk_misc_set_alignment (GTK_MISC (priv->label), 0.0, 0.5);

    priv->folder_bar_label = gtk_label_new ("");
    gtk_misc_set_alignment (GTK_MISC (priv->folder_bar_label), 1.0, 0.5);
    gtk_widget_show (priv->folder_bar_label);

    priv->button_label = gtk_label_new ("");
    gtk_misc_set_padding (GTK_MISC (priv->button_label), 5, 0);
    gtk_misc_set_alignment (GTK_MISC (priv->button_label), 0.0, 0.5);
    gtk_widget_show (priv->button_label);

    button_hbox = gtk_hbox_new (FALSE, 0);
    gtk_signal_connect (GTK_OBJECT (button_hbox), "realize",
                GTK_SIGNAL_FUNC (title_button_box_realize_cb), folder_title_bar);
    gtk_box_pack_start (GTK_BOX (button_hbox), priv->button_label, TRUE, TRUE, 0);
    gtk_widget_show (button_hbox);

    priv->button = gtk_toggle_button_new ();
    gtk_button_set_relief (GTK_BUTTON (priv->button), GTK_RELIEF_NONE);
    gtk_container_add (GTK_CONTAINER (priv->button), button_hbox);
    GTK_WIDGET_UNSET_FLAGS (priv->button, GTK_CAN_FOCUS);
    gtk_widget_show (priv->button);

    priv->hbox = gtk_hbox_new (FALSE, 0);
    gtk_container_set_border_width (GTK_CONTAINER (priv->hbox), 2);
    gtk_box_pack_start (GTK_BOX (priv->hbox), priv->label, FALSE, TRUE, 0);
    gtk_box_pack_start (GTK_BOX (priv->hbox), priv->button, FALSE, TRUE, 0);
    gtk_box_pack_start (GTK_BOX (priv->hbox), priv->folder_bar_label, TRUE, TRUE, 0);

    gtk_widget_show (priv->hbox);

    gtk_signal_connect (GTK_OBJECT (priv->button), "toggled",
                GTK_SIGNAL_FUNC (title_button_toggled_cb), folder_title_bar);

    gtk_container_add (GTK_CONTAINER (folder_title_bar), priv->hbox);

    gtk_signal_connect (GTK_OBJECT (folder_title_bar), "style_set",
                GTK_SIGNAL_FUNC (style_set_cb), NULL);

    e_shell_folder_title_bar_set_title (folder_title_bar, NULL);
}

/**
 * e_shell_folder_title_bar_new:
 * @void: 
 * 
 * Create a new title bar widget.
 * 
 * Return value: 
 **/
GtkWidget *
e_shell_folder_title_bar_new (void)
{
    EShellFolderTitleBar *new;

    gtk_widget_push_colormap (gdk_rgb_get_cmap ());
    gtk_widget_push_visual (gdk_rgb_get_visual ());
    new = gtk_type_new (e_shell_folder_title_bar_get_type ());

    e_shell_folder_title_bar_construct (new);
    gtk_widget_pop_visual ();
    gtk_widget_pop_colormap ();

    return GTK_WIDGET (new);
}

/**
 * e_shell_folder_title_bar_set_title:
 * @folder_title_bar: 
 * @title: 
 * 
 * Set the title for the title bar.
 **/
void
e_shell_folder_title_bar_set_title (EShellFolderTitleBar *folder_title_bar,
                    const char *title)
{
    EShellFolderTitleBarPrivate *priv;

    g_return_if_fail (folder_title_bar != NULL);
    g_return_if_fail (E_IS_SHELL_FOLDER_TITLE_BAR (folder_title_bar));

    priv = folder_title_bar->priv;

    if (title == NULL) {
        gtk_label_set_text (GTK_LABEL (priv->button_label), _("(Untitled)"));
        gtk_label_set_text (GTK_LABEL (priv->label), _("(Untitled)"));
    } else {
        gtk_label_set_text (GTK_LABEL (priv->button_label), title);
        gtk_label_set_text (GTK_LABEL (priv->label), title);
    }

    /* FIXME: There seems to be a bug in EClippedLabel, this is just a workaround.  */
    gtk_widget_queue_draw (GTK_WIDGET (folder_title_bar));
}

/**
 * e_shell_folder_title_bar_set_folder_bar_label:
 * @folder_title_bar:
 * @text: Some text to show in the label.
 *
 * Sets the right-justified text label (to the left of the icon) for
 * the title bar.
 **/
void
e_shell_folder_title_bar_set_folder_bar_label (EShellFolderTitleBar *folder_title_bar,
                           const char *text)
{
    EShellFolderTitleBarPrivate *priv;

    g_return_if_fail (folder_title_bar != NULL);
    g_return_if_fail (E_IS_SHELL_FOLDER_TITLE_BAR (folder_title_bar));

    priv = folder_title_bar->priv;

    if (text == NULL)
        gtk_label_set_text (GTK_LABEL (priv->folder_bar_label), "");
    else
        gtk_label_set_text (GTK_LABEL (priv->folder_bar_label), text);

    /* FIXME: Might want to set the styles somewhere in here too,
           black text on grey background isn't the best combination */
}

/**
 * e_shell_folder_title_bar_set_icon:
 * @folder_title_bar: 
 * @icon: 
 * 
 * Set the name of the icon for the title bar.
 **/
void
e_shell_folder_title_bar_set_icon (EShellFolderTitleBar *folder_title_bar,
                   const GdkPixbuf *icon)
{
    EShellFolderTitleBarPrivate *priv;
    GdkPixmap *pixmap;

    g_return_if_fail (icon != NULL);

    g_return_if_fail (folder_title_bar != NULL);
    g_return_if_fail (E_IS_SHELL_FOLDER_TITLE_BAR (folder_title_bar));

    priv = folder_title_bar->priv;

    gdk_pixbuf_ref ((GdkPixbuf *) icon);
    if (priv->icon)
        gdk_pixbuf_unref (priv->icon);
    priv->icon = (GdkPixbuf *) icon;

    pixmap = make_icon_pixmap (folder_title_bar, icon);

    gtk_pixmap_set (GTK_PIXMAP (priv->icon_widget), pixmap, NULL);
}


/**
 * e_shell_folder_title_bar_set_toggle_state:
 * @folder_title_bar: 
 * @state: 
 * 
 * Set whether the title bar's button is in pressed state (TRUE) or not (FALSE).
 **/
void
e_shell_folder_title_bar_set_toggle_state (EShellFolderTitleBar *folder_title_bar,
                       gboolean state)
{
    EShellFolderTitleBarPrivate *priv;

    g_return_if_fail (folder_title_bar != NULL);
    g_return_if_fail (E_IS_SHELL_FOLDER_TITLE_BAR (folder_title_bar));

    priv = folder_title_bar->priv;

    gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->button), state);
}

/**
 * e_shell_folder_title_bar_set_clickable:
 * @folder_title_bar: 
 * @clickable: 
 * 
 * Specify whether @folder_title_bar is clickable.  If not, the arrow pixmap is not shown.
 **/
void
e_shell_folder_title_bar_set_clickable (EShellFolderTitleBar *folder_title_bar,
                    gboolean clickable)
{
    EShellFolderTitleBarPrivate *priv;

    g_return_if_fail (folder_title_bar != NULL);
    g_return_if_fail (E_IS_SHELL_FOLDER_TITLE_BAR (folder_title_bar));

    priv = folder_title_bar->priv;

    if ((priv->clickable && clickable) || (! priv->clickable && ! clickable))
        return;

    if (clickable) {
        gtk_widget_show (priv->button);
        gtk_widget_hide (priv->label);
    } else {
        gtk_widget_hide (priv->button);
        gtk_widget_show (priv->label);
    }

    priv->clickable = !! clickable;
}


E_MAKE_TYPE (e_shell_folder_title_bar, "EShellFolderTitleBar", EShellFolderTitleBar, class_init, init, PARENT_TYPE)