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/.
37 #include "gtkprogressbar.h"
41 #define MIN_HORIZONTAL_BAR_WIDTH 150
42 #define MIN_HORIZONTAL_BAR_HEIGHT 20
43 #define MIN_VERTICAL_BAR_WIDTH 22
44 #define MIN_VERTICAL_BAR_HEIGHT 80
45 #define MAX_TEXT_LENGTH 80
46 #define TEXT_SPACING 2
65 static void gtk_progress_bar_class_init (GtkProgressBarClass *klass);
66 static void gtk_progress_bar_init (GtkProgressBar *pbar);
67 static void gtk_progress_bar_set_property (GObject *object,
71 static void gtk_progress_bar_get_property (GObject *object,
75 static void gtk_progress_bar_size_request (GtkWidget *widget,
76 GtkRequisition *requisition);
77 static void gtk_progress_bar_real_update (GtkProgress *progress);
78 static void gtk_progress_bar_paint (GtkProgress *progress);
79 static void gtk_progress_bar_act_mode_enter (GtkProgress *progress);
83 gtk_progress_bar_get_type (void)
85 static GType progress_bar_type = 0;
87 if (!progress_bar_type)
89 static const GTypeInfo progress_bar_info =
91 sizeof (GtkProgressBarClass),
93 NULL, /* base_finalize */
94 (GClassInitFunc) gtk_progress_bar_class_init,
95 NULL, /* class_finalize */
96 NULL, /* class_data */
97 sizeof (GtkProgressBar),
99 (GInstanceInitFunc) gtk_progress_bar_init,
103 g_type_register_static (GTK_TYPE_PROGRESS, "GtkProgressBar",
104 &progress_bar_info, 0);
107 return progress_bar_type;
111 gtk_progress_bar_class_init (GtkProgressBarClass *class)
113 GObjectClass *gobject_class;
114 GtkWidgetClass *widget_class;
115 GtkProgressClass *progress_class;
117 gobject_class = G_OBJECT_CLASS (class);
118 widget_class = (GtkWidgetClass *) class;
119 progress_class = (GtkProgressClass *) class;
121 gobject_class->set_property = gtk_progress_bar_set_property;
122 gobject_class->get_property = gtk_progress_bar_get_property;
124 widget_class->size_request = gtk_progress_bar_size_request;
126 progress_class->paint = gtk_progress_bar_paint;
127 progress_class->update = gtk_progress_bar_real_update;
128 progress_class->act_mode_enter = gtk_progress_bar_act_mode_enter;
130 g_object_class_install_property (gobject_class,
132 g_param_spec_object ("adjustment",
134 _("The GtkAdjustment connected to the progress bar (Deprecated)"),
138 g_object_class_install_property (gobject_class,
140 g_param_spec_enum ("orientation",
142 _("Orientation and growth direction of the progress bar"),
143 GTK_TYPE_PROGRESS_BAR_ORIENTATION,
144 GTK_PROGRESS_LEFT_TO_RIGHT,
147 g_object_class_install_property (gobject_class,
149 g_param_spec_enum ("bar_style",
151 _("Specifies the visual style of the bar in percentage mode (Deprecated)"),
152 GTK_TYPE_PROGRESS_BAR_STYLE,
153 GTK_PROGRESS_CONTINUOUS,
156 g_object_class_install_property (gobject_class,
158 g_param_spec_uint ("activity_step",
160 _("The increment used for each iteration in activity mode (Deprecated)"),
166 g_object_class_install_property (gobject_class,
167 PROP_ACTIVITY_BLOCKS,
168 g_param_spec_uint ("activity_blocks",
169 _("Activity Blocks"),
170 _("The number of blocks which can fit in the progress bar area in activity mode (Deprecated)"),
176 g_object_class_install_property (gobject_class,
177 PROP_DISCRETE_BLOCKS,
178 g_param_spec_uint ("discrete_blocks",
179 _("Discrete Blocks"),
180 _("The number of discrete blocks in a progress bar (when shown in the discrete style)"),
186 g_object_class_install_property (gobject_class,
188 g_param_spec_double ("fraction",
190 _("The fraction of total work that has been completed"),
196 g_object_class_install_property (gobject_class,
198 g_param_spec_double ("pulse_step",
200 _("The fraction of total progress to move the bouncing block when pulsed"),
206 g_object_class_install_property (gobject_class,
208 g_param_spec_string ("text",
210 _("Text to be displayed in the progress bar"),
217 gtk_progress_bar_init (GtkProgressBar *pbar)
219 pbar->bar_style = GTK_PROGRESS_CONTINUOUS;
222 pbar->orientation = GTK_PROGRESS_LEFT_TO_RIGHT;
223 pbar->pulse_fraction = 0.1;
224 pbar->activity_pos = 0;
225 pbar->activity_dir = 1;
226 pbar->activity_step = 3;
227 pbar->activity_blocks = 5;
231 gtk_progress_bar_set_property (GObject *object,
236 GtkProgressBar *pbar;
238 pbar = GTK_PROGRESS_BAR (object);
242 case PROP_ADJUSTMENT:
243 gtk_progress_set_adjustment (GTK_PROGRESS (pbar),
244 GTK_ADJUSTMENT (g_value_get_object (value)));
246 case PROP_ORIENTATION:
247 gtk_progress_bar_set_orientation (pbar, g_value_get_enum (value));
250 gtk_progress_bar_set_bar_style (pbar, g_value_get_enum (value));
252 case PROP_ACTIVITY_STEP:
253 gtk_progress_bar_set_activity_step (pbar, g_value_get_uint (value));
255 case PROP_ACTIVITY_BLOCKS:
256 gtk_progress_bar_set_activity_blocks (pbar, g_value_get_uint (value));
258 case PROP_DISCRETE_BLOCKS:
259 gtk_progress_bar_set_discrete_blocks (pbar, g_value_get_uint (value));
262 gtk_progress_bar_set_fraction (pbar, g_value_get_double (value));
264 case PROP_PULSE_STEP:
265 gtk_progress_bar_set_pulse_step (pbar, g_value_get_double (value));
268 gtk_progress_bar_set_text (pbar, g_value_get_string (value));
271 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
277 gtk_progress_bar_get_property (GObject *object,
282 GtkProgressBar *pbar;
284 pbar = GTK_PROGRESS_BAR (object);
288 case PROP_ADJUSTMENT:
289 g_value_set_object (value, GTK_PROGRESS (pbar)->adjustment);
291 case PROP_ORIENTATION:
292 g_value_set_enum (value, pbar->orientation);
295 g_value_set_enum (value, pbar->bar_style);
297 case PROP_ACTIVITY_STEP:
298 g_value_set_uint (value, pbar->activity_step);
300 case PROP_ACTIVITY_BLOCKS:
301 g_value_set_uint (value, pbar->activity_blocks);
303 case PROP_DISCRETE_BLOCKS:
304 g_value_set_uint (value, pbar->blocks);
307 g_value_set_double (value, gtk_progress_get_current_percentage (GTK_PROGRESS (pbar)));
309 case PROP_PULSE_STEP:
310 g_value_set_double (value, pbar->pulse_fraction);
313 g_value_set_string (value, gtk_progress_bar_get_text (pbar));
316 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
322 gtk_progress_bar_new (void)
326 pbar = gtk_widget_new (GTK_TYPE_PROGRESS_BAR, NULL);
332 gtk_progress_bar_new_with_adjustment (GtkAdjustment *adjustment)
336 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), NULL);
338 pbar = gtk_widget_new (GTK_TYPE_PROGRESS_BAR,
339 "adjustment", adjustment,
346 gtk_progress_bar_real_update (GtkProgress *progress)
348 GtkProgressBar *pbar;
351 g_return_if_fail (GTK_IS_PROGRESS (progress));
353 pbar = GTK_PROGRESS_BAR (progress);
354 widget = GTK_WIDGET (progress);
356 if (pbar->bar_style == GTK_PROGRESS_CONTINUOUS ||
357 GTK_PROGRESS (pbar)->activity_mode)
359 if (GTK_PROGRESS (pbar)->activity_mode)
363 /* advance the block */
365 if (pbar->orientation == GTK_PROGRESS_LEFT_TO_RIGHT ||
366 pbar->orientation == GTK_PROGRESS_RIGHT_TO_LEFT)
368 /* Update our activity step. */
370 pbar->activity_step = widget->allocation.width * pbar->pulse_fraction;
372 size = MAX (2, widget->allocation.width / pbar->activity_blocks);
374 if (pbar->activity_dir == 0)
376 pbar->activity_pos += pbar->activity_step;
377 if (pbar->activity_pos + size >=
378 widget->allocation.width -
379 widget->style->xthickness)
381 pbar->activity_pos = widget->allocation.width -
382 widget->style->xthickness - size;
383 pbar->activity_dir = 1;
388 pbar->activity_pos -= pbar->activity_step;
389 if (pbar->activity_pos <= widget->style->xthickness)
391 pbar->activity_pos = widget->style->xthickness;
392 pbar->activity_dir = 0;
398 /* Update our activity step. */
400 pbar->activity_step = widget->allocation.height * pbar->pulse_fraction;
402 size = MAX (2, widget->allocation.height / pbar->activity_blocks);
404 if (pbar->activity_dir == 0)
406 pbar->activity_pos += pbar->activity_step;
407 if (pbar->activity_pos + size >=
408 widget->allocation.height -
409 widget->style->ythickness)
411 pbar->activity_pos = widget->allocation.height -
412 widget->style->ythickness - size;
413 pbar->activity_dir = 1;
418 pbar->activity_pos -= pbar->activity_step;
419 if (pbar->activity_pos <= widget->style->ythickness)
421 pbar->activity_pos = widget->style->ythickness;
422 pbar->activity_dir = 0;
427 gtk_progress_bar_paint (progress);
428 gtk_widget_queue_draw (GTK_WIDGET (progress));
434 in_block = -1 + (gint)(gtk_progress_get_current_percentage (progress) *
435 (gdouble)pbar->blocks);
437 if (pbar->in_block != in_block)
439 pbar->in_block = in_block;
440 gtk_progress_bar_paint (progress);
441 gtk_widget_queue_draw (GTK_WIDGET (progress));
447 gtk_progress_bar_size_request (GtkWidget *widget,
448 GtkRequisition *requisition)
450 GtkProgress *progress;
451 GtkProgressBar *pbar;
453 PangoRectangle logical_rect;
456 g_return_if_fail (GTK_IS_PROGRESS_BAR (widget));
457 g_return_if_fail (requisition != NULL);
459 progress = GTK_PROGRESS (widget);
460 pbar = GTK_PROGRESS_BAR (widget);
462 if (progress->show_text && pbar->bar_style != GTK_PROGRESS_DISCRETE)
464 if (!progress->adjustment)
465 gtk_progress_set_adjustment (progress, NULL);
467 buf = gtk_progress_get_text_from_value (progress, progress->adjustment->upper);
469 layout = gtk_widget_create_pango_layout (widget, buf);
470 pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
472 g_object_unref (layout);
476 if (pbar->orientation == GTK_PROGRESS_LEFT_TO_RIGHT ||
477 pbar->orientation == GTK_PROGRESS_RIGHT_TO_LEFT)
479 if (progress->show_text && pbar->bar_style != GTK_PROGRESS_DISCRETE)
481 requisition->width = MAX (MIN_HORIZONTAL_BAR_WIDTH,
482 2 * widget->style->xthickness + 3 +
483 logical_rect.width + 2 * TEXT_SPACING);
485 requisition->height = MAX (MIN_HORIZONTAL_BAR_HEIGHT,
486 2 * widget->style->ythickness + 3 +
487 logical_rect.height + 2 * TEXT_SPACING);
491 requisition->width = MIN_HORIZONTAL_BAR_WIDTH;
492 requisition->height = MIN_HORIZONTAL_BAR_HEIGHT;
497 if (progress->show_text && pbar->bar_style != GTK_PROGRESS_DISCRETE)
499 requisition->width = MAX (MIN_VERTICAL_BAR_WIDTH,
500 2 * widget->style->xthickness + 3 +
501 logical_rect.width + 2 * TEXT_SPACING);
503 requisition->height = MAX (MIN_VERTICAL_BAR_HEIGHT,
504 2 * widget->style->ythickness + 3 +
505 logical_rect.height + 2 * TEXT_SPACING);
509 requisition->width = MIN_VERTICAL_BAR_WIDTH;
510 requisition->height = MIN_VERTICAL_BAR_HEIGHT;
516 gtk_progress_bar_act_mode_enter (GtkProgress *progress)
518 GtkProgressBar *pbar;
521 GtkProgressBarOrientation orientation;
523 pbar = GTK_PROGRESS_BAR (progress);
524 widget = GTK_WIDGET (progress);
526 orientation = pbar->orientation;
527 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
529 if (pbar->orientation == GTK_PROGRESS_LEFT_TO_RIGHT)
530 orientation = GTK_PROGRESS_RIGHT_TO_LEFT;
531 else if (pbar->orientation == GTK_PROGRESS_RIGHT_TO_LEFT)
532 orientation = GTK_PROGRESS_LEFT_TO_RIGHT;
535 /* calculate start pos */
537 if (orientation == GTK_PROGRESS_LEFT_TO_RIGHT ||
538 orientation == GTK_PROGRESS_RIGHT_TO_LEFT)
540 size = MAX (2, widget->allocation.width / pbar->activity_blocks);
542 if (orientation == GTK_PROGRESS_LEFT_TO_RIGHT)
544 pbar->activity_pos = widget->style->xthickness;
545 pbar->activity_dir = 0;
549 pbar->activity_pos = widget->allocation.width -
550 widget->style->xthickness - (widget->allocation.height -
551 widget->style->ythickness * 2);
552 pbar->activity_dir = 1;
557 size = MAX (2, widget->allocation.height / pbar->activity_blocks);
559 if (orientation == GTK_PROGRESS_TOP_TO_BOTTOM)
561 pbar->activity_pos = widget->style->ythickness;
562 pbar->activity_dir = 0;
566 pbar->activity_pos = widget->allocation.height -
567 widget->style->ythickness - (widget->allocation.width -
568 widget->style->xthickness * 2);
569 pbar->activity_dir = 1;
575 gtk_progress_bar_paint (GtkProgress *progress)
577 GtkProgressBar *pbar;
580 gint block_delta = 0;
587 GtkProgressBarOrientation orientation;
589 g_return_if_fail (GTK_IS_PROGRESS_BAR (progress));
591 pbar = GTK_PROGRESS_BAR (progress);
592 widget = GTK_WIDGET (progress);
594 orientation = pbar->orientation;
595 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
597 if (pbar->orientation == GTK_PROGRESS_LEFT_TO_RIGHT)
598 orientation = GTK_PROGRESS_RIGHT_TO_LEFT;
599 else if (pbar->orientation == GTK_PROGRESS_RIGHT_TO_LEFT)
600 orientation = GTK_PROGRESS_LEFT_TO_RIGHT;
603 if (orientation == GTK_PROGRESS_LEFT_TO_RIGHT ||
604 orientation == GTK_PROGRESS_RIGHT_TO_LEFT)
605 space = widget->allocation.width -
606 2 * widget->style->xthickness;
608 space = widget->allocation.height -
609 2 * widget->style->ythickness;
611 percentage = gtk_progress_get_current_percentage (progress);
613 if (progress->offscreen_pixmap)
615 gtk_paint_box (widget->style,
616 progress->offscreen_pixmap,
617 GTK_STATE_NORMAL, GTK_SHADOW_IN,
618 NULL, widget, "trough",
620 widget->allocation.width,
621 widget->allocation.height);
623 if (progress->activity_mode)
625 if (orientation == GTK_PROGRESS_LEFT_TO_RIGHT ||
626 orientation == GTK_PROGRESS_RIGHT_TO_LEFT)
628 size = MAX (2, widget->allocation.width / pbar->activity_blocks);
630 gtk_paint_box (widget->style,
631 progress->offscreen_pixmap,
632 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
635 widget->style->ythickness,
637 widget->allocation.height - widget->style->ythickness * 2);
642 size = MAX (2, widget->allocation.height / pbar->activity_blocks);
644 gtk_paint_box (widget->style,
645 progress->offscreen_pixmap,
646 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
648 widget->style->xthickness,
650 widget->allocation.width - widget->style->xthickness * 2,
656 amount = percentage * space;
663 case GTK_PROGRESS_LEFT_TO_RIGHT:
665 if (pbar->bar_style == GTK_PROGRESS_CONTINUOUS)
667 gtk_paint_box (widget->style,
668 progress->offscreen_pixmap,
669 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
671 widget->style->xthickness,
672 widget->style->ythickness,
674 widget->allocation.height - widget->style->ythickness * 2);
678 x = widget->style->xthickness;
680 for (i = 0; i <= pbar->in_block; i++)
682 block_delta = (((i + 1) * space) / pbar->blocks)
683 - ((i * space) / pbar->blocks);
685 gtk_paint_box (widget->style,
686 progress->offscreen_pixmap,
687 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
690 widget->style->ythickness,
692 widget->allocation.height - widget->style->ythickness * 2);
699 case GTK_PROGRESS_RIGHT_TO_LEFT:
701 if (pbar->bar_style == GTK_PROGRESS_CONTINUOUS)
703 gtk_paint_box (widget->style,
704 progress->offscreen_pixmap,
705 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
707 widget->allocation.width -
708 widget->style->xthickness - amount,
709 widget->style->ythickness,
711 widget->allocation.height -
712 widget->style->ythickness * 2);
716 x = widget->allocation.width -
717 widget->style->xthickness;
719 for (i = 0; i <= pbar->in_block; i++)
721 block_delta = (((i + 1) * space) / pbar->blocks) -
722 ((i * space) / pbar->blocks);
726 gtk_paint_box (widget->style,
727 progress->offscreen_pixmap,
728 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
731 widget->style->ythickness,
733 widget->allocation.height -
734 widget->style->ythickness * 2);
739 case GTK_PROGRESS_BOTTOM_TO_TOP:
741 if (pbar->bar_style == GTK_PROGRESS_CONTINUOUS)
743 gtk_paint_box (widget->style,
744 progress->offscreen_pixmap,
745 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
747 widget->style->xthickness,
748 widget->allocation.height -
749 widget->style->ythickness - amount,
750 widget->allocation.width -
751 widget->style->xthickness * 2,
756 y = widget->allocation.height -
757 widget->style->ythickness;
759 for (i = 0; i <= pbar->in_block; i++)
761 block_delta = (((i + 1) * space) / pbar->blocks) -
762 ((i * space) / pbar->blocks);
766 gtk_paint_box (widget->style,
767 progress->offscreen_pixmap,
768 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
770 widget->style->xthickness,
772 widget->allocation.width -
773 widget->style->xthickness * 2,
779 case GTK_PROGRESS_TOP_TO_BOTTOM:
781 if (pbar->bar_style == GTK_PROGRESS_CONTINUOUS)
783 gtk_paint_box (widget->style,
784 progress->offscreen_pixmap,
785 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
787 widget->style->xthickness,
788 widget->style->ythickness,
789 widget->allocation.width -
790 widget->style->xthickness * 2,
795 y = widget->style->ythickness;
797 for (i = 0; i <= pbar->in_block; i++)
800 block_delta = (((i + 1) * space) / pbar->blocks)
801 - ((i * space) / pbar->blocks);
803 gtk_paint_box (widget->style,
804 progress->offscreen_pixmap,
805 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
807 widget->style->xthickness,
809 widget->allocation.width -
810 widget->style->xthickness * 2,
823 if (progress->show_text && pbar->bar_style != GTK_PROGRESS_DISCRETE)
830 PangoRectangle logical_rect;
832 buf = gtk_progress_get_current_text (progress);
834 layout = gtk_widget_create_pango_layout (widget, buf);
835 pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
837 x = widget->style->xthickness + 1 +
838 (widget->allocation.width - 2 * widget->style->xthickness -
839 3 - logical_rect.width)
842 y = widget->style->ythickness + 1 +
843 (widget->allocation.height - 2 * widget->style->ythickness -
844 3 - logical_rect.height)
847 rect.x = widget->style->xthickness + 1;
848 rect.y = widget->style->ythickness + 1;
849 rect.width = widget->allocation.width -
850 2 * widget->style->xthickness - 3;
851 rect.height = widget->allocation.height -
852 2 * widget->style->ythickness - 3;
854 gtk_paint_layout (widget->style,
855 progress->offscreen_pixmap,
856 GTK_WIDGET_STATE (widget),
864 g_object_unref (layout);
870 /*******************************************************************/
873 * gtk_progress_bar_set_fraction:
874 * @pbar: a #GtkProgressBar
875 * @fraction: fraction of the task that's been completed
877 * Causes the progress bar to "fill in" the given fraction
878 * of the bar. The fraction should be between 0.0 and 1.0,
883 gtk_progress_bar_set_fraction (GtkProgressBar *pbar,
886 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
888 /* If we know the percentage, we don't want activity mode. */
889 gtk_progress_set_activity_mode (GTK_PROGRESS (pbar), FALSE);
891 /* We use the deprecated GtkProgress interface internally.
892 * Once everything's been deprecated for a good long time,
893 * we can clean up all this code.
895 gtk_progress_set_percentage (GTK_PROGRESS (pbar), fraction);
897 g_object_notify (G_OBJECT (pbar), "fraction");
901 * gtk_progress_bar_pulse:
902 * @pbar: a #GtkProgressBar
904 * Indicates that some progress is made, but you don't know how much.
905 * Causes the progress bar to enter "activity mode," where a block
906 * bounces back and forth. Each call to gtk_progress_bar_pulse()
907 * causes the block to move by a little bit (the amount of movement
908 * per pulse is determined by gtk_progress_bar_set_pulse_step()).
911 gtk_progress_bar_pulse (GtkProgressBar *pbar)
913 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
915 /* If we don't know the percentage, we must want activity mode. */
916 gtk_progress_set_activity_mode (GTK_PROGRESS (pbar), TRUE);
919 gtk_progress_bar_real_update (GTK_PROGRESS (pbar));
923 * gtk_progress_bar_set_text:
924 * @pbar: a #GtkProgressBar
925 * @text: a UTF-8 string
927 * Causes the given @text to appear superimposed on the progress bar.
930 gtk_progress_bar_set_text (GtkProgressBar *pbar,
933 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
935 gtk_progress_set_show_text (GTK_PROGRESS (pbar), text && *text);
936 gtk_progress_set_format_string (GTK_PROGRESS (pbar), text);
938 /* We don't support formats in this interface, but turn
939 * them back on for NULL, which should put us back to
942 GTK_PROGRESS (pbar)->use_text_format = (text == NULL);
944 g_object_notify (G_OBJECT (pbar), "text");
948 * gtk_progress_bar_set_pulse_step:
949 * @pbar: a #GtkProgressBar
950 * @fraction: fraction between 0.0 and 1.0
952 * Sets the fraction of total progress bar length to move the
953 * bouncing block for each call to gtk_progress_bar_pulse().
956 gtk_progress_bar_set_pulse_step (GtkProgressBar *pbar,
959 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
961 pbar->pulse_fraction = fraction;
963 g_object_notify (G_OBJECT (pbar), "pulse_step");
967 gtk_progress_bar_update (GtkProgressBar *pbar,
970 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
972 /* Use of gtk_progress_bar_update() is deprecated !
973 * Use gtk_progress_bar_set_percentage ()
976 gtk_progress_set_percentage (GTK_PROGRESS (pbar), percentage);
980 * gtk_progress_bar_set_orientation:
981 * @pbar: a #GtkProgressBar
982 * @orientation: orientation of the progress bar
984 * Causes the progress bar to switch to a different orientation
985 * (left-to-right, right-to-left, top-to-bottom, or bottom-to-top).
988 gtk_progress_bar_set_orientation (GtkProgressBar *pbar,
989 GtkProgressBarOrientation orientation)
991 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
993 if (pbar->orientation != orientation)
995 pbar->orientation = orientation;
997 if (GTK_WIDGET_DRAWABLE (GTK_WIDGET (pbar)))
998 gtk_widget_queue_resize (GTK_WIDGET (pbar));
1000 g_object_notify (G_OBJECT (pbar), "orientation");
1005 * gtk_progress_bar_get_text:
1006 * @pbar: a #GtkProgressBar
1008 * Retrieves the text displayed superimposed on the progress bar,
1009 * if any, otherwise %NULL. The return value is a reference
1010 * to the text, not a copy of it, so will become invalid
1011 * if you change the text in the progress bar.
1013 * Return value: text, or %NULL; this string is owned by the widget
1014 * and should not be modified or freed.
1016 G_CONST_RETURN gchar*
1017 gtk_progress_bar_get_text (GtkProgressBar *pbar)
1019 g_return_val_if_fail (GTK_IS_PROGRESS_BAR (pbar), NULL);
1021 if (GTK_PROGRESS (pbar)->use_text_format)
1024 return GTK_PROGRESS (pbar)->format;
1028 * gtk_progress_bar_get_fraction:
1029 * @pbar: a #GtkProgressBar
1031 * Returns the current fraction of the task that's been completed.
1033 * Return value: a fraction from 0.0 to 1.0
1036 gtk_progress_bar_get_fraction (GtkProgressBar *pbar)
1038 g_return_val_if_fail (GTK_IS_PROGRESS_BAR (pbar), 0);
1040 return gtk_progress_get_current_percentage (GTK_PROGRESS (pbar));
1044 * gtk_progress_bar_get_pulse_step:
1045 * @pbar: a #GtkProgressBar
1047 * Retrieves the pulse step set with gtk_progress_bar_set_pulse_step()
1049 * Return value: a fraction from 0.0 to 1.0
1052 gtk_progress_bar_get_pulse_step (GtkProgressBar *pbar)
1054 g_return_val_if_fail (GTK_IS_PROGRESS_BAR (pbar), 0);
1056 return pbar->pulse_fraction;
1060 * gtk_progress_bar_get_orientation:
1061 * @pbar: a #GtkProgressBar
1063 * Retrieves the current progress bar orientation.
1065 * Return value: orientation of the progress bar
1067 GtkProgressBarOrientation
1068 gtk_progress_bar_get_orientation (GtkProgressBar *pbar)
1070 g_return_val_if_fail (GTK_IS_PROGRESS_BAR (pbar), 0);
1072 return pbar->orientation;
1076 gtk_progress_bar_set_bar_style (GtkProgressBar *pbar,
1077 GtkProgressBarStyle bar_style)
1079 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
1081 if (pbar->bar_style != bar_style)
1083 pbar->bar_style = bar_style;
1085 if (GTK_WIDGET_DRAWABLE (GTK_WIDGET (pbar)))
1086 gtk_widget_queue_resize (GTK_WIDGET (pbar));
1088 g_object_notify (G_OBJECT (pbar), "bar_style");
1093 gtk_progress_bar_set_discrete_blocks (GtkProgressBar *pbar,
1096 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
1097 g_return_if_fail (blocks > 1);
1099 if (pbar->blocks != blocks)
1101 pbar->blocks = blocks;
1103 if (GTK_WIDGET_DRAWABLE (GTK_WIDGET (pbar)))
1104 gtk_widget_queue_resize (GTK_WIDGET (pbar));
1106 g_object_notify (G_OBJECT (pbar), "discrete_blocks");
1111 gtk_progress_bar_set_activity_step (GtkProgressBar *pbar,
1114 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
1116 if (pbar->activity_step != step)
1118 pbar->activity_step = step;
1119 g_object_notify (G_OBJECT (pbar), "activity_step");
1124 gtk_progress_bar_set_activity_blocks (GtkProgressBar *pbar,
1127 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
1128 g_return_if_fail (blocks > 1);
1130 if (pbar->activity_blocks != blocks)
1132 pbar->activity_blocks = blocks;
1133 g_object_notify (G_OBJECT (pbar), "activity_blocks");