gtk2/gtk/gtkscale.c
Timm Bäder 36ab70ddf5 widget: Add baseline and out_clip parameters to size-allocate
Since setting a clip is mandatory for almost all widgets, we can as well
change the size-allocate signature to include a out_clip parameter, just
like GtkCssGadget did. And since we now always propagate baselines, we
might as well pass that one on to size-allocate.

This way we can also make sure to transform the clip returned from
size-allocate to parent-coordinates, i.e. the same coordinate space
priv->allocation is in.
2017-07-19 21:27:16 -04:00

2099 lines
65 KiB
C
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/* GTK - The GIMP Toolkit
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
* Copyright (C) 2001 Red Hat, Inc.
*
* 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 <http://www.gnu.org/licenses/>.
*/
/*
* 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 <math.h>
#include <stdlib.h>
#include "gtkrangeprivate.h"
#include "gtkadjustment.h"
#include "gtkbindings.h"
#include "gtkbuildable.h"
#include "gtkbuilderprivate.h"
#include "gtkicontheme.h"
#include "gtkintl.h"
#include "gtkmarshalers.h"
#include "gtkorientable.h"
#include "gtkprivate.h"
#include "gtktypebuiltins.h"
#include "gtkstylecontextprivate.h"
#include "gtkstylepropertyprivate.h"
#include "gtkwidgetprivate.h"
#include "gtkcsswidgetnodeprivate.h"
#include "gtkgizmoprivate.h"
#include "a11y/gtkscaleaccessible.h"
/**
* SECTION:gtkscale
* @Short_description: A slider widget for selecting a value from a range
* @Title: GtkScale
*
* A GtkScale is a slider control used to select a numeric value.
* To use it, youll probably want to investigate the methods on
* its base class, #GtkRange, in addition to the methods for GtkScale itself.
* To set the value of a scale, you would normally use gtk_range_set_value().
* To detect changes to the value, you would normally use the
* #GtkRange::value-changed signal.
*
* Note that using the same upper and lower bounds for the #GtkScale (through
* the #GtkRange methods) will hide the slider itself. This is useful for
* applications that want to show an undeterminate value on the scale, without
* changing the layout of the application (such as movie or music players).
*
* # GtkScale as GtkBuildable
*
* GtkScale supports a custom <marks> element, which can contain multiple
* <mark> elements. The “value” and “position” attributes have the same
* meaning as gtk_scale_add_mark() parameters of the same name. If the
* element is not empty, its content is taken as the markup to show at
* the mark. It can be translated with the usual ”translatable” and
* “context” attributes.
*
* # CSS nodes
*
* |[<!-- language="plain" -->
* scale[.fine-tune][.marks-before][.marks-after]
* ├── marks.top
* │ ├── mark
* │ ┊ ├── [label]
* │ ┊ ╰── indicator
* ┊ ┊
* │ ╰── mark
* ├── [value]
* ├── trough
* │ ├── slider
* │ ├── [highlight]
* │ ╰── [fill]
* ╰── marks.bottom
* ├── mark
* ┊ ├── indicator
* ┊ ╰── [label]
* ╰── mark
* ]|
*
* GtkScale has a main CSS node with name scale and a subnode for its contents,
* with subnodes named trough and slider.
*
* The main node gets the style class .fine-tune added when the scale is in
* 'fine-tuning' mode.
*
* If the scale has an origin (see gtk_scale_set_has_origin()), there is a
* subnode with name highlight below the trough node that is used for rendering
* the highlighted part of the trough.
*
* If the scale is showing a fill level (see gtk_range_set_show_fill_level()),
* there is a subnode with name fill below the trough node that is used for
* rendering the filled in part of the trough.
*
* If marks are present, there is a marks subnode before or after the trough
* node, below which each mark gets a node with name mark. The marks nodes get
* either the .top or .bottom style class.
*
* The mark node has a subnode named indicator. If the mark has text, it also
* has a subnode named label. When the mark is either above or left of the
* scale, the label subnode is the first when present. Otherwise, the indicator
* subnode is the first.
*
* The main CSS node gets the 'marks-before' and/or 'marks-after' style classes
* added depending on what marks are present.
*
* If the scale is displaying the value (see #GtkScale:draw-value), there is
* subnode with name value.
*/
#define MAX_DIGITS (64) /* don't change this,
* a) you don't need to and
* b) you might cause buffer owerflows in
* unrelated code portions otherwise
*/
typedef struct _GtkScaleMark GtkScaleMark;
struct _GtkScalePrivate
{
GSList *marks;
GtkWidget *value_widget;
GtkWidget *top_marks_widget;
GtkWidget *bottom_marks_widget;
gint digits;
guint draw_value : 1;
guint value_pos : 2;
};
struct _GtkScaleMark
{
gdouble value;
int stop_position;
gchar *markup;
GtkWidget *label_widget;
GtkWidget *indicator_widget;
GtkWidget *widget;
GtkPositionType position; /* always GTK_POS_TOP or GTK_POS_BOTTOM */
};
enum {
PROP_0,
PROP_DIGITS,
PROP_DRAW_VALUE,
PROP_HAS_ORIGIN,
PROP_VALUE_POS,
LAST_PROP
};
enum {
FORMAT_VALUE,
LAST_SIGNAL
};
static GParamSpec *properties[LAST_PROP];
static guint signals[LAST_SIGNAL];
static void gtk_scale_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec);
static void gtk_scale_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec);
static void gtk_scale_measure (GtkWidget *widget,
GtkOrientation orientation,
int for_size,
int *minimum,
int *natural,
int *minimum_baseline,
int *natural_baseline);
static void gtk_scale_get_range_border (GtkRange *range,
GtkBorder *border);
static void gtk_scale_get_range_size_request (GtkRange *range,
GtkOrientation orientation,
gint *minimum,
gint *natural);
static void gtk_scale_finalize (GObject *object);
static void gtk_scale_snapshot (GtkWidget *widget,
GtkSnapshot *snapshot);
static void gtk_scale_real_get_layout_offsets (GtkScale *scale,
gint *x,
gint *y);
static void gtk_scale_buildable_interface_init (GtkBuildableIface *iface);
static gboolean gtk_scale_buildable_custom_tag_start (GtkBuildable *buildable,
GtkBuilder *builder,
GObject *child,
const gchar *tagname,
GMarkupParser *parser,
gpointer *data);
static void gtk_scale_buildable_custom_finished (GtkBuildable *buildable,
GtkBuilder *builder,
GObject *child,
const gchar *tagname,
gpointer user_data);
static gchar * gtk_scale_format_value (GtkScale *scale,
gdouble value);
G_DEFINE_TYPE_WITH_CODE (GtkScale, gtk_scale, GTK_TYPE_RANGE,
G_ADD_PRIVATE (GtkScale)
G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
gtk_scale_buildable_interface_init))
static gint
compare_marks (gconstpointer a, gconstpointer b, gpointer data)
{
gboolean inverted = GPOINTER_TO_INT (data);
gint val;
const GtkScaleMark *ma, *mb;
val = inverted ? -1 : 1;
ma = a; mb = b;
return (ma->value > mb->value) ? val : ((ma->value < mb->value) ? -val : 0);
}
static void
update_label_request (GtkScale *scale)
{
GtkScalePrivate *priv = gtk_scale_get_instance_private (scale);
GtkAdjustment *adjustment = gtk_range_get_adjustment (GTK_RANGE (scale));
double lowest_value, highest_value;
char *old_text;
char *text;
int size = 0;
int min;
g_assert (priv->value_widget != NULL);
lowest_value = gtk_adjustment_get_lower (adjustment);
highest_value = gtk_adjustment_get_upper (adjustment);
old_text = g_strdup (gtk_label_get_label (GTK_LABEL (priv->value_widget)));
text = gtk_scale_format_value (scale, lowest_value);
gtk_label_set_label (GTK_LABEL (priv->value_widget), text);
gtk_widget_measure (priv->value_widget, GTK_ORIENTATION_HORIZONTAL, -1,
&min, NULL, NULL, NULL);
size = MAX (size, min);
g_free (text);
text = gtk_scale_format_value (scale, highest_value);
gtk_label_set_label (GTK_LABEL (priv->value_widget), text);
gtk_widget_measure (priv->value_widget, GTK_ORIENTATION_HORIZONTAL, -1,
&min, NULL, NULL, NULL);
size = MAX (size, min);
g_free (text);
gtk_widget_set_size_request (priv->value_widget, size, -1);
gtk_label_set_label (GTK_LABEL (priv->value_widget), old_text);
g_free (old_text);
}
static void
gtk_scale_notify (GObject *object,
GParamSpec *pspec)
{
if (strcmp (pspec->name, "inverted") == 0)
{
GtkScale *scale = GTK_SCALE (object);
GtkScaleMark *mark;
GSList *m;
gint i, n;
gdouble *values;
scale->priv->marks = g_slist_sort_with_data (scale->priv->marks,
compare_marks,
GINT_TO_POINTER (gtk_range_get_inverted (GTK_RANGE (scale))));
n = g_slist_length (scale->priv->marks);
values = g_new (gdouble, n);
for (m = scale->priv->marks, i = 0; m; m = m->next, i++)
{
mark = m->data;
values[i] = mark->value;
}
_gtk_range_set_stop_values (GTK_RANGE (scale), values, n);
g_free (values);
}
else if (strcmp (pspec->name, "adjustment"))
{
GtkScale *scale = GTK_SCALE (object);
if (scale->priv->value_widget)
update_label_request (scale);
}
if (G_OBJECT_CLASS (gtk_scale_parent_class)->notify)
G_OBJECT_CLASS (gtk_scale_parent_class)->notify (object, pspec);
}
static void
gtk_scale_allocate_value (GtkScale *scale,
GtkAllocation *out_clip)
{
GtkScalePrivate *priv = scale->priv;
GtkWidget *widget = GTK_WIDGET (scale);
GtkRange *range = GTK_RANGE (widget);
GtkWidget *slider_widget;
GtkAllocation range_alloc, slider_alloc, value_alloc;
gtk_widget_get_content_allocation (widget, &range_alloc);
slider_widget = gtk_range_get_slider_widget (range);
gtk_widget_get_border_allocation (slider_widget, &slider_alloc);
gtk_widget_measure (priv->value_widget,
GTK_ORIENTATION_HORIZONTAL, -1,
&value_alloc.width, NULL,
NULL, NULL);
gtk_widget_measure (priv->value_widget,
GTK_ORIENTATION_VERTICAL, -1,
&value_alloc.height, NULL,
NULL, NULL);
if (gtk_orientable_get_orientation (GTK_ORIENTABLE (range)) == GTK_ORIENTATION_HORIZONTAL)
{
switch (priv->value_pos)
{
case GTK_POS_LEFT:
value_alloc.x = 0;
value_alloc.y = (range_alloc.height - value_alloc.height) / 2;
break;
case GTK_POS_RIGHT:
value_alloc.x = range_alloc.width - value_alloc.width;
value_alloc.y = (range_alloc.height - value_alloc.height) / 2;
break;
case GTK_POS_TOP:
value_alloc.x = slider_alloc.x + (slider_alloc.width - value_alloc.width) / 2;
value_alloc.x = CLAMP (value_alloc.x, range_alloc.x, range_alloc.x + range_alloc.width - value_alloc.width);
value_alloc.y = 0;
break;
case GTK_POS_BOTTOM:
value_alloc.x = slider_alloc.x + (slider_alloc.width - value_alloc.width) / 2;
value_alloc.x = CLAMP (value_alloc.x, range_alloc.x, range_alloc.x + range_alloc.width - value_alloc.width);
value_alloc.y = range_alloc.height - value_alloc.height;
break;
default:
g_return_if_reached ();
break;
}
}
else
{
switch (priv->value_pos)
{
case GTK_POS_LEFT:
value_alloc.x = 0;
value_alloc.y = CLAMP (value_alloc.y, range_alloc.y, range_alloc.y + range_alloc.height - value_alloc.height);
break;
case GTK_POS_RIGHT:
value_alloc.x = range_alloc.width - value_alloc.width;
value_alloc.y = CLAMP (value_alloc.y, range_alloc.y, range_alloc.y + range_alloc.height - value_alloc.height);
break;
case GTK_POS_TOP:
value_alloc.x = (range_alloc.width - value_alloc.width) / 2;
value_alloc.y = 0;
break;
case GTK_POS_BOTTOM:
value_alloc.x = (range_alloc.width - value_alloc.width) / 2;
value_alloc.y = range_alloc.height - value_alloc.height;
break;
default:
g_return_if_reached ();
}
}
gtk_widget_size_allocate (priv->value_widget, &value_alloc, -1, out_clip);
}
static void
gtk_scale_allocate_mark (GtkGizmo *gizmo,
const GtkAllocation *allocation,
int baseline,
GtkAllocation *out_clip)
{
GtkWidget *widget = GTK_WIDGET (gizmo);
GtkScale *scale = GTK_SCALE (gtk_widget_get_parent (gtk_widget_get_parent (widget)));
GtkScaleMark *mark = g_object_get_data (G_OBJECT (gizmo), "mark");
int indicator_width, indicator_height;
GtkAllocation indicator_alloc;
GtkOrientation orientation;
orientation = gtk_orientable_get_orientation (GTK_ORIENTABLE (scale));
gtk_widget_measure (mark->indicator_widget,
GTK_ORIENTATION_HORIZONTAL, -1,
&indicator_width, NULL,
NULL, NULL);
gtk_widget_measure (mark->indicator_widget,
GTK_ORIENTATION_VERTICAL, -1,
&indicator_height, NULL,
NULL, NULL);
if (orientation == GTK_ORIENTATION_HORIZONTAL)
{
indicator_alloc.x = (allocation->width - indicator_width) / 2;
if (mark->position == GTK_POS_TOP)
indicator_alloc.y = allocation->y + allocation->height - indicator_height;
else
indicator_alloc.y = allocation->y;
indicator_alloc.width = indicator_width;
indicator_alloc.height = indicator_height;
}
else
{
if (mark->position == GTK_POS_TOP)
indicator_alloc.x = allocation->x + allocation->width - indicator_width;
else
indicator_alloc.x = allocation->x;
indicator_alloc.y = (allocation->height - indicator_height) / 2;
indicator_alloc.width = indicator_width;
indicator_alloc.height = indicator_height;
}
gtk_widget_size_allocate (mark->indicator_widget, &indicator_alloc, baseline, out_clip);
if (mark->label_widget)
{
GtkAllocation label_alloc, label_clip;
label_alloc = *allocation;
if (orientation == GTK_ORIENTATION_HORIZONTAL)
{
label_alloc.height = allocation->height - indicator_alloc.height;
if (mark->position == GTK_POS_BOTTOM)
label_alloc.y = indicator_alloc.y + indicator_alloc.height;
}
else
{
label_alloc.width = allocation->width - indicator_alloc.width;
if (mark->position == GTK_POS_BOTTOM)
label_alloc.x = indicator_alloc.x + indicator_alloc.width;
}
gtk_widget_size_allocate (mark->label_widget, &label_alloc, baseline, &label_clip);
gdk_rectangle_union (out_clip, &label_clip, out_clip);
}
}
static void
gtk_scale_allocate_marks (GtkGizmo *gizmo,
const GtkAllocation *allocation,
int baseline,
GtkAllocation *out_clip)
{
GtkWidget *widget = GTK_WIDGET (gizmo);
GtkScale *scale = GTK_SCALE (gtk_widget_get_parent (widget));
GtkScalePrivate *priv = scale->priv;
GtkOrientation orientation;
int *marks;
int i;
GSList *m;
orientation = gtk_orientable_get_orientation (GTK_ORIENTABLE (scale));
_gtk_range_get_stop_positions (GTK_RANGE (scale), &marks);
for (m = priv->marks, i = 0; m; m = m->next, i++)
{
GtkScaleMark *mark = m->data;
GtkAllocation mark_alloc, mark_clip;
int mark_size;
if ((mark->position == GTK_POS_TOP && widget == priv->bottom_marks_widget) ||
(mark->position == GTK_POS_BOTTOM && widget == priv->top_marks_widget))
continue;
gtk_widget_measure (mark->widget,
orientation, -1,
&mark_size, NULL,
NULL, NULL);
mark->stop_position = marks[i];
if (orientation == GTK_ORIENTATION_HORIZONTAL)
{
mark_alloc.x = mark->stop_position;
mark_alloc.y = allocation->y;
mark_alloc.width = mark_size;
mark_alloc.height = allocation->height;
mark_alloc.x -= mark_size / 2;
}
else
{
mark_alloc.x = allocation->x;
mark_alloc.y = mark->stop_position;
mark_alloc.width = allocation->width;
mark_alloc.height = mark_size;
mark_alloc.y -= mark_size / 2;
}
gtk_widget_size_allocate (mark->widget, &mark_alloc, baseline, &mark_clip);
gdk_rectangle_union (out_clip, &mark_clip, out_clip);
}
g_free (marks);
}
static void
gtk_scale_size_allocate (GtkWidget *widget,
const GtkAllocation *allocation,
int baseline,
GtkAllocation *out_clip)
{
GtkScale *scale = GTK_SCALE (widget);
GtkScalePrivate *priv = scale->priv;
GtkAllocation marks_clip, range_rect, marks_rect;
GtkOrientation orientation;
GTK_WIDGET_CLASS (gtk_scale_parent_class)->size_allocate (widget, allocation, baseline, out_clip);
orientation = gtk_orientable_get_orientation (GTK_ORIENTABLE (widget));
gtk_range_get_range_rect (GTK_RANGE (scale), &range_rect);
if (orientation == GTK_ORIENTATION_HORIZONTAL)
{
int marks_height = 0;
if (priv->top_marks_widget)
{
gtk_widget_measure (priv->top_marks_widget,
GTK_ORIENTATION_VERTICAL, -1,
&marks_height, NULL,
NULL, NULL);
marks_rect = range_rect;
marks_rect.y = 0;
marks_rect.height = marks_height;
gtk_widget_size_allocate (priv->top_marks_widget, &marks_rect, -1, &marks_clip);
gdk_rectangle_union (out_clip, &marks_clip, out_clip);
}
if (priv->bottom_marks_widget)
{
gtk_widget_measure (priv->bottom_marks_widget,
GTK_ORIENTATION_VERTICAL, -1,
&marks_height, NULL,
NULL, NULL);
marks_rect = range_rect;
marks_rect.y += range_rect.height;
marks_rect.height = marks_height;
gtk_widget_size_allocate (priv->bottom_marks_widget, &marks_rect, -1, &marks_clip);
gdk_rectangle_union (out_clip, &marks_clip, out_clip);
}
}
else
{
int marks_width = 0;
if (priv->top_marks_widget)
{
gtk_widget_measure (priv->top_marks_widget,
GTK_ORIENTATION_HORIZONTAL, -1,
&marks_width, NULL,
NULL, NULL);
marks_rect = range_rect;
marks_rect.x -= marks_width;
marks_rect.width = marks_width;
gtk_widget_size_allocate (priv->top_marks_widget, &marks_rect, -1, &marks_clip);
gdk_rectangle_union (out_clip, &marks_clip, out_clip);
}
if (priv->bottom_marks_widget)
{
gtk_widget_measure (priv->bottom_marks_widget,
GTK_ORIENTATION_HORIZONTAL, -1,
&marks_width, NULL,
NULL, NULL);
marks_rect = range_rect;
marks_rect.x += range_rect.width;
marks_rect.width = marks_width;
gtk_widget_size_allocate (priv->bottom_marks_widget, &marks_rect, -1, &marks_clip);
gdk_rectangle_union (out_clip, &marks_clip, out_clip);
}
}
if (priv->value_widget)
{
GtkAllocation value_clip;
gtk_scale_allocate_value (scale, &value_clip);
gdk_rectangle_union (out_clip, &value_clip, out_clip);
}
}
#define add_slider_binding(binding_set, keyval, mask, scroll) \
gtk_binding_entry_add_signal (binding_set, keyval, mask, \
I_("move-slider"), 1, \
GTK_TYPE_SCROLL_TYPE, scroll)
static void
gtk_scale_value_changed (GtkRange *range)
{
GtkScalePrivate *priv = gtk_scale_get_instance_private (GTK_SCALE (range));
GtkAdjustment *adjustment = gtk_range_get_adjustment (range);
if (priv->value_widget)
{
char *text = gtk_scale_format_value (GTK_SCALE (range),
gtk_adjustment_get_value (adjustment));
gtk_label_set_label (GTK_LABEL (priv->value_widget), text);
g_free (text);
}
}
static void
gtk_scale_class_init (GtkScaleClass *class)
{
GObjectClass *gobject_class;
GtkWidgetClass *widget_class;
GtkRangeClass *range_class;
GtkBindingSet *binding_set;
gobject_class = G_OBJECT_CLASS (class);
range_class = (GtkRangeClass*) class;
widget_class = (GtkWidgetClass*) class;
gobject_class->set_property = gtk_scale_set_property;
gobject_class->get_property = gtk_scale_get_property;
gobject_class->notify = gtk_scale_notify;
gobject_class->finalize = gtk_scale_finalize;
widget_class->snapshot = gtk_scale_snapshot;
widget_class->size_allocate = gtk_scale_size_allocate;
widget_class->measure = gtk_scale_measure;
range_class->get_range_border = gtk_scale_get_range_border;
range_class->get_range_size_request = gtk_scale_get_range_size_request;
range_class->value_changed = gtk_scale_value_changed;
class->get_layout_offsets = gtk_scale_real_get_layout_offsets;
/**
* GtkScale::format-value:
* @scale: the object which received the signal
* @value: the value to format
*
* Signal which allows you to change how the scale value is displayed.
* Connect a signal handler which returns an allocated string representing
* @value. That string will then be used to display the scale's value.
*
* If no user-provided handlers are installed, the value will be displayed on
* its own, rounded according to the value of the #GtkScale:digits property.
*
* Here's an example signal handler which displays a value 1.0 as
* with "-->1.0<--".
* |[<!-- language="C" -->
* static gchar*
* format_value_callback (GtkScale *scale,
* gdouble value)
* {
* return g_strdup_printf ("-->\%0.*g<--",
* gtk_scale_get_digits (scale), value);
* }
* ]|
*
* Returns: allocated string representing @value
*/
signals[FORMAT_VALUE] =
g_signal_new (I_("format-value"),
G_TYPE_FROM_CLASS (gobject_class),
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GtkScaleClass, format_value),
_gtk_single_string_accumulator, NULL,
_gtk_marshal_STRING__DOUBLE,
G_TYPE_STRING, 1,
G_TYPE_DOUBLE);
properties[PROP_DIGITS] =
g_param_spec_int ("digits",
P_("Digits"),
P_("The number of decimal places that are displayed in the value"),
-1, MAX_DIGITS,
1,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
properties[PROP_DRAW_VALUE] =
g_param_spec_boolean ("draw-value",
P_("Draw Value"),
P_("Whether the current value is displayed as a string next to the slider"),
TRUE,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
properties[PROP_HAS_ORIGIN] =
g_param_spec_boolean ("has-origin",
P_("Has Origin"),
P_("Whether the scale has an origin"),
TRUE,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
properties[PROP_VALUE_POS] =
g_param_spec_enum ("value-pos",
P_("Value Position"),
P_("The position in which the current value is displayed"),
GTK_TYPE_POSITION_TYPE,
GTK_POS_TOP,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
g_object_class_install_properties (gobject_class, LAST_PROP, properties);
/* All bindings (even arrow keys) are on both h/v scale, because
* blind users etc. don't care about scale orientation.
*/
binding_set = gtk_binding_set_by_class (class);
add_slider_binding (binding_set, GDK_KEY_Left, 0,
GTK_SCROLL_STEP_LEFT);
add_slider_binding (binding_set, GDK_KEY_Left, GDK_CONTROL_MASK,
GTK_SCROLL_PAGE_LEFT);
add_slider_binding (binding_set, GDK_KEY_KP_Left, 0,
GTK_SCROLL_STEP_LEFT);
add_slider_binding (binding_set, GDK_KEY_KP_Left, GDK_CONTROL_MASK,
GTK_SCROLL_PAGE_LEFT);
add_slider_binding (binding_set, GDK_KEY_Right, 0,
GTK_SCROLL_STEP_RIGHT);
add_slider_binding (binding_set, GDK_KEY_Right, GDK_CONTROL_MASK,
GTK_SCROLL_PAGE_RIGHT);
add_slider_binding (binding_set, GDK_KEY_KP_Right, 0,
GTK_SCROLL_STEP_RIGHT);
add_slider_binding (binding_set, GDK_KEY_KP_Right, GDK_CONTROL_MASK,
GTK_SCROLL_PAGE_RIGHT);
add_slider_binding (binding_set, GDK_KEY_Up, 0,
GTK_SCROLL_STEP_UP);
add_slider_binding (binding_set, GDK_KEY_Up, GDK_CONTROL_MASK,
GTK_SCROLL_PAGE_UP);
add_slider_binding (binding_set, GDK_KEY_KP_Up, 0,
GTK_SCROLL_STEP_UP);
add_slider_binding (binding_set, GDK_KEY_KP_Up, GDK_CONTROL_MASK,
GTK_SCROLL_PAGE_UP);
add_slider_binding (binding_set, GDK_KEY_Down, 0,
GTK_SCROLL_STEP_DOWN);
add_slider_binding (binding_set, GDK_KEY_Down, GDK_CONTROL_MASK,
GTK_SCROLL_PAGE_DOWN);
add_slider_binding (binding_set, GDK_KEY_KP_Down, 0,
GTK_SCROLL_STEP_DOWN);
add_slider_binding (binding_set, GDK_KEY_KP_Down, GDK_CONTROL_MASK,
GTK_SCROLL_PAGE_DOWN);
add_slider_binding (binding_set, GDK_KEY_Page_Up, GDK_CONTROL_MASK,
GTK_SCROLL_PAGE_LEFT);
add_slider_binding (binding_set, GDK_KEY_KP_Page_Up, GDK_CONTROL_MASK,
GTK_SCROLL_PAGE_LEFT);
add_slider_binding (binding_set, GDK_KEY_Page_Up, 0,
GTK_SCROLL_PAGE_UP);
add_slider_binding (binding_set, GDK_KEY_KP_Page_Up, 0,
GTK_SCROLL_PAGE_UP);
add_slider_binding (binding_set, GDK_KEY_Page_Down, GDK_CONTROL_MASK,
GTK_SCROLL_PAGE_RIGHT);
add_slider_binding (binding_set, GDK_KEY_KP_Page_Down, GDK_CONTROL_MASK,
GTK_SCROLL_PAGE_RIGHT);
add_slider_binding (binding_set, GDK_KEY_Page_Down, 0,
GTK_SCROLL_PAGE_DOWN);
add_slider_binding (binding_set, GDK_KEY_KP_Page_Down, 0,
GTK_SCROLL_PAGE_DOWN);
/* Logical bindings (vs. visual bindings above) */
add_slider_binding (binding_set, GDK_KEY_plus, 0,
GTK_SCROLL_STEP_FORWARD);
add_slider_binding (binding_set, GDK_KEY_minus, 0,
GTK_SCROLL_STEP_BACKWARD);
add_slider_binding (binding_set, GDK_KEY_plus, GDK_CONTROL_MASK,
GTK_SCROLL_PAGE_FORWARD);
add_slider_binding (binding_set, GDK_KEY_minus, GDK_CONTROL_MASK,
GTK_SCROLL_PAGE_BACKWARD);
add_slider_binding (binding_set, GDK_KEY_KP_Add, 0,
GTK_SCROLL_STEP_FORWARD);
add_slider_binding (binding_set, GDK_KEY_KP_Subtract, 0,
GTK_SCROLL_STEP_BACKWARD);
add_slider_binding (binding_set, GDK_KEY_KP_Add, GDK_CONTROL_MASK,
GTK_SCROLL_PAGE_FORWARD);
add_slider_binding (binding_set, GDK_KEY_KP_Subtract, GDK_CONTROL_MASK,
GTK_SCROLL_PAGE_BACKWARD);
add_slider_binding (binding_set, GDK_KEY_Home, 0,
GTK_SCROLL_START);
add_slider_binding (binding_set, GDK_KEY_KP_Home, 0,
GTK_SCROLL_START);
add_slider_binding (binding_set, GDK_KEY_End, 0,
GTK_SCROLL_END);
add_slider_binding (binding_set, GDK_KEY_KP_End, 0,
GTK_SCROLL_END);
gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_SCALE_ACCESSIBLE);
gtk_widget_class_set_css_name (widget_class, "scale");
}
static void
gtk_scale_init (GtkScale *scale)
{
GtkScalePrivate *priv;
GtkRange *range = GTK_RANGE (scale);
scale->priv = gtk_scale_get_instance_private (scale);
priv = scale->priv;
priv->value_pos = GTK_POS_TOP;
priv->digits = 1;
gtk_widget_set_can_focus (GTK_WIDGET (scale), TRUE);
gtk_range_set_slider_size_fixed (range, TRUE);
_gtk_range_set_has_origin (range, TRUE);
gtk_scale_set_draw_value (scale, TRUE);
gtk_range_set_round_digits (range, priv->digits);
gtk_range_set_flippable (range, TRUE);
}
static void
gtk_scale_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
GtkScale *scale;
scale = GTK_SCALE (object);
switch (prop_id)
{
case PROP_DIGITS:
gtk_scale_set_digits (scale, g_value_get_int (value));
break;
case PROP_DRAW_VALUE:
gtk_scale_set_draw_value (scale, g_value_get_boolean (value));
break;
case PROP_HAS_ORIGIN:
gtk_scale_set_has_origin (scale, g_value_get_boolean (value));
break;
case PROP_VALUE_POS:
gtk_scale_set_value_pos (scale, g_value_get_enum (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gtk_scale_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
GtkScale *scale = GTK_SCALE (object);
GtkScalePrivate *priv = scale->priv;
switch (prop_id)
{
case PROP_DIGITS:
g_value_set_int (value, priv->digits);
break;
case PROP_DRAW_VALUE:
g_value_set_boolean (value, priv->draw_value);
break;
case PROP_HAS_ORIGIN:
g_value_set_boolean (value, gtk_scale_get_has_origin (scale));
break;
case PROP_VALUE_POS:
g_value_set_enum (value, priv->value_pos);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
/**
* gtk_scale_new:
* @orientation: the scales orientation.
* @adjustment: (nullable): the #GtkAdjustment which sets the range
* of the scale, or %NULL to create a new adjustment.
*
* Creates a new #GtkScale.
*
* Returns: a new #GtkScale
*
* Since: 3.0
**/
GtkWidget *
gtk_scale_new (GtkOrientation orientation,
GtkAdjustment *adjustment)
{
g_return_val_if_fail (adjustment == NULL || GTK_IS_ADJUSTMENT (adjustment),
NULL);
return g_object_new (GTK_TYPE_SCALE,
"orientation", orientation,
"adjustment", adjustment,
NULL);
}
/**
* gtk_scale_new_with_range:
* @orientation: the scales orientation.
* @min: minimum value
* @max: maximum value
* @step: step increment (tick size) used with keyboard shortcuts
*
* Creates a new scale widget with the given orientation that lets the
* user input a number between @min and @max (including @min and @max)
* with the increment @step. @step must be nonzero; its the distance
* the slider moves when using the arrow keys to adjust the scale
* value.
*
* Note that the way in which the precision is derived works best if @step
* is a power of ten. If the resulting precision is not suitable for your
* needs, use gtk_scale_set_digits() to correct it.
*
* Returns: a new #GtkScale
*
* Since: 3.0
*/
GtkWidget *
gtk_scale_new_with_range (GtkOrientation orientation,
gdouble min,
gdouble max,
gdouble step)
{
GtkAdjustment *adj;
gint digits;
g_return_val_if_fail (min < max, NULL);
g_return_val_if_fail (step != 0.0, NULL);
adj = gtk_adjustment_new (min, min, max, step, 10 * step, 0);
if (fabs (step) >= 1.0 || step == 0.0)
{
digits = 0;
}
else
{
digits = abs ((gint) floor (log10 (fabs (step))));
if (digits > 5)
digits = 5;
}
return g_object_new (GTK_TYPE_SCALE,
"orientation", orientation,
"adjustment", adj,
"digits", digits,
NULL);
}
/**
* gtk_scale_set_digits:
* @scale: a #GtkScale
* @digits: the number of decimal places to display,
* e.g. use 1 to display 1.0, 2 to display 1.00, etc
*
* Sets the number of decimal places that are displayed in the value. Also
* causes the value of the adjustment to be rounded to this number of digits,
* so the retrieved value matches the displayed one, if #GtkScale:draw-value is
* %TRUE when the value changes. If you want to enforce rounding the value when
* #GtkScale:draw-value is %FALSE, you can set #GtkRange:round-digits instead.
*
* Note that rounding to a small number of digits can interfere with
* the smooth autoscrolling that is built into #GtkScale. As an alternative,
* you can use the #GtkScale::format-value signal to format the displayed
* value yourself.
*/
void
gtk_scale_set_digits (GtkScale *scale,
gint digits)
{
GtkScalePrivate *priv;
GtkRange *range;
g_return_if_fail (GTK_IS_SCALE (scale));
priv = scale->priv;
range = GTK_RANGE (scale);
digits = CLAMP (digits, -1, MAX_DIGITS);
if (priv->digits != digits)
{
priv->digits = digits;
if (priv->draw_value)
gtk_range_set_round_digits (range, digits);
gtk_widget_queue_resize (GTK_WIDGET (scale));
g_object_notify_by_pspec (G_OBJECT (scale), properties[PROP_DIGITS]);
}
}
/**
* gtk_scale_get_digits:
* @scale: a #GtkScale
*
* Gets the number of decimal places that are displayed in the value.
*
* Returns: the number of decimal places that are displayed
*/
gint
gtk_scale_get_digits (GtkScale *scale)
{
g_return_val_if_fail (GTK_IS_SCALE (scale), -1);
return scale->priv->digits;
}
static void
update_value_position (GtkScale *scale)
{
GtkScalePrivate *priv = scale->priv;
GtkStyleContext *context;
if (!priv->value_widget)
return;
context = gtk_widget_get_style_context (priv->value_widget);
if (priv->value_pos == GTK_POS_TOP || priv->value_pos == GTK_POS_LEFT)
{
gtk_style_context_remove_class (context, GTK_STYLE_CLASS_BOTTOM);
gtk_style_context_add_class (context, GTK_STYLE_CLASS_TOP);
}
else
{
gtk_style_context_remove_class (context, GTK_STYLE_CLASS_TOP);
gtk_style_context_add_class (context, GTK_STYLE_CLASS_BOTTOM);
}
}
/**
* gtk_scale_set_draw_value:
* @scale: a #GtkScale
* @draw_value: %TRUE to draw the value
*
* Specifies whether the current value is displayed as a string next
* to the slider.
*/
void
gtk_scale_set_draw_value (GtkScale *scale,
gboolean draw_value)
{
GtkScalePrivate *priv;
GtkWidget *widget;
g_return_if_fail (GTK_IS_SCALE (scale));
priv = scale->priv;
widget = GTK_WIDGET (scale);
draw_value = draw_value != FALSE;
if (priv->draw_value != draw_value)
{
priv->draw_value = draw_value;
if (draw_value)
{
char *txt;
txt = gtk_scale_format_value (scale,
gtk_adjustment_get_value (gtk_range_get_adjustment (GTK_RANGE (scale))));
priv->value_widget = g_object_new (GTK_TYPE_LABEL,
"css-name", "value",
"label", txt,
NULL);
g_free (txt);
if (priv->value_pos == GTK_POS_TOP || priv->value_pos == GTK_POS_LEFT)
gtk_widget_insert_after (priv->value_widget, widget, NULL);
else
gtk_widget_insert_before (priv->value_widget, widget, NULL);
gtk_range_set_round_digits (GTK_RANGE (scale), priv->digits);
update_value_position (scale);
update_label_request (scale);
}
else if (priv->value_widget)
{
gtk_widget_unparent (priv->value_widget);
priv->value_widget = NULL;
gtk_range_set_round_digits (GTK_RANGE (scale), -1);
}
g_object_notify_by_pspec (G_OBJECT (scale), properties[PROP_DRAW_VALUE]);
}
}
/**
* gtk_scale_get_draw_value:
* @scale: a #GtkScale
*
* Returns whether the current value is displayed as a string
* next to the slider.
*
* Returns: whether the current value is displayed as a string
*/
gboolean
gtk_scale_get_draw_value (GtkScale *scale)
{
g_return_val_if_fail (GTK_IS_SCALE (scale), FALSE);
return scale->priv->draw_value;
}
/**
* gtk_scale_set_has_origin:
* @scale: a #GtkScale
* @has_origin: %TRUE if the scale has an origin
*
* If #GtkScale:has-origin is set to %TRUE (the default), the scale will
* highlight the part of the trough between the origin (bottom or left side)
* and the current value.
*
* Since: 3.4
*/
void
gtk_scale_set_has_origin (GtkScale *scale,
gboolean has_origin)
{
g_return_if_fail (GTK_IS_SCALE (scale));
has_origin = has_origin != FALSE;
if (_gtk_range_get_has_origin (GTK_RANGE (scale)) != has_origin)
{
_gtk_range_set_has_origin (GTK_RANGE (scale), has_origin);
gtk_widget_queue_draw (GTK_WIDGET (scale));
g_object_notify_by_pspec (G_OBJECT (scale), properties[PROP_HAS_ORIGIN]);
}
}
/**
* gtk_scale_get_has_origin:
* @scale: a #GtkScale
*
* Returns whether the scale has an origin.
*
* Returns: %TRUE if the scale has an origin.
*
* Since: 3.4
*/
gboolean
gtk_scale_get_has_origin (GtkScale *scale)
{
g_return_val_if_fail (GTK_IS_SCALE (scale), FALSE);
return _gtk_range_get_has_origin (GTK_RANGE (scale));
}
/**
* gtk_scale_set_value_pos:
* @scale: a #GtkScale
* @pos: the position in which the current value is displayed
*
* Sets the position in which the current value is displayed.
*/
void
gtk_scale_set_value_pos (GtkScale *scale,
GtkPositionType pos)
{
GtkScalePrivate *priv;
GtkWidget *widget;
g_return_if_fail (GTK_IS_SCALE (scale));
priv = scale->priv;
if (priv->value_pos != pos)
{
priv->value_pos = pos;
widget = GTK_WIDGET (scale);
update_value_position (scale);
if (gtk_widget_get_visible (widget) && gtk_widget_get_mapped (widget))
gtk_widget_queue_resize (widget);
g_object_notify_by_pspec (G_OBJECT (scale), properties[PROP_VALUE_POS]);
}
}
/**
* gtk_scale_get_value_pos:
* @scale: a #GtkScale
*
* Gets the position in which the current value is displayed.
*
* Returns: the position in which the current value is displayed
*/
GtkPositionType
gtk_scale_get_value_pos (GtkScale *scale)
{
g_return_val_if_fail (GTK_IS_SCALE (scale), 0);
return scale->priv->value_pos;
}
static void
gtk_scale_get_range_border (GtkRange *range,
GtkBorder *border)
{
GtkScalePrivate *priv;
GtkScale *scale;
scale = GTK_SCALE (range);
priv = scale->priv;
border->left = 0;
border->right = 0;
border->top = 0;
border->bottom = 0;
if (priv->value_widget)
{
int value_size;
GtkOrientation value_orientation;
if (priv->value_pos == GTK_POS_LEFT || priv->value_pos == GTK_POS_RIGHT)
value_orientation = GTK_ORIENTATION_HORIZONTAL;
else
value_orientation = GTK_ORIENTATION_VERTICAL;
gtk_widget_measure (priv->value_widget,
value_orientation, -1,
&value_size, NULL,
NULL, NULL);
switch (priv->value_pos)
{
case GTK_POS_LEFT:
border->left += value_size;
break;
case GTK_POS_RIGHT:
border->right += value_size;
break;
case GTK_POS_TOP:
border->top += value_size;
break;
case GTK_POS_BOTTOM:
border->bottom += value_size;
break;
}
}
if (gtk_orientable_get_orientation (GTK_ORIENTABLE (range)) == GTK_ORIENTATION_HORIZONTAL)
{
int height;
if (priv->top_marks_widget)
{
gtk_widget_measure (priv->top_marks_widget,
GTK_ORIENTATION_VERTICAL, -1,
&height, NULL,
NULL, NULL);
if (height > 0)
border->top += height;
}
if (priv->bottom_marks_widget)
{
gtk_widget_measure (priv->bottom_marks_widget,
GTK_ORIENTATION_VERTICAL, -1,
&height, NULL,
NULL, NULL);
if (height > 0)
border->bottom += height;
}
}
else
{
int width;
if (priv->top_marks_widget)
{
gtk_widget_measure (priv->top_marks_widget,
GTK_ORIENTATION_HORIZONTAL, -1,
&width, NULL,
NULL, NULL);
if (width > 0)
border->left += width;
}
if (priv->bottom_marks_widget)
{
gtk_widget_measure (priv->bottom_marks_widget,
GTK_ORIENTATION_HORIZONTAL, -1,
&width, NULL,
NULL, NULL);
if (width > 0)
border->right += width;
}
}
}
static void
gtk_scale_get_range_size_request (GtkRange *range,
GtkOrientation orientation,
gint *minimum,
gint *natural)
{
GtkScalePrivate *priv = GTK_SCALE (range)->priv;
/* Ensure the range requests enough size for our value */
if (priv->value_widget)
gtk_widget_measure (priv->value_widget,
orientation, -1,
minimum, natural,
NULL, NULL);
else
{
*minimum = 0;
*natural = 0;
}
}
static void
gtk_scale_measure_mark (GtkGizmo *gizmo,
GtkOrientation orientation,
gint for_size,
gint *minimum,
gint *natural,
gint *minimum_baseline,
gint *natural_baseline)
{
GtkScaleMark *mark = g_object_get_data (G_OBJECT (gizmo), "mark");
gtk_widget_measure (mark->indicator_widget,
orientation, -1,
minimum, natural,
NULL, NULL);
if (mark->label_widget)
{
int label_min, label_nat;
gtk_widget_measure (mark->label_widget,
orientation, -1,
&label_min, &label_nat,
NULL, NULL);
*minimum += label_min;
*natural += label_nat;
}
}
static void
gtk_scale_measure_marks (GtkGizmo *gizmo,
GtkOrientation orientation,
gint for_size,
gint *minimum,
gint *natural,
gint *minimum_baseline,
gint *natural_baseline)
{
GtkWidget *widget = GTK_WIDGET (gizmo);
GtkScale *scale = GTK_SCALE (gtk_widget_get_parent (widget));;
GtkScalePrivate *priv = scale->priv;
GtkOrientation scale_orientation = gtk_orientable_get_orientation (GTK_ORIENTABLE (scale));
GSList *m;
*minimum = *natural = 0;
for (m = priv->marks; m; m = m->next)
{
GtkScaleMark *mark = m->data;
int mark_size;
if ((mark->position == GTK_POS_TOP && widget == priv->bottom_marks_widget) ||
(mark->position == GTK_POS_BOTTOM && widget == priv->top_marks_widget))
continue;
gtk_widget_measure (mark->widget,
orientation, -1,
&mark_size, NULL,
NULL, NULL);
if (scale_orientation == orientation)
{
*minimum += mark_size;
*natural += mark_size;
}
else
{
*minimum = MAX (*minimum, mark_size);
*natural = MAX (*natural, mark_size);
}
}
}
static void
gtk_scale_measure (GtkWidget *widget,
GtkOrientation orientation,
int for_size,
int *minimum,
int *natural,
int *minimum_baseline,
int *natural_baseline)
{
GtkScale *scale = GTK_SCALE (widget);
GtkScalePrivate *priv = scale->priv;
GTK_WIDGET_CLASS (gtk_scale_parent_class)->measure (widget,
orientation,
for_size,
minimum, natural,
minimum_baseline, natural_baseline);
if (gtk_orientable_get_orientation (GTK_ORIENTABLE (widget)) == orientation)
{
int top_marks_size = 0, bottom_marks_size = 0, marks_size;
if (priv->top_marks_widget)
gtk_widget_measure (priv->top_marks_widget,
orientation, for_size,
&top_marks_size, NULL,
NULL, NULL);
if (priv->bottom_marks_widget)
gtk_widget_measure (priv->bottom_marks_widget,
orientation, for_size,
&bottom_marks_size, NULL,
NULL, NULL);
marks_size = MAX (top_marks_size, bottom_marks_size);
*minimum = MAX (*minimum, marks_size);
*natural = MAX (*natural, marks_size);
}
}
static void
gtk_scale_snapshot (GtkWidget *widget,
GtkSnapshot *snapshot)
{
GtkScale *scale = GTK_SCALE (widget);
GtkScalePrivate *priv = scale->priv;
if (priv->top_marks_widget)
gtk_widget_snapshot_child (widget, priv->top_marks_widget, snapshot);
if (priv->bottom_marks_widget)
gtk_widget_snapshot_child (widget, priv->bottom_marks_widget, snapshot);
if (priv->value_widget)
gtk_widget_snapshot_child (widget, priv->value_widget, snapshot);
GTK_WIDGET_CLASS (gtk_scale_parent_class)->snapshot (widget, snapshot);
}
static void
gtk_scale_real_get_layout_offsets (GtkScale *scale,
gint *x,
gint *y)
{
GtkScalePrivate *priv = scale->priv;
GtkAllocation value_alloc;
if (!priv->value_widget)
{
*x = 0;
*y = 0;
return;
}
gtk_widget_get_content_allocation (priv->value_widget, &value_alloc);
*x = value_alloc.x;
*y = value_alloc.y;
}
static gchar *
weed_out_neg_zero (gchar *str,
gint digits)
{
if (str[0] == '-')
{
gchar neg_zero[8];
g_snprintf (neg_zero, 8, "%0.*f", digits, -0.0);
if (strcmp (neg_zero, str) == 0)
memmove (str, str + 1, strlen (str) - 1);
}
return str;
}
/*
* Emits #GtkScale:format-value signal to format the value;
* if no user signal handlers, falls back to a default format.
*
* Returns: formatted value
*/
static gchar *
gtk_scale_format_value (GtkScale *scale,
gdouble value)
{
gchar *fmt = NULL;
g_signal_emit (scale, signals[FORMAT_VALUE], 0, value, &fmt);
if (fmt)
return fmt;
else
{
fmt = g_strdup_printf ("%0.*f", scale->priv->digits, value);
return weed_out_neg_zero (fmt, scale->priv->digits);
}
}
static void
gtk_scale_finalize (GObject *object)
{
GtkScale *scale = GTK_SCALE (object);
GtkScalePrivate *priv = scale->priv;
gtk_scale_clear_marks (scale);
if (priv->value_widget)
gtk_widget_unparent (priv->value_widget);
G_OBJECT_CLASS (gtk_scale_parent_class)->finalize (object);
}
/**
* gtk_scale_get_layout:
* @scale: A #GtkScale
*
* Gets the #PangoLayout used to display the scale. The returned
* object is owned by the scale so does not need to be freed by
* the caller.
*
* Returns: (transfer none) (nullable): the #PangoLayout for this scale,
* or %NULL if the #GtkScale:draw-value property is %FALSE.
*
* Since: 2.4
*/
PangoLayout *
gtk_scale_get_layout (GtkScale *scale)
{
g_return_val_if_fail (GTK_IS_SCALE (scale), NULL);
if (scale->priv->value_widget)
return gtk_label_get_layout (GTK_LABEL (scale->priv->value_widget));
return NULL;
}
/**
* gtk_scale_get_layout_offsets:
* @scale: a #GtkScale
* @x: (out) (allow-none): location to store X offset of layout, or %NULL
* @y: (out) (allow-none): location to store Y offset of layout, or %NULL
*
* Obtains the coordinates where the scale will draw the
* #PangoLayout representing the text in the scale. Remember
* when using the #PangoLayout function you need to convert to
* and from pixels using PANGO_PIXELS() or #PANGO_SCALE.
*
* If the #GtkScale:draw-value property is %FALSE, the return
* values are undefined.
*
* Since: 2.4
*/
void
gtk_scale_get_layout_offsets (GtkScale *scale,
gint *x,
gint *y)
{
gint local_x = 0;
gint local_y = 0;
g_return_if_fail (GTK_IS_SCALE (scale));
if (GTK_SCALE_GET_CLASS (scale)->get_layout_offsets)
(GTK_SCALE_GET_CLASS (scale)->get_layout_offsets) (scale, &local_x, &local_y);
if (x)
*x = local_x;
if (y)
*y = local_y;
}
static void
gtk_scale_mark_free (gpointer data)
{
GtkScaleMark *mark = data;
if (mark->label_widget)
gtk_widget_unparent (mark->label_widget);
gtk_widget_unparent (mark->indicator_widget);
gtk_widget_unparent (mark->widget);
g_free (mark->markup);
g_free (mark);
}
/**
* gtk_scale_clear_marks:
* @scale: a #GtkScale
*
* Removes any marks that have been added with gtk_scale_add_mark().
*
* Since: 2.16
*/
void
gtk_scale_clear_marks (GtkScale *scale)
{
GtkScalePrivate *priv;
GtkStyleContext *context;
g_return_if_fail (GTK_IS_SCALE (scale));
priv = scale->priv;
g_slist_free_full (priv->marks, gtk_scale_mark_free);
priv->marks = NULL;
if (priv->top_marks_widget)
{
gtk_widget_unparent (priv->top_marks_widget);
priv->top_marks_widget = NULL;
}
if (priv->bottom_marks_widget)
{
gtk_widget_unparent (priv->bottom_marks_widget);
priv->bottom_marks_widget = NULL;
}
context = gtk_widget_get_style_context (GTK_WIDGET (scale));
gtk_style_context_remove_class (context, "marks-before");
gtk_style_context_remove_class (context, "marks-after");
_gtk_range_set_stop_values (GTK_RANGE (scale), NULL, 0);
gtk_widget_queue_resize (GTK_WIDGET (scale));
}
/**
* gtk_scale_add_mark:
* @scale: a #GtkScale
* @value: the value at which the mark is placed, must be between
* the lower and upper limits of the scales adjustment
* @position: where to draw the mark. For a horizontal scale, #GTK_POS_TOP
* and %GTK_POS_LEFT are drawn above the scale, anything else below.
* For a vertical scale, #GTK_POS_LEFT and %GTK_POS_TOP are drawn to
* the left of the scale, anything else to the right.
* @markup: (allow-none): Text to be shown at the mark, using [Pango markup][PangoMarkupFormat], or %NULL
*
*
* Adds a mark at @value.
*
* A mark is indicated visually by drawing a tick mark next to the scale,
* and GTK+ makes it easy for the user to position the scale exactly at the
* marks value.
*
* If @markup is not %NULL, text is shown next to the tick mark.
*
* To remove marks from a scale, use gtk_scale_clear_marks().
*
* Since: 2.16
*/
void
gtk_scale_add_mark (GtkScale *scale,
gdouble value,
GtkPositionType position,
const gchar *markup)
{
GtkWidget *widget;
GtkScalePrivate *priv;
GtkScaleMark *mark;
GSList *m;
gdouble *values;
gint n, i;
GtkStyleContext *context;
GtkWidget *marks_widget;
g_return_if_fail (GTK_IS_SCALE (scale));
priv = scale->priv;
widget = GTK_WIDGET (scale);
mark = g_new0 (GtkScaleMark, 1);
mark->value = value;
mark->markup = g_strdup (markup);
if (position == GTK_POS_LEFT ||
position == GTK_POS_TOP)
mark->position = GTK_POS_TOP;
else
mark->position = GTK_POS_BOTTOM;
priv->marks = g_slist_insert_sorted_with_data (priv->marks, mark,
compare_marks,
GINT_TO_POINTER (gtk_range_get_inverted (GTK_RANGE (scale))));
if (mark->position == GTK_POS_TOP)
{
if (!priv->top_marks_widget)
{
priv->top_marks_widget = gtk_gizmo_new ("marks",
gtk_scale_measure_marks,
gtk_scale_allocate_marks,
NULL);
gtk_widget_insert_after (priv->top_marks_widget,
GTK_WIDGET (scale),
(priv->value_widget &&
(priv->value_pos == GTK_POS_TOP || priv->value_pos == GTK_POS_LEFT)) ?
priv->value_widget : NULL);
gtk_style_context_add_class (gtk_widget_get_style_context (priv->top_marks_widget),
GTK_STYLE_CLASS_TOP);
}
marks_widget = priv->top_marks_widget;
}
else
{
if (!priv->bottom_marks_widget)
{
priv->bottom_marks_widget = gtk_gizmo_new ("marks",
gtk_scale_measure_marks,
gtk_scale_allocate_marks,
NULL);
gtk_widget_insert_before (priv->bottom_marks_widget,
GTK_WIDGET (scale),
(priv->value_widget &&
(priv->value_pos == GTK_POS_BOTTOM || priv->value_pos == GTK_POS_RIGHT)) ?
priv->value_widget: NULL);
gtk_style_context_add_class (gtk_widget_get_style_context (priv->bottom_marks_widget),
GTK_STYLE_CLASS_BOTTOM);
}
marks_widget = priv->bottom_marks_widget;
}
mark->widget = gtk_gizmo_new ("mark",
gtk_scale_measure_mark,
gtk_scale_allocate_mark,
NULL);
g_object_set_data (G_OBJECT (mark->widget), "mark", mark);
mark->indicator_widget = gtk_gizmo_new ("indicator",
NULL,
NULL,
NULL);
gtk_widget_set_parent (mark->indicator_widget, mark->widget);
if (mark->markup && *mark->markup)
{
mark->label_widget = g_object_new (GTK_TYPE_LABEL,
"css-name", "label",
"use-markup", TRUE,
"label", mark->markup,
NULL);
if (marks_widget == priv->top_marks_widget)
gtk_widget_insert_after (mark->label_widget, mark->widget, NULL);
else
gtk_widget_insert_before (mark->label_widget, mark->widget, NULL);
}
m = g_slist_find (priv->marks, mark);
m = m->next;
while (m)
{
GtkScaleMark *next = m->data;
if (next->position == mark->position)
break;
m = m->next;
}
if (m)
{
GtkScaleMark *next = m->data;
gtk_widget_insert_before (mark->widget, marks_widget, next->widget);
}
else
{
gtk_widget_set_parent (mark->widget, marks_widget);
}
n = g_slist_length (priv->marks);
values = g_new (gdouble, n);
for (m = priv->marks, i = 0; m; m = m->next, i++)
{
mark = m->data;
values[i] = mark->value;
}
_gtk_range_set_stop_values (GTK_RANGE (scale), values, n);
g_free (values);
context = gtk_widget_get_style_context (GTK_WIDGET (scale));
if (priv->top_marks_widget)
gtk_style_context_add_class (context, "marks-before");
if (priv->bottom_marks_widget)
gtk_style_context_add_class (context, "marks-after");
gtk_widget_queue_resize (widget);
}
static GtkBuildableIface *parent_buildable_iface;
static void
gtk_scale_buildable_interface_init (GtkBuildableIface *iface)
{
parent_buildable_iface = g_type_interface_peek_parent (iface);
iface->custom_tag_start = gtk_scale_buildable_custom_tag_start;
iface->custom_finished = gtk_scale_buildable_custom_finished;
}
typedef struct
{
GtkScale *scale;
GtkBuilder *builder;
GSList *marks;
} MarksSubparserData;
typedef struct
{
gdouble value;
GtkPositionType position;
GString *markup;
gchar *context;
gboolean translatable;
} MarkData;
static void
mark_data_free (MarkData *data)
{
g_string_free (data->markup, TRUE);
g_free (data->context);
g_slice_free (MarkData, data);
}
static void
marks_start_element (GMarkupParseContext *context,
const gchar *element_name,
const gchar **names,
const gchar **values,
gpointer user_data,
GError **error)
{
MarksSubparserData *data = (MarksSubparserData*)user_data;
if (strcmp (element_name, "marks") == 0)
{
if (!_gtk_builder_check_parent (data->builder, context, "object", error))
return;
if (!g_markup_collect_attributes (element_name, names, values, error,
G_MARKUP_COLLECT_INVALID, NULL, NULL,
G_MARKUP_COLLECT_INVALID))
_gtk_builder_prefix_error (data->builder, context, error);
}
else if (strcmp (element_name, "mark") == 0)
{
const gchar *value_str;
gdouble value = 0;
const gchar *position_str = NULL;
GtkPositionType position = GTK_POS_BOTTOM;
const gchar *msg_context = NULL;
gboolean translatable = FALSE;
MarkData *mark;
if (!_gtk_builder_check_parent (data->builder, context, "marks", error))
return;
if (!g_markup_collect_attributes (element_name, names, values, error,
G_MARKUP_COLLECT_STRING, "value", &value_str,
G_MARKUP_COLLECT_BOOLEAN|G_MARKUP_COLLECT_OPTIONAL, "translatable", &translatable,
G_MARKUP_COLLECT_STRING|G_MARKUP_COLLECT_OPTIONAL, "comments", NULL,
G_MARKUP_COLLECT_STRING|G_MARKUP_COLLECT_OPTIONAL, "context", &msg_context,
G_MARKUP_COLLECT_STRING|G_MARKUP_COLLECT_OPTIONAL, "position", &position_str,
G_MARKUP_COLLECT_INVALID))
{
_gtk_builder_prefix_error (data->builder, context, error);
return;
}
if (value_str != NULL)
{
GValue gvalue = G_VALUE_INIT;
if (!gtk_builder_value_from_string_type (data->builder, G_TYPE_DOUBLE, value_str, &gvalue, error))
{
_gtk_builder_prefix_error (data->builder, context, error);
return;
}
value = g_value_get_double (&gvalue);
}
if (position_str != NULL)
{
GValue gvalue = G_VALUE_INIT;
if (!gtk_builder_value_from_string_type (data->builder, GTK_TYPE_POSITION_TYPE, position_str, &gvalue, error))
{
_gtk_builder_prefix_error (data->builder, context, error);
return;
}
position = g_value_get_enum (&gvalue);
}
mark = g_slice_new (MarkData);
mark->value = value;
if (position == GTK_POS_LEFT || position == GTK_POS_TOP)
mark->position = GTK_POS_TOP;
else
mark->position = GTK_POS_BOTTOM;
mark->markup = g_string_new ("");
mark->context = g_strdup (msg_context);
mark->translatable = translatable;
data->marks = g_slist_prepend (data->marks, mark);
}
else
{
_gtk_builder_error_unhandled_tag (data->builder, context,
"GtkScale", element_name,
error);
}
}
static void
marks_text (GMarkupParseContext *context,
const gchar *text,
gsize text_len,
gpointer user_data,
GError **error)
{
MarksSubparserData *data = (MarksSubparserData*)user_data;
if (strcmp (g_markup_parse_context_get_element (context), "mark") == 0)
{
MarkData *mark = data->marks->data;
g_string_append_len (mark->markup, text, text_len);
}
}
static const GMarkupParser marks_parser =
{
marks_start_element,
NULL,
marks_text,
};
static gboolean
gtk_scale_buildable_custom_tag_start (GtkBuildable *buildable,
GtkBuilder *builder,
GObject *child,
const gchar *tagname,
GMarkupParser *parser,
gpointer *parser_data)
{
MarksSubparserData *data;
if (child)
return FALSE;
if (strcmp (tagname, "marks") == 0)
{
data = g_slice_new0 (MarksSubparserData);
data->scale = GTK_SCALE (buildable);
data->builder = builder;
data->marks = NULL;
*parser = marks_parser;
*parser_data = data;
return TRUE;
}
return parent_buildable_iface->custom_tag_start (buildable, builder, child,
tagname, parser, parser_data);
}
static void
gtk_scale_buildable_custom_finished (GtkBuildable *buildable,
GtkBuilder *builder,
GObject *child,
const gchar *tagname,
gpointer user_data)
{
GtkScale *scale = GTK_SCALE (buildable);
MarksSubparserData *marks_data;
if (strcmp (tagname, "marks") == 0)
{
GSList *m;
const gchar *markup;
marks_data = (MarksSubparserData *)user_data;
for (m = marks_data->marks; m; m = m->next)
{
MarkData *mdata = m->data;
if (mdata->translatable && mdata->markup->len)
markup = _gtk_builder_parser_translate (gtk_builder_get_translation_domain (builder),
mdata->context,
mdata->markup->str);
else
markup = mdata->markup->str;
gtk_scale_add_mark (scale, mdata->value, mdata->position, markup);
mark_data_free (mdata);
}
g_slist_free (marks_data->marks);
g_slice_free (MarksSubparserData, marks_data);
}
else
{
parent_buildable_iface->custom_finished (buildable, builder, child,
tagname, user_data);
}
}