/* GTK - The GIMP Toolkit * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library. If not, see . */ /* * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS * file for a list of people on the GTK+ Team. See the ChangeLog * files for a list of changes. These files are distributed with * GTK+ at ftp://ftp.gtk.org/pub/gtk/. */ #include "config.h" #include "gtkprogressbar.h" #include "gtkboxlayout.h" #include "gtkgizmoprivate.h" #include "gtkintl.h" #include "gtklabel.h" #include "gtkorientable.h" #include "gtkprogresstrackerprivate.h" #include "gtkprivate.h" #include "gtkwidgetprivate.h" #include /** * GtkProgressBar: * * `GtkProgressBar` is typically used to display the progress of a long * running operation. * * It provides a visual clue that processing is underway. `GtkProgressBar` * can be used in two different modes: percentage mode and activity mode. * * ![An example GtkProgressBar](progressbar.png) * * When an application can determine how much work needs to take place * (e.g. read a fixed number of bytes from a file) and can monitor its * progress, it can use the `GtkProgressBar` in percentage mode and the * user sees a growing bar indicating the percentage of the work that * has been completed. In this mode, the application is required to call * [method@Gtk.ProgressBar.set_fraction] periodically to update the progress bar. * * When an application has no accurate way of knowing the amount of work * to do, it can use the `GtkProgressBar` in activity mode, which shows * activity by a block moving back and forth within the progress area. In * this mode, the application is required to call [method@Gtk.ProgressBar.pulse] * periodically to update the progress bar. * * There is quite a bit of flexibility provided to control the appearance * of the `GtkProgressBar`. Functions are provided to control the orientation * of the bar, optional text can be displayed along with the bar, and the * step size used in activity mode can be set. * * # CSS nodes * * ``` * progressbar[.osd] * ├── [text] * ╰── trough[.empty][.full] * ╰── progress[.pulse] * ``` * * `GtkProgressBar` has a main CSS node with name progressbar and subnodes with * names text and trough, of which the latter has a subnode named progress. The * text subnode is only present if text is shown. The progress subnode has the * style class .pulse when in activity mode. It gets the style classes .left, * .right, .top or .bottom added when the progress 'touches' the corresponding * end of the GtkProgressBar. The .osd class on the progressbar node is for use * in overlays like the one Epiphany has for page loading progress. * * # Accessibility * * `GtkProgressBar` uses the #GTK_ACCESSIBLE_ROLE_PROGRESS_BAR role. */ typedef struct _GtkProgressBarClass GtkProgressBarClass; struct _GtkProgressBar { GtkWidget parent_instance; char *text; GtkWidget *label; GtkWidget *trough_widget; GtkWidget *progress_widget; double fraction; double pulse_fraction; double activity_pos; guint activity_blocks; GtkOrientation orientation; guint tick_id; GtkProgressTracker tracker; gint64 pulse1; gint64 pulse2; double last_iteration; guint activity_dir : 1; guint activity_mode : 1; guint ellipsize : 3; guint show_text : 1; guint inverted : 1; }; struct _GtkProgressBarClass { GtkWidgetClass parent_class; }; enum { PROP_0, PROP_FRACTION, PROP_PULSE_STEP, PROP_INVERTED, PROP_TEXT, PROP_SHOW_TEXT, PROP_ELLIPSIZE, PROP_ORIENTATION, NUM_PROPERTIES = PROP_ORIENTATION }; static GParamSpec *progress_props[NUM_PROPERTIES] = { NULL, }; static void gtk_progress_bar_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec); static void gtk_progress_bar_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec); static void gtk_progress_bar_act_mode_enter (GtkProgressBar *progress); static void gtk_progress_bar_act_mode_leave (GtkProgressBar *progress); static void gtk_progress_bar_finalize (GObject *object); static void gtk_progress_bar_dispose (GObject *object); static void gtk_progress_bar_set_orientation (GtkProgressBar *progress, GtkOrientation orientation); static void gtk_progress_bar_direction_changed (GtkWidget *widget, GtkTextDirection previous_dir); G_DEFINE_TYPE_WITH_CODE (GtkProgressBar, gtk_progress_bar, GTK_TYPE_WIDGET, G_IMPLEMENT_INTERFACE (GTK_TYPE_ORIENTABLE, NULL)) static void gtk_progress_bar_class_init (GtkProgressBarClass *class) { GObjectClass *gobject_class; GtkWidgetClass *widget_class; gobject_class = G_OBJECT_CLASS (class); widget_class = (GtkWidgetClass *) class; gobject_class->set_property = gtk_progress_bar_set_property; gobject_class->get_property = gtk_progress_bar_get_property; gobject_class->dispose = gtk_progress_bar_dispose; gobject_class->finalize = gtk_progress_bar_finalize; widget_class->direction_changed = gtk_progress_bar_direction_changed; g_object_class_override_property (gobject_class, PROP_ORIENTATION, "orientation"); /** * GtkProgressBar:inverted: (attributes org.gtk.Property.get=gtk_progress_bar_get_inverted org.gtk.Property.set=gtk_progress_bar_set_inverted) * * Invert the direction in which the progress bar grows. */ progress_props[PROP_INVERTED] = g_param_spec_boolean ("inverted", P_("Inverted"), P_("Invert the direction in which the progress bar grows"), FALSE, GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY); /** * GtkProgressBar:fraction: (attributes org.gtk.Property.get=gtk_progress_bar_get_fraction org.gtk.Property.set=gtk_progress_bar_set_fraction) * * The fraction of total work that has been completed. */ progress_props[PROP_FRACTION] = g_param_spec_double ("fraction", P_("Fraction"), P_("The fraction of total work that has been completed"), 0.0, 1.0, 0.0, GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY); /** * GtkProgressBar:pulse-step: (attributes org.gtk.Property.get=gtk_progress_bar_get_pulse_step org.gtk.Property.set=gtk_progress_bar_set_pulse_step) * * The fraction of total progress to move the bounding block when pulsed. */ progress_props[PROP_PULSE_STEP] = g_param_spec_double ("pulse-step", P_("Pulse Step"), P_("The fraction of total progress to move the bouncing block when pulsed"), 0.0, 1.0, 0.1, GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY); /** * GtkProgressBar:text: (attributes org.gtk.Property.get=gtk_progress_bar_get_text org.gtk.Property.set=gtk_progress_bar_set_text) * * Text to be displayed in the progress bar. */ progress_props[PROP_TEXT] = g_param_spec_string ("text", P_("Text"), P_("Text to be displayed in the progress bar"), NULL, GTK_PARAM_READWRITE); /** * GtkProgressBar:show-text: (attributes org.gtk.Property.get=gtk_progress_bar_get_show_text org.gtk.Property.set=gtk_progress_bar_set_show_text) * * Sets whether the progress bar will show a text in addition * to the bar itself. * * The shown text is either the value of the [property@Gtk.ProgressBar:text] * property or, if that is %NULL, the [property@Gtk.ProgressBar:fraction] * value, as a percentage. * * To make a progress bar that is styled and sized suitably for showing text * (even if the actual text is blank), set [property@Gtk.ProgressBar:show-text] * to %TRUE and [property@Gtk.ProgressBar:text] to the empty string (not %NULL). */ progress_props[PROP_SHOW_TEXT] = g_param_spec_boolean ("show-text", P_("Show text"), P_("Whether the progress is shown as text."), FALSE, GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY); /** * GtkProgressBar:ellipsize: (attributes org.gtk.Property.get=gtk_progress_bar_get_ellipsize org.gtk.Property.set=gtk_progress_bar_set_ellipsize) * * The preferred place to ellipsize the string. * * The text will be ellipsized if the progress bar does not have enough room * to display the entire string, specified as a `PangoEllipsizeMode`. * * Note that setting this property to a value other than * %PANGO_ELLIPSIZE_NONE has the side-effect that the progress bar requests * only enough space to display the ellipsis ("..."). Another means to set a * progress bar's width is [method@Gtk.Widget.set_size_request]. */ progress_props[PROP_ELLIPSIZE] = g_param_spec_enum ("ellipsize", P_("Ellipsize"), P_("The preferred place to ellipsize the string, if the progress bar " "does not have enough room to display the entire string, if at all."), PANGO_TYPE_ELLIPSIZE_MODE, PANGO_ELLIPSIZE_NONE, GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY); g_object_class_install_properties (gobject_class, NUM_PROPERTIES, progress_props); gtk_widget_class_set_css_name (widget_class, I_("progressbar")); gtk_widget_class_set_layout_manager_type (widget_class, GTK_TYPE_BOX_LAYOUT); gtk_widget_class_set_accessible_role (widget_class, GTK_ACCESSIBLE_ROLE_PROGRESS_BAR); } static void update_fraction_classes (GtkProgressBar *pbar) { gboolean empty = FALSE; gboolean full = FALSE; /* Here we set classes based on fill-level unless we're in activity-mode. */ if (!pbar->activity_mode) { if (pbar->fraction <= 0.0) empty = TRUE; else if (pbar->fraction >= 1.0) full = TRUE; } if (empty) gtk_widget_add_css_class (pbar->trough_widget, "empty"); else gtk_widget_remove_css_class (pbar->trough_widget, "empty"); if (full) gtk_widget_add_css_class (pbar->trough_widget, "full"); else gtk_widget_remove_css_class (pbar->trough_widget, "full"); } static void update_node_classes (GtkProgressBar *pbar) { gboolean left = FALSE; gboolean right = FALSE; gboolean top = FALSE; gboolean bottom = FALSE; /* Here we set positional classes, depending on which end of the * progressbar the progress touches. */ if (pbar->activity_mode) { if (pbar->orientation == GTK_ORIENTATION_HORIZONTAL) { left = pbar->activity_pos <= 0.0; right = pbar->activity_pos >= 1.0; } else { top = pbar->activity_pos <= 0.0; bottom = pbar->activity_pos >= 1.0; } } else /* continuous */ { gboolean inverted; inverted = pbar->inverted; if (gtk_widget_get_direction (GTK_WIDGET (pbar)) == GTK_TEXT_DIR_RTL) { if (pbar->orientation == GTK_ORIENTATION_HORIZONTAL) inverted = !inverted; } if (pbar->orientation == GTK_ORIENTATION_HORIZONTAL) { left = !inverted || pbar->fraction >= 1.0; right = inverted || pbar->fraction >= 1.0; } else { top = !inverted || pbar->fraction >= 1.0; bottom = inverted || pbar->fraction >= 1.0; } } if (left) gtk_widget_add_css_class (pbar->progress_widget, "left"); else gtk_widget_remove_css_class (pbar->progress_widget, "left"); if (right) gtk_widget_add_css_class (pbar->progress_widget, "right"); else gtk_widget_remove_css_class (pbar->progress_widget, "right"); if (top) gtk_widget_add_css_class (pbar->progress_widget, "top"); else gtk_widget_remove_css_class (pbar->progress_widget, "top"); if (bottom) gtk_widget_add_css_class (pbar->progress_widget, "bottom"); else gtk_widget_remove_css_class (pbar->progress_widget, "bottom"); update_fraction_classes (pbar); } static void allocate_trough (GtkGizmo *gizmo, int width, int height, int baseline) { GtkProgressBar *pbar = GTK_PROGRESS_BAR (gtk_widget_get_parent (GTK_WIDGET (gizmo))); GtkAllocation alloc; int progress_width, progress_height; gboolean inverted; inverted = pbar->inverted; if (gtk_widget_get_direction (GTK_WIDGET (pbar)) == GTK_TEXT_DIR_RTL) { if (pbar->orientation == GTK_ORIENTATION_HORIZONTAL) inverted = !inverted; } gtk_widget_measure (pbar->progress_widget, GTK_ORIENTATION_VERTICAL, -1, &progress_height, NULL, NULL, NULL); gtk_widget_measure (pbar->progress_widget, GTK_ORIENTATION_HORIZONTAL, -1, &progress_width, NULL, NULL, NULL); if (pbar->activity_mode) { if (pbar->orientation == GTK_ORIENTATION_HORIZONTAL) { alloc.width = progress_width + (width - progress_width) / pbar->activity_blocks; alloc.x = pbar->activity_pos * (width - alloc.width); alloc.y = (height - progress_height) / 2; alloc.height = progress_height; } else { alloc.height = progress_height + (height - progress_height) / pbar->activity_blocks; alloc.y = pbar->activity_pos * (height - alloc.height); alloc.x = (width - progress_width) / 2; alloc.width = progress_width; } } else { if (pbar->orientation == GTK_ORIENTATION_HORIZONTAL) { alloc.width = progress_width + (width - progress_width) * pbar->fraction; alloc.height = progress_height; alloc.y = (height - progress_height) / 2; if (!inverted) alloc.x = 0; else alloc.x = width - alloc.width; } else { alloc.width = progress_width; alloc.height = progress_height + (height - progress_height) * pbar->fraction; alloc.x = (width - progress_width) / 2; if (!inverted) alloc.y = 0; else alloc.y = height - alloc.height; } } gtk_widget_size_allocate (pbar->progress_widget, &alloc, -1); } static void gtk_progress_bar_init (GtkProgressBar *pbar) { pbar->inverted = FALSE; pbar->pulse_fraction = 0.1; pbar->activity_pos = 0; pbar->activity_dir = 1; pbar->activity_blocks = 5; pbar->ellipsize = PANGO_ELLIPSIZE_NONE; pbar->show_text = FALSE; pbar->text = NULL; pbar->fraction = 0.0; pbar->trough_widget = gtk_gizmo_new_with_role ("trough", GTK_ACCESSIBLE_ROLE_NONE, NULL, allocate_trough, NULL, NULL, NULL, NULL); gtk_widget_set_parent (pbar->trough_widget, GTK_WIDGET (pbar)); pbar->progress_widget = gtk_gizmo_new_with_role ("progress", GTK_ACCESSIBLE_ROLE_NONE, NULL, NULL, NULL, NULL, NULL, NULL); gtk_widget_set_parent (pbar->progress_widget, pbar->trough_widget); /* horizontal is default */ pbar->orientation = GTK_ORIENTATION_VERTICAL; /* Just to force an update... */ gtk_progress_bar_set_orientation (pbar, GTK_ORIENTATION_HORIZONTAL); gtk_widget_update_orientation (GTK_WIDGET (pbar), pbar->orientation); gtk_accessible_update_property (GTK_ACCESSIBLE (pbar), GTK_ACCESSIBLE_PROPERTY_VALUE_MAX, 1.0, GTK_ACCESSIBLE_PROPERTY_VALUE_MIN, 0.0, GTK_ACCESSIBLE_PROPERTY_VALUE_NOW, 0.0, -1); } static void gtk_progress_bar_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec) { GtkProgressBar *pbar; pbar = GTK_PROGRESS_BAR (object); switch (prop_id) { case PROP_ORIENTATION: gtk_progress_bar_set_orientation (pbar, g_value_get_enum (value)); break; case PROP_INVERTED: gtk_progress_bar_set_inverted (pbar, g_value_get_boolean (value)); break; case PROP_FRACTION: gtk_progress_bar_set_fraction (pbar, g_value_get_double (value)); break; case PROP_PULSE_STEP: gtk_progress_bar_set_pulse_step (pbar, g_value_get_double (value)); break; case PROP_TEXT: gtk_progress_bar_set_text (pbar, g_value_get_string (value)); break; case PROP_SHOW_TEXT: gtk_progress_bar_set_show_text (pbar, g_value_get_boolean (value)); break; case PROP_ELLIPSIZE: gtk_progress_bar_set_ellipsize (pbar, g_value_get_enum (value)); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } } static void gtk_progress_bar_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec) { GtkProgressBar *pbar = GTK_PROGRESS_BAR (object); switch (prop_id) { case PROP_ORIENTATION: g_value_set_enum (value, pbar->orientation); break; case PROP_INVERTED: g_value_set_boolean (value, pbar->inverted); break; case PROP_FRACTION: g_value_set_double (value, pbar->fraction); break; case PROP_PULSE_STEP: g_value_set_double (value, pbar->pulse_fraction); break; case PROP_TEXT: g_value_set_string (value, pbar->text); break; case PROP_SHOW_TEXT: g_value_set_boolean (value, pbar->show_text); break; case PROP_ELLIPSIZE: g_value_set_enum (value, pbar->ellipsize); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } } /** * gtk_progress_bar_new: * * Creates a new `GtkProgressBar`. * * Returns: a `GtkProgressBar`. */ GtkWidget* gtk_progress_bar_new (void) { GtkWidget *pbar; pbar = g_object_new (GTK_TYPE_PROGRESS_BAR, NULL); return pbar; } static void gtk_progress_bar_dispose (GObject *object) { GtkProgressBar *pbar = GTK_PROGRESS_BAR (object); if (pbar->activity_mode) gtk_progress_bar_act_mode_leave (pbar); g_clear_pointer (&pbar->label, gtk_widget_unparent); g_clear_pointer (&pbar->progress_widget, gtk_widget_unparent); g_clear_pointer (&pbar->trough_widget, gtk_widget_unparent); G_OBJECT_CLASS (gtk_progress_bar_parent_class)->dispose (object); } static void gtk_progress_bar_finalize (GObject *object) { GtkProgressBar *pbar = GTK_PROGRESS_BAR (object); g_free (pbar->text); G_OBJECT_CLASS (gtk_progress_bar_parent_class)->finalize (object); } static char * get_current_text (GtkProgressBar *pbar) { if (pbar->text) return g_strdup (pbar->text); else return g_strdup_printf (C_("progress bar label", "%.0f %%"), pbar->fraction * 100.0); } static gboolean tick_cb (GtkWidget *widget, GdkFrameClock *frame_clock, gpointer user_data) { GtkProgressBar *pbar = GTK_PROGRESS_BAR (widget); gint64 frame_time; double iteration, pulse_iterations, current_iterations, fraction; if (pbar->pulse2 == 0 && pbar->pulse1 == 0) return G_SOURCE_CONTINUE; frame_time = gdk_frame_clock_get_frame_time (frame_clock); gtk_progress_tracker_advance_frame (&pbar->tracker, frame_time); g_assert (pbar->pulse2 > pbar->pulse1); pulse_iterations = (pbar->pulse2 - pbar->pulse1) / (double) G_USEC_PER_SEC; current_iterations = (frame_time - pbar->pulse1) / (double) G_USEC_PER_SEC; iteration = gtk_progress_tracker_get_iteration (&pbar->tracker); /* Determine the fraction to move the block from one frame * to the next when pulse_fraction is how far the block should * move between two calls to gtk_progress_bar_pulse(). */ fraction = pbar->pulse_fraction * (iteration - pbar->last_iteration) / MAX (pulse_iterations, current_iterations); pbar->last_iteration = iteration; if (current_iterations > 3 * pulse_iterations) return G_SOURCE_CONTINUE; /* advance the block */ if (pbar->activity_dir == 0) { pbar->activity_pos += fraction; if (pbar->activity_pos > 1.0) { pbar->activity_pos = 1.0; pbar->activity_dir = 1; } } else { pbar->activity_pos -= fraction; if (pbar->activity_pos <= 0) { pbar->activity_pos = 0; pbar->activity_dir = 0; } } update_node_classes (pbar); gtk_widget_queue_allocate (pbar->trough_widget); return G_SOURCE_CONTINUE; } static void gtk_progress_bar_act_mode_enter (GtkProgressBar *pbar) { GtkWidget *widget = GTK_WIDGET (pbar); gboolean inverted; gtk_widget_add_css_class (pbar->progress_widget, "pulse"); gtk_accessible_update_state (GTK_ACCESSIBLE (pbar), GTK_ACCESSIBLE_STATE_BUSY, TRUE, -1); inverted = pbar->inverted; if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL) { if (pbar->orientation == GTK_ORIENTATION_HORIZONTAL) inverted = !inverted; } /* calculate start pos */ if (!inverted) { pbar->activity_pos = 0.0; pbar->activity_dir = 0; } else { pbar->activity_pos = 1.0; pbar->activity_dir = 1; } update_node_classes (pbar); /* No fixed schedule for pulses, will adapt after calls to update_pulse. Just * start the tracker to repeat forever with iterations every second.*/ gtk_progress_tracker_start (&pbar->tracker, G_USEC_PER_SEC, 0, INFINITY); pbar->tick_id = gtk_widget_add_tick_callback (widget, tick_cb, NULL, NULL); pbar->pulse2 = 0; pbar->pulse1 = 0; pbar->last_iteration = 0; } static void gtk_progress_bar_act_mode_leave (GtkProgressBar *pbar) { if (pbar->tick_id) gtk_widget_remove_tick_callback (GTK_WIDGET (pbar), pbar->tick_id); pbar->tick_id = 0; gtk_accessible_update_state (GTK_ACCESSIBLE (pbar), GTK_ACCESSIBLE_STATE_BUSY, FALSE, -1); gtk_widget_remove_css_class (pbar->progress_widget, "pulse"); update_node_classes (pbar); } static void gtk_progress_bar_set_activity_mode (GtkProgressBar *pbar, gboolean activity_mode) { if (pbar->activity_mode == activity_mode) return; pbar->activity_mode = activity_mode; if (pbar->activity_mode) gtk_progress_bar_act_mode_enter (pbar); else gtk_progress_bar_act_mode_leave (pbar); gtk_widget_queue_resize (GTK_WIDGET (pbar)); } /** * gtk_progress_bar_set_fraction: (attributes org.gtk.Method.set_property=fraction) * @pbar: a `GtkProgressBar` * @fraction: fraction of the task that’s been completed * * Causes the progress bar to “fill in” the given fraction * of the bar. * * The fraction should be between 0.0 and 1.0, inclusive. */ void gtk_progress_bar_set_fraction (GtkProgressBar *pbar, double fraction) { char *text = NULL; g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar)); pbar->fraction = CLAMP (fraction, 0.0, 1.0); if (pbar->label) { text = get_current_text (pbar); gtk_label_set_label (GTK_LABEL (pbar->label), text); } gtk_progress_bar_set_activity_mode (pbar, FALSE); gtk_widget_queue_allocate (pbar->trough_widget); update_fraction_classes (pbar); gtk_accessible_update_property (GTK_ACCESSIBLE (pbar), GTK_ACCESSIBLE_PROPERTY_VALUE_MAX, 1.0, GTK_ACCESSIBLE_PROPERTY_VALUE_MIN, 0.0, GTK_ACCESSIBLE_PROPERTY_VALUE_NOW, fraction, -1); if (text != NULL) { gtk_accessible_update_property (GTK_ACCESSIBLE (pbar), GTK_ACCESSIBLE_PROPERTY_VALUE_TEXT, text, -1); } else { gtk_accessible_reset_property (GTK_ACCESSIBLE (pbar), GTK_ACCESSIBLE_PROPERTY_VALUE_TEXT); } g_free (text); g_object_notify_by_pspec (G_OBJECT (pbar), progress_props[PROP_FRACTION]); } static void gtk_progress_bar_update_pulse (GtkProgressBar *pbar) { gint64 pulse_time = g_get_monotonic_time (); if (pbar->pulse2 == pulse_time) return; pbar->pulse1 = pbar->pulse2; pbar->pulse2 = pulse_time; } /** * gtk_progress_bar_pulse: * @pbar: a `GtkProgressBar` * * Indicates that some progress has been made, but you don’t know how much. * * Causes the progress bar to enter “activity mode,” where a block * bounces back and forth. Each call to [method@Gtk.ProgressBar.pulse] * causes the block to move by a little bit (the amount of movement * per pulse is determined by [method@Gtk.ProgressBar.set_pulse_step]). */ void gtk_progress_bar_pulse (GtkProgressBar *pbar) { g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar)); gtk_progress_bar_set_activity_mode (pbar, TRUE); gtk_progress_bar_update_pulse (pbar); } /** * gtk_progress_bar_set_text: (attributes org.gtk.Method.set_property=text) * @pbar: a `GtkProgressBar` * @text: (allow-none): a UTF-8 string, or %NULL * * Causes the given @text to appear next to the progress bar. * * If @text is %NULL and [property@Gtk.ProgressBar:show-text] is %TRUE, * the current value of [property@Gtk.ProgressBar:fraction] will be displayed * as a percentage. * * If @text is non-%NULL and [property@Gtk.ProgressBar:show-text] is %TRUE, * the text will be displayed. In this case, it will not display the progress * percentage. If @text is the empty string, the progress bar will still * be styled and sized suitably for containing text, as long as * [property@Gtk.ProgressBar:show-text] is %TRUE. */ void gtk_progress_bar_set_text (GtkProgressBar *pbar, const char *text) { g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar)); /* Don't notify again if nothing's changed. */ if (g_strcmp0 (pbar->text, text) == 0) return; g_free (pbar->text); pbar->text = g_strdup (text); if (pbar->label) gtk_label_set_label (GTK_LABEL (pbar->label), text); g_object_notify_by_pspec (G_OBJECT (pbar), progress_props[PROP_TEXT]); } /** * gtk_progress_bar_set_show_text: (attributes org.gtk.Method.set_property=show-text) * @pbar: a `GtkProgressBar` * @show_text: whether to show text * * Sets whether the progress bar will show text next to the bar. * * The shown text is either the value of the [property@Gtk.ProgressBar:text] * property or, if that is %NULL, the [property@Gtk.ProgressBar:fraction] value, * as a percentage. * * To make a progress bar that is styled and sized suitably for containing * text (even if the actual text is blank), set [property@Gtk.ProgressBar:show-text] * to %TRUE and [property@Gtk.ProgressBar:text] to the empty string (not %NULL). */ void gtk_progress_bar_set_show_text (GtkProgressBar *pbar, gboolean show_text) { g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar)); show_text = !!show_text; if (pbar->show_text == show_text) return; pbar->show_text = show_text; if (show_text) { char *text = get_current_text (pbar); pbar->label = g_object_new (GTK_TYPE_LABEL, "accessible-role", GTK_ACCESSIBLE_ROLE_NONE, "css-name", "text", "label", text, "ellipsize", pbar->ellipsize, NULL); gtk_widget_insert_after (pbar->label, GTK_WIDGET (pbar), NULL); g_free (text); } else { g_clear_pointer (&pbar->label, gtk_widget_unparent); } g_object_notify_by_pspec (G_OBJECT (pbar), progress_props[PROP_SHOW_TEXT]); } /** * gtk_progress_bar_get_show_text: (attributes org.gtk.Method.get_property=show-text) * @pbar: a `GtkProgressBar` * * Returns whether the `GtkProgressBar` shows text. * * See [method@Gtk.ProgressBar.set_show_text]. * * Returns: %TRUE if text is shown in the progress bar */ gboolean gtk_progress_bar_get_show_text (GtkProgressBar *pbar) { g_return_val_if_fail (GTK_IS_PROGRESS_BAR (pbar), FALSE); return pbar->show_text; } /** * gtk_progress_bar_set_pulse_step: (attributes org.gtk.Method.set_property=pulse-step) * @pbar: a `GtkProgressBar` * @fraction: fraction between 0.0 and 1.0 * * Sets the fraction of total progress bar length to move the * bouncing block. * * The bouncing block is moved when [method@Gtk.ProgressBar.pulse] * is called. */ void gtk_progress_bar_set_pulse_step (GtkProgressBar *pbar, double fraction) { g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar)); pbar->pulse_fraction = fraction; g_object_notify_by_pspec (G_OBJECT (pbar), progress_props[PROP_PULSE_STEP]); } static void gtk_progress_bar_direction_changed (GtkWidget *widget, GtkTextDirection previous_dir) { GtkProgressBar *pbar = GTK_PROGRESS_BAR (widget); update_node_classes (pbar); GTK_WIDGET_CLASS (gtk_progress_bar_parent_class)->direction_changed (widget, previous_dir); } static void gtk_progress_bar_set_orientation (GtkProgressBar *pbar, GtkOrientation orientation) { GtkBoxLayout *layout; if (pbar->orientation == orientation) return; pbar->orientation = orientation; if (orientation == GTK_ORIENTATION_HORIZONTAL) { gtk_widget_set_vexpand (pbar->trough_widget, FALSE); gtk_widget_set_hexpand (pbar->trough_widget, TRUE); gtk_widget_set_halign (pbar->trough_widget, GTK_ALIGN_FILL); gtk_widget_set_valign (pbar->trough_widget, GTK_ALIGN_CENTER); } else { gtk_widget_set_vexpand (pbar->trough_widget, TRUE); gtk_widget_set_hexpand (pbar->trough_widget, FALSE); gtk_widget_set_halign (pbar->trough_widget, GTK_ALIGN_CENTER); gtk_widget_set_valign (pbar->trough_widget, GTK_ALIGN_FILL); } gtk_widget_update_orientation (GTK_WIDGET (pbar), pbar->orientation); update_node_classes (pbar); layout = GTK_BOX_LAYOUT (gtk_widget_get_layout_manager (GTK_WIDGET (pbar))); gtk_orientable_set_orientation (GTK_ORIENTABLE (layout), GTK_ORIENTATION_VERTICAL); g_object_notify (G_OBJECT (pbar), "orientation"); } /** * gtk_progress_bar_set_inverted: (attributes org.gtk.Method.set_property=inverted) * @pbar: a `GtkProgressBar` * @inverted: %TRUE to invert the progress bar * * Sets whether the progress bar is inverted. * * Progress bars normally grow from top to bottom or left to right. * Inverted progress bars grow in the opposite direction. */ void gtk_progress_bar_set_inverted (GtkProgressBar *pbar, gboolean inverted) { g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar)); if (pbar->inverted == inverted) return; pbar->inverted = inverted; update_node_classes (pbar); g_object_notify_by_pspec (G_OBJECT (pbar), progress_props[PROP_INVERTED]); } /** * gtk_progress_bar_get_text: (attributes org.gtk.Method.get_property=text) * @pbar: a `GtkProgressBar` * * Retrieves the text that is displayed with the progress bar. * * The return value is a reference to the text, not a copy of it, * so will become invalid if you change the text in the progress bar. * * Returns: (nullable): text, or %NULL; this string is owned by the widget * and should not be modified or freed. */ const char * gtk_progress_bar_get_text (GtkProgressBar *pbar) { g_return_val_if_fail (GTK_IS_PROGRESS_BAR (pbar), NULL); return pbar->text; } /** * gtk_progress_bar_get_fraction: (attributes org.gtk.Method.get_property=fraction) * @pbar: a `GtkProgressBar` * * Returns the current fraction of the task that’s been completed. * * Returns: a fraction from 0.0 to 1.0 */ double gtk_progress_bar_get_fraction (GtkProgressBar *pbar) { g_return_val_if_fail (GTK_IS_PROGRESS_BAR (pbar), 0); return pbar->fraction; } /** * gtk_progress_bar_get_pulse_step: (attributes org.gtk.Method.get_property=pulse-step) * @pbar: a `GtkProgressBar` * * Retrieves the pulse step. * * See [method@Gtk.ProgressBar.set_pulse_step]. * * Returns: a fraction from 0.0 to 1.0 */ double gtk_progress_bar_get_pulse_step (GtkProgressBar *pbar) { g_return_val_if_fail (GTK_IS_PROGRESS_BAR (pbar), 0); return pbar->pulse_fraction; } /** * gtk_progress_bar_get_inverted: (attributes org.gtk.Method.get_property=inverted) * @pbar: a `GtkProgressBar` * * Returns whether the progress bar is inverted. * * Returns: %TRUE if the progress bar is inverted */ gboolean gtk_progress_bar_get_inverted (GtkProgressBar *pbar) { g_return_val_if_fail (GTK_IS_PROGRESS_BAR (pbar), FALSE); return pbar->inverted; } /** * gtk_progress_bar_set_ellipsize: (attributes org.gtk.Method.set_property=ellipsize) * @pbar: a `GtkProgressBar` * @mode: a `PangoEllipsizeMode` * * Sets the mode used to ellipsize the text. * * The text is ellipsized if there is not enough space * to render the entire string. */ void gtk_progress_bar_set_ellipsize (GtkProgressBar *pbar, PangoEllipsizeMode mode) { g_return_if_fail (GTK_IS_PROGRESS_BAR (pbar)); g_return_if_fail (mode >= PANGO_ELLIPSIZE_NONE && mode <= PANGO_ELLIPSIZE_END); if ((PangoEllipsizeMode)pbar->ellipsize == mode) return; pbar->ellipsize = mode; if (pbar->label) gtk_label_set_ellipsize (GTK_LABEL (pbar->label), mode); g_object_notify_by_pspec (G_OBJECT (pbar), progress_props[PROP_ELLIPSIZE]); } /** * gtk_progress_bar_get_ellipsize: (attributes org.gtk.Method.get_property=ellipsize) * @pbar: a `GtkProgressBar` * * Returns the ellipsizing position of the progress bar. * * See [method@Gtk.ProgressBar.set_ellipsize]. * * Returns: `PangoEllipsizeMode` */ PangoEllipsizeMode gtk_progress_bar_get_ellipsize (GtkProgressBar *pbar) { g_return_val_if_fail (GTK_IS_PROGRESS_BAR (pbar), PANGO_ELLIPSIZE_NONE); return pbar->ellipsize; }