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, see <http://www.gnu.org/licenses/>.
22 * Modified by the GTK+ Team and others 2007. See the AUTHORS
23 * file for a list of people on the GTK+ Team. See the ChangeLog
24 * files for a list of changes. These files are distributed with
25 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
30 #include "gtkcellrendererspinner.h"
31 #include "gtkiconfactory.h"
32 #include "gtkicontheme.h"
34 #include "gtksettings.h"
35 #include "gtktypebuiltins.h"
38 #undef GDK_DEPRECATED_FOR
39 #define GDK_DEPRECATED
40 #define GDK_DEPRECATED_FOR(f)
42 #include "deprecated/gtkstyle.h"
46 * SECTION:gtkcellrendererspinner
47 * @Short_description: Renders a spinning animation in a cell
48 * @Title: GtkCellRendererSpinner
49 * @See_also: #GtkSpinner, #GtkCellRendererProgress
51 * GtkCellRendererSpinner renders a spinning animation in a cell, very
52 * similar to #GtkSpinner. It can often be used as an alternative
53 * to a #GtkCellRendererProgress for displaying indefinite activity,
54 * instead of actual progress.
56 * To start the animation in a cell, set the #GtkCellRendererSpinner:active
57 * property to %TRUE and increment the #GtkCellRendererSpinner:pulse property
58 * at regular intervals. The usual way to set the cell renderer properties
59 * for each cell is to bind them to columns in your tree model using e.g.
60 * gtk_tree_view_column_add_attribute().
71 struct _GtkCellRendererSpinnerPrivate
75 GtkIconSize icon_size, old_icon_size;
80 static void gtk_cell_renderer_spinner_get_property (GObject *object,
84 static void gtk_cell_renderer_spinner_set_property (GObject *object,
88 static void gtk_cell_renderer_spinner_get_size (GtkCellRenderer *cell,
90 const GdkRectangle *cell_area,
95 static void gtk_cell_renderer_spinner_render (GtkCellRenderer *cell,
98 const GdkRectangle *background_area,
99 const GdkRectangle *cell_area,
100 GtkCellRendererState flags);
102 G_DEFINE_TYPE (GtkCellRendererSpinner, gtk_cell_renderer_spinner, GTK_TYPE_CELL_RENDERER)
105 gtk_cell_renderer_spinner_class_init (GtkCellRendererSpinnerClass *klass)
107 GObjectClass *object_class = G_OBJECT_CLASS (klass);
108 GtkCellRendererClass *cell_class = GTK_CELL_RENDERER_CLASS (klass);
110 object_class->get_property = gtk_cell_renderer_spinner_get_property;
111 object_class->set_property = gtk_cell_renderer_spinner_set_property;
113 cell_class->get_size = gtk_cell_renderer_spinner_get_size;
114 cell_class->render = gtk_cell_renderer_spinner_render;
116 /* GtkCellRendererSpinner:active:
118 * Whether the spinner is active (ie. shown) in the cell
122 g_object_class_install_property (object_class,
124 g_param_spec_boolean ("active",
126 P_("Whether the spinner is active (ie. shown) in the cell"),
130 * GtkCellRendererSpinner:pulse:
132 * Pulse of the spinner. Increment this value to draw the next frame of the
133 * spinner animation. Usually, you would update this value in a timeout.
135 * By default, the #GtkSpinner widget draws one full cycle of the animation,
136 * consisting of 12 frames, in 750 milliseconds.
140 g_object_class_install_property (object_class,
142 g_param_spec_uint ("pulse",
144 P_("Pulse of the spinner"),
148 * GtkCellRendererSpinner:size:
150 * The #GtkIconSize value that specifies the size of the rendered spinner.
154 g_object_class_install_property (object_class,
156 g_param_spec_enum ("size",
158 P_("The GtkIconSize value that specifies the size of the rendered spinner"),
159 GTK_TYPE_ICON_SIZE, GTK_ICON_SIZE_MENU,
163 g_type_class_add_private (object_class, sizeof (GtkCellRendererSpinnerPrivate));
167 gtk_cell_renderer_spinner_init (GtkCellRendererSpinner *cell)
169 cell->priv = G_TYPE_INSTANCE_GET_PRIVATE (cell,
170 GTK_TYPE_CELL_RENDERER_SPINNER,
171 GtkCellRendererSpinnerPrivate);
173 cell->priv->pulse = 0;
174 cell->priv->old_icon_size = GTK_ICON_SIZE_INVALID;
175 cell->priv->icon_size = GTK_ICON_SIZE_MENU;
179 * gtk_cell_renderer_spinner_new:
181 * Returns a new cell renderer which will show a spinner to indicate
184 * Return value: a new #GtkCellRenderer
189 gtk_cell_renderer_spinner_new (void)
191 return g_object_new (GTK_TYPE_CELL_RENDERER_SPINNER, NULL);
195 gtk_cell_renderer_spinner_update_size (GtkCellRendererSpinner *cell,
198 GtkCellRendererSpinnerPrivate *priv = cell->priv;
200 GtkSettings *settings;
202 if (priv->old_icon_size == priv->icon_size)
205 screen = gtk_widget_get_screen (GTK_WIDGET (widget));
206 settings = gtk_settings_get_for_screen (screen);
208 if (!gtk_icon_size_lookup_for_settings (settings, priv->icon_size, &priv->size, NULL))
210 g_warning ("Invalid icon size %u\n", priv->icon_size);
216 gtk_cell_renderer_spinner_get_property (GObject *object,
221 GtkCellRendererSpinner *cell = GTK_CELL_RENDERER_SPINNER (object);
222 GtkCellRendererSpinnerPrivate *priv = cell->priv;
227 g_value_set_boolean (value, priv->active);
230 g_value_set_uint (value, priv->pulse);
233 g_value_set_enum (value, priv->icon_size);
236 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
241 gtk_cell_renderer_spinner_set_property (GObject *object,
246 GtkCellRendererSpinner *cell = GTK_CELL_RENDERER_SPINNER (object);
247 GtkCellRendererSpinnerPrivate *priv = cell->priv;
252 priv->active = g_value_get_boolean (value);
255 priv->pulse = g_value_get_uint (value);
258 priv->old_icon_size = priv->icon_size;
259 priv->icon_size = g_value_get_enum (value);
262 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
267 gtk_cell_renderer_spinner_get_size (GtkCellRenderer *cellr,
269 const GdkRectangle *cell_area,
275 GtkCellRendererSpinner *cell = GTK_CELL_RENDERER_SPINNER (cellr);
276 GtkCellRendererSpinnerPrivate *priv = cell->priv;
280 gfloat xalign, yalign;
283 rtl = gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL;
285 gtk_cell_renderer_spinner_update_size (cell, widget);
299 align = rtl ? 1.0 - xalign : xalign;
300 *x_offset = align * (cell_area->width - w);
301 *x_offset = MAX (*x_offset, 0);
305 align = rtl ? 1.0 - yalign : yalign;
306 *y_offset = align * (cell_area->height - h);
307 *y_offset = MAX (*y_offset, 0);
325 gtk_cell_renderer_spinner_render (GtkCellRenderer *cellr,
328 const GdkRectangle *background_area,
329 const GdkRectangle *cell_area,
330 GtkCellRendererState flags)
332 GtkCellRendererSpinner *cell = GTK_CELL_RENDERER_SPINNER (cellr);
333 GtkCellRendererSpinnerPrivate *priv = cell->priv;
335 GdkRectangle pix_rect;
336 GdkRectangle draw_rect;
342 gtk_cell_renderer_spinner_get_size (cellr, widget, (GdkRectangle *) cell_area,
343 &pix_rect.x, &pix_rect.y,
344 &pix_rect.width, &pix_rect.height);
350 pix_rect.x += cell_area->x + xpad;
351 pix_rect.y += cell_area->y + ypad;
352 pix_rect.width -= xpad * 2;
353 pix_rect.height -= ypad * 2;
355 if (!gdk_rectangle_intersect (cell_area, &pix_rect, &draw_rect))
358 state = GTK_STATE_NORMAL;
359 if (gtk_widget_get_state (widget) == GTK_STATE_INSENSITIVE ||
360 !gtk_cell_renderer_get_sensitive (cellr))
362 state = GTK_STATE_INSENSITIVE;
366 if ((flags & GTK_CELL_RENDERER_SELECTED) != 0)
368 if (gtk_widget_has_focus (widget))
369 state = GTK_STATE_SELECTED;
371 state = GTK_STATE_ACTIVE;
374 state = GTK_STATE_PRELIGHT;
379 gdk_cairo_rectangle (cr, cell_area);
382 gtk_paint_spinner (gtk_widget_get_style (widget),
388 draw_rect.x, draw_rect.y,
389 draw_rect.width, draw_rect.height);