path: root/hildon/hildon-seekbar.c

/*
 * This file is a part of hildon
 *
 * Copyright (C) 2005, 2006 Nokia Corporation, all rights reserved.
 *
 * Contact: Rodrigo Novo <rodrigo.novo@nokia.com>
 *
 * This library 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; version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library 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 this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

/**
 * SECTION:hildon-seekbar
 * @short_description: A widget used to identify a place from a content.
 *
 * HildonSeekbar allows seeking in media with a range widget.  It
 * supports for setting or getting the length (total time) of the media,
 * the position within it and the fraction (maximum position in a
 * stream/the amount currently downloaded).  The position is clamped
 * between zero and the total time, or zero and the fraction in case of
 * a stream.
 *
 * #HildonSeekbar has been deprecated since hildon 2.2. Use #GtkScale
 * instead. See hildon_gtk_hscale_new() and hildon_gtk_vscale_new().
 */

#undef                                          HILDON_DISABLE_DEPRECATED

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

#include                                        <libintl.h>
#include                                        <stdio.h>
#include                                        <math.h>
#include                                        <gdk/gdkkeysyms.h>

#include                                        "hildon-seekbar.h"
#include                                        "hildon-seekbar-private.h"

static GtkScaleClass*                           parent_class = NULL;

static void 
hildon_seekbar_class_init                       (HildonSeekbarClass *seekbar_class);

static void 
hildon_seekbar_init                             (HildonSeekbar *seekbar);

static void
hildon_seekbar_set_property                     (GObject *object, 
                                                 guint prop_id,
                                                 const GValue *value,
                                                 GParamSpec *pspec);

static void 
hildon_seekbar_get_property                     (GObject *object, 
                                                 guint prop_id,
                                                 GValue *value,
                                                 GParamSpec *pspec);

static void
hildon_seekbar_size_request                     (GtkWidget *widget,
                                                 GtkRequisition *event);

static void 
hildon_seekbar_size_allocate                    (GtkWidget *widget,
                                                 GtkAllocation *allocation);

static gboolean 
hildon_seekbar_button_press_event               (GtkWidget *widget,
                                                 GdkEventButton *event);

static gboolean
hildon_seekbar_button_release_event             (GtkWidget *widget,
                                                 GdkEventButton *event);

static gboolean 
hildon_seekbar_keypress                         (GtkWidget *widget,
                                                 GdkEventKey *event);

#define                                         MINIMUM_WIDTH 115

#define                                         DEFAULT_HEIGHT 58

#define                                         TOOL_MINIMUM_WIDTH 75

#define                                         TOOL_DEFAULT_HEIGHT 40

#define                                         DEFAULT_DISPLAYC_BORDER 10

#define                                         BUFFER_SIZE 32

#define                                         EXTRA_SIDE_BORDER 20

#define                                         TOOL_EXTRA_SIDE_BORDER 0

#define                                         NUM_STEPS 20

#define                                         SECONDS_PER_MINUTE 60

/* the number of digits precision for the internal range.
 * note, this needs to be enough so that the step size for
 * small total_times doesn't get rounded off. Currently set to 3
 * this is because for the smallest total time ( i.e 1 ) and the current
 * num steps ( 20 ) is: 1/20 = 0.05.  0.05 is 2 digits, and we
 * add one for safety */
#define                                         MAX_ROUND_DIGITS 3

enum 
{
    PROP_0,
    PROP_TOTAL_TIME,
    PROP_POSITION,
    PROP_FRACTION
};

/**
 * hildon_seekbar_get_type:
 * 
 * Initializes, and returns the type of a hildon seekbar.
 * 
 * Returns: GType of #HildonSeekbar
 * 
 */
GType G_GNUC_CONST 
hildon_seekbar_get_type                         (void)
{
    static GType seekbar_type = 0;

    if (!seekbar_type) {
        static const GTypeInfo seekbar_info = {
            sizeof (HildonSeekbarClass),
            NULL,       /* base_init */
            NULL,       /* base_finalize */
            (GClassInitFunc) hildon_seekbar_class_init,
            NULL,       /* class_finalize */
            NULL,       /* class_data */
            sizeof (HildonSeekbar),
            0,  /* n_preallocs */
            (GInstanceInitFunc) hildon_seekbar_init,
        };
        seekbar_type = g_type_register_static(GTK_TYPE_SCALE,
                "HildonSeekbar",
                &seekbar_info, 0);
    }

    return seekbar_type;
}

/**
 * Initialises the seekbar class.
 */
static void 
hildon_seekbar_class_init                       (HildonSeekbarClass *seekbar_class)
{
    GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (seekbar_class);
    GObjectClass *object_class = G_OBJECT_CLASS (seekbar_class);

    parent_class = g_type_class_peek_parent (seekbar_class);

    g_type_class_add_private (seekbar_class, sizeof (HildonSeekbarPrivate));

    widget_class->size_request          = hildon_seekbar_size_request;
    widget_class->size_allocate         = hildon_seekbar_size_allocate;
    widget_class->button_press_event    = hildon_seekbar_button_press_event;
    widget_class->button_release_event  = hildon_seekbar_button_release_event;
    widget_class->key_press_event       = hildon_seekbar_keypress;

    object_class->set_property          = hildon_seekbar_set_property;
    object_class->get_property          = hildon_seekbar_get_property;

    /**
     * HildonSeekbar:total-time:
     *
     * Total playing time of this media file.
     */
    g_object_class_install_property (object_class, PROP_TOTAL_TIME,
            g_param_spec_double ("total-time",
                "total time",
                "Total playing time of this media file",
                0,           /* min value */
                G_MAXDOUBLE, /* max value */
                0,           /* default */
                G_PARAM_READWRITE));

    /**
     * HildonSeekbar:position:
     *
     * Current position in this media file.
     */
    g_object_class_install_property (object_class, PROP_POSITION,
            g_param_spec_double ("position",
                "position",
                "Current position in this media file",
                0,           /* min value */
                G_MAXDOUBLE, /* max value */
                0,           /* default */
                G_PARAM_READWRITE));

    /**
     * HildonSeekbar:fraction:
     *
     * Current fraction related to the progress indicator.
     */
    g_object_class_install_property (object_class, PROP_FRACTION,
            g_param_spec_double ("fraction",
                "Fraction",
                "current fraction related to the"
                "progress indicator",
                0,           /* min value */
                G_MAXDOUBLE, /* max value */
                0,           /* default */
                G_PARAM_READWRITE));
}


static void
hildon_seekbar_init                             (HildonSeekbar *seekbar)
{
    GtkRange *range = GTK_RANGE(seekbar);

    /* Initialize range widget */
    range->orientation = GTK_ORIENTATION_HORIZONTAL;
    range->flippable = TRUE;
    range->round_digits = MAX_ROUND_DIGITS;

    gtk_scale_set_draw_value (GTK_SCALE (seekbar), FALSE);
}

/*
 * Purpose of this function is to prevent Up and Down keys from
 * changing the widget's value (like Left and Right). Instead they
 * are used for changing focus to other widgtes.
 */
static gboolean
hildon_seekbar_keypress                         (GtkWidget *widget,
                                                 GdkEventKey *event)
{
    if (event->keyval == GDK_Up || event->keyval == GDK_Down)
        return FALSE;

    return ((GTK_WIDGET_CLASS (parent_class)->key_press_event) (widget, event));
}

static void
hildon_seekbar_set_property                     (GObject *object, 
                                                 guint prop_id,
                                                 const GValue *value, 
                                                 GParamSpec *pspec)
{
    HildonSeekbar *seekbar = HILDON_SEEKBAR (object);

    switch (prop_id) {

        case PROP_TOTAL_TIME:
            hildon_seekbar_set_total_time (seekbar, g_value_get_double (value));
            break;

        case PROP_POSITION:
            hildon_seekbar_set_position (seekbar, g_value_get_double (value));
            break;

        case PROP_FRACTION:
            hildon_seekbar_set_fraction (seekbar, g_value_get_double (value));
            break;

        default:
            G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
            break;
    }
}

/* handle getting of seekbar properties */
static void
hildon_seekbar_get_property                     (GObject *object, 
                                                 guint prop_id,
                                                 GValue *value, 
                                                 GParamSpec *pspec)
{
    GtkRange *range = GTK_RANGE (object);

    switch (prop_id) {

        case PROP_TOTAL_TIME:
            g_value_set_double (value, range->adjustment->upper);
            break;

        case PROP_POSITION:
            g_value_set_double (value, range->adjustment->value);
            break;

        case PROP_FRACTION:
            g_value_set_double (value, 
                    hildon_seekbar_get_fraction (HILDON_SEEKBAR(object)));
            break;

        default:
            G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
            break;
    }
}

/**
 * hildon_seekbar_new:
 *
 * Create a new #HildonSeekbar widget.
 * 
 * Returns: a #GtkWidget pointer of #HildonSeekbar widget
 */
GtkWidget*
hildon_seekbar_new                              (void)
{
    return g_object_new (HILDON_TYPE_SEEKBAR, NULL);
}

/**
 * hildon_seekbar_get_total_time:
 * @seekbar: a #HildonSeekbar
 *
 * Gets the total playing time of the media (in seconds).
 *
 * Returns: total playing time.
 */
gint
hildon_seekbar_get_total_time                   (HildonSeekbar *seekbar)
{
    GtkWidget *widget;
    widget = GTK_WIDGET (seekbar);
    g_return_val_if_fail (HILDON_IS_SEEKBAR (seekbar), 0);
    g_return_val_if_fail (GTK_RANGE (widget)->adjustment, 0);
    return GTK_RANGE (widget)->adjustment->upper;
}

/**
 * hildon_seekbar_set_total_time:
 * @seekbar: a #HildonSeekbar
 * @time: integer greater than zero
 *
 * Set total playing time of media in seconds.
 */
void
hildon_seekbar_set_total_time                   (HildonSeekbar *seekbar, 
                                                 gint time)
{
    GtkAdjustment *adj;
    GtkWidget *widget;
    gboolean value_changed = FALSE;

    g_return_if_fail (HILDON_IS_SEEKBAR (seekbar));
    widget = GTK_WIDGET (seekbar);

    if (time <= 0) {
        return;
    }

    g_return_if_fail (GTK_RANGE (widget)->adjustment);

    adj = GTK_RANGE (widget)->adjustment;
    adj->upper = time;

    /* Clamp position to total time */
    if (adj->value > time) {
        adj->value = time;
        value_changed = TRUE;
    }

    /* Calculate new step value */
    adj->step_increment = adj->upper / NUM_STEPS;
    adj->page_increment = adj->step_increment;

    gtk_adjustment_changed (adj);

    /* Update range widget position/fraction */
    if (value_changed) {
        gtk_adjustment_value_changed (adj);
        hildon_seekbar_set_fraction(seekbar,
                MIN (hildon_seekbar_get_fraction (seekbar),
                    time));

        g_object_freeze_notify (G_OBJECT (seekbar));

        hildon_seekbar_set_position (seekbar,
                MIN (hildon_seekbar_get_position (seekbar),
                    time));

        g_object_notify(G_OBJECT (seekbar), "total-time");

        g_object_thaw_notify (G_OBJECT (seekbar));
    }
}

/**
 * hildon_seekbar_get_fraction:
 * @seekbar: pointer to #HildonSeekbar widget
 *
 * Get current fraction value of the rage.
 *
 * Returns: current fraction
 */
guint 
hildon_seekbar_get_fraction                     (HildonSeekbar *seekbar)
{
    g_return_val_if_fail (HILDON_IS_SEEKBAR (seekbar), 0);

#if defined(MAEMO_GTK) || GTK_CHECK_VERSION(2,11,0)
    return gtk_range_get_fill_level (GTK_RANGE (seekbar));
#else
    return 0;
#endif
}

/**
 * hildon_seekbar_set_fraction:
 * @seekbar: pointer to #HildonSeekbar widget
 * @fraction: the new position of the progress indicator
 *
 * Set current fraction value of the range.
 * It should be between the minimal and maximal values of the range in seekbar.
 */
void 
hildon_seekbar_set_fraction                     (HildonSeekbar *seekbar, 
                                                 guint fraction)
{
    GtkRange *range = NULL;
    g_return_if_fail (HILDON_IS_SEEKBAR (seekbar));

    range = GTK_RANGE(GTK_WIDGET(seekbar));

    g_return_if_fail (fraction <= range->adjustment->upper &&
            fraction >= range->adjustment->lower);

    /* Set to show stream indicator. */
    g_object_set (G_OBJECT (seekbar), "show-fill-level", TRUE, NULL);

    fraction = CLAMP (fraction, range->adjustment->lower,
            range->adjustment->upper);

#if defined(MAEMO_GTK) || GTK_CHECK_VERSION(2,11,0)
    /* Update stream position of range widget */
    gtk_range_set_fill_level (range, fraction);
#endif

    if (fraction < hildon_seekbar_get_position(seekbar))
        hildon_seekbar_set_position(seekbar, fraction);

    g_object_notify (G_OBJECT (seekbar), "fraction");
}

/**
 * hildon_seekbar_get_position:
 * @seekbar: pointer to #HildonSeekbar widget
 *
 * Get current position in stream in seconds.
 *
 * Returns: current position in stream in seconds
 */
gint 
hildon_seekbar_get_position                     (HildonSeekbar *seekbar)
{
    g_return_val_if_fail (HILDON_IS_SEEKBAR(seekbar), 0);
    g_return_val_if_fail (GTK_RANGE(seekbar)->adjustment, 0);

    return GTK_RANGE (seekbar)->adjustment->value;
}

/**
 * hildon_seekbar_set_position:
 * @seekbar: pointer to #HildonSeekbar widget
 * @time: time within range of >= 0 && < G_MAXINT
 *
 * Set current position in stream in seconds.
 */
void 
hildon_seekbar_set_position                     (HildonSeekbar *seekbar, 
                                                 gint time)
{
    GtkRange *range;
    GtkAdjustment *adj;
    gint value;

    g_return_if_fail (time >= 0);
    g_return_if_fail (HILDON_IS_SEEKBAR(seekbar));
    range = GTK_RANGE (seekbar);
    adj = range->adjustment;
    g_return_if_fail (adj);

    /* only change value if it is a different int. this allows us to have
       smooth scrolls for small total_times */
    value = floor (adj->value);
    if (time != value) {
        value = (time < adj->upper) ? time : adj->upper;

#if defined(MAEMO_GTK) || GTK_CHECK_VERSION(2,11,0)
        if (value <= gtk_range_get_fill_level (range)) {
#else
        if (value) {
#endif
            adj->value = value;
            gtk_adjustment_value_changed (adj);

            g_object_notify (G_OBJECT (seekbar), "position");
        }
    }
}

static void 
hildon_seekbar_size_request                     (GtkWidget *widget,
                                                 GtkRequisition *req)
{
    HildonSeekbar *self = NULL;
    HildonSeekbarPrivate *priv = NULL;
    GtkWidget *parent = NULL;

    self = HILDON_SEEKBAR (widget);
    priv = HILDON_SEEKBAR_GET_PRIVATE (self);

    parent = gtk_widget_get_ancestor (GTK_WIDGET (self), GTK_TYPE_TOOLBAR);

    priv->is_toolbar = parent ? TRUE : FALSE;

    if (GTK_WIDGET_CLASS (parent_class)->size_request)
        GTK_WIDGET_CLASS (parent_class)->size_request (widget, req);

    /* Request minimum size, depending on whether the widget is in a
     * toolbar or not */
    req->width = priv->is_toolbar ? TOOL_MINIMUM_WIDTH : MINIMUM_WIDTH;
    req->height = priv->is_toolbar ? TOOL_DEFAULT_HEIGHT : DEFAULT_HEIGHT;
}

static void 
hildon_seekbar_size_allocate                    (GtkWidget *widget,
                                                 GtkAllocation *allocation)
{
    HildonSeekbarPrivate *priv;

    priv = HILDON_SEEKBAR_GET_PRIVATE (widget);

    if (priv->is_toolbar == TRUE)
    {
        /* Center vertically */
        if (allocation->height > TOOL_DEFAULT_HEIGHT)
        {
            allocation->y +=
                (allocation->height - TOOL_DEFAULT_HEIGHT) / 2;
            allocation->height = TOOL_DEFAULT_HEIGHT;
        }
        /* Add space for border */
        allocation->x += TOOL_EXTRA_SIDE_BORDER;
        allocation->width -= 2 * TOOL_EXTRA_SIDE_BORDER;
    }
    else
    {
        /* Center vertically */
        if (allocation->height > DEFAULT_HEIGHT)
        {
            allocation->y += (allocation->height - DEFAULT_HEIGHT) / 2;
            allocation->height = DEFAULT_HEIGHT;
        }

        /* Add space for border */
        allocation->x += EXTRA_SIDE_BORDER;
        allocation->width -= 2 * EXTRA_SIDE_BORDER;
    }

    if (GTK_WIDGET_CLASS (parent_class)->size_allocate)
        GTK_WIDGET_CLASS (parent_class)->size_allocate (widget, allocation);
}

/*
 * Event handler for button press. Changes button1 to button2.
 */
static gboolean
hildon_seekbar_button_press_event               (GtkWidget *widget,
                                                 GdkEventButton *event)
{
    gint result = FALSE;

    /* We change here the button id because we want to use button2
     * functionality for button1: jump to mouse position
     * instead of slowly incrementing to it */
    if (event->button == 1) event->button = 2;

    /* call the parent handler */
    if (GTK_WIDGET_CLASS (parent_class)->button_press_event)
        result = GTK_WIDGET_CLASS (parent_class)->button_press_event (widget,
                event);

    return result;
}
/*
 * Event handler for button release. Changes button1 to button2.
 */
static gboolean
hildon_seekbar_button_release_event             (GtkWidget *widget,
                                                 GdkEventButton *event)
{
    gboolean result = FALSE;

    /* We change here the button id because we want to use button2
     * functionality for button1: jump to mouse position
     * instead of slowly incrementing to it */
    event->button = event->button == 1 ? 2 : event->button;

    /* call the parent handler */
    if (GTK_WIDGET_CLASS (parent_class)->button_release_event)
        result = GTK_WIDGET_CLASS (parent_class)->button_release_event (widget,
                event);

    return result;
}