gtk/gtk/gtkspinner.c
2012-09-17 22:47:36 -04:00

290 lines
8.0 KiB
C

/* GTK - The GIMP Toolkit
*
* Copyright (C) 2007 John Stowers, Neil Jagdish Patel.
* Copyright (C) 2009 Bastien Nocera, David Zeuthen
*
* 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; either
* version 2 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, see <http://www.gnu.org/licenses/>.
*
* Code adapted from egg-spinner
* by Christian Hergert <christian.hergert@gmail.com>
*/
/*
* Modified by the GTK+ Team and others 2007. See the AUTHORS
* file for a list of people on the GTK+ Team. See the ChangeLog
* files for a list of changes. These files are distributed with
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
#include "config.h"
#include "gtkspinner.h"
#include "gtkimage.h"
#include "gtkintl.h"
#include "gtkstylecontext.h"
#include "a11y/gtkspinneraccessible.h"
/**
* SECTION:gtkspinner
* @Short_description: Show a spinner animation
* @Title: GtkSpinner
* @See_also: #GtkCellRendererSpinner, #GtkProgressBar
*
* A GtkSpinner widget displays an icon-size spinning animation.
* It is often used as an alternative to a #GtkProgressBar for
* displaying indefinite activity, instead of actual progress.
*
* To start the animation, use gtk_spinner_start(), to stop it
* use gtk_spinner_stop().
*/
#define SPINNER_SIZE 12
enum {
PROP_0,
PROP_ACTIVE
};
struct _GtkSpinnerPrivate
{
gboolean active;
};
static gboolean gtk_spinner_draw (GtkWidget *widget,
cairo_t *cr);
static void gtk_spinner_get_property (GObject *object,
guint param_id,
GValue *value,
GParamSpec *pspec);
static void gtk_spinner_set_property (GObject *object,
guint param_id,
const GValue *value,
GParamSpec *pspec);
static void gtk_spinner_set_active (GtkSpinner *spinner,
gboolean active);
static void gtk_spinner_get_preferred_width (GtkWidget *widget,
gint *minimum_size,
gint *natural_size);
static void gtk_spinner_get_preferred_height (GtkWidget *widget,
gint *minimum_size,
gint *natural_size);
G_DEFINE_TYPE (GtkSpinner, gtk_spinner, GTK_TYPE_WIDGET)
static void
gtk_spinner_class_init (GtkSpinnerClass *klass)
{
GObjectClass *gobject_class;
GtkWidgetClass *widget_class;
gobject_class = G_OBJECT_CLASS(klass);
g_type_class_add_private (gobject_class, sizeof (GtkSpinnerPrivate));
gobject_class->get_property = gtk_spinner_get_property;
gobject_class->set_property = gtk_spinner_set_property;
widget_class = GTK_WIDGET_CLASS(klass);
widget_class->draw = gtk_spinner_draw;
widget_class->get_preferred_width = gtk_spinner_get_preferred_width;
widget_class->get_preferred_height = gtk_spinner_get_preferred_height;
/* GtkSpinner:active:
*
* Whether the spinner is active
*
* Since: 2.20
*/
g_object_class_install_property (gobject_class,
PROP_ACTIVE,
g_param_spec_boolean ("active",
P_("Active"),
P_("Whether the spinner is active"),
FALSE,
G_PARAM_READWRITE));
gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_SPINNER_ACCESSIBLE);
}
static void
gtk_spinner_get_property (GObject *object,
guint param_id,
GValue *value,
GParamSpec *pspec)
{
GtkSpinnerPrivate *priv;
priv = GTK_SPINNER (object)->priv;
switch (param_id)
{
case PROP_ACTIVE:
g_value_set_boolean (value, priv->active);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
}
}
static void
gtk_spinner_set_property (GObject *object,
guint param_id,
const GValue *value,
GParamSpec *pspec)
{
switch (param_id)
{
case PROP_ACTIVE:
gtk_spinner_set_active (GTK_SPINNER (object), g_value_get_boolean (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
}
}
static void
gtk_spinner_init (GtkSpinner *spinner)
{
GtkSpinnerPrivate *priv;
GtkStyleContext *context;
priv = G_TYPE_INSTANCE_GET_PRIVATE (spinner,
GTK_TYPE_SPINNER,
GtkSpinnerPrivate);
spinner->priv = priv;
gtk_widget_set_has_window (GTK_WIDGET (spinner), FALSE);
context = gtk_widget_get_style_context (GTK_WIDGET (spinner));
gtk_style_context_add_class (context, GTK_STYLE_CLASS_SPINNER);
}
static void
gtk_spinner_get_preferred_width (GtkWidget *widget,
gint *minimum_size,
gint *natural_size)
{
if (minimum_size)
*minimum_size = SPINNER_SIZE;
if (natural_size)
*natural_size = SPINNER_SIZE;
}
static void
gtk_spinner_get_preferred_height (GtkWidget *widget,
gint *minimum_size,
gint *natural_size)
{
if (minimum_size)
*minimum_size = SPINNER_SIZE;
if (natural_size)
*natural_size = SPINNER_SIZE;
}
static gboolean
gtk_spinner_draw (GtkWidget *widget,
cairo_t *cr)
{
GtkStyleContext *context;
gint width, height;
gint size;
context = gtk_widget_get_style_context (widget);
width = gtk_widget_get_allocated_width (widget);
height = gtk_widget_get_allocated_height (widget);
size = MIN (width, height);
gtk_render_activity (context, cr,
(width - size) / 2,
(height - size) / 2,
size, size);
return FALSE;
}
static void
gtk_spinner_set_active (GtkSpinner *spinner,
gboolean active)
{
GtkSpinnerPrivate *priv = spinner->priv;
active = !!active;
if (priv->active != active)
{
priv->active = active;
g_object_notify (G_OBJECT (spinner), "active");
if (active)
gtk_widget_set_state_flags (GTK_WIDGET (spinner),
GTK_STATE_FLAG_ACTIVE, FALSE);
else
gtk_widget_unset_state_flags (GTK_WIDGET (spinner),
GTK_STATE_FLAG_ACTIVE);
}
}
/**
* gtk_spinner_new:
*
* Returns a new spinner widget. Not yet started.
*
* Return value: a new #GtkSpinner
*
* Since: 2.20
*/
GtkWidget *
gtk_spinner_new (void)
{
return g_object_new (GTK_TYPE_SPINNER, NULL);
}
/**
* gtk_spinner_start:
* @spinner: a #GtkSpinner
*
* Starts the animation of the spinner.
*
* Since: 2.20
*/
void
gtk_spinner_start (GtkSpinner *spinner)
{
g_return_if_fail (GTK_IS_SPINNER (spinner));
gtk_spinner_set_active (spinner, TRUE);
}
/**
* gtk_spinner_stop:
* @spinner: a #GtkSpinner
*
* Stops the animation of the spinner.
*
* Since: 2.20
*/
void
gtk_spinner_stop (GtkSpinner *spinner)
{
g_return_if_fail (GTK_IS_SPINNER (spinner));
gtk_spinner_set_active (spinner, FALSE);
}