#include <string.h>
#include "gtkprogressbar.h"
-#include "gtkorientable.h"
+#include "gtkorientableprivate.h"
#include "gtkprivate.h"
#include "gtkintl.h"
+#include "a11y/gtkprogressbaraccessible.h"
+
+/**
+ * SECTION:gtkprogressbar
+ * @Short_description: A widget which indicates progress visually
+ * @Title: GtkProgressBar
+ *
+ * The #GtkProgressBar is typically used to display the progress of a long
+ * running operation. It provides a visual clue that processing
+ * is underway. The #GtkProgressBar can be used in two different
+ * modes: percentage mode and activity mode.
+ *
+ * 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
+ * gtk_progress_bar_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 gtk_progress_bar_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.
+ */
#define MIN_HORIZONTAL_BAR_WIDTH 150
#define MIN_HORIZONTAL_BAR_HEIGHT 20
struct _GtkProgressBarPrivate
{
- GtkOrientation orientation;
-
gchar *text;
gdouble fraction;
gdouble pulse_fraction;
- guint blocks;
- gint in_block;
-
gint activity_pos;
guint activity_blocks;
guint activity_step;
+ GtkOrientation orientation;
+
guint activity_dir : 1;
guint activity_mode : 1;
guint ellipsize : 3;
NULL,
GTK_PARAM_READWRITE));
+ /**
+ * GtkProgressBar:show_text:
+ *
+ * Sets whether the progressbar will show text superimposed
+ * over the bar. The shown text is either the value of
+ * the #GtkProgressBar::text property or, if that is %NULL,
+ * the #GtkProgressBar::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 #GtkProgressBar:show-text to
+ * %TRUE and #GtkProgressBar:text to the empty string (not %NULL).
+ *
+ * Since: 3.0
+ */
g_object_class_install_property (gobject_class,
PROP_SHOW_TEXT,
g_param_spec_boolean ("show-text",
G_PARAM_READWRITE));
g_type_class_add_private (class, sizeof (GtkProgressBarPrivate));
+
+ gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_PROGRESS_BAR_ACCESSIBLE);
}
static void
GtkProgressBarPrivate);
priv = pbar->priv;
- priv->blocks = 10;
- priv->in_block = -1;
priv->orientation = GTK_ORIENTATION_HORIZONTAL;
priv->inverted = FALSE;
priv->pulse_fraction = 0.1;
}
}
+/**
+ * gtk_progress_bar_new:
+ *
+ * Creates a new #GtkProgressBar.
+ *
+ * Returns: a #GtkProgressBar.
+ */
GtkWidget*
gtk_progress_bar_new (void)
{
if (priv->activity_mode)
{
GtkAllocation allocation;
- GtkStyle *style;
- guint size;
+ GtkStyleContext *context;
+ GtkStateFlags state;
+ GtkBorder padding;
+ gint size;
gtk_widget_get_allocation (widget, &allocation);
- style = gtk_widget_get_style (widget);
+ context = gtk_widget_get_style_context (widget);
+ state = gtk_widget_get_state_flags (widget);
+ gtk_style_context_get_padding (context, state, &padding);
/* advance the block */
if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
if (priv->activity_dir == 0)
{
priv->activity_pos += priv->activity_step;
- if (priv->activity_pos + size >= allocation.width - style->xthickness)
+ if (priv->activity_pos + size >= allocation.width - padding.left)
{
- priv->activity_pos = allocation.width - style->xthickness - size;
+ priv->activity_pos = allocation.width - padding.left - size;
priv->activity_dir = 1;
}
}
else
{
priv->activity_pos -= priv->activity_step;
- if (priv->activity_pos <= style->xthickness)
+ if (priv->activity_pos <= padding.left)
{
- priv->activity_pos = style->xthickness;
+ priv->activity_pos = padding.left;
priv->activity_dir = 0;
}
}
if (priv->activity_dir == 0)
{
priv->activity_pos += priv->activity_step;
- if (priv->activity_pos + size >= allocation.height - style->ythickness)
+ if (priv->activity_pos + size >= allocation.height - padding.top)
{
- priv->activity_pos = allocation.height - style->ythickness - size;
+ priv->activity_pos = allocation.height - padding.top - size;
priv->activity_dir = 1;
}
}
else
{
priv->activity_pos -= priv->activity_step;
- if (priv->activity_pos <= style->ythickness)
+ if (priv->activity_pos <= padding.top)
{
- priv->activity_pos = style->ythickness;
+ priv->activity_pos = padding.top;
priv->activity_dir = 0;
}
}
{
GtkProgressBar *pbar;
GtkProgressBarPrivate *priv;
- GtkStyle *style;
+ GtkStyleContext *style_context;
+ GtkStateFlags state;
+ GtkBorder padding;
gchar *buf;
PangoRectangle logical_rect;
PangoLayout *layout;
g_return_if_fail (GTK_IS_PROGRESS_BAR (widget));
- style = gtk_widget_get_style (widget);
+ style_context = gtk_widget_get_style_context (widget);
+ state = gtk_widget_get_state_flags (widget);
+ gtk_style_context_get_padding (style_context, state, &padding);
+
gtk_widget_style_get (widget,
"xspacing", &xspacing,
NULL);
pbar = GTK_PROGRESS_BAR (widget);
priv = pbar->priv;
- width = 2 * style->xthickness + xspacing;
+ width = padding.left + padding.right + xspacing;
if (priv->show_text)
{
if (priv->ellipsize)
{
+ const PangoFontDescription *font_desc;
PangoContext *context;
PangoFontMetrics *metrics;
gint char_width;
/* The minimum size for ellipsized text is ~ 3 chars */
context = pango_layout_get_context (layout);
- metrics = pango_context_get_metrics (context, style->font_desc, pango_context_get_language (context));
+ font_desc = gtk_style_context_get_font (style_context, state);
+ metrics = pango_context_get_metrics (context, font_desc, pango_context_get_language (context));
char_width = pango_font_metrics_get_approximate_char_width (metrics);
pango_font_metrics_unref (metrics);
{
GtkProgressBar *pbar;
GtkProgressBarPrivate *priv;
- GtkStyle *style;
+ GtkStyleContext *context;
+ GtkStateFlags state;
+ GtkBorder padding;
gchar *buf;
PangoRectangle logical_rect;
PangoLayout *layout;
g_return_if_fail (GTK_IS_PROGRESS_BAR (widget));
- style = gtk_widget_get_style (widget);
+ context = gtk_widget_get_style_context (widget);
+ state = gtk_widget_get_state_flags (widget);
+ gtk_style_context_get_padding (context, state, &padding);
+
gtk_widget_style_get (widget,
"yspacing", &yspacing,
NULL);
pbar = GTK_PROGRESS_BAR (widget);
priv = pbar->priv;
- height = 2 * style->ythickness + yspacing;
+ height = padding.top + padding.bottom + yspacing;
if (priv->show_text)
{
{
GtkProgressBarPrivate *priv = pbar->priv;
GtkAllocation allocation;
- GtkStyle *style;
+ GtkStyleContext *context;
+ GtkStateFlags state;
+ GtkBorder padding;
GtkWidget *widget = GTK_WIDGET (pbar);
GtkOrientation orientation;
gboolean inverted;
- style = gtk_widget_get_style (widget);
+ context = gtk_widget_get_style_context (widget);
+ state = gtk_widget_get_state_flags (widget);
+ gtk_style_context_get_padding (context, state, &padding);
orientation = priv->orientation;
inverted = priv->inverted;
{
if (!inverted)
{
- priv->activity_pos = style->xthickness;
+ priv->activity_pos = padding.left;
priv->activity_dir = 0;
}
else
{
gtk_widget_get_allocation (widget, &allocation);
- priv->activity_pos = allocation.width - style->xthickness -
- (allocation.height - style->ythickness * 2);
+ priv->activity_pos = allocation.width - padding.left -
+ (allocation.height - padding.top - padding.bottom);
priv->activity_dir = 1;
}
}
{
if (!inverted)
{
- priv->activity_pos = style->ythickness;
+ priv->activity_pos = padding.top;
priv->activity_dir = 0;
}
else
{
gtk_widget_get_allocation (widget, &allocation);
- priv->activity_pos = allocation.height - style->ythickness -
- (allocation.width - style->xthickness * 2);
+ priv->activity_pos = allocation.height - padding.top -
+ (allocation.width - padding.left - padding.right);
priv->activity_dir = 1;
}
}
int width,
int height)
{
- GtkStyle *style;
+ GtkStyleContext *context;
+ GtkStateFlags state;
+ GtkBorder padding;
GtkWidget *widget = GTK_WIDGET (pbar);
GdkRectangle area;
- style = gtk_widget_get_style (widget);
+ context = gtk_widget_get_style_context (widget);
+ state = gtk_widget_get_state_flags (widget);
+ gtk_style_context_get_padding (context, state, &padding);
if (orientation == GTK_ORIENTATION_HORIZONTAL)
{
gtk_progress_bar_get_activity (pbar, orientation, &area.x, &area.width);
- area.y = style->ythickness;
- area.height = height - 2 * style->ythickness;
+ area.y = padding.top;
+ area.height = height - padding.top - padding.bottom;
}
else
{
gtk_progress_bar_get_activity (pbar, orientation, &area.y, &area.height);
- area.x = style->xthickness;
- area.width = width - 2 * style->xthickness;
+ area.x = padding.left;
+ area.width = width - padding.left - padding.right;
}
- gtk_paint_box (style,
- cr,
- GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
- widget, "bar",
- area.x, area.y, area.width, area.height);
+ gtk_style_context_save (context);
+ gtk_style_context_add_class (context, GTK_STYLE_CLASS_PROGRESSBAR);
+
+ gtk_render_activity (context, cr, area.x, area.y, area.width, area.height);
+
+ gtk_style_context_restore (context);
}
static void
int width,
int height)
{
- GtkStyle *style;
+ GtkStyleContext *context;
+ GtkStateFlags state;
+ GtkBorder padding;
GtkWidget *widget = GTK_WIDGET (pbar);
GdkRectangle area;
if (amount <= 0)
return;
- style = gtk_widget_get_style (widget);
+ context = gtk_widget_get_style_context (widget);
+ state = gtk_widget_get_state_flags (widget);
+ gtk_style_context_get_padding (context, state, &padding);
if (orientation == GTK_ORIENTATION_HORIZONTAL)
{
area.width = amount;
- area.height = height - style->ythickness * 2;
- area.y = style->ythickness;
+ area.height = height - padding.top - padding.bottom;
+ area.y = padding.top;
- area.x = style->xthickness;
- if (inverted)
- area.x = width - amount - area.x;
+ if (!inverted)
+ area.x = padding.left;
+ else
+ area.x = width - amount - padding.right;
}
else
{
- area.width = width - style->xthickness * 2;
+ area.width = width - padding.left - padding.right;
area.height = amount;
- area.x = style->xthickness;
+ area.x = padding.left;
- area.y = style->ythickness;
- if (inverted)
- area.y = height - amount - area.y;
+ if (!inverted)
+ area.y = padding.top;
+ else
+ area.y = height - amount - padding.bottom;
}
- gtk_paint_box (style,
- cr,
- GTK_STATE_PRELIGHT, GTK_SHADOW_OUT,
- widget, "bar",
- area.x, area.y, area.width, area.height);
+ gtk_style_context_save (context);
+ gtk_style_context_add_class (context, GTK_STYLE_CLASS_PROGRESSBAR);
+
+ gtk_render_activity (context, cr, area.x, area.y, area.width, area.height);
+
+ gtk_style_context_restore (context);
}
static void
int height)
{
GtkProgressBarPrivate *priv = pbar->priv;
- GtkStyle *style;
+ GtkStyleContext *context;
+ GtkStateFlags state;
+ GtkBorder padding;
GtkWidget *widget = GTK_WIDGET (pbar);
gint x;
gint y;
gfloat text_xalign = 0.5;
gfloat text_yalign = 0.5;
- style = gtk_widget_get_style (widget);
+ context = gtk_widget_get_style_context (widget);
+ state = gtk_widget_get_state_flags (widget);
+ gtk_style_context_get_padding (context, state, &padding);
if (gtk_widget_get_direction (widget) != GTK_TEXT_DIR_LTR)
text_xalign = 1.0 - text_xalign;
pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
- x = style->xthickness + 1 + text_xalign * (width - 2 * style->xthickness - 2 - logical_rect.width);
-
- y = style->ythickness + 1 + text_yalign * (height - 2 * style->ythickness - 2 - logical_rect.height);
+ x = padding.left + 1 + text_xalign * (width - padding.left - padding.right - 2 - logical_rect.width);
+ y = padding.top + 1 + text_yalign * (height - padding.top - padding.bottom - 2 - logical_rect.height);
- rect.x = style->xthickness;
- rect.y = style->ythickness;
- rect.width = width - 2 * style->xthickness;
- rect.height = height - 2 * style->ythickness;
+ rect.x = padding.left;
+ rect.y = padding.top;
+ rect.width = width - padding.left - padding.right;
+ rect.height = height - padding.top - padding.bottom;
prelight_clip = start_clip = end_clip = rect;
}
}
+ gtk_style_context_save (context);
+ gtk_style_context_add_class (context, GTK_STYLE_CLASS_TROUGH);
+
if (start_clip.width > 0 && start_clip.height > 0)
{
cairo_save (cr);
gdk_cairo_rectangle (cr, &start_clip);
cairo_clip (cr);
- gtk_paint_layout (style,
- cr,
- GTK_STATE_NORMAL,
- FALSE,
- widget,
- "progressbar",
- x, y,
- layout);
+
+ gtk_render_layout (context, cr, x, y, layout);
cairo_restore (cr);
}
cairo_save (cr);
gdk_cairo_rectangle (cr, &end_clip);
cairo_clip (cr);
- gtk_paint_layout (style,
- cr,
- GTK_STATE_NORMAL,
- FALSE,
- widget,
- "progressbar",
- x, y,
- layout);
+
+ gtk_render_layout (context, cr, x, y, layout);
cairo_restore (cr);
}
+ gtk_style_context_restore (context);
+
cairo_save (cr);
gdk_cairo_rectangle (cr, &prelight_clip);
cairo_clip (cr);
- gtk_paint_layout (style,
- cr,
- GTK_STATE_PRELIGHT,
- FALSE,
- widget,
- "progressbar",
- x, y,
- layout);
+
+ gtk_style_context_save (context);
+ gtk_style_context_add_class (context, GTK_STYLE_CLASS_PROGRESSBAR);
+
+ gtk_render_layout (context, cr, x, y, layout);
+
+ gtk_style_context_restore (context);
cairo_restore (cr);
g_object_unref (layout);
GtkProgressBarPrivate *priv = pbar->priv;
GtkOrientation orientation;
gboolean inverted;
- GtkStyle *style;
+ GtkStyleContext *context;
+ GtkStateFlags state;
+ GtkBorder padding;
int width, height;
- style = gtk_widget_get_style (widget);
+ context = gtk_widget_get_style_context (widget);
+ state = gtk_widget_get_state_flags (widget);
+ gtk_style_context_get_padding (context, state, &padding);
orientation = priv->orientation;
inverted = priv->inverted;
width = gtk_widget_get_allocated_width (widget);
height = gtk_widget_get_allocated_height (widget);
- gtk_paint_box (style,
- cr,
- GTK_STATE_NORMAL, GTK_SHADOW_IN,
- widget, "trough",
- 0, 0,
- width, height);
+ gtk_style_context_save (context);
+ gtk_style_context_add_class (context, GTK_STYLE_CLASS_TROUGH);
+
+ gtk_render_background (context, cr, 0, 0, width, height);
+ gtk_render_frame (context, cr, 0, 0, width, height);
+
+ gtk_style_context_restore (context);
if (priv->activity_mode)
{
gint space;
if (orientation == GTK_ORIENTATION_HORIZONTAL)
- space = width - 2 * style->xthickness;
+ space = width - padding.left - padding.right;
else
- space = height - 2 * style->ythickness;
+ space = height - padding.top - padding.bottom;
amount = space * gtk_progress_bar_get_fraction (pbar);
if (priv->activity_mode)
gtk_progress_bar_act_mode_enter (pbar);
- if (gtk_widget_is_drawable (GTK_WIDGET (pbar)))
- gtk_widget_queue_resize (GTK_WIDGET (pbar));
+ gtk_widget_queue_resize (GTK_WIDGET (pbar));
}
}
* @text: (allow-none): a UTF-8 string, or %NULL
*
* Causes the given @text to appear superimposed on the progress bar.
+ *
+ * If @text is %NULL and #GtkProgressBar:show-text is %TRUE, the current
+ * value of #GtkProgressBar:fraction will be displayed as a percentage.
+ *
+ * If @text is non-%NULL and #GtkProgressBar: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 #GtkProgressBar:show-text is %TRUE.
**/
void
gtk_progress_bar_set_text (GtkProgressBar *pbar,
priv = pbar->priv;
+ /* Don't notify again if nothing's changed. */
+ if (g_strcmp0 (priv->text, text) == 0)
+ return;
+
g_free (priv->text);
- priv->text = text && *text ? g_strdup (text) : NULL;
+ priv->text = g_strdup (text);
- if (gtk_widget_is_drawable (GTK_WIDGET (pbar)))
- gtk_widget_queue_resize (GTK_WIDGET (pbar));
+ gtk_widget_queue_resize (GTK_WIDGET (pbar));
g_object_notify (G_OBJECT (pbar), "text");
}
* the #GtkProgressBar::text property or, if that is %NULL,
* the #GtkProgressBar::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 #GtkProgressBar:show-text to
+ * %TRUE and #GtkProgressBar:text to the empty string (not %NULL).
+ *
* Since: 3.0
*/
void
{
priv->show_text = show_text;
- if (gtk_widget_is_drawable (GTK_WIDGET (pbar)))
- gtk_widget_queue_resize (GTK_WIDGET (pbar));
+ gtk_widget_queue_resize (GTK_WIDGET (pbar));
g_object_notify (G_OBJECT (pbar), "show-text");
}
if (priv->orientation != orientation)
{
priv->orientation = orientation;
+ _gtk_orientable_set_style_classes (GTK_ORIENTABLE (pbar));
- if (gtk_widget_is_drawable (GTK_WIDGET (pbar)))
- gtk_widget_queue_resize (GTK_WIDGET (pbar));
+ gtk_widget_queue_resize (GTK_WIDGET (pbar));
}
}
{
priv->inverted = inverted;
- if (gtk_widget_is_drawable (GTK_WIDGET (pbar)))
- gtk_widget_queue_resize (GTK_WIDGET (pbar));
+ gtk_widget_queue_resize (GTK_WIDGET (pbar));
g_object_notify (G_OBJECT (pbar), "inverted");
}
* Return value: text, or %NULL; this string is owned by the widget
* and should not be modified or freed.
**/
-G_CONST_RETURN gchar*
+const gchar*
gtk_progress_bar_get_text (GtkProgressBar *pbar)
{
g_return_val_if_fail (GTK_IS_PROGRESS_BAR (pbar), NULL);
projects / ~andy / gtk / blobdiff