Pileus Git - ~andy/gtk/blob - gtk/gtkspinner.c

   1 /* GTK - The GIMP Toolkit
   2  *
   3  * Copyright (C) 2007 John Stowers, Neil Jagdish Patel.
   4  * Copyright (C) 2009 Bastien Nocera, David Zeuthen
   5  *
   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.
  10  *
  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.
  15  *
  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.
  20  *
  21  * Code adapted from egg-spinner
  22  * by Christian Hergert <christian.hergert@gmail.com>
  23  */
  24
  25 /*
  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/.
  30  */
  31
  32 #include "config.h"
  33
  34 #include "gtkintl.h"
  35 #include "gtkaccessible.h"
  36 #include "gtkimage.h"
  37 #include "gtkspinner.h"
  38 #include "gtkstyle.h"
  39 #include "gtkalias.h"
  40
  41
  42 /**
  43  * SECTION:gtkspinner
  44  * @Short_description: Show a spinner animation
  45  * @Title: GtkSpinner
  46  * @See_also: #GtkCellRendererSpinner, #GtkProgressBar
  47  *
  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.
  51  *
  52  * To start the animation, use gtk_spinner_start(), to stop it
  53  * use gtk_spinner_stop().
  54  */
  55
  56
  57 #define GTK_SPINNER_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_SPINNER, GtkSpinnerPrivate))
  58
  59 G_DEFINE_TYPE (GtkSpinner, gtk_spinner, GTK_TYPE_DRAWING_AREA);
  60
  61 enum {
  62   PROP_0,
  63   PROP_ACTIVE
  64 };
  65
  66 struct _GtkSpinnerPrivate
  67 {
  68   guint current;
  69   guint num_steps;
  70   guint cycle_duration;
  71   gboolean active;
  72   guint timeout;
  73 };
  74
  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,
  87                                         guint            param_id,
  88                                         GValue          *value,
  89                                         GParamSpec      *pspec);
  90 static void gtk_spinner_set_property   (GObject         *object,
  91                                         guint            param_id,
  92                                         const GValue    *value,
  93                                         GParamSpec      *pspec);
  94 static void gtk_spinner_set_active     (GtkSpinner      *spinner,
  95                                         gboolean         active);
  96 static AtkObject *gtk_spinner_get_accessible      (GtkWidget *widget);
  97 static GType      gtk_spinner_accessible_get_type (void);
  98
  99 static void
 100 gtk_spinner_class_init (GtkSpinnerClass *klass)
 101 {
 102   GObjectClass *gobject_class;
 103   GtkWidgetClass *widget_class;
 104
 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;
 110
 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;
 118
 119   /* GtkSpinner:active:
 120    *
 121    * Whether the spinner is active
 122    *
 123    * Since: 2.20
 124    */
 125   g_object_class_install_property (gobject_class,
 126                                    PROP_ACTIVE,
 127                                    g_param_spec_boolean ("active",
 128                                                          P_("Active"),
 129                                                          P_("Whether the spinner is active"),
 130                                                          FALSE,
 131                                                          G_PARAM_READWRITE));
 132   /**
 133    * GtkSpinner:num-steps:
 134    *
 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).
 138    *
 139    * Since: 2.20
 140    */
 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)."),
 145                                                              1,
 146                                                              G_MAXUINT,
 147                                                              12,
 148                                                              G_PARAM_READABLE));
 149
 150   /**
 151    * GtkSpinner:cycle-duration:
 152    *
 153    * The duration in milliseconds for the spinner to complete a full cycle.
 154    *
 155    * Since: 2.20
 156    */
 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"),
 161                                                              500,
 162                                                              G_MAXUINT,
 163                                                              1000,
 164                                                              G_PARAM_READABLE));
 165 }
 166
 167 static void
 168 gtk_spinner_get_property (GObject    *object,
 169                           guint       param_id,
 170                           GValue     *value,
 171                           GParamSpec *pspec)
 172 {
 173   GtkSpinnerPrivate *priv;
 174
 175   priv = GTK_SPINNER (object)->priv;
 176
 177   switch (param_id)
 178     {
 179       case PROP_ACTIVE:
 180         g_value_set_boolean (value, priv->active);
 181         break;
 182       default:
 183         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
 184     }
 185 }
 186
 187 static void
 188 gtk_spinner_set_property (GObject      *object,
 189                           guint         param_id,
 190                           const GValue *value,
 191                           GParamSpec   *pspec)
 192 {
 193   switch (param_id)
 194     {
 195       case PROP_ACTIVE:
 196         gtk_spinner_set_active (GTK_SPINNER (object), g_value_get_boolean (value));
 197         break;
 198       default:
 199         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
 200     }
 201 }
 202
 203 static void
 204 gtk_spinner_init (GtkSpinner *spinner)
 205 {
 206   GtkSpinnerPrivate *priv;
 207
 208   priv = GTK_SPINNER_GET_PRIVATE (spinner);
 209   priv->current = 0;
 210   priv->timeout = 0;
 211
 212   spinner->priv = priv;
 213
 214   GTK_WIDGET_SET_FLAGS (GTK_WIDGET (spinner), GTK_NO_WINDOW);
 215 }
 216
 217 static gboolean
 218 gtk_spinner_expose (GtkWidget *widget, GdkEventExpose *event)
 219 {
 220   GtkStateType state_type;
 221   GtkSpinnerPrivate *priv;
 222   int width, height;
 223
 224   priv = GTK_SPINNER (widget)->priv;
 225
 226   width = widget->allocation.width;
 227   height = widget->allocation.height;
 228
 229   if ((width < 12) || (height <12))
 230     gtk_widget_set_size_request (widget, 12, 12);
 231
 232   state_type = GTK_STATE_NORMAL;
 233   if (!GTK_WIDGET_IS_SENSITIVE (widget))
 234    state_type = GTK_STATE_INSENSITIVE;
 235
 236   gtk_paint_spinner (widget->style,
 237                      widget->window,
 238                      state_type,
 239                      priv->current,
 240                      event->area.x, event->area.y,
 241                      event->area.width, event->area.height);
 242
 243   return FALSE;
 244 }
 245
 246 static gboolean
 247 gtk_spinner_timeout (gpointer data)
 248 {
 249   GtkSpinnerPrivate *priv;
 250
 251   priv = GTK_SPINNER (data)->priv;
 252
 253   if (priv->current + 1 >= priv->num_steps)
 254     priv->current = 0;
 255   else
 256     priv->current++;
 257
 258   gtk_widget_queue_draw (GTK_WIDGET (data));
 259
 260   return TRUE;
 261 }
 262
 263 static void
 264 gtk_spinner_add_timeout (GtkSpinner *spinner)
 265 {
 266   GtkSpinnerPrivate *priv;
 267
 268   priv = spinner->priv;
 269
 270   priv->timeout = gdk_threads_add_timeout ((guint) priv->cycle_duration / priv->num_steps, gtk_spinner_timeout, spinner);
 271 }
 272
 273 static void
 274 gtk_spinner_remove_timeout (GtkSpinner *spinner)
 275 {
 276   GtkSpinnerPrivate *priv;
 277
 278   priv = spinner->priv;
 279
 280   g_source_remove (priv->timeout);
 281   priv->timeout = 0;
 282 }
 283
 284 static void
 285 gtk_spinner_realize (GtkWidget *widget)
 286 {
 287   GtkSpinnerPrivate *priv;
 288
 289   priv = GTK_SPINNER (widget)->priv;
 290
 291   GTK_WIDGET_CLASS (gtk_spinner_parent_class)->realize (widget);
 292
 293   if (priv->active)
 294     gtk_spinner_add_timeout (GTK_SPINNER (widget));
 295 }
 296
 297 static void
 298 gtk_spinner_unrealize (GtkWidget *widget)
 299 {
 300   GtkSpinnerPrivate *priv;
 301
 302   priv = GTK_SPINNER (widget)->priv;
 303
 304   if (priv->timeout != 0)
 305     {
 306       gtk_spinner_remove_timeout (GTK_SPINNER (widget));
 307     }
 308
 309   GTK_WIDGET_CLASS (gtk_spinner_parent_class)->unrealize (widget);
 310 }
 311
 312 static void
 313 gtk_spinner_screen_changed (GtkWidget* widget, GdkScreen* old_screen)
 314 {
 315   GtkSpinner *spinner;
 316   GdkScreen* new_screen;
 317   GdkColormap* colormap;
 318
 319   spinner = GTK_SPINNER (widget);
 320
 321   new_screen = gtk_widget_get_screen (widget);
 322   colormap = gdk_screen_get_rgba_colormap (new_screen);
 323
 324   if (!colormap)
 325     {
 326       colormap = gdk_screen_get_rgb_colormap (new_screen);
 327     }
 328
 329   gtk_widget_set_colormap (widget, colormap);
 330 }
 331
 332 static void
 333 gtk_spinner_style_set (GtkWidget *widget,
 334                        GtkStyle  *prev_style)
 335 {
 336   GtkSpinnerPrivate *priv;
 337
 338   priv = GTK_SPINNER (widget)->priv;
 339
 340   gtk_widget_style_get (GTK_WIDGET (widget),
 341                         "num-steps", &(priv->num_steps),
 342                         "cycle-duration", &(priv->cycle_duration),
 343                         NULL);
 344
 345   if (priv->current > priv->num_steps)
 346     priv->current = 0;
 347 }
 348
 349 static void
 350 gtk_spinner_dispose (GObject *gobject)
 351 {
 352   GtkSpinnerPrivate *priv;
 353
 354   priv = GTK_SPINNER (gobject)->priv;
 355
 356   if (priv->timeout != 0)
 357     {
 358       gtk_spinner_remove_timeout (GTK_SPINNER (gobject));
 359     }
 360
 361   G_OBJECT_CLASS (gtk_spinner_parent_class)->dispose (gobject);
 362 }
 363
 364 static void
 365 gtk_spinner_set_active (GtkSpinner *spinner, gboolean active)
 366 {
 367   GtkSpinnerPrivate *priv;
 368
 369   active = active != FALSE;
 370
 371   priv = GTK_SPINNER (spinner)->priv;
 372
 373   if (priv->active != active)
 374     {
 375       priv->active = active;
 376       g_object_notify (G_OBJECT (spinner), "active");
 377
 378       if (active && GTK_WIDGET_REALIZED (GTK_WIDGET (spinner)) && priv->timeout == 0)
 379         {
 380           gtk_spinner_add_timeout (spinner);
 381         }
 382       else if (!active && priv->timeout != 0)
 383         {
 384           gtk_spinner_remove_timeout (spinner);
 385         }
 386     }
 387 }
 388
 389 static GType
 390 gtk_spinner_accessible_factory_get_accessible_type (void)
 391 {
 392   return gtk_spinner_accessible_get_type ();
 393 }
 394
 395 static AtkObject *
 396 gtk_spinner_accessible_new (GObject *obj)
 397 {
 398   AtkObject *accessible;
 399
 400   g_return_val_if_fail (GTK_IS_WIDGET (obj), NULL);
 401
 402   accessible = g_object_new (gtk_spinner_accessible_get_type (), NULL);
 403   atk_object_initialize (accessible, obj);
 404
 405   return accessible;
 406 }
 407
 408 static AtkObject*
 409 gtk_spinner_accessible_factory_create_accessible (GObject *obj)
 410 {
 411   return gtk_spinner_accessible_new (obj);
 412 }
 413
 414 static void
 415 gtk_spinner_accessible_factory_class_init (AtkObjectFactoryClass *klass)
 416 {
 417   klass->create_accessible = gtk_spinner_accessible_factory_create_accessible;
 418   klass->get_accessible_type = gtk_spinner_accessible_factory_get_accessible_type;
 419 }
 420
 421 static GType
 422 gtk_spinner_accessible_factory_get_type (void)
 423 {
 424   static GType type = 0;
 425
 426   if (!type)
 427     {
 428       const GTypeInfo tinfo =
 429       {
 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),
 437         0,             /* n_preallocs */
 438         NULL, NULL
 439       };
 440
 441       type = g_type_register_static (ATK_TYPE_OBJECT_FACTORY,
 442                                     I_("GtkSpinnerAccessibleFactory"),
 443                                     &tinfo, 0);
 444     }
 445   return type;
 446 }
 447
 448 static AtkObjectClass *a11y_parent_class = NULL;
 449
 450 static void
 451 gtk_spinner_accessible_initialize (AtkObject *accessible,
 452                                    gpointer   widget)
 453 {
 454   atk_object_set_name (accessible, C_("throbbing progress animation widget", "Spinner"));
 455   atk_object_set_description (accessible, _("Provides visual indication of progress"));
 456
 457   a11y_parent_class->initialize (accessible, widget);
 458 }
 459
 460 static void
 461 gtk_spinner_accessible_class_init (AtkObjectClass *klass)
 462 {
 463   a11y_parent_class = g_type_class_peek_parent (klass);
 464
 465   klass->initialize = gtk_spinner_accessible_initialize;
 466 }
 467
 468 static void
 469 gtk_spinner_accessible_image_get_size (AtkImage *image,
 470                                        gint     *width,
 471                                        gint     *height)
 472 {
 473   GtkWidget *widget;
 474
 475   widget = GTK_ACCESSIBLE (image)->widget;
 476   if (!widget)
 477     {
 478       *width = *height = 0;
 479     }
 480   else
 481     {
 482       *width = widget->allocation.width;
 483       *height = widget->allocation.height;
 484     }
 485 }
 486
 487 static void
 488 gtk_spinner_accessible_image_interface_init (AtkImageIface *iface)
 489 {
 490   iface->get_image_size = gtk_spinner_accessible_image_get_size;
 491 }
 492
 493 static GType
 494 gtk_spinner_accessible_get_type (void)
 495 {
 496   static GType type = 0;
 497
 498   /* Action interface
 499      Name etc. ... */
 500   if (G_UNLIKELY (type == 0))
 501     {
 502       const GInterfaceInfo atk_image_info = {
 503               (GInterfaceInitFunc) gtk_spinner_accessible_image_interface_init,
 504               (GInterfaceFinalizeFunc) NULL,
 505               NULL
 506       };
 507       GType type;
 508       GType parent_atk_type;
 509       GTypeInfo tinfo = { 0 };
 510       GTypeQuery query;
 511       AtkObjectFactory *factory;
 512
 513       if ((type = g_type_from_name ("GtkSpinnerAccessible")))
 514         return type;
 515
 516       factory = atk_registry_get_factory (atk_get_default_registry (),
 517                                           GTK_TYPE_IMAGE);
 518       if (!factory)
 519         return G_TYPE_INVALID;
 520
 521       parent_atk_type = atk_object_factory_get_accessible_type (factory);
 522       if (!parent_atk_type)
 523         return G_TYPE_INVALID;
 524
 525       /*
 526        * Figure out the size of the class and instance
 527        * we are deriving from
 528        */
 529       g_type_query (parent_atk_type, &query);
 530
 531       tinfo.class_init = (GClassInitFunc) gtk_spinner_accessible_class_init;
 532       tinfo.class_size    = query.class_size;
 533       tinfo.instance_size = query.instance_size;
 534
 535       /* Register the type */
 536       type = g_type_register_static (parent_atk_type,
 537                                      "GtkSpinnerAccessible",
 538                                      &tinfo, 0);
 539
 540       g_type_add_interface_static (type, ATK_TYPE_IMAGE,
 541                                    &atk_image_info);
 542     }
 543
 544   return type;
 545 }
 546
 547 static AtkObject *
 548 gtk_spinner_get_accessible (GtkWidget *widget)
 549 {
 550   static gboolean first_time = TRUE;
 551
 552   if (first_time)
 553     {
 554       AtkObjectFactory *factory;
 555       AtkRegistry *registry;
 556       GType derived_type;
 557       GType derived_atk_type;
 558
 559       /*
 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.
 563        */
 564       derived_type = g_type_parent (GTK_TYPE_SPINNER);
 565
 566       registry = atk_get_default_registry ();
 567       factory = atk_registry_get_factory (registry,
 568                                           derived_type);
 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,
 572                                        GTK_TYPE_SPINNER,
 573                                        gtk_spinner_accessible_factory_get_type ());
 574       first_time = FALSE;
 575     }
 576   return GTK_WIDGET_CLASS (gtk_spinner_parent_class)->get_accessible (widget);
 577 }
 578
 579 /**
 580  * gtk_spinner_new:
 581  *
 582  * Returns a new spinner widget. Not yet started.
 583  *
 584  * Return value: a new #GtkSpinner
 585  *
 586  * Since: 2.20
 587  */
 588 GtkWidget *
 589 gtk_spinner_new (void)
 590 {
 591   return g_object_new (GTK_TYPE_SPINNER, NULL);
 592 }
 593
 594 /**
 595  * gtk_spinner_start:
 596  * @spinner: a #GtkSpinner
 597  *
 598  * Starts the animation of the spinner.
 599  *
 600  * Since: 2.20
 601  */
 602 void
 603 gtk_spinner_start (GtkSpinner *spinner)
 604 {
 605   g_return_if_fail (GTK_IS_SPINNER (spinner));
 606
 607   gtk_spinner_set_active (spinner, TRUE);
 608 }
 609
 610 /**
 611  * gtk_spinner_stop:
 612  * @spinner: a #GtkSpinner
 613  *
 614  * Stops the animation of the spinner.
 615  *
 616  * Since: 2.20
 617  */
 618 void
 619 gtk_spinner_stop (GtkSpinner *spinner)
 620 {
 621   g_return_if_fail (GTK_IS_SPINNER (spinner));
 622
 623   gtk_spinner_set_active (spinner, FALSE);
 624 }
 625
 626 #define __GTK_SPINNER_C__
 627 #include "gtkaliasdef.c"