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"
38 #include "gtksignal.h"
42 #define MIN_HORIZONTAL_BAR_WIDTH 150
43 #define MIN_HORIZONTAL_BAR_HEIGHT 20
44 #define MIN_VERTICAL_BAR_WIDTH 22
45 #define MIN_VERTICAL_BAR_HEIGHT 80
46 #define MAX_TEXT_LENGTH 80
47 #define TEXT_SPACING 2
66 static void gtk_progress_bar_class_init (GtkProgressBarClass *klass);
67 static void gtk_progress_bar_init (GtkProgressBar *pbar);
68 static void gtk_progress_bar_set_property (GObject *object,
72 static void gtk_progress_bar_get_property (GObject *object,
76 static void gtk_progress_bar_size_request (GtkWidget *widget,
77 GtkRequisition *requisition);
78 static void gtk_progress_bar_real_update (GtkProgress *progress);
79 static void gtk_progress_bar_paint (GtkProgress *progress);
80 static void gtk_progress_bar_act_mode_enter (GtkProgress *progress);
84 gtk_progress_bar_get_type (void)
86 static GtkType progress_bar_type = 0;
88 if (!progress_bar_type)
90 static const GtkTypeInfo progress_bar_info =
93 sizeof (GtkProgressBar),
94 sizeof (GtkProgressBarClass),
95 (GtkClassInitFunc) gtk_progress_bar_class_init,
96 (GtkObjectInitFunc) gtk_progress_bar_init,
97 /* reserved_1 */ NULL,
98 /* reserved_2 */ NULL,
99 (GtkClassInitFunc) NULL
102 progress_bar_type = gtk_type_unique (GTK_TYPE_PROGRESS, &progress_bar_info);
105 return progress_bar_type;
109 gtk_progress_bar_class_init (GtkProgressBarClass *class)
111 GObjectClass *gobject_class;
112 GtkWidgetClass *widget_class;
113 GtkProgressClass *progress_class;
115 gobject_class = G_OBJECT_CLASS (class);
116 widget_class = (GtkWidgetClass *) class;
117 progress_class = (GtkProgressClass *) class;
119 gobject_class->set_property = gtk_progress_bar_set_property;
120 gobject_class->get_property = gtk_progress_bar_get_property;
122 widget_class->size_request = gtk_progress_bar_size_request;
124 progress_class->paint = gtk_progress_bar_paint;
125 progress_class->update = gtk_progress_bar_real_update;
126 progress_class->act_mode_enter = gtk_progress_bar_act_mode_enter;
128 g_object_class_install_property (gobject_class,
130 g_param_spec_object ("adjustment",
132 _("The GtkAdjustment connected to the progress bar (Deprecated)"),
136 g_object_class_install_property (gobject_class,
138 g_param_spec_enum ("orientation",
140 _("Orientation and growth of the progress bar"),
141 GTK_TYPE_PROGRESS_BAR_ORIENTATION,
142 GTK_PROGRESS_LEFT_TO_RIGHT,
145 g_object_class_install_property (gobject_class,
147 g_param_spec_enum ("bar_style",
149 _("Specifies the visual style of the bar in percentage mode (Deprecated)"),
150 GTK_TYPE_PROGRESS_BAR_STYLE,
151 GTK_PROGRESS_CONTINUOUS,
154 g_object_class_install_property (gobject_class,
156 g_param_spec_uint ("activity_step",
158 _("The increment used for each iteration in activity mode (Deprecated)"),
164 g_object_class_install_property (gobject_class,
165 PROP_ACTIVITY_BLOCKS,
166 g_param_spec_uint ("activity_blocks",
167 _("Activity Blocks"),
168 _("The number of blocks which can fit in the progress bar area in activity mode (Deprecated)"),
174 g_object_class_install_property (gobject_class,
175 PROP_DISCRETE_BLOCKS,
176 g_param_spec_uint ("discrete_blocks",
177 _("Discrete Blocks"),
178 _("The number of discrete blocks in a progress bar (when shown in the discrete style"),
184 g_object_class_install_property (gobject_class,
186 g_param_spec_double ("fraction",
188 _("The fraction of total work that has been completed"),
194 g_object_class_install_property (gobject_class,
196 g_param_spec_double ("pulse_step",
198 _("The fraction of total progress to move the bouncing block when pulsed"),
204 g_object_class_install_property (gobject_class,
206 g_param_spec_string ("text",
208 _("Text to be displayed in the progress bar"),
215 gtk_progress_bar_init (GtkProgressBar *pbar)
217 pbar->bar_style = GTK_PROGRESS_CONTINUOUS;
220 pbar->orientation = GTK_PROGRESS_LEFT_TO_RIGHT;
221 pbar->pulse_fraction = 0.1;
222 pbar->activity_pos = 0;
223 pbar->activity_dir = 1;
224 pbar->activity_step = 3;
225 pbar->activity_blocks = 5;
229 gtk_progress_bar_set_property (GObject *object,
234 GtkProgressBar *pbar;
236 pbar = GTK_PROGRESS_BAR (object);
240 case PROP_ADJUSTMENT:
241 gtk_progress_set_adjustment (GTK_PROGRESS (pbar),
242 GTK_ADJUSTMENT (g_value_get_object (value)));
244 case PROP_ORIENTATION:
245 gtk_progress_bar_set_orientation (pbar, g_value_get_enum (value));
248 gtk_progress_bar_set_bar_style (pbar, g_value_get_enum (value));
250 case PROP_ACTIVITY_STEP:
251 gtk_progress_bar_set_activity_step (pbar, g_value_get_uint (value));
253 case PROP_ACTIVITY_BLOCKS:
254 gtk_progress_bar_set_activity_blocks (pbar, g_value_get_uint (value));
256 case PROP_DISCRETE_BLOCKS:
257 gtk_progress_bar_set_discrete_blocks (pbar, g_value_get_uint (value));
260 gtk_progress_bar_set_fraction (pbar, g_value_get_double (value));
262 case PROP_PULSE_STEP:
263 gtk_progress_bar_set_pulse_step (pbar, g_value_get_double (value));
266 gtk_progress_bar_set_text (pbar, g_value_get_string (value));
269 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
275 gtk_progress_bar_get_property (GObject *object,
280 GtkProgressBar *pbar;
282 pbar = GTK_PROGRESS_BAR (object);
286 case PROP_ADJUSTMENT:
287 g_value_set_object (value, G_OBJECT (GTK_PROGRESS (pbar)->adjustment));
289 case PROP_ORIENTATION:
290 g_value_set_enum (value, pbar->orientation);
293 g_value_set_enum (value, pbar->bar_style);
295 case PROP_ACTIVITY_STEP:
296 g_value_set_uint (value, pbar->activity_step);
298 case PROP_ACTIVITY_BLOCKS:
299 g_value_set_uint (value, pbar->activity_blocks);
301 case PROP_DISCRETE_BLOCKS:
302 g_value_set_uint (value, pbar->blocks);
305 g_value_set_double (value, gtk_progress_get_current_percentage (GTK_PROGRESS (pbar)));
307 case PROP_PULSE_STEP:
308 g_value_set_double (value, pbar->pulse_fraction);
311 g_value_set_string (value, gtk_progress_bar_get_text (pbar));
314 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
320 gtk_progress_bar_new (void)
324 pbar = gtk_widget_new (GTK_TYPE_PROGRESS_BAR, NULL);
330 gtk_progress_bar_new_with_adjustment (GtkAdjustment *adjustment)
334 g_return_val_if_fail (adjustment != NULL, NULL);
335 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), NULL);
337 pbar = gtk_widget_new (GTK_TYPE_PROGRESS_BAR,
338 "adjustment", adjustment,
345 gtk_progress_bar_real_update (GtkProgress *progress)
347 GtkProgressBar *pbar;
350 g_return_if_fail (progress != NULL);
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 (widget != NULL);
457 g_return_if_fail (GTK_IS_PROGRESS_BAR (widget));
458 g_return_if_fail (requisition != NULL);
460 progress = GTK_PROGRESS (widget);
461 pbar = GTK_PROGRESS_BAR (widget);
463 if (progress->show_text && pbar->bar_style != GTK_PROGRESS_DISCRETE)
465 buf = gtk_progress_get_text_from_value (progress, progress->adjustment->upper);
467 layout = gtk_widget_create_pango_layout (widget, buf);
468 pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
470 g_object_unref (G_OBJECT (layout));
474 if (pbar->orientation == GTK_PROGRESS_LEFT_TO_RIGHT ||
475 pbar->orientation == GTK_PROGRESS_RIGHT_TO_LEFT)
477 if (progress->show_text && pbar->bar_style != GTK_PROGRESS_DISCRETE)
479 requisition->width = MAX (MIN_HORIZONTAL_BAR_WIDTH,
480 2 * widget->style->xthickness + 3 +
481 logical_rect.width + 2 * TEXT_SPACING);
483 requisition->height = MAX (MIN_HORIZONTAL_BAR_HEIGHT,
484 2 * widget->style->ythickness + 3 +
485 logical_rect.height + 2 * TEXT_SPACING);
489 requisition->width = MIN_HORIZONTAL_BAR_WIDTH;
490 requisition->height = MIN_HORIZONTAL_BAR_HEIGHT;
495 if (progress->show_text && pbar->bar_style != GTK_PROGRESS_DISCRETE)
497 requisition->width = MAX (MIN_VERTICAL_BAR_WIDTH,
498 2 * widget->style->xthickness + 3 +
499 logical_rect.width + 2 * TEXT_SPACING);
501 requisition->height = MAX (MIN_VERTICAL_BAR_HEIGHT,
502 2 * widget->style->ythickness + 3 +
503 logical_rect.height + 2 * TEXT_SPACING);
507 requisition->width = MIN_VERTICAL_BAR_WIDTH;
508 requisition->height = MIN_VERTICAL_BAR_HEIGHT;
514 gtk_progress_bar_act_mode_enter (GtkProgress *progress)
516 GtkProgressBar *pbar;
520 pbar = GTK_PROGRESS_BAR (progress);
521 widget = GTK_WIDGET (progress);
523 /* calculate start pos */
525 if (pbar->orientation == GTK_PROGRESS_LEFT_TO_RIGHT ||
526 pbar->orientation == GTK_PROGRESS_RIGHT_TO_LEFT)
528 size = MAX (2, widget->allocation.width / pbar->activity_blocks);
530 if (pbar->orientation == GTK_PROGRESS_LEFT_TO_RIGHT)
532 pbar->activity_pos = widget->style->xthickness;
533 pbar->activity_dir = 0;
537 pbar->activity_pos = widget->allocation.width -
538 widget->style->xthickness - (widget->allocation.height -
539 widget->style->ythickness * 2);
540 pbar->activity_dir = 1;
545 size = MAX (2, widget->allocation.height / pbar->activity_blocks);
547 if (pbar->orientation == GTK_PROGRESS_TOP_TO_BOTTOM)
549 pbar->activity_pos = widget->style->ythickness;
550 pbar->activity_dir = 0;
554 pbar->activity_pos = widget->allocation.height -
555 widget->style->ythickness - (widget->allocation.width -
556 widget->style->xthickness * 2);
557 pbar->activity_dir = 1;
563 gtk_progress_bar_paint (GtkProgress *progress)
565 GtkProgressBar *pbar;
568 gint block_delta = 0;
576 g_return_if_fail (progress != NULL);
577 g_return_if_fail (GTK_IS_PROGRESS_BAR (progress));
579 pbar = GTK_PROGRESS_BAR (progress);
580 widget = GTK_WIDGET (progress);
582 if (pbar->orientation == GTK_PROGRESS_LEFT_TO_RIGHT ||
583 pbar->orientation == GTK_PROGRESS_RIGHT_TO_LEFT)
584 space = widget->allocation.width -
585 2 * widget->style->xthickness;
587 space = widget->allocation.height -
588 2 * widget->style->ythickness;
590 percentage = gtk_progress_get_current_percentage (progress);
592 if (progress->offscreen_pixmap)
594 gtk_paint_box (widget->style,
595 progress->offscreen_pixmap,
596 GTK_STATE_NORMAL, GTK_SHADOW_IN,
597 NULL, widget, "trough",
599 widget->allocation.width,
600 widget->allocation.height);
602 if (progress->activity_mode)
604 if (pbar->orientation == GTK_PROGRESS_LEFT_TO_RIGHT ||
605 pbar->orientation == GTK_PROGRESS_RIGHT_TO_LEFT)
607 size = MAX (2, widget->allocation.width / pbar->activity_blocks);
609 gtk_paint_box (widget->style,
610 progress->offscreen_pixmap,
611 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
614 widget->style->ythickness,
616 widget->allocation.height - widget->style->ythickness * 2);
621 size = MAX (2, widget->allocation.height / pbar->activity_blocks);
623 gtk_paint_box (widget->style,
624 progress->offscreen_pixmap,
625 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
627 widget->style->xthickness,
629 widget->allocation.width - widget->style->xthickness * 2,
635 amount = percentage * space;
639 switch (pbar->orientation)
642 case GTK_PROGRESS_LEFT_TO_RIGHT:
644 if (pbar->bar_style == GTK_PROGRESS_CONTINUOUS)
646 gtk_paint_box (widget->style,
647 progress->offscreen_pixmap,
648 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
650 widget->style->xthickness,
651 widget->style->ythickness,
653 widget->allocation.height - widget->style->ythickness * 2);
657 x = widget->style->xthickness;
659 for (i = 0; i <= pbar->in_block; i++)
661 block_delta = (((i + 1) * space) / pbar->blocks)
662 - ((i * space) / pbar->blocks);
664 gtk_paint_box (widget->style,
665 progress->offscreen_pixmap,
666 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
669 widget->style->ythickness,
671 widget->allocation.height - widget->style->ythickness * 2);
678 case GTK_PROGRESS_RIGHT_TO_LEFT:
680 if (pbar->bar_style == GTK_PROGRESS_CONTINUOUS)
682 gtk_paint_box (widget->style,
683 progress->offscreen_pixmap,
684 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
686 widget->allocation.width -
687 widget->style->xthickness - amount,
688 widget->style->ythickness,
690 widget->allocation.height -
691 widget->style->ythickness * 2);
695 x = widget->allocation.width -
696 widget->style->xthickness;
698 for (i = 0; i <= pbar->in_block; i++)
700 block_delta = (((i + 1) * space) / pbar->blocks) -
701 ((i * space) / pbar->blocks);
705 gtk_paint_box (widget->style,
706 progress->offscreen_pixmap,
707 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
710 widget->style->ythickness,
712 widget->allocation.height -
713 widget->style->ythickness * 2);
718 case GTK_PROGRESS_BOTTOM_TO_TOP:
720 if (pbar->bar_style == GTK_PROGRESS_CONTINUOUS)
722 gtk_paint_box (widget->style,
723 progress->offscreen_pixmap,
724 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
726 widget->style->xthickness,
727 widget->allocation.height -
728 widget->style->ythickness - amount,
729 widget->allocation.width -
730 widget->style->xthickness * 2,
735 y = widget->allocation.height -
736 widget->style->ythickness;
738 for (i = 0; i <= pbar->in_block; i++)
740 block_delta = (((i + 1) * space) / pbar->blocks) -
741 ((i * space) / pbar->blocks);
745 gtk_paint_box (widget->style,
746 progress->offscreen_pixmap,
747 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
749 widget->style->xthickness,
751 widget->allocation.width -
752 widget->style->xthickness * 2,
758 case GTK_PROGRESS_TOP_TO_BOTTOM:
760 if (pbar->bar_style == GTK_PROGRESS_CONTINUOUS)
762 gtk_paint_box (widget->style,
763 progress->offscreen_pixmap,
764 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
766 widget->style->xthickness,
767 widget->style->ythickness,
768 widget->allocation.width -
769 widget->style->xthickness * 2,
774 y = widget->style->ythickness;
776 for (i = 0; i <= pbar->in_block; i++)
779 block_delta = (((i + 1) * space) / pbar->blocks)
780 - ((i * space) / pbar->blocks);
782 gtk_paint_box (widget->style,
783 progress->offscreen_pixmap,
784 GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
786 widget->style->xthickness,
788 widget->allocation.width -
789 widget->style->xthickness * 2,
802 if (progress->show_text && pbar->bar_style != GTK_PROGRESS_DISCRETE)
809 PangoRectangle logical_rect;
811 buf = gtk_progress_get_current_text (progress);
813 layout = gtk_widget_create_pango_layout (widget, buf);
814 pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
816 x = widget->style->xthickness + 1 +
817 (widget->allocation.width - 2 * widget->style->xthickness -
818 3 - logical_rect.width)
821 y = widget->style->ythickness + 1 +
822 (widget->allocation.height - 2 * widget->style->ythickness -
823 3 - logical_rect.height)
826 rect.x = widget->style->xthickness + 1;
827 rect.y = widget->style->ythickness + 1;
828 rect.width = widget->allocation.width -
829 2 * widget->style->xthickness - 3;
830 rect.height = widget->allocation.height -
831 2 * widget->style->ythickness - 3;
833 gtk_paint_layout (widget->style,
834 progress->offscreen_pixmap,
835 GTK_WIDGET_STATE (widget),
843 g_object_unref (G_OBJECT (layout));
849 /*******************************************************************/
852 * gtk_progress_bar_set_fraction:
853 * @pbar: a #GtkProgressBar
854 * @fraction: fraction of the task that's been completed
856 * Causes the progress bar to "fill in" the given fraction
857 * of the bar. The fraction should be between 0.0 and 1.0,
862 gtk_progress_bar_set_fraction (GtkProgressBar *pbar,
865 g_return_if_fail (pbar != NULL);
866 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
868 /* If we know the percentage, we don't want activity mode. */
869 gtk_progress_set_activity_mode (GTK_PROGRESS (pbar), FALSE);
871 /* We use the deprecated GtkProgress interface internally.
872 * Once everything's been deprecated for a good long time,
873 * we can clean up all this code.
875 gtk_progress_set_percentage (GTK_PROGRESS (pbar), fraction);
877 g_object_notify (G_OBJECT (pbar), "fraction");
881 * gtk_progress_bar_pulse:
882 * @pbar: a #GtkProgressBar
884 * Indicates that some progress is made, but you don't know how much.
885 * Causes the progress bar to enter "activity mode," where a block
886 * bounces back and forth. Each call to gtk_progress_bar_pulse()
887 * causes the block to move by a little bit (the amount of movement
888 * per pulse is determined by gtk_progress_bar_set_pulse_step()).
891 gtk_progress_bar_pulse (GtkProgressBar *pbar)
893 g_return_if_fail (pbar != NULL);
894 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
896 /* If we don't know the percentage, we must want activity mode. */
897 gtk_progress_set_activity_mode (GTK_PROGRESS (pbar), TRUE);
900 gtk_progress_bar_real_update (GTK_PROGRESS (pbar));
904 * gtk_progress_bar_set_text:
905 * @pbar: a #GtkProgressBar
906 * @text: a UTF-8 string
908 * Causes the given @text to appear superimposed on the progress bar.
911 gtk_progress_bar_set_text (GtkProgressBar *pbar,
914 g_return_if_fail (pbar != NULL);
915 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
917 /* We don't support formats in this interface */
918 GTK_PROGRESS (pbar)->use_text_format = FALSE;
922 gtk_progress_set_show_text (GTK_PROGRESS (pbar), TRUE);
923 gtk_progress_set_format_string (GTK_PROGRESS (pbar), text);
927 gtk_progress_set_show_text (GTK_PROGRESS (pbar), FALSE);
928 gtk_progress_set_format_string (GTK_PROGRESS (pbar), "");
931 g_object_notify (G_OBJECT (pbar), "text");
935 * gtk_progress_bar_set_pulse_step:
936 * @pbar: a #GtkProgressBar
937 * @fraction: fraction between 0.0 and 1.0
939 * Sets the fraction of total progress bar length to move the
940 * bouncing block for each call to gtk_progress_bar_pulse().
943 gtk_progress_bar_set_pulse_step (GtkProgressBar *pbar,
946 g_return_if_fail (pbar != NULL);
947 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
949 pbar->pulse_fraction = fraction;
951 g_object_notify (G_OBJECT (pbar), "pulse_step");
955 gtk_progress_bar_update (GtkProgressBar *pbar,
958 g_return_if_fail (pbar != NULL);
959 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
961 /* Use of gtk_progress_bar_update() is deprecated !
962 * Use gtk_progress_bar_set_percentage ()
965 gtk_progress_set_percentage (GTK_PROGRESS (pbar), percentage);
969 * gtk_progress_bar_set_orientation:
970 * @pbar: a #GtkProgressBar
971 * @orientation: orientation of the progress bar
973 * Causes the progress bar to switch to a different orientation
974 * (left-to-right, right-to-left, top-to-bottom, or bottom-to-top).
977 gtk_progress_bar_set_orientation (GtkProgressBar *pbar,
978 GtkProgressBarOrientation orientation)
980 g_return_if_fail (pbar != NULL);
981 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
983 if (pbar->orientation != orientation)
985 pbar->orientation = orientation;
987 if (GTK_WIDGET_DRAWABLE (GTK_WIDGET (pbar)))
988 gtk_widget_queue_resize (GTK_WIDGET (pbar));
990 g_object_notify (G_OBJECT (pbar), "orientation");
995 * gtk_progress_bar_get_text:
996 * @pbar: a #GtkProgressBar
998 * Retrieves the text displayed superimposed on the progress bar,
999 * if any, otherwise %NULL. The return value is a reference
1000 * to the text, not a copy of it, so will become invalid
1001 * if you change the text in the progress bar.
1003 * Return value: text, or %NULL; don't free the string
1005 G_CONST_RETURN gchar*
1006 gtk_progress_bar_get_text (GtkProgressBar *pbar)
1008 g_return_val_if_fail (GTK_IS_PROGRESS_BAR (pbar), NULL);
1010 if (GTK_PROGRESS (pbar)->use_text_format)
1013 return GTK_PROGRESS (pbar)->format;
1017 * gtk_progress_bar_get_fraction:
1018 * @pbar: a #GtkProgressBar
1020 * Returns the current fraction of the task that's been completed.
1022 * Return value: a fraction from 0.0 to 1.0
1025 gtk_progress_bar_get_fraction (GtkProgressBar *pbar)
1027 g_return_val_if_fail (GTK_IS_PROGRESS_BAR (pbar), 0);
1029 return gtk_progress_get_current_percentage (GTK_PROGRESS (pbar));
1033 * gtk_progress_bar_get_pulse_step:
1034 * @pbar: a #GtkProgressBar
1036 * Retrieves the pulse step set with gtk_progress_bar_set_pulse_step()
1038 * Return value: a fraction from 0.0 to 1.0
1041 gtk_progress_bar_get_pulse_step (GtkProgressBar *pbar)
1043 g_return_val_if_fail (GTK_IS_PROGRESS_BAR (pbar), 0);
1045 return pbar->pulse_fraction;
1049 * gtk_progress_bar_get_orientation:
1050 * @pbar: a #GtkProgressBar
1052 * Retrieves the current progress bar orientation.
1054 * Return value: orientation of the progress bar
1056 GtkProgressBarOrientation
1057 gtk_progress_bar_get_orientation (GtkProgressBar *pbar)
1059 g_return_val_if_fail (GTK_IS_PROGRESS_BAR (pbar), 0);
1061 return pbar->orientation;
1065 gtk_progress_bar_set_bar_style (GtkProgressBar *pbar,
1066 GtkProgressBarStyle bar_style)
1068 g_return_if_fail (pbar != NULL);
1069 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
1071 if (pbar->bar_style != bar_style)
1073 pbar->bar_style = bar_style;
1075 if (GTK_WIDGET_DRAWABLE (GTK_WIDGET (pbar)))
1076 gtk_widget_queue_resize (GTK_WIDGET (pbar));
1078 g_object_notify (G_OBJECT (pbar), "bar_style");
1083 gtk_progress_bar_set_discrete_blocks (GtkProgressBar *pbar,
1086 g_return_if_fail (pbar != NULL);
1087 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
1088 g_return_if_fail (blocks > 1);
1090 if (pbar->blocks != blocks)
1092 pbar->blocks = blocks;
1094 if (GTK_WIDGET_DRAWABLE (GTK_WIDGET (pbar)))
1095 gtk_widget_queue_resize (GTK_WIDGET (pbar));
1097 g_object_notify (G_OBJECT (pbar), "discrete_blocks");
1102 gtk_progress_bar_set_activity_step (GtkProgressBar *pbar,
1105 g_return_if_fail (pbar != NULL);
1106 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
1108 if (pbar->activity_step != step)
1110 pbar->activity_step = step;
1111 g_object_notify (G_OBJECT (pbar), "activity_step");
1116 gtk_progress_bar_set_activity_blocks (GtkProgressBar *pbar,
1119 g_return_if_fail (pbar != NULL);
1120 g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar));
1121 g_return_if_fail (blocks > 1);
1123 if (pbar->activity_blocks != blocks)
1125 pbar->activity_blocks = blocks;
1126 g_object_notify (G_OBJECT (pbar), "activity_blocks");