procyberian/gimp
2
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/gimp.git synced 2025-07-03 17:33:25 +00:00
Code Issues 1 Projects 1 Releases Packages Wiki Activity Actions
gimp/libgimpwidgets/gimpruler.c
Jehan d493f0537f Issue #8900 and #9923: reimplementing GimpUnit as a proper class. 
This fixes all our GObject Introspection issues with GimpUnit which was
both an enum and an int-derived type of user-defined units *completing*
the enum values. GIR clearly didn't like this!

Now GimpUnit is a proper class and units are unique objects, allowing to
compare them with an identity test (i.e. `unit == gimp_unit_pixel ()`
tells us if unit is the pixel unit or not), which makes it easy to use,
just like with int, yet adding also methods, making for nicer
introspected API.

As an aside, this also fixes #10738, by having all the built-in units
retrievable even if libgimpbase had not been properly initialized with
gimp_base_init().
I haven't checked in details how GIR works to introspect, but it looks
like it loads the library to inspect and runs functions, hence
triggering some CRITICALS because virtual methods (supposed to be
initialized with gimp_base_init() run by libgimp) are not set. This new
code won't trigger any critical because the vtable method are now not
necessary, at least for all built-in units.

Note that GimpUnit is still in libgimpbase. It could have been moved to
libgimp in order to avoid any virtual method table (since we need to
keep core and libgimp side's units in sync, PDB is required), but too
many libgimpwidgets widgets were already using GimpUnit. And technically
most of GimpUnit logic doesn't require PDB (only the creation/sync
part). This is one of the reasons why user-created GimpUnit list is
handled and stored differently from other types of objects.

Globally this simplifies the code a lot too and we don't need separate
implementations of various utils for core and libgimp, which means less
prone to errors.
2024-08-02 10:46:38 +02:00

1388 lines
41 KiB
C
Raw Blame History

/* LIBGIMP - The GIMP Library
* Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
*
* 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 3 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
* <https://www.gnu.org/licenses/>.
*/
#include "config.h"
#include <gtk/gtk.h>
#include <string.h>
#include "libgimpbase/gimpbase.h"
#include "libgimpmath/gimpmath.h"
#include "gimpwidgetstypes.h"
#include "gimpruler.h"
/**
* SECTION: gimpruler
* @title: GimpRuler
* @short_description: A ruler widget with configurable unit and orientation.
*
* A ruler widget with configurable unit and orientation.
**/
#define MINIMUM_INCR 5
#define IMMEDIATE_REDRAW_THRESHOLD 20
enum
{
PROP_0,
PROP_ORIENTATION,
PROP_UNIT,
PROP_LOWER,
PROP_UPPER,
PROP_POSITION,
PROP_MAX_SIZE,
N_PROPS
};
static GParamSpec *object_props[N_PROPS] = { NULL, };
/* All distances below are in 1/72nd's of an inch. (According to
* Adobe that's a point, but points are really 1/72.27 in.)
*/
struct _GimpRuler
{
GtkWidget parent_instance;
GtkOrientation orientation;
GimpUnit *unit;
gdouble lower;
gdouble upper;
gdouble position;
gdouble max_size;
GdkWindow *input_window;
cairo_surface_t *backing_store;
gboolean backing_store_valid;
GdkRectangle last_pos_rect;
guint pos_redraw_idle_id;
PangoLayout *layout;
GList *track_widgets;
};
typedef struct
{
const gdouble ruler_scale[16];
const gint subdivide[5];
} RulerMetric;
static const RulerMetric ruler_metric_decimal =
{
{ 1, 2, 5, 10, 25, 50, 100, 250, 500, 1000, 2500, 5000, 10000, 25000, 50000, 100000 },
{ 1, 5, 10, 50, 100 }
};
static const RulerMetric ruler_metric_inches =
{
/* 12 inch = 1 foot; 36 inch = 1 yard; 72 inchs = 1 fathom */
{ 1, 2, 6, 12, 36, 72, 100, 250, 500, 1000, 2500, 5000, 10000, 25000, 50000, 100000 },
/* Inches are divided by multiples of 2. */
{ 1, 2, 4, 8, 16 }
};
static const RulerMetric ruler_metric_feet =
{
/* 3 feet = 1 yard; 6 feet = 1 fathom */
{ 1, 3, 6, 12, 36, 72, 100, 250, 500, 1000, 2500, 5000, 10000, 25000, 50000, 100000 },
/* 1 foot = 12 inches, so let's divide up to 12, */
{ 1, 3, 6, 12,
/* then divide the inch by 2. */
24 }
};
static const RulerMetric ruler_metric_yards =
{
/* 1 fathom = 2 yards. Should we go back to base-10 digits? */
{ 1, 2, 5, 10, 25, 50, 100, 250, 500, 1000, 2500, 5000, 10000, 25000, 50000, 100000 },
/* 1 yard = 3 feet = 36 inches. */
{ 1, 3, 6, 12, 36 }
};
static void gimp_ruler_dispose (GObject *object);
static void gimp_ruler_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec);
static void gimp_ruler_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec);
static void gimp_ruler_realize (GtkWidget *widget);
static void gimp_ruler_unrealize (GtkWidget *widget);
static void gimp_ruler_map (GtkWidget *widget);
static void gimp_ruler_unmap (GtkWidget *widget);
static void gimp_ruler_size_allocate (GtkWidget *widget,
GtkAllocation *allocation);
static void gimp_ruler_get_preferred_width (GtkWidget *widget,
gint *minimum_width,
gint *natural_width);
static void gimp_ruler_get_preferred_height (GtkWidget *widget,
gint *minimum_height,
gint *natural_height);
static void gimp_ruler_style_updated (GtkWidget *widget);
static gboolean gimp_ruler_motion_notify (GtkWidget *widget,
GdkEventMotion *event);
static gboolean gimp_ruler_draw (GtkWidget *widget,
cairo_t *cr);
static void gimp_ruler_draw_ticks (GimpRuler *ruler);
static GdkRectangle gimp_ruler_get_pos_rect (GimpRuler *ruler,
gdouble position);
static gboolean gimp_ruler_idle_queue_pos_redraw (gpointer data);
static void gimp_ruler_queue_pos_redraw (GimpRuler *ruler);
static void gimp_ruler_draw_pos (GimpRuler *ruler,
cairo_t *cr);
static void gimp_ruler_make_pixmap (GimpRuler *ruler);
static PangoLayout * gimp_ruler_get_layout (GtkWidget *widget,
const gchar *text);
static const RulerMetric *
gimp_ruler_get_metric (GimpUnit *unit);
G_DEFINE_TYPE (GimpRuler, gimp_ruler, GTK_TYPE_WIDGET)
#define parent_class gimp_ruler_parent_class
static void
gimp_ruler_class_init (GimpRulerClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
object_class->dispose = gimp_ruler_dispose;
object_class->set_property = gimp_ruler_set_property;
object_class->get_property = gimp_ruler_get_property;
widget_class->realize = gimp_ruler_realize;
widget_class->unrealize = gimp_ruler_unrealize;
widget_class->map = gimp_ruler_map;
widget_class->unmap = gimp_ruler_unmap;
widget_class->get_preferred_width = gimp_ruler_get_preferred_width;
widget_class->get_preferred_height = gimp_ruler_get_preferred_height;
widget_class->size_allocate = gimp_ruler_size_allocate;
widget_class->style_updated = gimp_ruler_style_updated;
widget_class->motion_notify_event = gimp_ruler_motion_notify;
widget_class->draw = gimp_ruler_draw;
object_props[PROP_ORIENTATION] = g_param_spec_enum ("orientation",
"Orientation",
"The orientation of the ruler",
GTK_TYPE_ORIENTATION,
GTK_ORIENTATION_HORIZONTAL,
GIMP_PARAM_READWRITE);
object_props[PROP_UNIT] = gimp_param_spec_unit ("unit",
"Unit",
"Unit of ruler",
TRUE, TRUE, gimp_unit_pixel (),
GIMP_PARAM_READWRITE);
object_props[PROP_LOWER] = g_param_spec_double ("lower",
"Lower",
"Lower limit of ruler",
-G_MAXDOUBLE,
G_MAXDOUBLE,
0.0,
GIMP_PARAM_READWRITE);
object_props[PROP_UPPER] = g_param_spec_double ("upper",
"Upper",
"Upper limit of ruler",
-G_MAXDOUBLE,
G_MAXDOUBLE,
0.0,
GIMP_PARAM_READWRITE);
object_props[PROP_POSITION] = g_param_spec_double ("position",
"Position",
"Position of mark on the ruler",
-G_MAXDOUBLE,
G_MAXDOUBLE,
0.0,
GIMP_PARAM_READWRITE);
object_props[PROP_MAX_SIZE] = g_param_spec_double ("max-size",
"Max Size",
"Maximum size of the ruler",
-G_MAXDOUBLE,
G_MAXDOUBLE,
0.0,
GIMP_PARAM_READWRITE);
g_object_class_install_properties (object_class, N_PROPS, object_props);
gtk_widget_class_set_css_name (widget_class, "GimpRuler");
}
static void
gimp_ruler_init (GimpRuler *ruler)
{
gtk_widget_set_has_window (GTK_WIDGET (ruler), FALSE);
ruler->orientation = GTK_ORIENTATION_HORIZONTAL;
ruler->unit = gimp_unit_pixel ();
}
static void
gimp_ruler_dispose (GObject *object)
{
GimpRuler *ruler = GIMP_RULER (object);
while (ruler->track_widgets)
gimp_ruler_remove_track_widget (ruler, ruler->track_widgets->data);
if (ruler->pos_redraw_idle_id)
{
g_source_remove (ruler->pos_redraw_idle_id);
ruler->pos_redraw_idle_id = 0;
}
G_OBJECT_CLASS (parent_class)->dispose (object);
}
static void
gimp_ruler_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
GimpRuler *ruler = GIMP_RULER (object);
switch (prop_id)
{
case PROP_ORIENTATION:
ruler->orientation = g_value_get_enum (value);
gtk_widget_queue_resize (GTK_WIDGET (ruler));
break;
case PROP_UNIT:
gimp_ruler_set_unit (ruler, g_value_get_object (value));
break;
case PROP_LOWER:
gimp_ruler_set_range (ruler,
g_value_get_double (value),
ruler->upper,
ruler->max_size);
break;
case PROP_UPPER:
gimp_ruler_set_range (ruler,
ruler->lower,
g_value_get_double (value),
ruler->max_size);
break;
case PROP_POSITION:
gimp_ruler_set_position (ruler, g_value_get_double (value));
break;
case PROP_MAX_SIZE:
gimp_ruler_set_range (ruler,
ruler->lower,
ruler->upper,
g_value_get_double (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gimp_ruler_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
GimpRuler *ruler = GIMP_RULER (object);
switch (prop_id)
{
case PROP_ORIENTATION:
g_value_set_enum (value, ruler->orientation);
break;
case PROP_UNIT:
g_value_set_object (value, ruler->unit);
break;
case PROP_LOWER:
g_value_set_double (value, ruler->lower);
break;
case PROP_UPPER:
g_value_set_double (value, ruler->upper);
break;
case PROP_POSITION:
g_value_set_double (value, ruler->position);
break;
case PROP_MAX_SIZE:
g_value_set_double (value, ruler->max_size);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
/**
* gimp_ruler_new:
* @orientation: the ruler's orientation.
*
* Creates a new ruler.
*
* Returns: a new #GimpRuler widget.
*
* Since: 2.8
**/
GtkWidget *
gimp_ruler_new (GtkOrientation orientation)
{
return g_object_new (GIMP_TYPE_RULER,
"orientation", orientation,
NULL);
}
static void
gimp_ruler_update_position (GimpRuler *ruler,
gdouble x,
gdouble y)
{
GtkAllocation allocation;
gdouble lower = 0;
gdouble upper = 0;
gtk_widget_get_allocation (GTK_WIDGET (ruler), &allocation);
gimp_ruler_get_range (ruler, &lower, &upper, NULL);
if (ruler->orientation == GTK_ORIENTATION_HORIZONTAL)
{
gimp_ruler_set_position (ruler,
lower +
(upper - lower) * x / allocation.width);
}
else
{
gimp_ruler_set_position (ruler,
lower +
(upper - lower) * y / allocation.height);
}
}
/* Returns TRUE if a translation should be done */
static gboolean
gtk_widget_get_translation_to_window (GtkWidget *widget,
GdkWindow *window,
int *x,
int *y)
{
GdkWindow *w, *widget_window;
if (! gtk_widget_get_has_window (widget))
{
GtkAllocation allocation;
gtk_widget_get_allocation (widget, &allocation);
*x = -allocation.x;
*y = -allocation.y;
}
else
{
*x = 0;
*y = 0;
}
widget_window = gtk_widget_get_window (widget);
for (w = window;
w && w != widget_window;
w = gdk_window_get_effective_parent (w))
{
gdouble px, py;
gdk_window_coords_to_parent (w, *x, *y, &px, &py);
*x += px;
*y += py;
}
if (w == NULL)
{
*x = 0;
*y = 0;
return FALSE;
}
return TRUE;
}
static void
gimp_ruler_event_to_widget_coords (GtkWidget *widget,
GdkWindow *window,
gdouble event_x,
gdouble event_y,
gint *widget_x,
gint *widget_y)
{
gint tx, ty;
if (gtk_widget_get_translation_to_window (widget, window, &tx, &ty))
{
event_x += tx;
event_y += ty;
}
*widget_x = event_x;
*widget_y = event_y;
}
static gboolean
gimp_ruler_track_widget_motion_notify (GtkWidget *widget,
GdkEventMotion *mevent,
GimpRuler *ruler)
{
gint widget_x;
gint widget_y;
gint ruler_x;
gint ruler_y;
widget = gtk_get_event_widget ((GdkEvent *) mevent);
gimp_ruler_event_to_widget_coords (widget, mevent->window,
mevent->x, mevent->y,
&widget_x, &widget_y);
if (gtk_widget_translate_coordinates (widget, GTK_WIDGET (ruler),
widget_x, widget_y,
&ruler_x, &ruler_y))
{
gimp_ruler_update_position (ruler, ruler_x, ruler_y);
}
return FALSE;
}
/**
* gimp_ruler_add_track_widget:
* @ruler: a #GimpRuler
* @widget: the track widget to add
*
* Adds a "track widget" to the ruler. The ruler will connect to
* GtkWidget:motion-notify-event: on the track widget and update its
* position marker accordingly. The marker is correctly updated also
* for the track widget's children, regardless of whether they are
* ordinary children of off-screen children.
*
* Since: 2.8
*/
void
gimp_ruler_add_track_widget (GimpRuler *ruler,
GtkWidget *widget)
{
g_return_if_fail (GIMP_IS_RULER (ruler));
g_return_if_fail (GTK_IS_WIDGET (ruler));
g_return_if_fail (g_list_find (ruler->track_widgets, widget) == NULL);
ruler->track_widgets = g_list_prepend (ruler->track_widgets, widget);
g_signal_connect (widget, "motion-notify-event",
G_CALLBACK (gimp_ruler_track_widget_motion_notify),
ruler);
g_signal_connect_swapped (widget, "destroy",
G_CALLBACK (gimp_ruler_remove_track_widget),
ruler);
}
/**
* gimp_ruler_remove_track_widget:
* @ruler: a #GimpRuler
* @widget: the track widget to remove
*
* Removes a previously added track widget from the ruler. See
* gimp_ruler_add_track_widget().
*
* Since: 2.8
*/
void
gimp_ruler_remove_track_widget (GimpRuler *ruler,
GtkWidget *widget)
{
g_return_if_fail (GIMP_IS_RULER (ruler));
g_return_if_fail (GTK_IS_WIDGET (ruler));
g_return_if_fail (g_list_find (ruler->track_widgets, widget) != NULL);
ruler->track_widgets = g_list_remove (ruler->track_widgets, widget);
g_signal_handlers_disconnect_by_func (widget,
gimp_ruler_track_widget_motion_notify,
ruler);
g_signal_handlers_disconnect_by_func (widget,
gimp_ruler_remove_track_widget,
ruler);
}
/**
* gimp_ruler_set_unit:
* @ruler: a #GimpRuler
* @unit: the #GimpUnit to set the ruler to
*
* This sets the unit of the ruler.
*
* Since: 2.8
*/
void
gimp_ruler_set_unit (GimpRuler *ruler,
GimpUnit *unit)
{
g_return_if_fail (GIMP_IS_RULER (ruler));
g_return_if_fail (GIMP_IS_UNIT (unit));
if (ruler->unit != unit)
{
ruler->unit = unit;
g_object_notify_by_pspec (G_OBJECT (ruler), object_props[PROP_UNIT]);
ruler->backing_store_valid = FALSE;
gtk_widget_queue_draw (GTK_WIDGET (ruler));
}
}
/**
* gimp_ruler_get_unit:
* @ruler: a #GimpRuler
*
* Returns: (transfer none): the unit currently used in the @ruler widget.
*
* Since: 2.8
**/
GimpUnit *
gimp_ruler_get_unit (GimpRuler *ruler)
{
g_return_val_if_fail (GIMP_IS_RULER (ruler), 0);
return ruler->unit;
}
/**
* gimp_ruler_set_position:
* @ruler: a #GimpRuler
* @position: the position to set the ruler to
*
* This sets the position of the ruler.
*
* Since: 2.8
*/
void
gimp_ruler_set_position (GimpRuler *ruler,
gdouble position)
{
g_return_if_fail (GIMP_IS_RULER (ruler));
if (ruler->position != position)
{
GdkRectangle rect;
gint xdiff, ydiff;
ruler->position = position;
g_object_notify_by_pspec (G_OBJECT (ruler), object_props[PROP_POSITION]);
rect = gimp_ruler_get_pos_rect (ruler, ruler->position);
xdiff = rect.x - ruler->last_pos_rect.x;
ydiff = rect.y - ruler->last_pos_rect.y;
#ifndef GDK_WINDOWING_QUARTZ
/*
* If the position has changed far enough, queue a redraw immediately.
* Otherwise, we only queue a redraw in a low priority idle handler, to
* allow for other things (like updating the canvas) to run.
*
* TODO: This might not be necessary any more in GTK3 with the frame
* clock. Investigate this more after the port to GTK3.
*/
if (ruler->last_pos_rect.width != 0 &&
ruler->last_pos_rect.height != 0 &&
(ABS (xdiff) > IMMEDIATE_REDRAW_THRESHOLD ||
ABS (ydiff) > IMMEDIATE_REDRAW_THRESHOLD))
{
if (ruler->pos_redraw_idle_id)
{
g_source_remove (ruler->pos_redraw_idle_id);
ruler->pos_redraw_idle_id = 0;
}
gimp_ruler_queue_pos_redraw (ruler);
}
else if (! ruler->pos_redraw_idle_id)
#else
/*
* pos_redraw_idle_id being set can be counted on to mean
* a redraw is needed (on mac only) since we will not do
* a high priority draws due to the dramatic performance
* they will have.
*/
if (! ruler->pos_redraw_idle_id)
#endif
{
ruler->pos_redraw_idle_id =
g_idle_add_full (G_PRIORITY_LOW,
gimp_ruler_idle_queue_pos_redraw,
ruler, NULL);
}
}
}
/**
* gimp_ruler_get_position:
* @ruler: a #GimpRuler
*
* Returns: the current position of the @ruler widget.
*
* Since: 2.8
**/
gdouble
gimp_ruler_get_position (GimpRuler *ruler)
{
g_return_val_if_fail (GIMP_IS_RULER (ruler), 0.0);
return ruler->position;
}
/**
* gimp_ruler_set_range:
* @ruler: a #GimpRuler
* @lower: the lower limit of the ruler
* @upper: the upper limit of the ruler
* @max_size: the maximum size of the ruler used when calculating the space to
* leave for the text
*
* This sets the range of the ruler.
*
* Since: 2.8
*/
void
gimp_ruler_set_range (GimpRuler *ruler,
gdouble lower,
gdouble upper,
gdouble max_size)
{
g_return_if_fail (GIMP_IS_RULER (ruler));
g_object_freeze_notify (G_OBJECT (ruler));
if (ruler->lower != lower)
{
ruler->lower = lower;
g_object_notify_by_pspec (G_OBJECT (ruler), object_props[PROP_LOWER]);
}
if (ruler->upper != upper)
{
ruler->upper = upper;
g_object_notify_by_pspec (G_OBJECT (ruler), object_props[PROP_UPPER]);
}
if (ruler->max_size != max_size)
{
ruler->max_size = max_size;
g_object_notify_by_pspec (G_OBJECT (ruler), object_props[PROP_MAX_SIZE]);
}
g_object_thaw_notify (G_OBJECT (ruler));
ruler->backing_store_valid = FALSE;
gtk_widget_queue_draw (GTK_WIDGET (ruler));
}
/**
* gimp_ruler_get_range:
* @ruler: a #GimpRuler
* @lower: (out) (optional): location to store lower limit of the ruler,
* or %NULL
* @upper: (out) (optional): location to store upper limit of the ruler,
* or %NULL
* @max_size: (out) (optional): location to store the maximum size of the ruler
* used when calculating the space to leave for
* the text, or %NULL.
*
* Retrieves values indicating the range and current position of a #GimpRuler.
* See gimp_ruler_set_range().
*
* Since: 2.8
**/
void
gimp_ruler_get_range (GimpRuler *ruler,
gdouble *lower,
gdouble *upper,
gdouble *max_size)
{
g_return_if_fail (GIMP_IS_RULER (ruler));
if (lower)
*lower = ruler->lower;
if (upper)
*upper = ruler->upper;
if (max_size)
*max_size = ruler->max_size;
}
static void
gimp_ruler_realize (GtkWidget *widget)
{
GimpRuler *ruler = GIMP_RULER (widget);
GtkAllocation allocation;
GdkWindowAttr attributes;
gint attributes_mask;
GTK_WIDGET_CLASS (gimp_ruler_parent_class)->realize (widget);
gtk_widget_get_allocation (widget, &allocation);
attributes.window_type = GDK_WINDOW_CHILD;
attributes.x = allocation.x;
attributes.y = allocation.y;
attributes.width = allocation.width;
attributes.height = allocation.height;
attributes.wclass = GDK_INPUT_ONLY;
attributes.event_mask = (gtk_widget_get_events (widget) |
GDK_EXPOSURE_MASK |
GDK_POINTER_MOTION_MASK);
attributes_mask = GDK_WA_X | GDK_WA_Y;
ruler->input_window = gdk_window_new (gtk_widget_get_window (widget),
&attributes, attributes_mask);
gdk_window_set_user_data (ruler->input_window, ruler);
gimp_ruler_make_pixmap (ruler);
}
static void
gimp_ruler_unrealize (GtkWidget *widget)
{
GimpRuler *ruler = GIMP_RULER (widget);
g_clear_pointer (&ruler->backing_store, cairo_surface_destroy);
ruler->backing_store_valid = FALSE;
g_clear_object (&ruler->layout);
g_clear_pointer (&ruler->input_window, gdk_window_destroy);
GTK_WIDGET_CLASS (gimp_ruler_parent_class)->unrealize (widget);
}
static void
gimp_ruler_map (GtkWidget *widget)
{
GimpRuler *ruler = GIMP_RULER (widget);
GTK_WIDGET_CLASS (parent_class)->map (widget);
if (ruler->input_window)
gdk_window_show (ruler->input_window);
}
static void
gimp_ruler_unmap (GtkWidget *widget)
{
GimpRuler *ruler = GIMP_RULER (widget);
if (ruler->input_window)
gdk_window_hide (ruler->input_window);
GTK_WIDGET_CLASS (parent_class)->unmap (widget);
}
static void
gimp_ruler_size_allocate (GtkWidget *widget,
GtkAllocation *allocation)
{
GimpRuler *ruler = GIMP_RULER (widget);
GtkAllocation widget_allocation;
gboolean resized;
gtk_widget_get_allocation (widget, &widget_allocation);
resized = (widget_allocation.width != allocation->width ||
widget_allocation.height != allocation->height);
GTK_WIDGET_CLASS (parent_class)->size_allocate (widget, allocation);
if (gtk_widget_get_realized (widget))
{
gdk_window_move_resize (ruler->input_window,
allocation->x, allocation->y,
allocation->width, allocation->height);
if (resized)
gimp_ruler_make_pixmap (ruler);
}
}
static void
gimp_ruler_size_request (GtkWidget *widget,
GtkRequisition *requisition)
{
GimpRuler *ruler = GIMP_RULER (widget);
GtkStyleContext *context = gtk_widget_get_style_context (widget);
PangoLayout *layout;
PangoRectangle ink_rect;
GtkBorder border;
gint size;
layout = gimp_ruler_get_layout (widget, "0123456789");
pango_layout_get_pixel_extents (layout, &ink_rect, NULL);
size = 2 + ink_rect.height * 1.7;
gtk_style_context_get_border (context, gtk_widget_get_state_flags (widget), &border);
requisition->width = border.left + border.right;
requisition->height = border.top + border.bottom;
if (ruler->orientation == GTK_ORIENTATION_HORIZONTAL)
{
requisition->width += 1;
requisition->height += size;
}
else
{
requisition->width += size;
requisition->height += 1;
}
}
static void
gimp_ruler_get_preferred_width (GtkWidget *widget,
gint *minimum_width,
gint *natural_width)
{
GtkRequisition requisition;
gimp_ruler_size_request (widget, &requisition);
*minimum_width = *natural_width = requisition.width;
}
static void
gimp_ruler_get_preferred_height (GtkWidget *widget,
gint *minimum_height,
gint *natural_height)
{
GtkRequisition requisition;
gimp_ruler_size_request (widget, &requisition);
*minimum_height = *natural_height = requisition.height;
}
static void
gimp_ruler_style_updated (GtkWidget *widget)
{
GimpRuler *ruler = GIMP_RULER (widget);
GTK_WIDGET_CLASS (gimp_ruler_parent_class)->style_updated (widget);
ruler->backing_store_valid = FALSE;
g_clear_object (&ruler->layout);
}
static gboolean
gimp_ruler_motion_notify (GtkWidget *widget,
GdkEventMotion *event)
{
GimpRuler *ruler = GIMP_RULER (widget);
gimp_ruler_update_position (ruler, event->x, event->y);
return FALSE;
}
static gboolean
gimp_ruler_draw (GtkWidget *widget,
cairo_t *cr)
{
GimpRuler *ruler = GIMP_RULER (widget);
GtkStyleContext *context = gtk_widget_get_style_context (widget);
GtkAllocation allocation;
gtk_widget_get_allocation (widget, &allocation);
gtk_render_background (context, cr, 0, 0, allocation.width, allocation.height);
gtk_render_frame (context, cr, 0, 0, allocation.width, allocation.height);
if (! ruler->backing_store_valid)
gimp_ruler_draw_ticks (ruler);
cairo_set_source_surface (cr, ruler->backing_store, 0, 0);
cairo_paint (cr);
gimp_ruler_draw_pos (ruler, cr);
return FALSE;
}
static void
gimp_ruler_draw_ticks (GimpRuler *ruler)
{
GtkWidget *widget = GTK_WIDGET (ruler);
GtkStyleContext *context = gtk_widget_get_style_context (widget);
GtkAllocation allocation;
GtkBorder border;
GdkRGBA color;
cairo_t *cr;
gint i;
gint width, height;
gint length, ideal_length;
gdouble lower = 0; /* Upper and lower limits, in ruler units */
gdouble upper = 0;
gdouble increment; /* Number of pixels per unit */
gint scale; /* Number of units per major unit */
gdouble start, end, cur;
gchar unit_str[32];
gint digit_height;
gint digit_offset;
gint text_size;
gint pos;
gdouble max_size;
GimpUnit *unit;
PangoLayout *layout;
PangoRectangle logical_rect, ink_rect;
const RulerMetric *ruler_metric;
if (! gtk_widget_is_drawable (widget))
return;
gtk_widget_get_allocation (widget, &allocation);
gtk_style_context_get_border (context, gtk_widget_get_state_flags (widget), &border);
layout = gimp_ruler_get_layout (widget, "0123456789");
pango_layout_get_extents (layout, &ink_rect, &logical_rect);
digit_height = PANGO_PIXELS (ink_rect.height) + 2;
digit_offset = ink_rect.y;
if (ruler->orientation == GTK_ORIENTATION_HORIZONTAL)
{
width = allocation.width;
height = allocation.height - (border.top + border.bottom);
}
else
{
width = allocation.height;
height = allocation.width - (border.top + border.bottom);
}
cr = cairo_create (ruler->backing_store);
cairo_set_operator (cr, CAIRO_OPERATOR_CLEAR);
cairo_paint (cr);
cairo_set_operator (cr, CAIRO_OPERATOR_OVER);
gtk_style_context_get_color (context, gtk_widget_get_state_flags (widget),
&color);
gdk_cairo_set_source_rgba (cr, &color);
if (ruler->orientation == GTK_ORIENTATION_HORIZONTAL)
{
cairo_rectangle (cr,
border.left,
height + border.top,
allocation.width - (border.left + border.right),
1);
}
else
{
cairo_rectangle (cr,
height + border.left,
border.top,
1,
allocation.height - (border.top + border.bottom));
}
gimp_ruler_get_range (ruler, &lower, &upper, &max_size);
if ((upper - lower) == 0)
goto out;
increment = (gdouble) width / (upper - lower);
/* determine the scale
* use the maximum extents of the ruler to determine the largest
* possible number to be displayed. Calculate the height in pixels
* of this displayed text. Use this height to find a scale which
* leaves sufficient room for drawing the ruler.
*
* We calculate the text size as for the vruler instead of
* actually measuring the text width, so that the result for the
* scale looks consistent with an accompanying vruler.
*/
scale = ceil (max_size);
g_snprintf (unit_str, sizeof (unit_str), "%d", scale);
text_size = strlen (unit_str) * digit_height + 1;
unit = gimp_ruler_get_unit (ruler);
ruler_metric = gimp_ruler_get_metric (unit);
for (scale = 0; scale < G_N_ELEMENTS (ruler_metric->ruler_scale); scale++)
if (ruler_metric->ruler_scale[scale] * fabs (increment) > 2 * text_size)
break;
if (scale == G_N_ELEMENTS (ruler_metric->ruler_scale))
scale = G_N_ELEMENTS (ruler_metric->ruler_scale) - 1;
/* drawing starts here */
length = 0;
for (i = G_N_ELEMENTS (ruler_metric->subdivide) - 1; i >= 0; i--)
{
gdouble subd_incr;
/* hack to get proper subdivisions at full pixels */
if (unit == gimp_unit_pixel () && scale == 1 && i == 1)
subd_incr = 1.0;
else
subd_incr = ((gdouble) ruler_metric->ruler_scale[scale] /
(gdouble) ruler_metric->subdivide[i]);
if (subd_incr * fabs (increment) <= MINIMUM_INCR)
continue;
/* don't subdivide pixels */
if (unit == gimp_unit_pixel () && subd_incr < 1.0)
continue;
/* Calculate the length of the tickmarks. Make sure that
* this length increases for each set of ticks
*/
ideal_length = height / (i + 1) - 1;
if (ideal_length > ++length)
length = ideal_length;
if (lower < upper)
{
start = floor (lower / subd_incr) * subd_incr;
end = ceil (upper / subd_incr) * subd_incr;
}
else
{
start = floor (upper / subd_incr) * subd_incr;
end = ceil (lower / subd_incr) * subd_incr;
}
for (cur = start; cur <= end; cur += subd_incr)
{
pos = ROUND ((cur - lower) * increment);
if (ruler->orientation == GTK_ORIENTATION_HORIZONTAL)
{
cairo_rectangle (cr,
pos, height + border.top - length,
1, length);
}
else
{
cairo_rectangle (cr,
height + border.left - length, pos,
length, 1);
}
/* draw label */
if (i == 0)
{
g_snprintf (unit_str, sizeof (unit_str), "%d", (int) cur);
if (ruler->orientation == GTK_ORIENTATION_HORIZONTAL)
{
pango_layout_set_text (layout, unit_str, -1);
pango_layout_get_extents (layout, &logical_rect, NULL);
cairo_move_to (cr,
pos + 2,
border.top + PANGO_PIXELS (logical_rect.y - digit_offset));
pango_cairo_show_layout (cr, layout);
}
else
{
gint j;
for (j = 0; j < (int) strlen (unit_str); j++)
{
pango_layout_set_text (layout, unit_str + j, 1);
pango_layout_get_extents (layout, NULL, &logical_rect);
cairo_move_to (cr,
border.left + 1,
pos + digit_height * j + 2 + PANGO_PIXELS (logical_rect.y - digit_offset));
pango_cairo_show_layout (cr, layout);
}
}
}
}
}
cairo_fill (cr);
ruler->backing_store_valid = TRUE;
out:
cairo_destroy (cr);
}
static GdkRectangle
gimp_ruler_get_pos_rect (GimpRuler *ruler,
gdouble position)
{
GtkWidget *widget = GTK_WIDGET (ruler);
GtkStyleContext *context = gtk_widget_get_style_context (widget);
GtkAllocation allocation;
GtkBorder border;
gint width, height;
gdouble upper = 0;
gdouble lower = 0;
gdouble increment;
GdkRectangle rect = { 0, };
if (! gtk_widget_is_drawable (widget))
return rect;
gtk_widget_get_allocation (widget, &allocation);
gtk_style_context_get_border (context, gtk_widget_get_state_flags (widget), &border);
if (ruler->orientation == GTK_ORIENTATION_HORIZONTAL)
{
width = allocation.width;
height = allocation.height - (border.top + border.bottom);
rect.width = height / 2 + 2;
rect.width |= 1; /* make sure it's odd */
rect.height = rect.width / 2 + 1;
}
else
{
width = allocation.width - (border.left + border.right);
height = allocation.height;
rect.height = width / 2 + 2;
rect.height |= 1; /* make sure it's odd */
rect.width = rect.height / 2 + 1;
}
gimp_ruler_get_range (ruler, &lower, &upper, NULL);
if (ruler->orientation == GTK_ORIENTATION_HORIZONTAL)
{
increment = (gdouble) width / (upper - lower);
rect.x = ROUND ((position - lower) * increment) + (border.left + border.right - rect.width) / 2 - 1;
rect.y = (height + rect.height) / 2 + border.top;
}
else
{
increment = (gdouble) height / (upper - lower);
rect.x = (width + rect.width) / 2 + border.left;
rect.y = ROUND ((position - lower) * increment) + (border.top + border.bottom - rect.height) / 2 - 1;
}
return rect;
}
static gboolean
gimp_ruler_idle_queue_pos_redraw (gpointer data)
{
GimpRuler *ruler = data;
gimp_ruler_queue_pos_redraw (ruler);
/*
* pos_redraw_idle_id being set can be counted on to mean
* a redraw is needed (on mac only) since we will not do
* a high priority draws due to the dramatic performance
* they will have.
*/
ruler->pos_redraw_idle_id = 0;
return G_SOURCE_REMOVE;
}
static void
gimp_ruler_queue_pos_redraw (GimpRuler *ruler)
{
const GdkRectangle rect = gimp_ruler_get_pos_rect (ruler, ruler->position);
GtkAllocation allocation;
gtk_widget_get_allocation (GTK_WIDGET(ruler), &allocation);
gtk_widget_queue_draw_area (GTK_WIDGET (ruler),
rect.x + allocation.x,
rect.y + allocation.y,
rect.width,
rect.height);
if (ruler->last_pos_rect.width != 0 &&
ruler->last_pos_rect.height != 0)
{
gtk_widget_queue_draw_area (GTK_WIDGET (ruler),
ruler->last_pos_rect.x + allocation.x,
ruler->last_pos_rect.y + allocation.y,
ruler->last_pos_rect.width,
ruler->last_pos_rect.height);
ruler->last_pos_rect.x = 0;
ruler->last_pos_rect.y = 0;
ruler->last_pos_rect.width = 0;
ruler->last_pos_rect.height = 0;
}
}
static void
gimp_ruler_draw_pos (GimpRuler *ruler,
cairo_t *cr)
{
GtkWidget *widget = GTK_WIDGET (ruler);
GtkStyleContext *context = gtk_widget_get_style_context (widget);
GdkRectangle pos_rect;
if (! gtk_widget_is_drawable (widget))
return;
pos_rect = gimp_ruler_get_pos_rect (ruler, gimp_ruler_get_position (ruler));
if ((pos_rect.width > 0) && (pos_rect.height > 0))
{
GdkRGBA color;
gtk_style_context_get_color (context, gtk_widget_get_state_flags (widget),
&color);
gdk_cairo_set_source_rgba (cr, &color);
cairo_move_to (cr, pos_rect.x, pos_rect.y);
if (ruler->orientation == GTK_ORIENTATION_HORIZONTAL)
{
cairo_line_to (cr, pos_rect.x + pos_rect.width / 2.0,
pos_rect.y + pos_rect.height);
cairo_line_to (cr, pos_rect.x + pos_rect.width,
pos_rect.y);
}
else
{
cairo_line_to (cr, pos_rect.x + pos_rect.width,
pos_rect.y + pos_rect.height / 2.0);
cairo_line_to (cr, pos_rect.x,
pos_rect.y + pos_rect.height);
}
cairo_fill (cr);
}
if (ruler->last_pos_rect.width != 0 &&
ruler->last_pos_rect.height != 0)
{
gdk_rectangle_union (&ruler->last_pos_rect,
&pos_rect,
&ruler->last_pos_rect);
}
else
{
ruler->last_pos_rect = pos_rect;
}
}
static void
gimp_ruler_make_pixmap (GimpRuler *ruler)
{
GtkWidget *widget = GTK_WIDGET (ruler);
GtkAllocation allocation;
gtk_widget_get_allocation (widget, &allocation);
if (ruler->backing_store)
cairo_surface_destroy (ruler->backing_store);
ruler->backing_store =
gdk_window_create_similar_surface (gtk_widget_get_window (widget),
CAIRO_CONTENT_COLOR_ALPHA,
allocation.width,
allocation.height);
ruler->backing_store_valid = FALSE;
}
static PangoLayout *
gimp_ruler_get_layout (GtkWidget *widget,
const gchar *text)
{
GimpRuler *ruler = GIMP_RULER (widget);
if (ruler->layout)
{
pango_layout_set_text (ruler->layout, text, -1);
return ruler->layout;
}
ruler->layout = gtk_widget_create_pango_layout (widget, text);
return ruler->layout;
}
#define FACTOR_EPSILON 0.0000001
#define FACTOR_EQUAL(u, f) (ABS (f - gimp_unit_get_factor (u)) < FACTOR_EPSILON)
static const RulerMetric *
gimp_ruler_get_metric (GimpUnit *unit)
{
if (unit == gimp_unit_inch ())
{
return &ruler_metric_inches;
}
/* XXX: recognizing feet or yard unit this way definitely sucks.
* Actually the subdvision and rule scale rules should probably become
* settable values in unitrc instead of hardcoded rules.
* This way, people would be able to set how they want a unit to be
* shown (we could definitely imagine someone wanting to see inches
* with base-10 divisions).
*/
else if (FACTOR_EQUAL (unit, 0.083333))
{
return &ruler_metric_feet;
}
else if (FACTOR_EQUAL (unit, 0.027778))
{
return &ruler_metric_yards;
}
return &ruler_metric_decimal;
}
Reference in a new issue View git blame Copy permalink