1 /* GTK - The GIMP Toolkit
3 * Copyright (C) 2009 Matthias Clasen <mclasen@redhat.com>
4 * Copyright (C) 2008 Richard Hughes <richard@hughsie.com>
5 * Copyright (C) 2009 Bastien Nocera <hadess@hadess.net>
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
24 * Modified by the GTK+ Team and others 2007. See the AUTHORS
25 * file for a list of people on the GTK+ Team. See the ChangeLog
26 * files for a list of changes. These files are distributed with
27 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
32 #include "gtkcellrendererspinner.h"
33 #include "gtkiconfactory.h"
34 #include "gtkicontheme.h"
35 #include "gtktypebuiltins.h"
40 * SECTION:gtkcellrendererspinner
41 * @Short_description: Renders a spinning animation in a cell
42 * @Title: GtkCellRendererSpinner
43 * @See_also: #GtkSpinner, #GtkCellRendererProgress
45 * GtkCellRendererSpinner renders a spinning animation in a cell, very
46 * similar to #GtkSpinner. It can often be used as an alternative
47 * to a #GtkCellRendererProgress for displaying indefinite activity,
48 * instead of actual progress.
50 * To start the animation in a cell, set the #GtkCellRendererSpinner:active
51 * property to %TRUE and increment the #GtkCellRendererSpinner:pulse property
52 * at regular intervals. The usual way to set the cell renderer properties
53 * for each cell is to bind them to columns in your tree model using e.g.
54 * gtk_tree_view_column_add_attribute().
65 struct _GtkCellRendererSpinnerPrivate
69 GtkIconSize icon_size, old_icon_size;
74 static void gtk_cell_renderer_spinner_get_property (GObject *object,
78 static void gtk_cell_renderer_spinner_set_property (GObject *object,
82 static void gtk_cell_renderer_spinner_get_size (GtkCellRenderer *cell,
84 const GdkRectangle *cell_area,
89 static void gtk_cell_renderer_spinner_render (GtkCellRenderer *cell,
92 const GdkRectangle *background_area,
93 const GdkRectangle *cell_area,
94 GtkCellRendererState flags);
96 G_DEFINE_TYPE (GtkCellRendererSpinner, gtk_cell_renderer_spinner, GTK_TYPE_CELL_RENDERER)
99 gtk_cell_renderer_spinner_class_init (GtkCellRendererSpinnerClass *klass)
101 GObjectClass *object_class = G_OBJECT_CLASS (klass);
102 GtkCellRendererClass *cell_class = GTK_CELL_RENDERER_CLASS (klass);
104 object_class->get_property = gtk_cell_renderer_spinner_get_property;
105 object_class->set_property = gtk_cell_renderer_spinner_set_property;
107 cell_class->get_size = gtk_cell_renderer_spinner_get_size;
108 cell_class->render = gtk_cell_renderer_spinner_render;
110 /* GtkCellRendererSpinner:active:
112 * Whether the spinner is active (ie. shown) in the cell
116 g_object_class_install_property (object_class,
118 g_param_spec_boolean ("active",
120 P_("Whether the spinner is active (ie. shown) in the cell"),
124 * GtkCellRendererSpinner:pulse:
126 * Pulse of the spinner. Increment this value to draw the next frame of the
127 * spinner animation. Usually, you would update this value in a timeout.
129 * By default, the #GtkSpinner widget draws one full cycle of the animation,
130 * consisting of 12 frames, in 750 milliseconds.
134 g_object_class_install_property (object_class,
136 g_param_spec_uint ("pulse",
138 P_("Pulse of the spinner"),
142 * GtkCellRendererSpinner:size:
144 * The #GtkIconSize value that specifies the size of the rendered spinner.
148 g_object_class_install_property (object_class,
150 g_param_spec_enum ("size",
152 P_("The GtkIconSize value that specifies the size of the rendered spinner"),
153 GTK_TYPE_ICON_SIZE, GTK_ICON_SIZE_MENU,
157 g_type_class_add_private (object_class, sizeof (GtkCellRendererSpinnerPrivate));
161 gtk_cell_renderer_spinner_init (GtkCellRendererSpinner *cell)
163 cell->priv = G_TYPE_INSTANCE_GET_PRIVATE (cell,
164 GTK_TYPE_CELL_RENDERER_SPINNER,
165 GtkCellRendererSpinnerPrivate);
167 cell->priv->pulse = 0;
168 cell->priv->old_icon_size = GTK_ICON_SIZE_INVALID;
169 cell->priv->icon_size = GTK_ICON_SIZE_MENU;
173 * gtk_cell_renderer_spinner_new:
175 * Returns a new cell renderer which will show a spinner to indicate
178 * Return value: a new #GtkCellRenderer
183 gtk_cell_renderer_spinner_new (void)
185 return g_object_new (GTK_TYPE_CELL_RENDERER_SPINNER, NULL);
189 gtk_cell_renderer_spinner_update_size (GtkCellRendererSpinner *cell,
192 GtkCellRendererSpinnerPrivate *priv = cell->priv;
194 GtkIconTheme *icon_theme;
195 GtkSettings *settings;
197 if (cell->priv->old_icon_size == cell->priv->icon_size)
200 screen = gtk_widget_get_screen (GTK_WIDGET (widget));
201 icon_theme = gtk_icon_theme_get_for_screen (screen);
202 settings = gtk_settings_get_for_screen (screen);
204 if (!gtk_icon_size_lookup_for_settings (settings, priv->icon_size, &priv->size, NULL))
206 g_warning ("Invalid icon size %u\n", priv->icon_size);
212 gtk_cell_renderer_spinner_get_property (GObject *object,
217 GtkCellRendererSpinner *cell = GTK_CELL_RENDERER_SPINNER (object);
218 GtkCellRendererSpinnerPrivate *priv = cell->priv;
223 g_value_set_boolean (value, priv->active);
226 g_value_set_uint (value, priv->pulse);
229 g_value_set_enum (value, priv->icon_size);
232 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
237 gtk_cell_renderer_spinner_set_property (GObject *object,
242 GtkCellRendererSpinner *cell = GTK_CELL_RENDERER_SPINNER (object);
243 GtkCellRendererSpinnerPrivate *priv = cell->priv;
248 priv->active = g_value_get_boolean (value);
251 priv->pulse = g_value_get_uint (value);
254 priv->old_icon_size = priv->icon_size;
255 priv->icon_size = g_value_get_enum (value);
258 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
263 gtk_cell_renderer_spinner_get_size (GtkCellRenderer *cellr,
265 const GdkRectangle *cell_area,
271 GtkCellRendererSpinner *cell = GTK_CELL_RENDERER_SPINNER (cellr);
272 GtkCellRendererSpinnerPrivate *priv = cell->priv;
276 gfloat xalign, yalign;
279 rtl = gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL;
281 gtk_cell_renderer_spinner_update_size (cell, widget);
295 align = rtl ? 1.0 - xalign : xalign;
296 *x_offset = align * (cell_area->width - w);
297 *x_offset = MAX (*x_offset, 0);
301 align = rtl ? 1.0 - yalign : yalign;
302 *y_offset = align * (cell_area->height - h);
303 *y_offset = MAX (*y_offset, 0);
321 gtk_cell_renderer_spinner_render (GtkCellRenderer *cellr,
324 const GdkRectangle *background_area,
325 const GdkRectangle *cell_area,
326 GtkCellRendererState flags)
328 GtkCellRendererSpinner *cell = GTK_CELL_RENDERER_SPINNER (cellr);
329 GtkCellRendererSpinnerPrivate *priv = cell->priv;
331 GdkRectangle pix_rect;
332 GdkRectangle draw_rect;
338 gtk_cell_renderer_spinner_get_size (cellr, widget, (GdkRectangle *) cell_area,
339 &pix_rect.x, &pix_rect.y,
340 &pix_rect.width, &pix_rect.height);
346 pix_rect.x += cell_area->x + xpad;
347 pix_rect.y += cell_area->y + ypad;
348 pix_rect.width -= xpad * 2;
349 pix_rect.height -= ypad * 2;
351 if (!gdk_rectangle_intersect (cell_area, &pix_rect, &draw_rect))
354 state = GTK_STATE_NORMAL;
355 if (gtk_widget_get_state (widget) == GTK_STATE_INSENSITIVE ||
356 !gtk_cell_renderer_get_sensitive (cellr))
358 state = GTK_STATE_INSENSITIVE;
362 if ((flags & GTK_CELL_RENDERER_SELECTED) != 0)
364 if (gtk_widget_has_focus (widget))
365 state = GTK_STATE_SELECTED;
367 state = GTK_STATE_ACTIVE;
370 state = GTK_STATE_PRELIGHT;
375 gdk_cairo_rectangle (cr, cell_area);
378 gtk_paint_spinner (gtk_widget_get_style (widget),
384 draw_rect.x, draw_rect.y,
385 draw_rect.width, draw_rect.height);