gtk2/gtk/gtkscale.c
2010-10-30 17:35:20 +09:00

1780 lines
52 KiB
C

/* 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, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/*
* 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 "gdk/gdkkeysyms.h"
#include "gtkscale.h"
#include "gtkiconfactory.h"
#include "gtkicontheme.h"
#include "gtkmarshalers.h"
#include "gtkbindings.h"
#include "gtkorientable.h"
#include "gtkprivate.h"
#include "gtkintl.h"
#include "gtkbuildable.h"
#include "gtkbuilderprivate.h"
/**
* SECTION:gtkscale
* @Short_description: Base class for GtkHScale and GtkVScale
* @Title: GtkScale
*
* A GtkScale is a slider control used to select a numeric value.
* To use it, you'll 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.
*
* <refsect2 id="GtkScale-BUILDER-UI"><title>GtkScale as GtkBuildable</title>
* GtkScale supports a custom &lt;marks&gt; element, which
* can contain multiple &lt;mark&gt; 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.
* </refsect2>
*/
#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
{
PangoLayout *layout;
GSList *marks;
gint digits;
guint draw_value : 1;
guint value_pos : 2;
};
struct _GtkScaleMark
{
gdouble value;
gchar *markup;
GtkPositionType position;
};
enum {
PROP_0,
PROP_DIGITS,
PROP_DRAW_VALUE,
PROP_VALUE_POS
};
enum {
FORMAT_VALUE,
LAST_SIGNAL
};
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_get_preferred_width (GtkWidget *widget,
gint *minimum,
gint *natural);
static void gtk_scale_get_preferred_height (GtkWidget *widget,
gint *minimum,
gint *natural);
static void gtk_scale_style_set (GtkWidget *widget,
GtkStyle *previous);
static void gtk_scale_get_range_border (GtkRange *range,
GtkBorder *border);
static void gtk_scale_get_mark_label_size (GtkScale *scale,
GtkPositionType position,
gint *count1,
gint *width1,
gint *height1,
gint *count2,
gint *width2,
gint *height2);
static void gtk_scale_finalize (GObject *object);
static void gtk_scale_screen_changed (GtkWidget *widget,
GdkScreen *old_screen);
static gboolean gtk_scale_draw (GtkWidget *widget,
cairo_t *cr);
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);
G_DEFINE_TYPE_WITH_CODE (GtkScale, gtk_scale, GTK_TYPE_RANGE,
G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
gtk_scale_buildable_interface_init))
static gboolean
single_string_accumulator (GSignalInvocationHint *ihint,
GValue *return_accu,
const GValue *handler_return,
gpointer dummy)
{
gboolean continue_emission;
const gchar *str;
str = g_value_get_string (handler_return);
g_value_set_string (return_accu, str);
continue_emission = str == NULL;
return continue_emission;
}
#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_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->finalize = gtk_scale_finalize;
widget_class->style_set = gtk_scale_style_set;
widget_class->screen_changed = gtk_scale_screen_changed;
widget_class->draw = gtk_scale_draw;
widget_class->get_preferred_width = gtk_scale_get_preferred_width;
widget_class->get_preferred_height = gtk_scale_get_preferred_height;
range_class->slider_detail = "Xscale";
range_class->get_range_border = gtk_scale_get_range_border;
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.
*
* Here's an example signal handler which displays a value 1.0 as
* with "--&gt;1.0&lt;--".
* |[
* static gchar*
* format_value_callback (GtkScale *scale,
* gdouble value)
* {
* return g_strdup_printf ("--&gt;&percnt;0.*g&lt;--",
* gtk_scale_get_digits (scale), value);
* }
* ]|
*
* Return value: 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),
single_string_accumulator, NULL,
_gtk_marshal_STRING__DOUBLE,
G_TYPE_STRING, 1,
G_TYPE_DOUBLE);
g_object_class_install_property (gobject_class,
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_object_class_install_property (gobject_class,
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_object_class_install_property (gobject_class,
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));
gtk_widget_class_install_style_property (widget_class,
g_param_spec_int ("slider-length",
P_("Slider Length"),
P_("Length of scale's slider"),
0,
G_MAXINT,
31,
GTK_PARAM_READABLE));
gtk_widget_class_install_style_property (widget_class,
g_param_spec_int ("value-spacing",
P_("Value spacing"),
P_("Space between value text and the slider/trough area"),
0,
G_MAXINT,
2,
GTK_PARAM_READABLE));
/* 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);
g_type_class_add_private (gobject_class, sizeof (GtkScalePrivate));
}
static void
gtk_scale_orientation_notify (GtkRange *range,
const GParamSpec *pspec)
{
GtkOrientation orientation;
orientation = gtk_orientable_get_orientation (GTK_ORIENTABLE (range));
gtk_range_set_flippable (range,
orientation == GTK_ORIENTATION_HORIZONTAL);
}
static void
gtk_scale_init (GtkScale *scale)
{
GtkScalePrivate *priv;
GtkRange *range = GTK_RANGE (scale);
scale->priv = G_TYPE_INSTANCE_GET_PRIVATE (scale,
GTK_TYPE_SCALE,
GtkScalePrivate);
priv = scale->priv;
gtk_widget_set_can_focus (GTK_WIDGET (scale), TRUE);
gtk_range_set_slider_size_fixed (range, TRUE);
priv->draw_value = TRUE;
priv->value_pos = GTK_POS_TOP;
priv->digits = 1;
_gtk_range_set_round_digits (range, priv->digits);
gtk_scale_orientation_notify (range, NULL);
g_signal_connect (scale, "notify::orientation",
G_CALLBACK (gtk_scale_orientation_notify),
NULL);
}
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_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_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 scale's orientation.
* @adjustment: the #GtkAdjustment which sets the range of the scale, or
* %NULL to create a new adjustment.
*
* Creates a new #GtkScale.
*
* Return value: 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 scale's 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; it's 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.
*
* Return value: 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 off to this
* number of digits, so the retrieved value matches the value the user saw.
*/
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_scale_clear_layout (scale);
gtk_widget_queue_resize (GTK_WIDGET (scale));
g_object_notify (G_OBJECT (scale), "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;
}
/**
* 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;
g_return_if_fail (GTK_IS_SCALE (scale));
priv = scale->priv;
draw_value = draw_value != FALSE;
if (priv->draw_value != draw_value)
{
priv->draw_value = draw_value;
if (draw_value)
_gtk_range_set_round_digits (GTK_RANGE (scale), priv->digits);
else
_gtk_range_set_round_digits (GTK_RANGE (scale), -1);
_gtk_scale_clear_layout (scale);
gtk_widget_queue_resize (GTK_WIDGET (scale));
g_object_notify (G_OBJECT (scale), "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_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);
_gtk_scale_clear_layout (scale);
if (gtk_widget_get_visible (widget) && gtk_widget_get_mapped (widget))
gtk_widget_queue_resize (widget);
g_object_notify (G_OBJECT (scale), "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;
GtkWidget *widget;
GtkScale *scale;
gint w, h;
widget = GTK_WIDGET (range);
scale = GTK_SCALE (range);
priv = scale->priv;
_gtk_scale_get_value_size (scale, &w, &h);
border->left = 0;
border->right = 0;
border->top = 0;
border->bottom = 0;
if (priv->draw_value)
{
gint value_spacing;
gtk_widget_style_get (widget, "value-spacing", &value_spacing, NULL);
switch (priv->value_pos)
{
case GTK_POS_LEFT:
border->left += w + value_spacing;
break;
case GTK_POS_RIGHT:
border->right += w + value_spacing;
break;
case GTK_POS_TOP:
border->top += h + value_spacing;
break;
case GTK_POS_BOTTOM:
border->bottom += h + value_spacing;
break;
}
}
if (priv->marks)
{
gint slider_width;
gint value_spacing;
gint n1, w1, h1, n2, w2, h2;
gtk_widget_style_get (widget,
"slider-width", &slider_width,
"value-spacing", &value_spacing,
NULL);
if (gtk_orientable_get_orientation (GTK_ORIENTABLE (scale)) == GTK_ORIENTATION_HORIZONTAL)
{
gtk_scale_get_mark_label_size (scale, GTK_POS_TOP, &n1, &w1, &h1, &n2, &w2, &h2);
if (n1 > 0)
border->top += h1 + value_spacing + slider_width / 2;
if (n2 > 0)
border->bottom += h2 + value_spacing + slider_width / 2;
}
else
{
gtk_scale_get_mark_label_size (scale, GTK_POS_LEFT, &n1, &w1, &h1, &n2, &w2, &h2);
if (n1 > 0)
border->left += w1 + value_spacing + slider_width / 2;
if (n2 > 0)
border->right += w2 + value_spacing + slider_width / 2;
}
}
}
/* FIXME this could actually be static at the moment. */
void
_gtk_scale_get_value_size (GtkScale *scale,
gint *width,
gint *height)
{
GtkScalePrivate *priv = scale->priv;
GtkRange *range;
if (priv->draw_value)
{
GtkAdjustment *adjustment;
PangoLayout *layout;
PangoRectangle logical_rect;
gchar *txt;
range = GTK_RANGE (scale);
layout = gtk_widget_create_pango_layout (GTK_WIDGET (scale), NULL);
adjustment = gtk_range_get_adjustment (range);
txt = _gtk_scale_format_value (scale, gtk_adjustment_get_lower (adjustment));
pango_layout_set_text (layout, txt, -1);
g_free (txt);
pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
if (width)
*width = logical_rect.width;
if (height)
*height = logical_rect.height;
txt = _gtk_scale_format_value (scale, gtk_adjustment_get_upper (adjustment));
pango_layout_set_text (layout, txt, -1);
g_free (txt);
pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
if (width)
*width = MAX (*width, logical_rect.width);
if (height)
*height = MAX (*height, logical_rect.height);
g_object_unref (layout);
}
else
{
if (width)
*width = 0;
if (height)
*height = 0;
}
}
static void
gtk_scale_get_mark_label_size (GtkScale *scale,
GtkPositionType position,
gint *count1,
gint *width1,
gint *height1,
gint *count2,
gint *width2,
gint *height2)
{
GtkScalePrivate *priv = scale->priv;
PangoLayout *layout;
PangoRectangle logical_rect;
GSList *m;
gint w, h;
*count1 = *count2 = 0;
*width1 = *width2 = 0;
*height1 = *height2 = 0;
layout = gtk_widget_create_pango_layout (GTK_WIDGET (scale), NULL);
for (m = priv->marks; m; m = m->next)
{
GtkScaleMark *mark = m->data;
if (mark->markup && *mark->markup)
{
pango_layout_set_markup (layout, mark->markup, -1);
pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
w = logical_rect.width;
h = logical_rect.height;
}
else
{
w = 0;
h = 0;
}
if (mark->position == position)
{
(*count1)++;
*width1 = MAX (*width1, w);
*height1 = MAX (*height1, h);
}
else
{
(*count2)++;
*width2 = MAX (*width2, w);
*height2 = MAX (*height2, h);
}
}
g_object_unref (layout);
}
static void
gtk_scale_style_set (GtkWidget *widget,
GtkStyle *previous)
{
gint slider_length;
GtkRange *range;
range = GTK_RANGE (widget);
gtk_widget_style_get (widget,
"slider-length", &slider_length,
NULL);
gtk_range_set_min_slider_size (range, slider_length);
_gtk_scale_clear_layout (GTK_SCALE (widget));
GTK_WIDGET_CLASS (gtk_scale_parent_class)->style_set (widget, previous);
}
static void
gtk_scale_screen_changed (GtkWidget *widget,
GdkScreen *old_screen)
{
_gtk_scale_clear_layout (GTK_SCALE (widget));
}
static void
gtk_scale_get_preferred_width (GtkWidget *widget,
gint *minimum,
gint *natural)
{
GTK_WIDGET_CLASS (gtk_scale_parent_class)->get_preferred_width (widget, minimum, natural);
if (gtk_orientable_get_orientation (GTK_ORIENTABLE (widget)) == GTK_ORIENTATION_HORIZONTAL)
{
gint n1, w1, h1, n2, w2, h2;
gint slider_length;
gint w;
gtk_widget_style_get (widget, "slider-length", &slider_length, NULL);
gtk_scale_get_mark_label_size (GTK_SCALE (widget), GTK_POS_TOP, &n1, &w1, &h1, &n2, &w2, &h2);
w1 = (n1 - 1) * w1 + MAX (w1, slider_length);
w2 = (n2 - 1) * w2 + MAX (w2, slider_length);
w = MAX (w1, w2);
*minimum = MAX (*minimum, w);
*natural = MAX (*natural, w);
}
}
static void
gtk_scale_get_preferred_height (GtkWidget *widget,
gint *minimum,
gint *natural)
{
GTK_WIDGET_CLASS (gtk_scale_parent_class)->get_preferred_height (widget, minimum, natural);
if (gtk_orientable_get_orientation (GTK_ORIENTABLE (widget)) == GTK_ORIENTATION_VERTICAL)
{
gint n1, w1, h1, n2, w2, h2;
gint slider_length;
gint h;
gtk_widget_style_get (widget, "slider-length", &slider_length, NULL);
gtk_scale_get_mark_label_size (GTK_SCALE (widget), GTK_POS_LEFT, &n1, &w1, &h1, &n2, &w2, &h2);
h1 = (n1 - 1) * h1 + MAX (h1, slider_length);
h2 = (n2 - 1) * h1 + MAX (h2, slider_length);
h = MAX (h1, h2);
*minimum = MAX (*minimum, h);
*natural = MAX (*natural, h);
}
}
static gint
find_next_pos (GtkWidget *widget,
GSList *list,
gint *marks,
GtkPositionType pos,
gint match)
{
GtkAllocation allocation;
GSList *m;
gint i;
for (m = list->next, i = 1; m; m = m->next, i++)
{
GtkScaleMark *mark = m->data;
if (match == (mark->position == pos))
return marks[i];
}
gtk_widget_get_allocation (widget, &allocation);
if (pos == GTK_POS_TOP || pos == GTK_POS_BOTTOM)
return allocation.width;
else
return allocation.height;
}
static gboolean
gtk_scale_draw (GtkWidget *widget,
cairo_t *cr)
{
GtkScale *scale = GTK_SCALE (widget);
GtkScalePrivate *priv = scale->priv;
GtkRange *range = GTK_RANGE (scale);
GtkStateType state_type;
GtkStyle *style;
gint n_marks;
gint *marks;
gint focus_padding;
gint slider_width;
gint value_spacing;
gint min_sep = 4;
style = gtk_widget_get_style (widget);
gtk_widget_style_get (widget,
"focus-padding", &focus_padding,
"slider-width", &slider_width,
"value-spacing", &value_spacing,
NULL);
/* We need to chain up _first_ so the various geometry members of
* GtkRange struct are updated.
*/
GTK_WIDGET_CLASS (gtk_scale_parent_class)->draw (widget, cr);
state_type = GTK_STATE_NORMAL;
if (!gtk_widget_is_sensitive (widget))
state_type = GTK_STATE_INSENSITIVE;
if (priv->marks)
{
GtkOrientation orientation;
GdkRectangle range_rect;
gint i;
gint x1, x2, x3, y1, y2, y3;
PangoLayout *layout;
PangoRectangle logical_rect;
GSList *m;
gint min_pos_before, min_pos_after;
gint min_pos, max_pos;
orientation = gtk_orientable_get_orientation (GTK_ORIENTABLE (range));
n_marks = _gtk_range_get_stop_positions (range, &marks);
layout = gtk_widget_create_pango_layout (widget, NULL);
gtk_range_get_range_rect (range, &range_rect);
min_pos_before = min_pos_after = 0;
for (m = priv->marks, i = 0; m; m = m->next, i++)
{
GtkScaleMark *mark = m->data;
if (orientation == GTK_ORIENTATION_HORIZONTAL)
{
x1 = marks[i];
if (mark->position == GTK_POS_TOP)
{
y1 = range_rect.y;
y2 = y1 - slider_width / 2;
min_pos = min_pos_before;
max_pos = find_next_pos (widget, m, marks + i, GTK_POS_TOP, 1) - min_sep;
}
else
{
y1 = range_rect.y + range_rect.height;
y2 = y1 + slider_width / 2;
min_pos = min_pos_after;
max_pos = find_next_pos (widget, m, marks + i, GTK_POS_TOP, 0) - min_sep;
}
gtk_paint_vline (style, cr, state_type,
widget, "scale-mark", y1, y2, x1);
if (mark->markup)
{
pango_layout_set_markup (layout, mark->markup, -1);
pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
x3 = x1 - logical_rect.width / 2;
if (x3 < min_pos)
x3 = min_pos;
if (x3 + logical_rect.width > max_pos)
x3 = max_pos - logical_rect.width;
if (x3 < 0)
x3 = 0;
if (mark->position == GTK_POS_TOP)
{
y3 = y2 - value_spacing - logical_rect.height;
min_pos_before = x3 + logical_rect.width + min_sep;
}
else
{
y3 = y2 + value_spacing;
min_pos_after = x3 + logical_rect.width + min_sep;
}
gtk_paint_layout (style, cr, state_type,
FALSE, widget, "scale-mark",
x3, y3, layout);
}
}
else
{
if (mark->position == GTK_POS_LEFT)
{
x1 = range_rect.x;
x2 = range_rect.x - slider_width / 2;
min_pos = min_pos_before;
max_pos = find_next_pos (widget, m, marks + i, GTK_POS_LEFT, 1) - min_sep;
}
else
{
x1 = range_rect.x + range_rect.width;
x2 = range_rect.x + range_rect.width + slider_width / 2;
min_pos = min_pos_after;
max_pos = find_next_pos (widget, m, marks + i, GTK_POS_LEFT, 0) - min_sep;
}
y1 = marks[i];
gtk_paint_hline (style, cr, state_type,
widget, "range-mark", x1, x2, y1);
if (mark->markup)
{
pango_layout_set_markup (layout, mark->markup, -1);
pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
y3 = y1 - logical_rect.height / 2;
if (y3 < min_pos)
y3 = min_pos;
if (y3 + logical_rect.height > max_pos)
y3 = max_pos - logical_rect.height;
if (y3 < 0)
y3 = 0;
if (mark->position == GTK_POS_LEFT)
{
x3 = x2 - value_spacing - logical_rect.width;
min_pos_before = y3 + logical_rect.height + min_sep;
}
else
{
x3 = x2 + value_spacing;
min_pos_after = y3 + logical_rect.height + min_sep;
}
gtk_paint_layout (style, cr, state_type,
FALSE, widget, "scale-mark",
x3, y3, layout);
}
}
}
g_object_unref (layout);
g_free (marks);
}
if (priv->draw_value)
{
GtkOrientation orientation;
GtkAllocation allocation;
PangoLayout *layout;
gint x, y;
orientation = gtk_orientable_get_orientation (GTK_ORIENTABLE (range));
layout = gtk_scale_get_layout (scale);
gtk_scale_get_layout_offsets (scale, &x, &y);
gtk_widget_get_allocation (widget, &allocation);
gtk_paint_layout (style,
cr,
state_type,
FALSE,
widget,
orientation == GTK_ORIENTATION_HORIZONTAL ?
"hscale" : "vscale",
x - allocation.x,
y - allocation.y,
layout);
}
return FALSE;
}
static void
gtk_scale_real_get_layout_offsets (GtkScale *scale,
gint *x,
gint *y)
{
GtkScalePrivate *priv = scale->priv;
GtkAllocation allocation;
GtkWidget *widget = GTK_WIDGET (scale);
GtkRange *range = GTK_RANGE (widget);
GdkRectangle range_rect;
PangoLayout *layout = gtk_scale_get_layout (scale);
PangoRectangle logical_rect;
gint slider_start, slider_end;
gint value_spacing;
if (!layout)
{
*x = 0;
*y = 0;
return;
}
gtk_widget_style_get (widget, "value-spacing", &value_spacing, NULL);
pango_layout_get_pixel_extents (layout, NULL, &logical_rect);
gtk_widget_get_allocation (widget, &allocation);
gtk_range_get_range_rect (range, &range_rect);
gtk_range_get_slider_range (range,
&slider_start,
&slider_end);
if (gtk_orientable_get_orientation (GTK_ORIENTABLE (range)) == GTK_ORIENTATION_HORIZONTAL)
{
switch (priv->value_pos)
{
case GTK_POS_LEFT:
*x = range_rect.x - value_spacing - logical_rect.width;
*y = range_rect.y + (range_rect.height - logical_rect.height) / 2;
break;
case GTK_POS_RIGHT:
*x = range_rect.x + range_rect.width + value_spacing;
*y = range_rect.y + (range_rect.height - logical_rect.height) / 2;
break;
case GTK_POS_TOP:
*x = slider_start + (slider_end - slider_start - logical_rect.width) / 2;
*x = CLAMP (*x, 0, allocation.width - logical_rect.width);
*y = range_rect.y - logical_rect.height - value_spacing;
break;
case GTK_POS_BOTTOM:
*x = slider_start + (slider_end - slider_start - logical_rect.width) / 2;
*x = CLAMP (*x, 0, allocation.width - logical_rect.width);
*y = range_rect.y + range_rect.height + value_spacing;
break;
default:
g_return_if_reached ();
break;
}
}
else
{
switch (priv->value_pos)
{
case GTK_POS_LEFT:
*x = range_rect.x - logical_rect.width - value_spacing;
*y = slider_start + (slider_end - slider_start - logical_rect.height) / 2;
*y = CLAMP (*y, 0, allocation.height - logical_rect.height);
break;
case GTK_POS_RIGHT:
*x = range_rect.x + range_rect.width + value_spacing;
*y = slider_start + (slider_end - slider_start - logical_rect.height) / 2;
*y = CLAMP (*y, 0, allocation.height - logical_rect.height);
break;
case GTK_POS_TOP:
*x = range_rect.x + (range_rect.width - logical_rect.width) / 2;
*y = range_rect.y - logical_rect.height - value_spacing;
break;
case GTK_POS_BOTTOM:
*x = range_rect.x + (range_rect.width - logical_rect.width) / 2;
*y = range_rect.y + range_rect.height + value_spacing;
break;
default:
g_return_if_reached ();
}
}
*x += allocation.x;
*y += allocation.y;
}
/**
* _gtk_scale_format_value:
* @scale: a #GtkScale
* @value: adjustment value
*
* Emits #GtkScale::format-value signal to format the value,
* if no user signal handlers, falls back to a default format.
*
* Return value: formatted value
*/
gchar*
_gtk_scale_format_value (GtkScale *scale,
gdouble value)
{
GtkScalePrivate *priv = scale->priv;
gchar *fmt = NULL;
g_signal_emit (scale,
signals[FORMAT_VALUE],
0,
value,
&fmt);
if (fmt)
return fmt;
else
/* insert a LRM, to prevent -20 to come out as 20- in RTL locales */
return g_strdup_printf ("\342\200\216%0.*f", priv->digits, value);
}
static void
gtk_scale_finalize (GObject *object)
{
GtkScale *scale = GTK_SCALE (object);
_gtk_scale_clear_layout (scale);
gtk_scale_clear_marks (scale);
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.
*
* Return value: (transfer none): 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)
{
GtkScalePrivate *priv;
gchar *txt;
g_return_val_if_fail (GTK_IS_SCALE (scale), NULL);
priv = scale->priv;
if (!priv->layout)
{
if (priv->draw_value)
priv->layout = gtk_widget_create_pango_layout (GTK_WIDGET (scale), NULL);
}
if (priv->draw_value)
{
txt = _gtk_scale_format_value (scale,
gtk_adjustment_get_value (gtk_range_get_adjustment (GTK_RANGE (scale))));
pango_layout_set_text (priv->layout, txt, -1);
g_free (txt);
}
return priv->layout;
}
/**
* gtk_scale_get_layout_offsets:
* @scale: a #GtkScale
* @x: (allow-none): location to store X offset of layout, or %NULL
* @y: (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;
}
void
_gtk_scale_clear_layout (GtkScale *scale)
{
GtkScalePrivate *priv = scale->priv;
g_return_if_fail (GTK_IS_SCALE (scale));
if (priv->layout)
{
g_object_unref (priv->layout);
priv->layout = NULL;
}
}
static void
gtk_scale_mark_free (GtkScaleMark *mark)
{
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;
g_return_if_fail (GTK_IS_SCALE (scale));
priv = scale->priv;
g_slist_foreach (priv->marks, (GFunc)gtk_scale_mark_free, NULL);
g_slist_free (priv->marks);
priv->marks = NULL;
_gtk_range_set_stop_values (GTK_RANGE (scale), NULL, 0);
gtk_widget_queue_resize (GTK_WIDGET (scale));
}
static gint
compare_marks (gpointer a, gpointer b)
{
GtkScaleMark *ma, *mb;
ma = a; mb = b;
return (gint) (ma->value - mb->value);
}
/**
* 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
* is drawn above the scale, anything else below. For a vertical scale,
* #GTK_POS_LEFT is drawn to the left of the scale, anything else to the
* right.
* @markup: (allow-none): Text to be shown at the mark, using <link linkend="PangoMarkupFormat">Pango markup</link>, 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)
{
GtkScalePrivate *priv;
GtkScaleMark *mark;
GSList *m;
gdouble *values;
gint n, i;
g_return_if_fail (GTK_IS_SCALE (scale));
priv = scale->priv;
mark = g_new (GtkScaleMark, 1);
mark->value = value;
mark->markup = g_strdup (markup);
mark->position = position;
priv->marks = g_slist_insert_sorted (priv->marks, mark,
(GCompareFunc) compare_marks);
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);
gtk_widget_queue_resize (GTK_WIDGET (scale));
}
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 *parser_data = (MarksSubparserData*)user_data;
guint i;
gint line_number, char_number;
if (strcmp (element_name, "marks") == 0)
;
else if (strcmp (element_name, "mark") == 0)
{
gdouble value = 0;
gboolean has_value = FALSE;
GtkPositionType position = GTK_POS_BOTTOM;
const gchar *msg_context = NULL;
gboolean translatable = FALSE;
MarkData *mark;
for (i = 0; names[i]; i++)
{
if (strcmp (names[i], "translatable") == 0)
{
if (!_gtk_builder_boolean_from_string (values[i], &translatable, error))
return;
}
else if (strcmp (names[i], "comments") == 0)
{
/* do nothing, comments are for translators */
}
else if (strcmp (names[i], "context") == 0)
msg_context = values[i];
else if (strcmp (names[i], "value") == 0)
{
GValue gvalue = { 0, };
if (!gtk_builder_value_from_string_type (parser_data->builder, G_TYPE_DOUBLE, values[i], &gvalue, error))
return;
value = g_value_get_double (&gvalue);
has_value = TRUE;
}
else if (strcmp (names[i], "position") == 0)
{
GValue gvalue = { 0, };
if (!gtk_builder_value_from_string_type (parser_data->builder, GTK_TYPE_POSITION_TYPE, values[i], &gvalue, error))
return;
position = g_value_get_enum (&gvalue);
}
else
{
g_markup_parse_context_get_position (context,
&line_number,
&char_number);
g_set_error (error,
GTK_BUILDER_ERROR,
GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
"%s:%d:%d '%s' is not a valid attribute of <%s>",
"<input>",
line_number, char_number, names[i], "mark");
return;
}
}
if (!has_value)
{
g_markup_parse_context_get_position (context,
&line_number,
&char_number);
g_set_error (error,
GTK_BUILDER_ERROR,
GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
"%s:%d:%d <%s> requires attribute \"%s\"",
"<input>",
line_number, char_number, "mark",
"value");
return;
}
mark = g_slice_new (MarkData);
mark->value = value;
mark->position = position;
mark->markup = g_string_new ("");
mark->context = g_strdup (msg_context);
mark->translatable = translatable;
parser_data->marks = g_slist_prepend (parser_data->marks, mark);
}
else
{
g_markup_parse_context_get_position (context,
&line_number,
&char_number);
g_set_error (error,
GTK_BUILDER_ERROR,
GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
"%s:%d:%d unsupported tag for GtkScale: \"%s\"",
"<input>",
line_number, char_number, element_name);
return;
}
}
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 *data)
{
MarksSubparserData *parser_data;
if (child)
return FALSE;
if (strcmp (tagname, "marks") == 0)
{
parser_data = g_slice_new0 (MarksSubparserData);
parser_data->scale = GTK_SCALE (buildable);
parser_data->marks = NULL;
*parser = marks_parser;
*data = parser_data;
return TRUE;
}
return parent_buildable_iface->custom_tag_start (buildable, builder, child,
tagname, 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;
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);
}
}