1 /* GTK - The GIMP Toolkit
3 * Copyright (C) 2007 John Stowers, Neil Jagdish Patel.
4 * Copyright (C) 2009 Bastien Nocera, David Zeuthen
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
21 * Code adapted from egg-spinner
22 * by Christian Hergert <christian.hergert@gmail.com>
26 * Modified by the GTK+ Team and others 2007. See the AUTHORS
27 * file for a list of people on the GTK+ Team. See the ChangeLog
28 * files for a list of changes. These files are distributed with
29 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
35 #include "gtkaccessible.h"
37 #include "gtkspinner.h"
44 * @Short_description: Show a spinner animation
46 * @See_also: #GtkCellRendererSpinner, #GtkProgressBar
48 * A GtkSpinner widget displays an icon-size spinning animation.
49 * It is often used as an alternative to a #GtkProgressBar for
50 * displaying indefinite activity, instead of actual progress.
52 * To start the animation, use gtk_spinner_start(), to stop it
53 * use gtk_spinner_stop().
57 #define GTK_SPINNER_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_SPINNER, GtkSpinnerPrivate))
59 G_DEFINE_TYPE (GtkSpinner, gtk_spinner, GTK_TYPE_DRAWING_AREA);
66 struct _GtkSpinnerPrivate
75 static void gtk_spinner_class_init (GtkSpinnerClass *klass);
76 static void gtk_spinner_init (GtkSpinner *spinner);
77 static void gtk_spinner_dispose (GObject *gobject);
78 static void gtk_spinner_realize (GtkWidget *widget);
79 static void gtk_spinner_unrealize (GtkWidget *widget);
80 static gboolean gtk_spinner_expose (GtkWidget *widget,
81 GdkEventExpose *event);
82 static void gtk_spinner_screen_changed (GtkWidget *widget,
83 GdkScreen *old_screen);
84 static void gtk_spinner_style_set (GtkWidget *widget,
85 GtkStyle *prev_style);
86 static void gtk_spinner_get_property (GObject *object,
90 static void gtk_spinner_set_property (GObject *object,
94 static void gtk_spinner_set_active (GtkSpinner *spinner,
96 static AtkObject *gtk_spinner_get_accessible (GtkWidget *widget);
97 static GType gtk_spinner_accessible_get_type (void);
100 gtk_spinner_class_init (GtkSpinnerClass *klass)
102 GObjectClass *gobject_class;
103 GtkWidgetClass *widget_class;
105 gobject_class = G_OBJECT_CLASS(klass);
106 g_type_class_add_private (gobject_class, sizeof (GtkSpinnerPrivate));
107 gobject_class->dispose = gtk_spinner_dispose;
108 gobject_class->get_property = gtk_spinner_get_property;
109 gobject_class->set_property = gtk_spinner_set_property;
111 widget_class = GTK_WIDGET_CLASS(klass);
112 widget_class->expose_event = gtk_spinner_expose;
113 widget_class->realize = gtk_spinner_realize;
114 widget_class->unrealize = gtk_spinner_unrealize;
115 widget_class->screen_changed = gtk_spinner_screen_changed;
116 widget_class->style_set = gtk_spinner_style_set;
117 widget_class->get_accessible = gtk_spinner_get_accessible;
119 /* GtkSpinner:active:
121 * Whether the spinner is active
125 g_object_class_install_property (gobject_class,
127 g_param_spec_boolean ("active",
129 P_("Whether the spinner is active"),
133 * GtkSpinner:num-steps:
135 * The number of steps for the spinner to complete a full loop.
136 * The animation will complete a full cycle in one second by default
137 * (see the #GtkSpinner:cycle-duration style property).
141 gtk_widget_class_install_style_property (widget_class,
142 g_param_spec_uint ("num-steps",
143 P_("Number of steps"),
144 P_("The number of steps for the spinner to complete a full loop. The animation will complete a full cycle in one second by default (see #GtkSpinner:cycle-duration)."),
151 * GtkSpinner:cycle-duration:
153 * The duration in milliseconds for the spinner to complete a full cycle.
157 gtk_widget_class_install_style_property (widget_class,
158 g_param_spec_uint ("cycle-duration",
159 P_("Animation duration"),
160 P_("The length of time in milliseconds for the spinner to complete a full loop"),
168 gtk_spinner_get_property (GObject *object,
173 GtkSpinnerPrivate *priv;
175 priv = GTK_SPINNER (object)->priv;
180 g_value_set_boolean (value, priv->active);
183 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
188 gtk_spinner_set_property (GObject *object,
196 gtk_spinner_set_active (GTK_SPINNER (object), g_value_get_boolean (value));
199 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
204 gtk_spinner_init (GtkSpinner *spinner)
206 GtkSpinnerPrivate *priv;
208 priv = GTK_SPINNER_GET_PRIVATE (spinner);
212 spinner->priv = priv;
214 GTK_WIDGET_SET_FLAGS (GTK_WIDGET (spinner), GTK_NO_WINDOW);
218 gtk_spinner_expose (GtkWidget *widget, GdkEventExpose *event)
220 GtkStateType state_type;
221 GtkSpinnerPrivate *priv;
224 priv = GTK_SPINNER (widget)->priv;
226 width = widget->allocation.width;
227 height = widget->allocation.height;
229 if ((width < 12) || (height <12))
230 gtk_widget_set_size_request (widget, 12, 12);
232 state_type = GTK_STATE_NORMAL;
233 if (!GTK_WIDGET_IS_SENSITIVE (widget))
234 state_type = GTK_STATE_INSENSITIVE;
236 gtk_paint_spinner (widget->style,
240 event->area.x, event->area.y,
241 event->area.width, event->area.height);
247 gtk_spinner_timeout (gpointer data)
249 GtkSpinnerPrivate *priv;
251 priv = GTK_SPINNER (data)->priv;
253 if (priv->current + 1 >= priv->num_steps)
258 gtk_widget_queue_draw (GTK_WIDGET (data));
264 gtk_spinner_add_timeout (GtkSpinner *spinner)
266 GtkSpinnerPrivate *priv;
268 priv = spinner->priv;
270 priv->timeout = gdk_threads_add_timeout ((guint) priv->cycle_duration / priv->num_steps, gtk_spinner_timeout, spinner);
274 gtk_spinner_remove_timeout (GtkSpinner *spinner)
276 GtkSpinnerPrivate *priv;
278 priv = spinner->priv;
280 g_source_remove (priv->timeout);
285 gtk_spinner_realize (GtkWidget *widget)
287 GtkSpinnerPrivate *priv;
289 priv = GTK_SPINNER (widget)->priv;
291 GTK_WIDGET_CLASS (gtk_spinner_parent_class)->realize (widget);
294 gtk_spinner_add_timeout (GTK_SPINNER (widget));
298 gtk_spinner_unrealize (GtkWidget *widget)
300 GtkSpinnerPrivate *priv;
302 priv = GTK_SPINNER (widget)->priv;
304 if (priv->timeout != 0)
306 gtk_spinner_remove_timeout (GTK_SPINNER (widget));
309 GTK_WIDGET_CLASS (gtk_spinner_parent_class)->unrealize (widget);
313 gtk_spinner_screen_changed (GtkWidget* widget, GdkScreen* old_screen)
316 GdkScreen* new_screen;
317 GdkColormap* colormap;
319 spinner = GTK_SPINNER (widget);
321 new_screen = gtk_widget_get_screen (widget);
322 colormap = gdk_screen_get_rgba_colormap (new_screen);
326 colormap = gdk_screen_get_rgb_colormap (new_screen);
329 gtk_widget_set_colormap (widget, colormap);
333 gtk_spinner_style_set (GtkWidget *widget,
334 GtkStyle *prev_style)
336 GtkSpinnerPrivate *priv;
338 priv = GTK_SPINNER (widget)->priv;
340 gtk_widget_style_get (GTK_WIDGET (widget),
341 "num-steps", &(priv->num_steps),
342 "cycle-duration", &(priv->cycle_duration),
345 if (priv->current > priv->num_steps)
350 gtk_spinner_dispose (GObject *gobject)
352 GtkSpinnerPrivate *priv;
354 priv = GTK_SPINNER (gobject)->priv;
356 if (priv->timeout != 0)
358 gtk_spinner_remove_timeout (GTK_SPINNER (gobject));
361 G_OBJECT_CLASS (gtk_spinner_parent_class)->dispose (gobject);
365 gtk_spinner_set_active (GtkSpinner *spinner, gboolean active)
367 GtkSpinnerPrivate *priv;
369 active = active != FALSE;
371 priv = GTK_SPINNER (spinner)->priv;
373 if (priv->active != active)
375 priv->active = active;
376 g_object_notify (G_OBJECT (spinner), "active");
378 if (active && GTK_WIDGET_REALIZED (GTK_WIDGET (spinner)) && priv->timeout == 0)
380 gtk_spinner_add_timeout (spinner);
382 else if (!active && priv->timeout != 0)
384 gtk_spinner_remove_timeout (spinner);
390 gtk_spinner_accessible_factory_get_accessible_type (void)
392 return gtk_spinner_accessible_get_type ();
396 gtk_spinner_accessible_new (GObject *obj)
398 AtkObject *accessible;
400 g_return_val_if_fail (GTK_IS_WIDGET (obj), NULL);
402 accessible = g_object_new (gtk_spinner_accessible_get_type (), NULL);
403 atk_object_initialize (accessible, obj);
409 gtk_spinner_accessible_factory_create_accessible (GObject *obj)
411 return gtk_spinner_accessible_new (obj);
415 gtk_spinner_accessible_factory_class_init (AtkObjectFactoryClass *klass)
417 klass->create_accessible = gtk_spinner_accessible_factory_create_accessible;
418 klass->get_accessible_type = gtk_spinner_accessible_factory_get_accessible_type;
422 gtk_spinner_accessible_factory_get_type (void)
424 static GType type = 0;
428 const GTypeInfo tinfo =
430 sizeof (AtkObjectFactoryClass),
431 NULL, /* base_init */
432 NULL, /* base_finalize */
433 (GClassInitFunc) gtk_spinner_accessible_factory_class_init,
434 NULL, /* class_finalize */
435 NULL, /* class_data */
436 sizeof (AtkObjectFactory),
441 type = g_type_register_static (ATK_TYPE_OBJECT_FACTORY,
442 I_("GtkSpinnerAccessibleFactory"),
448 static AtkObjectClass *a11y_parent_class = NULL;
451 gtk_spinner_accessible_initialize (AtkObject *accessible,
454 atk_object_set_name (accessible, _("Spinner"));
455 atk_object_set_description (accessible, _("Provides visual status"));
457 a11y_parent_class->initialize (accessible, widget);
461 gtk_spinner_accessible_class_init (AtkObjectClass *klass)
463 a11y_parent_class = g_type_class_peek_parent (klass);
465 klass->initialize = gtk_spinner_accessible_initialize;
469 gtk_spinner_accessible_image_get_size (AtkImage *image,
475 widget = GTK_ACCESSIBLE (image)->widget;
478 *width = *height = 0;
482 *width = widget->allocation.width;
483 *height = widget->allocation.height;
488 gtk_spinner_accessible_image_interface_init (AtkImageIface *iface)
490 iface->get_image_size = gtk_spinner_accessible_image_get_size;
494 gtk_spinner_accessible_get_type (void)
496 static GType type = 0;
500 if (G_UNLIKELY (type == 0))
502 const GInterfaceInfo atk_image_info = {
503 (GInterfaceInitFunc) gtk_spinner_accessible_image_interface_init,
504 (GInterfaceFinalizeFunc) NULL,
508 GType parent_atk_type;
509 GTypeInfo tinfo = { 0 };
511 AtkObjectFactory *factory;
513 if ((type = g_type_from_name ("GtkSpinnerAccessible")))
516 factory = atk_registry_get_factory (atk_get_default_registry (),
519 return G_TYPE_INVALID;
521 parent_atk_type = atk_object_factory_get_accessible_type (factory);
522 if (!parent_atk_type)
523 return G_TYPE_INVALID;
526 * Figure out the size of the class and instance
527 * we are deriving from
529 g_type_query (parent_atk_type, &query);
531 tinfo.class_init = (GClassInitFunc) gtk_spinner_accessible_class_init;
532 tinfo.class_size = query.class_size;
533 tinfo.instance_size = query.instance_size;
535 /* Register the type */
536 type = g_type_register_static (parent_atk_type,
537 "GtkSpinnerAccessible",
540 g_type_add_interface_static (type, ATK_TYPE_IMAGE,
548 gtk_spinner_get_accessible (GtkWidget *widget)
550 static gboolean first_time = TRUE;
554 AtkObjectFactory *factory;
555 AtkRegistry *registry;
557 GType derived_atk_type;
560 * Figure out whether accessibility is enabled by looking at the
561 * type of the accessible object which would be created for
562 * the parent type of GtkSpinner.
564 derived_type = g_type_parent (GTK_TYPE_SPINNER);
566 registry = atk_get_default_registry ();
567 factory = atk_registry_get_factory (registry,
569 derived_atk_type = atk_object_factory_get_accessible_type (factory);
570 if (g_type_is_a (derived_atk_type, GTK_TYPE_ACCESSIBLE))
571 atk_registry_set_factory_type (registry,
573 gtk_spinner_accessible_factory_get_type ());
576 return GTK_WIDGET_CLASS (gtk_spinner_parent_class)->get_accessible (widget);
582 * Returns a new spinner widget. Not yet started.
584 * Return value: a new #GtkSpinner
589 gtk_spinner_new (void)
591 return g_object_new (GTK_TYPE_SPINNER, NULL);
596 * @spinner: a #GtkSpinner
598 * Starts the animation of the spinner.
603 gtk_spinner_start (GtkSpinner *spinner)
605 g_return_if_fail (GTK_IS_SPINNER (spinner));
607 gtk_spinner_set_active (spinner, TRUE);
612 * @spinner: a #GtkSpinner
614 * Stops the animation of the spinner.
619 gtk_spinner_stop (GtkSpinner *spinner)
621 g_return_if_fail (GTK_IS_SPINNER (spinner));
623 gtk_spinner_set_active (spinner, FALSE);
626 #define __GTK_SPINNER_C__
627 #include "gtkaliasdef.c"