gtkspinner.c 7.92 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/* 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
Javier Jardón's avatar
Javier Jardón committed
17
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
 *
 * 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"
33 34 35 36

#include "gtkimage.h"
#include "gtkintl.h"
#include "gtkstylecontext.h"
Matthias Clasen's avatar
Matthias Clasen committed
37
#include "a11y/gtkspinneraccessible.h"
38

39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

/**
 * 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().
 */


55
#define SPINNER_SIZE 16
56

57 58 59 60 61 62 63
enum {
  PROP_0,
  PROP_ACTIVE
};

struct _GtkSpinnerPrivate
{
64
  gboolean active;
65 66
};

67 68
static gboolean gtk_spinner_draw       (GtkWidget       *widget,
                                        cairo_t         *cr);
69 70 71 72 73 74 75 76
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);
77 78
static void gtk_spinner_set_active     (GtkSpinner      *spinner,
                                        gboolean         active);
79 80 81 82 83 84 85
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);

86

87
G_DEFINE_TYPE_WITH_PRIVATE (GtkSpinner, gtk_spinner, GTK_TYPE_WIDGET)
88

89 90 91 92 93 94 95 96 97 98 99
static void
gtk_spinner_class_init (GtkSpinnerClass *klass)
{
  GObjectClass *gobject_class;
  GtkWidgetClass *widget_class;

  gobject_class = G_OBJECT_CLASS(klass);
  gobject_class->get_property = gtk_spinner_get_property;
  gobject_class->set_property = gtk_spinner_set_property;

  widget_class = GTK_WIDGET_CLASS(klass);
100
  widget_class->draw = gtk_spinner_draw;
101 102
  widget_class->get_preferred_width = gtk_spinner_get_preferred_width;
  widget_class->get_preferred_height = gtk_spinner_get_preferred_height;
103

104
  /* GtkSpinner:active:
105 106 107
   *
   * Whether the spinner is active
   *
108
   * Since: 2.20
109 110 111 112 113 114 115 116
   */
  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));
117

118
  gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_SPINNER_ACCESSIBLE);
119 120 121 122 123 124 125 126 127 128
}

static void
gtk_spinner_get_property (GObject    *object,
                          guint       param_id,
                          GValue     *value,
                          GParamSpec *pspec)
{
  GtkSpinnerPrivate *priv;

129
  priv = GTK_SPINNER (object)->priv;
130 131 132 133

  switch (param_id)
    {
      case PROP_ACTIVE:
134
        g_value_set_boolean (value, priv->active);
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
        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:
150
        gtk_spinner_set_active (GTK_SPINNER (object), g_value_get_boolean (value));
151 152 153 154 155 156 157 158 159
        break;
      default:
        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
    }
}

static void
gtk_spinner_init (GtkSpinner *spinner)
{
160
  GtkStyleContext *context;
161

162
  spinner->priv = gtk_spinner_get_instance_private (spinner);
163

164
  gtk_widget_set_has_window (GTK_WIDGET (spinner), FALSE);
165 166 167

  context = gtk_widget_get_style_context (GTK_WIDGET (spinner));
  gtk_style_context_add_class (context, GTK_STYLE_CLASS_SPINNER);
168 169
}

170
static void
171 172 173
gtk_spinner_get_preferred_width (GtkWidget *widget,
                                 gint      *minimum_size,
                                 gint      *natural_size)
174 175 176 177 178 179 180 181 182
{
  if (minimum_size)
    *minimum_size = SPINNER_SIZE;

  if (natural_size)
    *natural_size = SPINNER_SIZE;
}

static void
183 184 185
gtk_spinner_get_preferred_height (GtkWidget *widget,
                                  gint      *minimum_size,
                                  gint      *natural_size)
186 187 188 189 190 191 192 193
{
  if (minimum_size)
    *minimum_size = SPINNER_SIZE;

  if (natural_size)
    *natural_size = SPINNER_SIZE;
}

194
static gboolean
195 196
gtk_spinner_draw (GtkWidget *widget,
                  cairo_t   *cr)
197
{
198
  GtkStyleContext *context;
199 200
  gint width, height;
  gint size;
201

202
  context = gtk_widget_get_style_context (widget);
203

204 205 206 207
  width = gtk_widget_get_allocated_width (widget);
  height = gtk_widget_get_allocated_height (widget);
  size = MIN (width, height);

208 209 210 211 212 213
  /* at most allow a double size spinner */
  if (size >= 3 * SPINNER_SIZE)
    size = SPINNER_SIZE * 2;
  else
    size = SPINNER_SIZE;

214 215 216 217
  gtk_render_activity (context, cr,
                       (width - size) / 2,
                       (height - size) / 2,
                       size, size);
218 219 220 221 222

  return FALSE;
}

static void
223 224
gtk_spinner_set_active (GtkSpinner *spinner,
                        gboolean    active)
225
{
226
  GtkSpinnerPrivate *priv = spinner->priv;
227

228
  active = !!active;
229 230

  if (priv->active != active)
231
    {
232
      priv->active = active;
233

234 235
      g_object_notify (G_OBJECT (spinner), "active");

236 237 238 239 240 241
      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);
242 243 244 245
    }
}

/**
246
 * gtk_spinner_new:
247 248 249 250 251 252 253 254 255 256 257 258 259 260
 *
 * 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);
}

/**
261 262
 * gtk_spinner_start:
 * @spinner: a #GtkSpinner
263
 *
264
 * Starts the animation of the spinner.
265 266 267 268 269 270 271 272
 *
 * Since: 2.20
 */
void
gtk_spinner_start (GtkSpinner *spinner)
{
  g_return_if_fail (GTK_IS_SPINNER (spinner));

273
  gtk_spinner_set_active (spinner, TRUE);
274 275 276
}

/**
277 278
 * gtk_spinner_stop:
 * @spinner: a #GtkSpinner
279
 *
280
 * Stops the animation of the spinner.
281 282 283 284 285 286 287 288
 *
 * Since: 2.20
 */
void
gtk_spinner_stop (GtkSpinner *spinner)
{
  g_return_if_fail (GTK_IS_SPINNER (spinner));

289
  gtk_spinner_set_active (spinner, FALSE);
290
}