1 /* GDK - The GIMP Drawing Kit
2 * Copyright (C) 2000 Red Hat, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
22 #include <pango/pangocairo.h>
26 #include "gdkinternals.h"
29 #include "gdkprivate.h"
30 #include "gdkscreen.h"
34 #define GDK_INFO_KEY "gdk-info"
36 /* We have various arrays indexed by render part; if PangoRenderPart
37 * is extended, we want to make sure not to overwrite the end of
40 #define MAX_RENDER_PART PANGO_RENDER_PART_STRIKETHROUGH
42 struct _GdkPangoRendererPrivate
46 /* GdkPangoRenderer specific state */
47 PangoColor override_color[MAX_RENDER_PART + 1];
48 gboolean override_color_set[MAX_RENDER_PART + 1];
50 GdkBitmap *stipple[MAX_RENDER_PART + 1];
51 PangoColor emboss_color;
55 PangoRenderPart last_part;
58 GdkDrawable *drawable;
64 static PangoAttrType gdk_pango_attr_stipple_type;
65 static PangoAttrType gdk_pango_attr_embossed_type;
66 static PangoAttrType gdk_pango_attr_emboss_color_type;
73 G_DEFINE_TYPE (GdkPangoRenderer, gdk_pango_renderer, PANGO_TYPE_RENDERER)
76 gdk_pango_renderer_finalize (GObject *object)
78 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (object);
79 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
83 g_object_unref (priv->base_gc);
85 g_object_unref (priv->drawable);
87 for (i = 0; i <= MAX_RENDER_PART; i++)
89 g_object_unref (priv->stipple[i]);
91 G_OBJECT_CLASS (gdk_pango_renderer_parent_class)->finalize (object);
95 gdk_pango_renderer_constructor (GType type,
96 guint n_construct_properties,
97 GObjectConstructParam *construct_params)
100 GdkPangoRenderer *gdk_renderer;
102 object = G_OBJECT_CLASS (gdk_pango_renderer_parent_class)->constructor (type,
103 n_construct_properties,
106 gdk_renderer = GDK_PANGO_RENDERER (object);
108 if (!gdk_renderer->priv->screen)
110 g_warning ("Screen must be specified at construct time for GdkPangoRenderer");
111 gdk_renderer->priv->screen = gdk_screen_get_default ();
117 /* Adjusts matrix and color for the renderer to draw the secondary
118 * "shadow" copy for embossed text */
120 emboss_context (GdkPangoRenderer *renderer, cairo_t *cr)
122 GdkPangoRendererPrivate *priv = renderer->priv;
123 cairo_matrix_t tmp_matrix;
124 double red, green, blue;
126 /* The gymnastics here to adjust the matrix are because we want
127 * to offset by +1,+1 in device-space, not in user-space,
128 * so we can't just draw the layout at x + 1, y + 1
130 cairo_get_matrix (cr, &tmp_matrix);
131 tmp_matrix.x0 += 1.0;
132 tmp_matrix.y0 += 1.0;
133 cairo_set_matrix (cr, &tmp_matrix);
135 red = (double) priv->emboss_color.red / 65535.;
136 green = (double) priv->emboss_color.green / 65535.;
137 blue = (double) priv->emboss_color.blue / 65535.;
139 cairo_set_source_rgb (cr, red, green, blue);
142 static inline gboolean
143 color_equal (const PangoColor *c1, const PangoColor *c2)
149 c1->red == c2->red &&
150 c1->green == c2->green &&
151 c1->blue == c2->blue)
158 get_cairo_context (GdkPangoRenderer *gdk_renderer,
159 PangoRenderPart part)
161 PangoRenderer *renderer = PANGO_RENDERER (gdk_renderer);
162 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
166 const PangoMatrix *matrix;
168 priv->cr = gdk_cairo_create (priv->drawable);
170 matrix = pango_renderer_get_matrix (renderer);
173 cairo_matrix_t cairo_matrix;
175 cairo_matrix_init (&cairo_matrix,
176 matrix->xx, matrix->yx,
177 matrix->xy, matrix->yy,
178 matrix->x0, matrix->y0);
179 cairo_set_matrix (priv->cr, &cairo_matrix);
183 if (part != priv->last_part)
185 PangoColor *pango_color;
190 pango_color = pango_renderer_get_color (renderer, part);
192 if (priv->last_part != -1)
193 changed = priv->gc_changed ||
194 priv->stipple[priv->last_part] != priv->stipple[part] ||
195 !color_equal (pango_color,
196 pango_renderer_get_color (renderer, priv->last_part));
204 tmp_color.red = pango_color->red;
205 tmp_color.green = pango_color->green;
206 tmp_color.blue = pango_color->blue;
213 _gdk_gc_update_context (priv->base_gc,
221 priv->last_part = part;
222 priv->gc_changed = FALSE;
229 gdk_pango_renderer_draw_glyphs (PangoRenderer *renderer,
231 PangoGlyphString *glyphs,
235 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
236 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
239 cr = get_cairo_context (gdk_renderer,
240 PANGO_RENDER_PART_FOREGROUND);
245 emboss_context (gdk_renderer, cr);
246 cairo_move_to (cr, (double)x / PANGO_SCALE, (double)y / PANGO_SCALE);
247 pango_cairo_show_glyph_string (cr, font, glyphs);
251 cairo_move_to (cr, (double)x / PANGO_SCALE, (double)y / PANGO_SCALE);
252 pango_cairo_show_glyph_string (cr, font, glyphs);
256 gdk_pango_renderer_draw_rectangle (PangoRenderer *renderer,
257 PangoRenderPart part,
263 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
264 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
267 cr = get_cairo_context (gdk_renderer, part);
269 if (priv->embossed && part != PANGO_RENDER_PART_BACKGROUND)
272 emboss_context (gdk_renderer, cr);
274 (double)x / PANGO_SCALE, (double)y / PANGO_SCALE,
275 (double)width / PANGO_SCALE, (double)height / PANGO_SCALE);
282 (double)x / PANGO_SCALE, (double)y / PANGO_SCALE,
283 (double)width / PANGO_SCALE, (double)height / PANGO_SCALE);
288 gdk_pango_renderer_draw_error_underline (PangoRenderer *renderer,
294 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
295 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
298 cr = get_cairo_context (gdk_renderer, PANGO_RENDER_PART_UNDERLINE);
303 emboss_context (gdk_renderer, cr);
304 pango_cairo_show_error_underline (cr,
305 (double)x / PANGO_SCALE, (double)y / PANGO_SCALE,
306 (double)width / PANGO_SCALE, (double)height / PANGO_SCALE);
310 pango_cairo_show_error_underline (cr,
311 (double)x / PANGO_SCALE, (double)y / PANGO_SCALE,
312 (double)width / PANGO_SCALE, (double)height / PANGO_SCALE);
316 gdk_pango_renderer_draw_shape (PangoRenderer *renderer,
317 PangoAttrShape *attr,
321 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
322 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
324 PangoCairoShapeRendererFunc shape_renderer;
325 gpointer shape_renderer_data;
327 double dx = (double)x / PANGO_SCALE, dy = (double)y / PANGO_SCALE;
329 layout = pango_renderer_get_layout (renderer);
334 shape_renderer = pango_cairo_context_get_shape_renderer (pango_layout_get_context (layout),
335 &shape_renderer_data);
340 cr = get_cairo_context (gdk_renderer, PANGO_RENDER_PART_FOREGROUND);
347 emboss_context (gdk_renderer, cr);
349 cairo_move_to (cr, dx, dy);
350 shape_renderer (cr, attr, FALSE, shape_renderer_data);
355 cairo_move_to (cr, dx, dy);
356 shape_renderer (cr, attr, FALSE, shape_renderer_data);
362 gdk_pango_renderer_part_changed (PangoRenderer *renderer,
363 PangoRenderPart part)
365 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
367 if (gdk_renderer->priv->last_part == part)
368 gdk_renderer->priv->last_part = (PangoRenderPart)-1;
372 gdk_pango_renderer_begin (PangoRenderer *renderer)
374 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
375 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
377 if (!priv->drawable || !priv->base_gc)
379 g_warning ("gdk_pango_renderer_set_drawable() and gdk_pango_renderer_set_drawable()"
380 "must be used to set the target drawable and GC before using the renderer\n");
385 gdk_pango_renderer_end (PangoRenderer *renderer)
387 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
388 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
392 cairo_destroy (priv->cr);
395 priv->last_part = (PangoRenderPart)-1;
399 gdk_pango_renderer_prepare_run (PangoRenderer *renderer,
402 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
403 gboolean embossed = FALSE;
404 GdkBitmap *stipple = NULL;
405 gboolean changed = FALSE;
406 PangoColor emboss_color;
410 emboss_color.red = 0xffff;
411 emboss_color.green = 0xffff;
412 emboss_color.blue = 0xffff;
414 for (l = run->item->analysis.extra_attrs; l; l = l->next)
416 PangoAttribute *attr = l->data;
418 /* stipple_type and embossed_type aren't necessarily
419 * initialized, but they are 0, which is an
420 * invalid type so won't occur.
422 if (attr->klass->type == gdk_pango_attr_stipple_type)
424 stipple = ((GdkPangoAttrStipple*)attr)->stipple;
426 else if (attr->klass->type == gdk_pango_attr_embossed_type)
428 embossed = ((GdkPangoAttrEmbossed*)attr)->embossed;
430 else if (attr->klass->type == gdk_pango_attr_emboss_color_type)
432 emboss_color = ((GdkPangoAttrEmbossColor*)attr)->color;
436 gdk_pango_renderer_set_stipple (gdk_renderer, PANGO_RENDER_PART_FOREGROUND, stipple);
437 gdk_pango_renderer_set_stipple (gdk_renderer, PANGO_RENDER_PART_BACKGROUND, stipple);
438 gdk_pango_renderer_set_stipple (gdk_renderer, PANGO_RENDER_PART_UNDERLINE, stipple);
439 gdk_pango_renderer_set_stipple (gdk_renderer, PANGO_RENDER_PART_STRIKETHROUGH, stipple);
441 if (embossed != gdk_renderer->priv->embossed)
443 gdk_renderer->priv->embossed = embossed;
447 if (!color_equal (&gdk_renderer->priv->emboss_color, &emboss_color))
449 gdk_renderer->priv->emboss_color = emboss_color;
454 pango_renderer_part_changed (renderer, PANGO_RENDER_PART_FOREGROUND);
456 PANGO_RENDERER_CLASS (gdk_pango_renderer_parent_class)->prepare_run (renderer, run);
458 for (i = 0; i <= MAX_RENDER_PART; i++)
460 if (gdk_renderer->priv->override_color_set[i])
461 pango_renderer_set_color (renderer, i, &gdk_renderer->priv->override_color[i]);
466 gdk_pango_renderer_set_property (GObject *object,
471 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (object);
476 gdk_renderer->priv->screen = g_value_get_object (value);
479 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
485 gdk_pango_renderer_get_property (GObject *object,
490 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (object);
495 g_value_set_object (value, gdk_renderer->priv->screen);
498 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
504 gdk_pango_renderer_init (GdkPangoRenderer *renderer)
506 renderer->priv = G_TYPE_INSTANCE_GET_PRIVATE (renderer,
507 GDK_TYPE_PANGO_RENDERER,
508 GdkPangoRendererPrivate);
510 renderer->priv->last_part = (PangoRenderPart)-1;
511 renderer->priv->gc_changed = TRUE;
515 gdk_pango_renderer_class_init (GdkPangoRendererClass *klass)
517 GObjectClass *object_class = G_OBJECT_CLASS (klass);
519 PangoRendererClass *renderer_class = PANGO_RENDERER_CLASS (klass);
521 renderer_class->draw_glyphs = gdk_pango_renderer_draw_glyphs;
522 renderer_class->draw_rectangle = gdk_pango_renderer_draw_rectangle;
523 renderer_class->draw_error_underline = gdk_pango_renderer_draw_error_underline;
524 renderer_class->draw_shape = gdk_pango_renderer_draw_shape;
525 renderer_class->part_changed = gdk_pango_renderer_part_changed;
526 renderer_class->begin = gdk_pango_renderer_begin;
527 renderer_class->end = gdk_pango_renderer_end;
528 renderer_class->prepare_run = gdk_pango_renderer_prepare_run;
530 object_class->finalize = gdk_pango_renderer_finalize;
531 object_class->constructor = gdk_pango_renderer_constructor;
532 object_class->set_property = gdk_pango_renderer_set_property;
533 object_class->get_property = gdk_pango_renderer_get_property;
535 g_object_class_install_property (object_class,
537 g_param_spec_object ("screen",
539 P_("the GdkScreen for the renderer"),
541 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
542 G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK |
543 G_PARAM_STATIC_BLURB));
545 g_type_class_add_private (object_class, sizeof (GdkPangoRendererPrivate));
549 * gdk_pango_renderer_new:
550 * @screen: a #GdkScreen
552 * Creates a new #PangoRenderer for @screen. Normally you can use the
553 * results of gdk_pango_renderer_get_default() rather than creating a new
556 * Return value: a newly created #PangoRenderer. Free with g_object_unref().
561 gdk_pango_renderer_new (GdkScreen *screen)
563 g_return_val_if_fail (screen != NULL, NULL);
565 return g_object_new (GDK_TYPE_PANGO_RENDERER,
571 on_renderer_display_closed (GdkDisplay *display,
573 GdkPangoRenderer *renderer)
575 g_signal_handlers_disconnect_by_func (display,
576 on_renderer_display_closed,
578 g_object_set_data (G_OBJECT (renderer->priv->screen),
579 g_intern_static_string ("gdk-pango-renderer"), NULL);
583 * gdk_pango_renderer_get_default:
584 * @screen: a #GdkScreen
586 * Gets the default #PangoRenderer for a screen. This default renderer
587 * is shared by all users of the display, so properties such as the color
588 * or transformation matrix set for the renderer may be overwritten
589 * by functions such as gdk_draw_layout().
591 * Before using the renderer, you need to call gdk_pango_renderer_set_drawable()
592 * and gdk_pango_renderer_set_gc() to set the drawable and graphics context
593 * to use for drawing.
595 * Return value: the default #PangoRenderer for @screen. The
596 * renderer is owned by GTK+ and will be kept around until the
602 gdk_pango_renderer_get_default (GdkScreen *screen)
604 PangoRenderer *renderer;
606 g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
608 renderer = g_object_get_data (G_OBJECT (screen), "gdk-pango-renderer");
611 renderer = gdk_pango_renderer_new (screen);
612 g_object_set_data_full (G_OBJECT (screen),
613 g_intern_static_string ("gdk-pango-renderer"), renderer,
614 (GDestroyNotify)g_object_unref);
616 g_signal_connect (gdk_screen_get_display (screen), "closed",
617 G_CALLBACK (on_renderer_display_closed), renderer);
624 * gdk_pango_renderer_set_drawable:
625 * @gdk_renderer: a #GdkPangoRenderer
626 * @drawable: (allow-none): the new target drawable, or %NULL
628 * Sets the drawable the renderer draws to.
633 gdk_pango_renderer_set_drawable (GdkPangoRenderer *gdk_renderer,
634 GdkDrawable *drawable)
636 GdkPangoRendererPrivate *priv;
638 g_return_if_fail (GDK_IS_PANGO_RENDERER (gdk_renderer));
639 g_return_if_fail (drawable == NULL || GDK_IS_DRAWABLE (drawable));
641 priv = gdk_renderer->priv;
643 if (priv->drawable != drawable)
646 g_object_unref (priv->drawable);
647 priv->drawable = drawable;
649 g_object_ref (priv->drawable);
654 * gdk_pango_renderer_set_gc:
655 * @gdk_renderer: a #GdkPangoRenderer
656 * @gc: (allow-none): the new GC to use for drawing, or %NULL
658 * Sets the GC the renderer draws with. Note that the GC must not be
659 * modified until it is unset by calling the function again with
660 * %NULL for the @gc parameter, since GDK may make internal copies
661 * of the GC which won't be updated to follow changes to the
667 gdk_pango_renderer_set_gc (GdkPangoRenderer *gdk_renderer,
670 GdkPangoRendererPrivate *priv;
672 g_return_if_fail (GDK_IS_PANGO_RENDERER (gdk_renderer));
673 g_return_if_fail (gc == NULL || GDK_IS_GC (gc));
675 priv = gdk_renderer->priv;
677 if (priv->base_gc != gc)
680 g_object_unref (priv->base_gc);
683 g_object_ref (priv->base_gc);
685 priv->gc_changed = TRUE;
691 * gdk_pango_renderer_set_stipple:
692 * @gdk_renderer: a #GdkPangoRenderer
693 * @part: the part to render with the stipple
694 * @stipple: the new stipple value.
696 * Sets the stipple for one render part (foreground, background, underline,
697 * etc.) Note that this is overwritten when iterating through the individual
698 * styled runs of a #PangoLayout or #PangoLayoutLine. This function is thus
699 * only useful when you call low level functions like pango_renderer_draw_glyphs()
700 * directly, or in the 'prepare_run' virtual function of a subclass of
706 gdk_pango_renderer_set_stipple (GdkPangoRenderer *gdk_renderer,
707 PangoRenderPart part,
710 g_return_if_fail (GDK_IS_PANGO_RENDERER (gdk_renderer));
712 if (part > MAX_RENDER_PART) /* Silently ignore unknown parts */
715 if (stipple != gdk_renderer->priv->stipple[part])
717 if (gdk_renderer->priv->stipple[part])
718 g_object_unref (gdk_renderer->priv->stipple[part]);
720 gdk_renderer->priv->stipple[part] = stipple;
722 if (gdk_renderer->priv->stipple[part])
723 g_object_ref (gdk_renderer->priv->stipple[part]);
725 pango_renderer_part_changed (PANGO_RENDERER (gdk_renderer), part);
730 * gdk_pango_renderer_set_override_color:
731 * @gdk_renderer: a #GdkPangoRenderer
732 * @part: the part to render to set the color of
733 * @color: (allow-none): the color to use, or %NULL to unset a previously
734 * set override color.
736 * Sets the color for a particular render part (foreground,
737 * background, underline, etc.), overriding any attributes on the layouts
738 * renderered with this renderer.
743 gdk_pango_renderer_set_override_color (GdkPangoRenderer *gdk_renderer,
744 PangoRenderPart part,
745 const GdkColor *color)
747 GdkPangoRendererPrivate *priv;
749 g_return_if_fail (GDK_IS_PANGO_RENDERER (gdk_renderer));
751 priv = gdk_renderer->priv;
753 if (part > MAX_RENDER_PART) /* Silently ignore unknown parts */
758 priv->override_color[part].red = color->red;
759 priv->override_color[part].green = color->green;
760 priv->override_color[part].blue = color->blue;
761 priv->override_color_set[part] = TRUE;
764 priv->override_color_set[part] = FALSE;
767 /* Gets a renderer to draw with, setting the properties of the
768 * renderer and activating it. Note that since we activate the
769 * renderer here, the implicit setting of the matrix that
770 * pango_renderer_draw_layout_[line] normally do when they
771 * activate the renderer is suppressed. */
772 static PangoRenderer *
773 get_renderer (GdkDrawable *drawable,
775 const GdkColor *foreground,
776 const GdkColor *background)
778 GdkScreen *screen = gdk_drawable_get_screen (drawable);
779 PangoRenderer *renderer = gdk_pango_renderer_get_default (screen);
780 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
782 gdk_pango_renderer_set_drawable (gdk_renderer, drawable);
783 gdk_pango_renderer_set_gc (gdk_renderer, gc);
785 gdk_pango_renderer_set_override_color (gdk_renderer,
786 PANGO_RENDER_PART_FOREGROUND,
788 gdk_pango_renderer_set_override_color (gdk_renderer,
789 PANGO_RENDER_PART_UNDERLINE,
791 gdk_pango_renderer_set_override_color (gdk_renderer,
792 PANGO_RENDER_PART_STRIKETHROUGH,
795 gdk_pango_renderer_set_override_color (gdk_renderer,
796 PANGO_RENDER_PART_BACKGROUND,
799 pango_renderer_activate (renderer);
804 /* Cleans up the renderer obtained with get_renderer() */
806 release_renderer (PangoRenderer *renderer)
808 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
810 pango_renderer_deactivate (renderer);
812 gdk_pango_renderer_set_override_color (gdk_renderer,
813 PANGO_RENDER_PART_FOREGROUND,
815 gdk_pango_renderer_set_override_color (gdk_renderer,
816 PANGO_RENDER_PART_UNDERLINE,
818 gdk_pango_renderer_set_override_color (gdk_renderer,
819 PANGO_RENDER_PART_STRIKETHROUGH,
821 gdk_pango_renderer_set_override_color (gdk_renderer,
822 PANGO_RENDER_PART_BACKGROUND,
825 gdk_pango_renderer_set_drawable (gdk_renderer, NULL);
826 gdk_pango_renderer_set_gc (gdk_renderer, NULL);
830 * gdk_draw_layout_line_with_colors:
831 * @drawable: the drawable on which to draw the line
832 * @gc: base graphics to use
833 * @x: the x position of start of string (in pixels)
834 * @y: the y position of baseline (in pixels)
835 * @line: a #PangoLayoutLine
836 * @foreground: (allow-none): foreground override color, or %NULL for none
837 * @background: (allow-none): background override color, or %NULL for none
839 * Render a #PangoLayoutLine onto a #GdkDrawable, overriding the
840 * layout's normal colors with @foreground and/or @background.
841 * @foreground and @background need not be allocated.
843 * If the layout's #PangoContext has a transformation matrix set, then
844 * @x and @y specify the position of the left edge of the baseline
845 * (left is in before-tranform user coordinates) in after-transform
846 * device coordinates.
849 gdk_draw_layout_line_with_colors (GdkDrawable *drawable,
853 PangoLayoutLine *line,
854 const GdkColor *foreground,
855 const GdkColor *background)
857 PangoRenderer *renderer;
858 const PangoMatrix *matrix;
860 g_return_if_fail (GDK_IS_DRAWABLE (drawable));
861 g_return_if_fail (GDK_IS_GC (gc));
862 g_return_if_fail (line != NULL);
864 renderer = get_renderer (drawable, gc, foreground, background);
866 /* When we have a matrix, we do positioning by adjusting the matrix, and
867 * clamp just pass x=0, y=0 to the lower levels. We don't want to introduce
868 * a matrix when the caller didn't provide one, however, since that adds
869 * lots of floating point arithmetic for each glyph.
871 matrix = pango_context_get_matrix (pango_layout_get_context (line->layout));
874 PangoMatrix tmp_matrix;
876 tmp_matrix = *matrix;
879 pango_renderer_set_matrix (renderer, &tmp_matrix);
884 /* Fall back to introduce a matrix if the coords would scale out of range.
885 * The x and y here will be added to in-layout coordinates. So we cannot
886 * support the entire range here safely. So, we just accept the middle half
887 * and use fallback for the rest. */
888 else if (GDK_PANGO_UNITS_OVERFLOWS (x, y))
890 PangoMatrix tmp_matrix = PANGO_MATRIX_INIT;
893 pango_renderer_set_matrix (renderer, &tmp_matrix);
899 pango_renderer_set_matrix (renderer, NULL);
901 pango_renderer_draw_layout_line (renderer, line, x * PANGO_SCALE, y * PANGO_SCALE);
903 release_renderer (renderer);
907 * gdk_draw_layout_with_colors:
908 * @drawable: the drawable on which to draw string
909 * @gc: base graphics context to use
910 * @x: the X position of the left of the layout (in pixels)
911 * @y: the Y position of the top of the layout (in pixels)
912 * @layout: a #PangoLayout
913 * @foreground: (allow-none): foreground override color, or %NULL for none
914 * @background: (allow-none): background override color, or %NULL for none
916 * Render a #PangoLayout onto a #GdkDrawable, overriding the
917 * layout's normal colors with @foreground and/or @background.
918 * @foreground and @background need not be allocated.
920 * If the layout's #PangoContext has a transformation matrix set, then
921 * @x and @y specify the position of the top left corner of the
922 * bounding box (in device space) of the transformed layout.
924 * If you're using GTK+, the ususal way to obtain a #PangoLayout
925 * is gtk_widget_create_pango_layout().
928 gdk_draw_layout_with_colors (GdkDrawable *drawable,
933 const GdkColor *foreground,
934 const GdkColor *background)
936 PangoRenderer *renderer;
937 const PangoMatrix *matrix;
939 g_return_if_fail (GDK_IS_DRAWABLE (drawable));
940 g_return_if_fail (GDK_IS_GC (gc));
941 g_return_if_fail (PANGO_IS_LAYOUT (layout));
943 renderer = get_renderer (drawable, gc, foreground, background);
945 /* When we have a matrix, we do positioning by adjusting the matrix, and
946 * clamp just pass x=0, y=0 to the lower levels. We don't want to introduce
947 * a matrix when the caller didn't provide one, however, since that adds
948 * lots of floating point arithmetic for each glyph.
950 matrix = pango_context_get_matrix (pango_layout_get_context (layout));
953 PangoMatrix tmp_matrix;
956 pango_layout_get_extents (layout, NULL, &rect);
957 pango_matrix_transform_rectangle (matrix, &rect);
958 pango_extents_to_pixels (&rect, NULL);
960 tmp_matrix = *matrix;
961 tmp_matrix.x0 += x - rect.x;
962 tmp_matrix.y0 += y - rect.y;
963 pango_renderer_set_matrix (renderer, &tmp_matrix);
968 else if (GDK_PANGO_UNITS_OVERFLOWS (x, y))
970 PangoMatrix tmp_matrix = PANGO_MATRIX_INIT;
973 pango_renderer_set_matrix (renderer, &tmp_matrix);
979 pango_renderer_set_matrix (renderer, NULL);
981 pango_renderer_draw_layout (renderer, layout, x * PANGO_SCALE, y * PANGO_SCALE);
983 release_renderer (renderer);
987 * gdk_draw_layout_line:
988 * @drawable: the drawable on which to draw the line
989 * @gc: base graphics to use
990 * @x: the x position of start of string (in pixels)
991 * @y: the y position of baseline (in pixels)
992 * @line: a #PangoLayoutLine
994 * Render a #PangoLayoutLine onto an GDK drawable
996 * If the layout's #PangoContext has a transformation matrix set, then
997 * @x and @y specify the position of the left edge of the baseline
998 * (left is in before-tranform user coordinates) in after-transform
999 * device coordinates.
1002 gdk_draw_layout_line (GdkDrawable *drawable,
1006 PangoLayoutLine *line)
1008 g_return_if_fail (GDK_IS_DRAWABLE (drawable));
1009 g_return_if_fail (GDK_IS_GC (gc));
1010 g_return_if_fail (line != NULL);
1012 gdk_draw_layout_line_with_colors (drawable, gc, x, y, line, NULL, NULL);
1017 * @drawable: the drawable on which to draw string
1018 * @gc: base graphics context to use
1019 * @x: the X position of the left of the layout (in pixels)
1020 * @y: the Y position of the top of the layout (in pixels)
1021 * @layout: a #PangoLayout
1023 * Render a #PangoLayout onto a GDK drawable
1025 * If the layout's #PangoContext has a transformation matrix set, then
1026 * @x and @y specify the position of the top left corner of the
1027 * bounding box (in device space) of the transformed layout.
1029 * If you're using GTK+, the usual way to obtain a #PangoLayout
1030 * is gtk_widget_create_pango_layout().
1033 gdk_draw_layout (GdkDrawable *drawable,
1037 PangoLayout *layout)
1039 g_return_if_fail (GDK_IS_DRAWABLE (drawable));
1040 g_return_if_fail (GDK_IS_GC (gc));
1041 g_return_if_fail (PANGO_IS_LAYOUT (layout));
1043 gdk_draw_layout_with_colors (drawable, gc, x, y, layout, NULL, NULL);
1046 /* GdkPangoAttrStipple */
1048 static PangoAttribute *
1049 gdk_pango_attr_stipple_copy (const PangoAttribute *attr)
1051 const GdkPangoAttrStipple *src = (const GdkPangoAttrStipple*) attr;
1053 return gdk_pango_attr_stipple_new (src->stipple);
1057 gdk_pango_attr_stipple_destroy (PangoAttribute *attr)
1059 GdkPangoAttrStipple *st = (GdkPangoAttrStipple*) attr;
1062 g_object_unref (st->stipple);
1068 gdk_pango_attr_stipple_compare (const PangoAttribute *attr1,
1069 const PangoAttribute *attr2)
1071 const GdkPangoAttrStipple *a = (const GdkPangoAttrStipple*) attr1;
1072 const GdkPangoAttrStipple *b = (const GdkPangoAttrStipple*) attr2;
1074 return a->stipple == b->stipple;
1078 * gdk_pango_attr_stipple_new:
1079 * @stipple: a bitmap to be set as stipple
1081 * Creates a new attribute containing a stipple bitmap to be used when
1082 * rendering the text.
1084 * Return value: new #PangoAttribute
1088 gdk_pango_attr_stipple_new (GdkBitmap *stipple)
1090 GdkPangoAttrStipple *result;
1092 static PangoAttrClass klass = {
1094 gdk_pango_attr_stipple_copy,
1095 gdk_pango_attr_stipple_destroy,
1096 gdk_pango_attr_stipple_compare
1100 klass.type = gdk_pango_attr_stipple_type =
1101 pango_attr_type_register ("GdkPangoAttrStipple");
1103 result = g_new (GdkPangoAttrStipple, 1);
1104 result->attr.klass = &klass;
1107 g_object_ref (stipple);
1109 result->stipple = stipple;
1111 return (PangoAttribute *)result;
1114 /* GdkPangoAttrEmbossed */
1116 static PangoAttribute *
1117 gdk_pango_attr_embossed_copy (const PangoAttribute *attr)
1119 const GdkPangoAttrEmbossed *e = (const GdkPangoAttrEmbossed*) attr;
1121 return gdk_pango_attr_embossed_new (e->embossed);
1125 gdk_pango_attr_embossed_destroy (PangoAttribute *attr)
1131 gdk_pango_attr_embossed_compare (const PangoAttribute *attr1,
1132 const PangoAttribute *attr2)
1134 const GdkPangoAttrEmbossed *e1 = (const GdkPangoAttrEmbossed*) attr1;
1135 const GdkPangoAttrEmbossed *e2 = (const GdkPangoAttrEmbossed*) attr2;
1137 return e1->embossed == e2->embossed;
1141 * gdk_pango_attr_embossed_new:
1142 * @embossed: if the region should be embossed
1144 * Creates a new attribute flagging a region as embossed or not.
1146 * Return value: new #PangoAttribute
1150 gdk_pango_attr_embossed_new (gboolean embossed)
1152 GdkPangoAttrEmbossed *result;
1154 static PangoAttrClass klass = {
1156 gdk_pango_attr_embossed_copy,
1157 gdk_pango_attr_embossed_destroy,
1158 gdk_pango_attr_embossed_compare
1162 klass.type = gdk_pango_attr_embossed_type =
1163 pango_attr_type_register ("GdkPangoAttrEmbossed");
1165 result = g_new (GdkPangoAttrEmbossed, 1);
1166 result->attr.klass = &klass;
1167 result->embossed = embossed;
1169 return (PangoAttribute *)result;
1172 /* GdkPangoAttrEmbossColor */
1174 static PangoAttribute *
1175 gdk_pango_attr_emboss_color_copy (const PangoAttribute *attr)
1177 const GdkPangoAttrEmbossColor *old = (const GdkPangoAttrEmbossColor*) attr;
1178 GdkPangoAttrEmbossColor *copy;
1180 copy = g_new (GdkPangoAttrEmbossColor, 1);
1181 copy->attr.klass = old->attr.klass;
1182 copy->color = old->color;
1184 return (PangoAttribute *) copy;
1188 gdk_pango_attr_emboss_color_destroy (PangoAttribute *attr)
1194 gdk_pango_attr_emboss_color_compare (const PangoAttribute *attr1,
1195 const PangoAttribute *attr2)
1197 const GdkPangoAttrEmbossColor *c1 = (const GdkPangoAttrEmbossColor*) attr1;
1198 const GdkPangoAttrEmbossColor *c2 = (const GdkPangoAttrEmbossColor*) attr2;
1200 return color_equal (&c1->color, &c2->color);
1204 * gdk_pango_attr_emboss_color_new:
1205 * @color: a GdkColor representing the color to emboss with
1207 * Creates a new attribute specifying the color to emboss text with.
1209 * Return value: new #PangoAttribute
1214 gdk_pango_attr_emboss_color_new (const GdkColor *color)
1216 GdkPangoAttrEmbossColor *result;
1218 static PangoAttrClass klass = {
1220 gdk_pango_attr_emboss_color_copy,
1221 gdk_pango_attr_emboss_color_destroy,
1222 gdk_pango_attr_emboss_color_compare
1226 klass.type = gdk_pango_attr_emboss_color_type =
1227 pango_attr_type_register ("GdkPangoAttrEmbossColor");
1229 result = g_new (GdkPangoAttrEmbossColor, 1);
1230 result->attr.klass = &klass;
1231 result->color.red = color->red;
1232 result->color.green = color->green;
1233 result->color.blue = color->blue;
1235 return (PangoAttribute *) result;
1238 /* Get a clip region to draw only part of a layout. index_ranges
1239 * contains alternating range starts/stops. The region is the
1240 * region which contains the given ranges, i.e. if you draw with the
1241 * region as clip, only the given ranges are drawn.
1243 static cairo_region_t*
1244 layout_iter_get_line_clip_region (PangoLayoutIter *iter,
1247 const gint *index_ranges,
1250 PangoLayoutLine *line;
1251 cairo_region_t *clip_region;
1252 PangoRectangle logical_rect;
1256 line = pango_layout_iter_get_line_readonly (iter);
1258 clip_region = cairo_region_create ();
1260 pango_layout_iter_get_line_extents (iter, NULL, &logical_rect);
1261 baseline = pango_layout_iter_get_baseline (iter);
1264 while (i < n_ranges)
1266 gint *pixel_ranges = NULL;
1267 gint n_pixel_ranges = 0;
1270 /* Note that get_x_ranges returns layout coordinates
1272 if (index_ranges[i*2+1] >= line->start_index &&
1273 index_ranges[i*2] < line->start_index + line->length)
1274 pango_layout_line_get_x_ranges (line,
1276 index_ranges[i*2+1],
1277 &pixel_ranges, &n_pixel_ranges);
1279 for (j = 0; j < n_pixel_ranges; j++)
1284 x_off = PANGO_PIXELS (pixel_ranges[2*j] - logical_rect.x);
1285 y_off = PANGO_PIXELS (baseline - logical_rect.y);
1287 rect.x = x_origin + x_off;
1288 rect.y = y_origin - y_off;
1289 rect.width = PANGO_PIXELS (pixel_ranges[2*j + 1] - logical_rect.x) - x_off;
1290 rect.height = PANGO_PIXELS (baseline - logical_rect.y + logical_rect.height) - y_off;
1292 cairo_region_union_rectangle (clip_region, &rect);
1295 g_free (pixel_ranges);
1302 * gdk_pango_layout_line_get_clip_region:
1303 * @line: a #PangoLayoutLine
1304 * @x_origin: X pixel where you intend to draw the layout line with this clip
1305 * @y_origin: baseline pixel where you intend to draw the layout line with this clip
1306 * @index_ranges: array of byte indexes into the layout, where even members of array are start indexes and odd elements are end indexes
1307 * @n_ranges: number of ranges in @index_ranges, i.e. half the size of @index_ranges
1309 * Obtains a clip region which contains the areas where the given
1310 * ranges of text would be drawn. @x_origin and @y_origin are the same
1311 * position you would pass to gdk_draw_layout_line(). @index_ranges
1312 * should contain ranges of bytes in the layout's text. The clip
1313 * region will include space to the left or right of the line (to the
1314 * layout bounding box) if you have indexes above or below the indexes
1315 * contained inside the line. This is to draw the selection all the way
1316 * to the side of the layout. However, the clip region is in line coordinates,
1317 * not layout coordinates.
1319 * Note that the regions returned correspond to logical extents of the text
1320 * ranges, not ink extents. So the drawn line may in fact touch areas out of
1321 * the clip region. The clip region is mainly useful for highlightling parts
1322 * of text, such as when text is selected.
1324 * Return value: a clip region containing the given ranges
1327 gdk_pango_layout_line_get_clip_region (PangoLayoutLine *line,
1330 const gint *index_ranges,
1333 cairo_region_t *clip_region;
1334 PangoLayoutIter *iter;
1336 g_return_val_if_fail (line != NULL, NULL);
1337 g_return_val_if_fail (index_ranges != NULL, NULL);
1339 iter = pango_layout_get_iter (line->layout);
1340 while (pango_layout_iter_get_line_readonly (iter) != line)
1341 pango_layout_iter_next_line (iter);
1343 clip_region = layout_iter_get_line_clip_region(iter, x_origin, y_origin, index_ranges, n_ranges);
1345 pango_layout_iter_free (iter);
1351 * gdk_pango_layout_get_clip_region:
1352 * @layout: a #PangoLayout
1353 * @x_origin: X pixel where you intend to draw the layout with this clip
1354 * @y_origin: Y pixel where you intend to draw the layout with this clip
1355 * @index_ranges: array of byte indexes into the layout, where even members of array are start indexes and odd elements are end indexes
1356 * @n_ranges: number of ranges in @index_ranges, i.e. half the size of @index_ranges
1358 * Obtains a clip region which contains the areas where the given ranges
1359 * of text would be drawn. @x_origin and @y_origin are the same position
1360 * you would pass to gdk_draw_layout_line(). @index_ranges should contain
1361 * ranges of bytes in the layout's text.
1363 * Note that the regions returned correspond to logical extents of the text
1364 * ranges, not ink extents. So the drawn layout may in fact touch areas out of
1365 * the clip region. The clip region is mainly useful for highlightling parts
1366 * of text, such as when text is selected.
1368 * Return value: a clip region containing the given ranges
1371 gdk_pango_layout_get_clip_region (PangoLayout *layout,
1374 const gint *index_ranges,
1377 PangoLayoutIter *iter;
1378 cairo_region_t *clip_region;
1380 g_return_val_if_fail (PANGO_IS_LAYOUT (layout), NULL);
1381 g_return_val_if_fail (index_ranges != NULL, NULL);
1383 clip_region = cairo_region_create ();
1385 iter = pango_layout_get_iter (layout);
1389 PangoRectangle logical_rect;
1390 cairo_region_t *line_region;
1393 pango_layout_iter_get_line_extents (iter, NULL, &logical_rect);
1394 baseline = pango_layout_iter_get_baseline (iter);
1396 line_region = layout_iter_get_line_clip_region(iter,
1397 x_origin + PANGO_PIXELS (logical_rect.x),
1398 y_origin + PANGO_PIXELS (baseline),
1402 cairo_region_union (clip_region, line_region);
1403 cairo_region_destroy (line_region);
1405 while (pango_layout_iter_next_line (iter));
1407 pango_layout_iter_free (iter);
1413 * gdk_pango_context_get:
1415 * Creates a #PangoContext for the default GDK screen.
1417 * The context must be freed when you're finished with it.
1419 * When using GTK+, normally you should use gtk_widget_get_pango_context()
1420 * instead of this function, to get the appropriate context for
1421 * the widget you intend to render text onto.
1423 * The newly created context will have the default font options (see
1424 * #cairo_font_options_t) for the default screen; if these options
1425 * change it will not be updated. Using gtk_widget_get_pango_context()
1426 * is more convenient if you want to keep a context around and track
1427 * changes to the screen's font rendering settings.
1429 * Return value: a new #PangoContext for the default display
1432 gdk_pango_context_get (void)
1434 return gdk_pango_context_get_for_screen (gdk_screen_get_default ());
1438 * gdk_pango_context_get_for_screen:
1439 * @screen: the #GdkScreen for which the context is to be created.
1441 * Creates a #PangoContext for @screen.
1443 * The context must be freed when you're finished with it.
1445 * When using GTK+, normally you should use gtk_widget_get_pango_context()
1446 * instead of this function, to get the appropriate context for
1447 * the widget you intend to render text onto.
1449 * The newly created context will have the default font options
1450 * (see #cairo_font_options_t) for the screen; if these options
1451 * change it will not be updated. Using gtk_widget_get_pango_context()
1452 * is more convenient if you want to keep a context around and track
1453 * changes to the screen's font rendering settings.
1455 * Return value: a new #PangoContext for @screen
1460 gdk_pango_context_get_for_screen (GdkScreen *screen)
1462 PangoFontMap *fontmap;
1463 PangoContext *context;
1464 const cairo_font_options_t *options;
1467 g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
1469 fontmap = pango_cairo_font_map_get_default ();
1471 context = pango_cairo_font_map_create_context (PANGO_CAIRO_FONT_MAP (fontmap));
1473 options = gdk_screen_get_font_options (screen);
1474 pango_cairo_context_set_font_options (context, options);
1476 dpi = gdk_screen_get_resolution (screen);
1477 pango_cairo_context_set_resolution (context, dpi);
1482 #define __GDK_PANGO_C__
1483 #include "gdkaliasdef.c"