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,
219 GdkEventExpose *event)
221 GtkStateType state_type;
222 GtkSpinnerPrivate *priv;
225 priv = GTK_SPINNER (widget)->priv;
227 width = widget->allocation.width;
228 height = widget->allocation.height;
230 if ((width < 12) || (height <12))
231 gtk_widget_set_size_request (widget, 12, 12);
233 state_type = GTK_STATE_NORMAL;
234 if (!gtk_widget_is_sensitive (widget))
235 state_type = GTK_STATE_INSENSITIVE;
237 gtk_paint_spinner (widget->style,
244 event->area.x, event->area.y,
245 event->area.width, event->area.height);
251 gtk_spinner_timeout (gpointer data)
253 GtkSpinnerPrivate *priv;
255 priv = GTK_SPINNER (data)->priv;
257 if (priv->current + 1 >= priv->num_steps)
262 gtk_widget_queue_draw (GTK_WIDGET (data));
268 gtk_spinner_add_timeout (GtkSpinner *spinner)
270 GtkSpinnerPrivate *priv;
272 priv = spinner->priv;
274 priv->timeout = gdk_threads_add_timeout ((guint) priv->cycle_duration / priv->num_steps, gtk_spinner_timeout, spinner);
278 gtk_spinner_remove_timeout (GtkSpinner *spinner)
280 GtkSpinnerPrivate *priv;
282 priv = spinner->priv;
284 g_source_remove (priv->timeout);
289 gtk_spinner_realize (GtkWidget *widget)
291 GtkSpinnerPrivate *priv;
293 priv = GTK_SPINNER (widget)->priv;
295 GTK_WIDGET_CLASS (gtk_spinner_parent_class)->realize (widget);
298 gtk_spinner_add_timeout (GTK_SPINNER (widget));
302 gtk_spinner_unrealize (GtkWidget *widget)
304 GtkSpinnerPrivate *priv;
306 priv = GTK_SPINNER (widget)->priv;
308 if (priv->timeout != 0)
310 gtk_spinner_remove_timeout (GTK_SPINNER (widget));
313 GTK_WIDGET_CLASS (gtk_spinner_parent_class)->unrealize (widget);
317 gtk_spinner_screen_changed (GtkWidget* widget, GdkScreen* old_screen)
320 GdkScreen* new_screen;
321 GdkColormap* colormap;
323 spinner = GTK_SPINNER (widget);
325 new_screen = gtk_widget_get_screen (widget);
326 colormap = gdk_screen_get_rgba_colormap (new_screen);
330 colormap = gdk_screen_get_rgb_colormap (new_screen);
333 gtk_widget_set_colormap (widget, colormap);
337 gtk_spinner_style_set (GtkWidget *widget,
338 GtkStyle *prev_style)
340 GtkSpinnerPrivate *priv;
342 priv = GTK_SPINNER (widget)->priv;
344 gtk_widget_style_get (GTK_WIDGET (widget),
345 "num-steps", &(priv->num_steps),
346 "cycle-duration", &(priv->cycle_duration),
349 if (priv->current > priv->num_steps)
354 gtk_spinner_dispose (GObject *gobject)
356 GtkSpinnerPrivate *priv;
358 priv = GTK_SPINNER (gobject)->priv;
360 if (priv->timeout != 0)
362 gtk_spinner_remove_timeout (GTK_SPINNER (gobject));
365 G_OBJECT_CLASS (gtk_spinner_parent_class)->dispose (gobject);
369 gtk_spinner_set_active (GtkSpinner *spinner, gboolean active)
371 GtkSpinnerPrivate *priv;
373 active = active != FALSE;
375 priv = GTK_SPINNER (spinner)->priv;
377 if (priv->active != active)
379 priv->active = active;
380 g_object_notify (G_OBJECT (spinner), "active");
382 if (active && gtk_widget_get_realized (GTK_WIDGET (spinner)) && priv->timeout == 0)
384 gtk_spinner_add_timeout (spinner);
386 else if (!active && priv->timeout != 0)
388 gtk_spinner_remove_timeout (spinner);
394 gtk_spinner_accessible_factory_get_accessible_type (void)
396 return gtk_spinner_accessible_get_type ();
400 gtk_spinner_accessible_new (GObject *obj)
402 AtkObject *accessible;
404 g_return_val_if_fail (GTK_IS_WIDGET (obj), NULL);
406 accessible = g_object_new (gtk_spinner_accessible_get_type (), NULL);
407 atk_object_initialize (accessible, obj);
413 gtk_spinner_accessible_factory_create_accessible (GObject *obj)
415 return gtk_spinner_accessible_new (obj);
419 gtk_spinner_accessible_factory_class_init (AtkObjectFactoryClass *klass)
421 klass->create_accessible = gtk_spinner_accessible_factory_create_accessible;
422 klass->get_accessible_type = gtk_spinner_accessible_factory_get_accessible_type;
426 gtk_spinner_accessible_factory_get_type (void)
428 static GType type = 0;
432 const GTypeInfo tinfo =
434 sizeof (AtkObjectFactoryClass),
435 NULL, /* base_init */
436 NULL, /* base_finalize */
437 (GClassInitFunc) gtk_spinner_accessible_factory_class_init,
438 NULL, /* class_finalize */
439 NULL, /* class_data */
440 sizeof (AtkObjectFactory),
445 type = g_type_register_static (ATK_TYPE_OBJECT_FACTORY,
446 I_("GtkSpinnerAccessibleFactory"),
452 static AtkObjectClass *a11y_parent_class = NULL;
455 gtk_spinner_accessible_initialize (AtkObject *accessible,
458 atk_object_set_name (accessible, C_("throbbing progress animation widget", "Spinner"));
459 atk_object_set_description (accessible, _("Provides visual indication of progress"));
461 a11y_parent_class->initialize (accessible, widget);
465 gtk_spinner_accessible_class_init (AtkObjectClass *klass)
467 a11y_parent_class = g_type_class_peek_parent (klass);
469 klass->initialize = gtk_spinner_accessible_initialize;
473 gtk_spinner_accessible_image_get_size (AtkImage *image,
479 widget = GTK_ACCESSIBLE (image)->widget;
482 *width = *height = 0;
486 *width = widget->allocation.width;
487 *height = widget->allocation.height;
492 gtk_spinner_accessible_image_interface_init (AtkImageIface *iface)
494 iface->get_image_size = gtk_spinner_accessible_image_get_size;
498 gtk_spinner_accessible_get_type (void)
500 static GType type = 0;
504 if (G_UNLIKELY (type == 0))
506 const GInterfaceInfo atk_image_info = {
507 (GInterfaceInitFunc) gtk_spinner_accessible_image_interface_init,
508 (GInterfaceFinalizeFunc) NULL,
512 GType parent_atk_type;
513 GTypeInfo tinfo = { 0 };
515 AtkObjectFactory *factory;
517 if ((type = g_type_from_name ("GtkSpinnerAccessible")))
520 factory = atk_registry_get_factory (atk_get_default_registry (),
523 return G_TYPE_INVALID;
525 parent_atk_type = atk_object_factory_get_accessible_type (factory);
526 if (!parent_atk_type)
527 return G_TYPE_INVALID;
530 * Figure out the size of the class and instance
531 * we are deriving from
533 g_type_query (parent_atk_type, &query);
535 tinfo.class_init = (GClassInitFunc) gtk_spinner_accessible_class_init;
536 tinfo.class_size = query.class_size;
537 tinfo.instance_size = query.instance_size;
539 /* Register the type */
540 type = g_type_register_static (parent_atk_type,
541 "GtkSpinnerAccessible",
544 g_type_add_interface_static (type, ATK_TYPE_IMAGE,
552 gtk_spinner_get_accessible (GtkWidget *widget)
554 static gboolean first_time = TRUE;
558 AtkObjectFactory *factory;
559 AtkRegistry *registry;
561 GType derived_atk_type;
564 * Figure out whether accessibility is enabled by looking at the
565 * type of the accessible object which would be created for
566 * the parent type of GtkSpinner.
568 derived_type = g_type_parent (GTK_TYPE_SPINNER);
570 registry = atk_get_default_registry ();
571 factory = atk_registry_get_factory (registry,
573 derived_atk_type = atk_object_factory_get_accessible_type (factory);
574 if (g_type_is_a (derived_atk_type, GTK_TYPE_ACCESSIBLE))
575 atk_registry_set_factory_type (registry,
577 gtk_spinner_accessible_factory_get_type ());
580 return GTK_WIDGET_CLASS (gtk_spinner_parent_class)->get_accessible (widget);
586 * Returns a new spinner widget. Not yet started.
588 * Return value: a new #GtkSpinner
593 gtk_spinner_new (void)
595 return g_object_new (GTK_TYPE_SPINNER, NULL);
600 * @spinner: a #GtkSpinner
602 * Starts the animation of the spinner.
607 gtk_spinner_start (GtkSpinner *spinner)
609 g_return_if_fail (GTK_IS_SPINNER (spinner));
611 gtk_spinner_set_active (spinner, TRUE);
616 * @spinner: a #GtkSpinner
618 * Stops the animation of the spinner.
623 gtk_spinner_stop (GtkSpinner *spinner)
625 g_return_if_fail (GTK_IS_SPINNER (spinner));
627 gtk_spinner_set_active (spinner, FALSE);
630 #define __GTK_SPINNER_C__
631 #include "gtkaliasdef.c"