1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
30 #undef GTK_DISABLE_DEPRECATED
31 #include "gtkprogress.h"
32 #include "gtkprivate.h"
37 #define DEFAULT_FORMAT "%P %%"
48 static void gtk_progress_set_property (GObject *object,
52 static void gtk_progress_get_property (GObject *object,
56 static void gtk_progress_destroy (GtkObject *object);
57 static void gtk_progress_finalize (GObject *object);
58 static void gtk_progress_realize (GtkWidget *widget);
59 static gboolean gtk_progress_expose (GtkWidget *widget,
60 GdkEventExpose *event);
61 static void gtk_progress_size_allocate (GtkWidget *widget,
62 GtkAllocation *allocation);
63 static void gtk_progress_create_pixmap (GtkProgress *progress);
64 static void gtk_progress_value_changed (GtkAdjustment *adjustment,
65 GtkProgress *progress);
66 static void gtk_progress_changed (GtkAdjustment *adjustment,
67 GtkProgress *progress);
69 G_DEFINE_TYPE (GtkProgress, gtk_progress, GTK_TYPE_WIDGET)
72 gtk_progress_class_init (GtkProgressClass *class)
74 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
75 GtkObjectClass *object_class;
76 GtkWidgetClass *widget_class;
78 object_class = (GtkObjectClass *) class;
79 widget_class = (GtkWidgetClass *) class;
81 gobject_class->finalize = gtk_progress_finalize;
83 gobject_class->set_property = gtk_progress_set_property;
84 gobject_class->get_property = gtk_progress_get_property;
85 object_class->destroy = gtk_progress_destroy;
87 widget_class->realize = gtk_progress_realize;
88 widget_class->expose_event = gtk_progress_expose;
89 widget_class->size_allocate = gtk_progress_size_allocate;
91 /* to be overridden */
94 class->act_mode_enter = NULL;
96 g_object_class_install_property (gobject_class,
98 g_param_spec_boolean ("activity-mode",
100 P_("If TRUE, the GtkProgress is in activity mode, meaning that it signals "
101 "something is happening, but not how much of the activity is finished. "
102 "This is used when you're doing something but don't know how long it will take."),
104 GTK_PARAM_READWRITE));
105 g_object_class_install_property (gobject_class,
107 g_param_spec_boolean ("show-text",
109 P_("Whether the progress is shown as text."),
111 GTK_PARAM_READWRITE));
112 g_object_class_install_property (gobject_class,
114 g_param_spec_float ("text-xalign",
115 P_("Text x alignment"),
116 P_("The horizontal text alignment, from 0 (left) to 1 (right). Reversed for RTL layouts."),
118 GTK_PARAM_READWRITE));
119 g_object_class_install_property (gobject_class,
121 g_param_spec_float ("text-yalign",
122 P_("Text y alignment"),
123 P_("The vertical text alignment, from 0 (top) to 1 (bottom)."),
125 GTK_PARAM_READWRITE));
129 gtk_progress_set_property (GObject *object,
134 GtkProgress *progress;
136 progress = GTK_PROGRESS (object);
140 case PROP_ACTIVITY_MODE:
141 gtk_progress_set_activity_mode (progress, g_value_get_boolean (value));
144 gtk_progress_set_show_text (progress, g_value_get_boolean (value));
146 case PROP_TEXT_XALIGN:
147 gtk_progress_set_text_alignment (progress,
148 g_value_get_float (value),
151 case PROP_TEXT_YALIGN:
152 gtk_progress_set_text_alignment (progress,
154 g_value_get_float (value));
157 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
163 gtk_progress_get_property (GObject *object,
168 GtkProgress *progress;
170 progress = GTK_PROGRESS (object);
174 case PROP_ACTIVITY_MODE:
175 g_value_set_boolean (value, (progress->activity_mode != FALSE));
178 g_value_set_boolean (value, (progress->show_text != FALSE));
180 case PROP_TEXT_XALIGN:
181 g_value_set_float (value, progress->x_align);
183 case PROP_TEXT_YALIGN:
184 g_value_set_float (value, progress->y_align);
187 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
193 gtk_progress_init (GtkProgress *progress)
195 progress->adjustment = NULL;
196 progress->offscreen_pixmap = NULL;
197 progress->format = g_strdup (DEFAULT_FORMAT);
198 progress->x_align = 0.5;
199 progress->y_align = 0.5;
200 progress->show_text = FALSE;
201 progress->activity_mode = FALSE;
202 progress->use_text_format = TRUE;
206 gtk_progress_realize (GtkWidget *widget)
208 GtkProgress *progress;
209 GdkWindowAttr attributes;
210 gint attributes_mask;
212 g_return_if_fail (GTK_IS_PROGRESS (widget));
214 progress = GTK_PROGRESS (widget);
215 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
217 attributes.window_type = GDK_WINDOW_CHILD;
218 attributes.x = widget->allocation.x;
219 attributes.y = widget->allocation.y;
220 attributes.width = widget->allocation.width;
221 attributes.height = widget->allocation.height;
222 attributes.wclass = GDK_INPUT_OUTPUT;
223 attributes.visual = gtk_widget_get_visual (widget);
224 attributes.colormap = gtk_widget_get_colormap (widget);
225 attributes.event_mask = gtk_widget_get_events (widget);
226 attributes.event_mask |= GDK_EXPOSURE_MASK;
228 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
230 widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
231 &attributes, attributes_mask);
232 gdk_window_set_user_data (widget->window, progress);
234 widget->style = gtk_style_attach (widget->style, widget->window);
235 gtk_style_set_background (widget->style, widget->window, GTK_STATE_ACTIVE);
237 gtk_progress_create_pixmap (progress);
241 gtk_progress_destroy (GtkObject *object)
243 GtkProgress *progress;
245 g_return_if_fail (GTK_IS_PROGRESS (object));
247 progress = GTK_PROGRESS (object);
249 if (progress->adjustment)
251 g_signal_handlers_disconnect_by_func (progress->adjustment,
252 gtk_progress_value_changed,
254 g_signal_handlers_disconnect_by_func (progress->adjustment,
255 gtk_progress_changed,
257 g_object_unref (progress->adjustment);
258 progress->adjustment = NULL;
261 GTK_OBJECT_CLASS (gtk_progress_parent_class)->destroy (object);
265 gtk_progress_finalize (GObject *object)
267 GtkProgress *progress;
269 g_return_if_fail (GTK_IS_PROGRESS (object));
271 progress = GTK_PROGRESS (object);
273 if (progress->offscreen_pixmap)
274 g_object_unref (progress->offscreen_pixmap);
276 g_free (progress->format);
278 G_OBJECT_CLASS (gtk_progress_parent_class)->finalize (object);
282 gtk_progress_expose (GtkWidget *widget,
283 GdkEventExpose *event)
285 g_return_val_if_fail (GTK_IS_PROGRESS (widget), FALSE);
286 g_return_val_if_fail (event != NULL, FALSE);
288 if (GTK_WIDGET_DRAWABLE (widget))
289 gdk_draw_drawable (widget->window,
290 widget->style->black_gc,
291 GTK_PROGRESS (widget)->offscreen_pixmap,
292 event->area.x, event->area.y,
293 event->area.x, event->area.y,
301 gtk_progress_size_allocate (GtkWidget *widget,
302 GtkAllocation *allocation)
304 g_return_if_fail (GTK_IS_PROGRESS (widget));
305 g_return_if_fail (allocation != NULL);
307 widget->allocation = *allocation;
309 if (GTK_WIDGET_REALIZED (widget))
311 gdk_window_move_resize (widget->window,
312 allocation->x, allocation->y,
313 allocation->width, allocation->height);
315 gtk_progress_create_pixmap (GTK_PROGRESS (widget));
320 gtk_progress_create_pixmap (GtkProgress *progress)
324 g_return_if_fail (GTK_IS_PROGRESS (progress));
326 if (GTK_WIDGET_REALIZED (progress))
328 widget = GTK_WIDGET (progress);
330 if (progress->offscreen_pixmap)
331 g_object_unref (progress->offscreen_pixmap);
333 progress->offscreen_pixmap = gdk_pixmap_new (widget->window,
334 widget->allocation.width,
335 widget->allocation.height,
338 /* clear the pixmap for transparent themes */
339 gtk_paint_flat_box (widget->style,
340 progress->offscreen_pixmap,
341 GTK_STATE_NORMAL, GTK_SHADOW_NONE,
342 NULL, widget, "trough", 0, 0, -1, -1);
344 GTK_PROGRESS_GET_CLASS (progress)->paint (progress);
349 gtk_progress_changed (GtkAdjustment *adjustment,
350 GtkProgress *progress)
352 /* A change in the value of adjustment->upper can change
355 if (progress->use_text_format && progress->show_text)
356 gtk_widget_queue_resize (GTK_WIDGET (progress));
358 GTK_PROGRESS_GET_CLASS (progress)->update (progress);
362 gtk_progress_value_changed (GtkAdjustment *adjustment,
363 GtkProgress *progress)
365 GTK_PROGRESS_GET_CLASS (progress)->update (progress);
369 gtk_progress_build_string (GtkProgress *progress,
373 gchar buf[256] = { 0 };
374 gchar tmp[256] = { 0 };
379 src = progress->format;
381 /* This is the new supported version of this function */
382 if (!progress->use_text_format)
383 return g_strdup (src);
385 /* And here's all the deprecated goo. */
401 c = *(src + sizeof(gchar));
404 if (c >= '0' && c <= '2')
406 digits = (gint) (c - '0');
408 c = *(src + sizeof(gchar));
422 g_snprintf (fmt, sizeof (fmt), "%%.%df", digits);
423 g_snprintf (tmp, sizeof (tmp), fmt, 100 * percentage);
426 g_snprintf (tmp, sizeof (tmp), "%.0f", 100 * percentage);
428 dest = &(buf[strlen (buf)]);
435 g_snprintf (fmt, sizeof (fmt), "%%.%df", digits);
436 g_snprintf (tmp, sizeof (tmp), fmt, value);
439 g_snprintf (tmp, sizeof (tmp), "%.0f", value);
441 dest = &(buf[strlen (buf)]);
448 g_snprintf (fmt, sizeof (fmt), "%%.%df", digits);
449 g_snprintf (tmp, sizeof (tmp), fmt, progress->adjustment->lower);
452 g_snprintf (tmp, sizeof (tmp), "%.0f", progress->adjustment->lower);
454 dest = &(buf[strlen (buf)]);
461 g_snprintf (fmt, sizeof (fmt), "%%.%df", digits);
462 g_snprintf (tmp, sizeof (tmp), fmt, progress->adjustment->upper);
465 g_snprintf (tmp, sizeof (tmp), "%.0f", progress->adjustment->upper);
467 dest = &(buf[strlen (buf)]);
477 return g_strdup (buf);
480 /***************************************************************/
483 gtk_progress_set_adjustment (GtkProgress *progress,
484 GtkAdjustment *adjustment)
486 g_return_if_fail (GTK_IS_PROGRESS (progress));
488 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
490 adjustment = (GtkAdjustment*) gtk_adjustment_new (0, 0, 100, 0, 0, 0);
492 if (progress->adjustment != adjustment)
494 if (progress->adjustment)
496 g_signal_handlers_disconnect_by_func (progress->adjustment,
497 gtk_progress_changed,
499 g_signal_handlers_disconnect_by_func (progress->adjustment,
500 gtk_progress_value_changed,
502 g_object_unref (progress->adjustment);
504 progress->adjustment = adjustment;
507 g_object_ref_sink (adjustment);
508 g_signal_connect (adjustment, "changed",
509 G_CALLBACK (gtk_progress_changed),
511 g_signal_connect (adjustment, "value_changed",
512 G_CALLBACK (gtk_progress_value_changed),
516 gtk_progress_changed (adjustment, progress);
521 gtk_progress_configure (GtkProgress *progress,
527 gboolean changed = FALSE;
529 g_return_if_fail (GTK_IS_PROGRESS (progress));
530 g_return_if_fail (min <= max);
531 g_return_if_fail (value >= min && value <= max);
533 if (!progress->adjustment)
534 gtk_progress_set_adjustment (progress, NULL);
535 adj = progress->adjustment;
537 if (fabs (adj->lower - min) > EPSILON || fabs (adj->upper - max) > EPSILON)
544 gtk_adjustment_value_changed (adj);
546 gtk_adjustment_changed (adj);
550 gtk_progress_set_percentage (GtkProgress *progress,
553 g_return_if_fail (GTK_IS_PROGRESS (progress));
554 g_return_if_fail (percentage >= 0 && percentage <= 1.0);
556 if (!progress->adjustment)
557 gtk_progress_set_adjustment (progress, NULL);
558 gtk_progress_set_value (progress, progress->adjustment->lower + percentage *
559 (progress->adjustment->upper - progress->adjustment->lower));
563 gtk_progress_get_current_percentage (GtkProgress *progress)
565 g_return_val_if_fail (GTK_IS_PROGRESS (progress), 0);
567 if (!progress->adjustment)
568 gtk_progress_set_adjustment (progress, NULL);
570 return gtk_progress_get_percentage_from_value (progress, progress->adjustment->value);
574 gtk_progress_get_percentage_from_value (GtkProgress *progress,
577 g_return_val_if_fail (GTK_IS_PROGRESS (progress), 0);
579 if (!progress->adjustment)
580 gtk_progress_set_adjustment (progress, NULL);
582 if (progress->adjustment->lower < progress->adjustment->upper &&
583 value >= progress->adjustment->lower &&
584 value <= progress->adjustment->upper)
585 return (value - progress->adjustment->lower) /
586 (progress->adjustment->upper - progress->adjustment->lower);
592 gtk_progress_set_value (GtkProgress *progress,
595 g_return_if_fail (GTK_IS_PROGRESS (progress));
597 if (!progress->adjustment)
598 gtk_progress_set_adjustment (progress, NULL);
600 if (fabs (progress->adjustment->value - value) > EPSILON)
601 gtk_adjustment_set_value (progress->adjustment, value);
605 gtk_progress_get_value (GtkProgress *progress)
607 g_return_val_if_fail (GTK_IS_PROGRESS (progress), 0);
609 return progress->adjustment ? progress->adjustment->value : 0;
613 gtk_progress_set_show_text (GtkProgress *progress,
616 g_return_if_fail (GTK_IS_PROGRESS (progress));
618 if (progress->show_text != show_text)
620 progress->show_text = show_text;
622 gtk_widget_queue_resize (GTK_WIDGET (progress));
624 g_object_notify (G_OBJECT (progress), "show-text");
629 gtk_progress_set_text_alignment (GtkProgress *progress,
633 g_return_if_fail (GTK_IS_PROGRESS (progress));
634 g_return_if_fail (x_align >= 0.0 && x_align <= 1.0);
635 g_return_if_fail (y_align >= 0.0 && y_align <= 1.0);
637 if (progress->x_align != x_align || progress->y_align != y_align)
639 g_object_freeze_notify (G_OBJECT (progress));
640 if (progress->x_align != x_align)
642 progress->x_align = x_align;
643 g_object_notify (G_OBJECT (progress), "text-xalign");
646 if (progress->y_align != y_align)
648 progress->y_align = y_align;
649 g_object_notify (G_OBJECT (progress), "text-yalign");
651 g_object_thaw_notify (G_OBJECT (progress));
653 if (GTK_WIDGET_DRAWABLE (GTK_WIDGET (progress)))
654 gtk_widget_queue_resize (GTK_WIDGET (progress));
659 gtk_progress_set_format_string (GtkProgress *progress,
664 g_return_if_fail (GTK_IS_PROGRESS (progress));
666 /* Turn on format, in case someone called
667 * gtk_progress_bar_set_text() and turned it off.
669 progress->use_text_format = TRUE;
671 old_format = progress->format;
674 format = DEFAULT_FORMAT;
676 progress->format = g_strdup (format);
679 gtk_widget_queue_resize (GTK_WIDGET (progress));
683 gtk_progress_get_current_text (GtkProgress *progress)
685 g_return_val_if_fail (GTK_IS_PROGRESS (progress), NULL);
687 if (!progress->adjustment)
688 gtk_progress_set_adjustment (progress, NULL);
690 return gtk_progress_build_string (progress, progress->adjustment->value,
691 gtk_progress_get_current_percentage (progress));
695 gtk_progress_get_text_from_value (GtkProgress *progress,
698 g_return_val_if_fail (GTK_IS_PROGRESS (progress), NULL);
700 if (!progress->adjustment)
701 gtk_progress_set_adjustment (progress, NULL);
703 return gtk_progress_build_string (progress, value,
704 gtk_progress_get_percentage_from_value (progress, value));
708 gtk_progress_set_activity_mode (GtkProgress *progress,
709 gboolean activity_mode)
711 g_return_if_fail (GTK_IS_PROGRESS (progress));
713 if (progress->activity_mode != (activity_mode != FALSE))
715 progress->activity_mode = (activity_mode != FALSE);
717 if (progress->activity_mode)
718 GTK_PROGRESS_GET_CLASS (progress)->act_mode_enter (progress);
720 if (GTK_WIDGET_DRAWABLE (GTK_WIDGET (progress)))
721 gtk_widget_queue_resize (GTK_WIDGET (progress));
723 g_object_notify (G_OBJECT (progress), "activity-mode");
727 #define __GTK_PROGRESS_C__
728 #include "gtkaliasdef.c"