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"
28 #include "gdkprivate.h"
29 #include "gdkscreen.h"
33 #define GDK_INFO_KEY "gdk-info"
35 /* We have various arrays indexed by render part; if PangoRenderPart
36 * is extended, we want to make sure not to overwrite the end of
39 #define MAX_RENDER_PART PANGO_RENDER_PART_STRIKETHROUGH
41 struct _GdkPangoRendererPrivate
45 /* GdkPangoRenderer specific state */
46 PangoColor override_color[MAX_RENDER_PART + 1];
47 gboolean override_color_set[MAX_RENDER_PART + 1];
49 GdkBitmap *stipple[MAX_RENDER_PART + 1];
50 PangoColor emboss_color;
54 PangoRenderPart last_part;
57 GdkDrawable *drawable;
63 static PangoAttrType gdk_pango_attr_stipple_type;
64 static PangoAttrType gdk_pango_attr_embossed_type;
65 static PangoAttrType gdk_pango_attr_emboss_color_type;
72 G_DEFINE_TYPE (GdkPangoRenderer, gdk_pango_renderer, PANGO_TYPE_RENDERER)
75 gdk_pango_renderer_finalize (GObject *object)
77 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (object);
78 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
82 g_object_unref (priv->base_gc);
84 g_object_unref (priv->drawable);
86 for (i = 0; i <= MAX_RENDER_PART; i++)
88 g_object_unref (priv->stipple[i]);
90 G_OBJECT_CLASS (gdk_pango_renderer_parent_class)->finalize (object);
94 gdk_pango_renderer_constructor (GType type,
95 guint n_construct_properties,
96 GObjectConstructParam *construct_params)
99 GdkPangoRenderer *gdk_renderer;
101 object = G_OBJECT_CLASS (gdk_pango_renderer_parent_class)->constructor (type,
102 n_construct_properties,
105 gdk_renderer = GDK_PANGO_RENDERER (object);
107 if (!gdk_renderer->priv->screen)
109 g_warning ("Screen must be specified at construct time for GdkPangoRenderer");
110 gdk_renderer->priv->screen = gdk_screen_get_default ();
116 /* Adjusts matrix and color for the renderer to draw the secondary
117 * "shadow" copy for embossed text */
119 emboss_context (GdkPangoRenderer *renderer, cairo_t *cr)
121 GdkPangoRendererPrivate *priv = renderer->priv;
122 cairo_matrix_t tmp_matrix;
123 double red, green, blue;
125 /* The gymnastics here to adjust the matrix are because we want
126 * to offset by +1,+1 in device-space, not in user-space,
127 * so we can't just draw the layout at x + 1, y + 1
129 cairo_get_matrix (cr, &tmp_matrix);
130 tmp_matrix.x0 += 1.0;
131 tmp_matrix.y0 += 1.0;
132 cairo_set_matrix (cr, &tmp_matrix);
134 red = (double) priv->emboss_color.red / 65535.;
135 green = (double) priv->emboss_color.green / 65535.;
136 blue = (double) priv->emboss_color.blue / 65535.;
138 cairo_set_source_rgb (cr, red, green, blue);
141 static inline gboolean
142 color_equal (const PangoColor *c1, const PangoColor *c2)
148 c1->red == c2->red &&
149 c1->green == c2->green &&
150 c1->blue == c2->blue)
157 get_cairo_context (GdkPangoRenderer *gdk_renderer,
158 PangoRenderPart part)
160 PangoRenderer *renderer = PANGO_RENDERER (gdk_renderer);
161 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
165 const PangoMatrix *matrix;
167 priv->cr = gdk_cairo_create (priv->drawable);
169 matrix = pango_renderer_get_matrix (renderer);
172 cairo_matrix_t cairo_matrix;
174 cairo_matrix_init (&cairo_matrix,
175 matrix->xx, matrix->yx,
176 matrix->xy, matrix->yy,
177 matrix->x0, matrix->y0);
178 cairo_set_matrix (priv->cr, &cairo_matrix);
182 if (part != priv->last_part)
184 PangoColor *pango_color;
189 pango_color = pango_renderer_get_color (renderer, part);
191 if (priv->last_part != -1)
192 changed = priv->gc_changed ||
193 priv->stipple[priv->last_part] != priv->stipple[part] ||
194 !color_equal (pango_color,
195 pango_renderer_get_color (renderer, priv->last_part));
203 tmp_color.red = pango_color->red;
204 tmp_color.green = pango_color->green;
205 tmp_color.blue = pango_color->blue;
212 _gdk_gc_update_context (priv->base_gc,
220 priv->last_part = part;
221 priv->gc_changed = FALSE;
228 gdk_pango_renderer_draw_glyphs (PangoRenderer *renderer,
230 PangoGlyphString *glyphs,
234 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
235 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
238 cr = get_cairo_context (gdk_renderer,
239 PANGO_RENDER_PART_FOREGROUND);
244 emboss_context (gdk_renderer, cr);
245 cairo_move_to (cr, (double)x / PANGO_SCALE, (double)y / PANGO_SCALE);
246 pango_cairo_show_glyph_string (cr, font, glyphs);
250 cairo_move_to (cr, (double)x / PANGO_SCALE, (double)y / PANGO_SCALE);
251 pango_cairo_show_glyph_string (cr, font, glyphs);
255 gdk_pango_renderer_draw_rectangle (PangoRenderer *renderer,
256 PangoRenderPart part,
262 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
263 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
266 cr = get_cairo_context (gdk_renderer, part);
268 if (priv->embossed && part != PANGO_RENDER_PART_BACKGROUND)
271 emboss_context (gdk_renderer, cr);
273 (double)x / PANGO_SCALE, (double)y / PANGO_SCALE,
274 (double)width / PANGO_SCALE, (double)height / PANGO_SCALE);
281 (double)x / PANGO_SCALE, (double)y / PANGO_SCALE,
282 (double)width / PANGO_SCALE, (double)height / PANGO_SCALE);
287 gdk_pango_renderer_draw_error_underline (PangoRenderer *renderer,
293 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
294 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
297 cr = get_cairo_context (gdk_renderer, PANGO_RENDER_PART_UNDERLINE);
302 emboss_context (gdk_renderer, cr);
303 pango_cairo_show_error_underline (cr,
304 (double)x / PANGO_SCALE, (double)y / PANGO_SCALE,
305 (double)width / PANGO_SCALE, (double)height / PANGO_SCALE);
309 pango_cairo_show_error_underline (cr,
310 (double)x / PANGO_SCALE, (double)y / PANGO_SCALE,
311 (double)width / PANGO_SCALE, (double)height / PANGO_SCALE);
315 gdk_pango_renderer_draw_shape (PangoRenderer *renderer,
316 PangoAttrShape *attr,
320 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
321 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
323 PangoCairoShapeRendererFunc shape_renderer;
324 gpointer shape_renderer_data;
326 double dx = (double)x / PANGO_SCALE, dy = (double)y / PANGO_SCALE;
328 layout = pango_renderer_get_layout (renderer);
333 shape_renderer = pango_cairo_context_get_shape_renderer (pango_layout_get_context (layout),
334 &shape_renderer_data);
339 cr = get_cairo_context (gdk_renderer, PANGO_RENDER_PART_FOREGROUND);
346 emboss_context (gdk_renderer, cr);
348 cairo_move_to (cr, dx, dy);
349 shape_renderer (cr, attr, FALSE, shape_renderer_data);
354 cairo_move_to (cr, dx, dy);
355 shape_renderer (cr, attr, FALSE, shape_renderer_data);
361 gdk_pango_renderer_part_changed (PangoRenderer *renderer,
362 PangoRenderPart part)
364 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
366 if (gdk_renderer->priv->last_part == part)
367 gdk_renderer->priv->last_part = (PangoRenderPart)-1;
371 gdk_pango_renderer_begin (PangoRenderer *renderer)
373 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
374 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
376 if (!priv->drawable || !priv->base_gc)
378 g_warning ("gdk_pango_renderer_set_drawable() and gdk_pango_renderer_set_drawable()"
379 "must be used to set the target drawable and GC before using the renderer\n");
384 gdk_pango_renderer_end (PangoRenderer *renderer)
386 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
387 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
391 cairo_destroy (priv->cr);
394 priv->last_part = (PangoRenderPart)-1;
398 gdk_pango_renderer_prepare_run (PangoRenderer *renderer,
401 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
402 gboolean embossed = FALSE;
403 GdkBitmap *stipple = NULL;
404 gboolean changed = FALSE;
405 PangoColor emboss_color;
409 emboss_color.red = 0xffff;
410 emboss_color.green = 0xffff;
411 emboss_color.blue = 0xffff;
413 for (l = run->item->analysis.extra_attrs; l; l = l->next)
415 PangoAttribute *attr = l->data;
417 /* stipple_type and embossed_type aren't necessarily
418 * initialized, but they are 0, which is an
419 * invalid type so won't occur.
421 if (attr->klass->type == gdk_pango_attr_stipple_type)
423 stipple = ((GdkPangoAttrStipple*)attr)->stipple;
425 else if (attr->klass->type == gdk_pango_attr_embossed_type)
427 embossed = ((GdkPangoAttrEmbossed*)attr)->embossed;
429 else if (attr->klass->type == gdk_pango_attr_emboss_color_type)
431 emboss_color = ((GdkPangoAttrEmbossColor*)attr)->color;
435 gdk_pango_renderer_set_stipple (gdk_renderer, PANGO_RENDER_PART_FOREGROUND, stipple);
436 gdk_pango_renderer_set_stipple (gdk_renderer, PANGO_RENDER_PART_BACKGROUND, stipple);
437 gdk_pango_renderer_set_stipple (gdk_renderer, PANGO_RENDER_PART_UNDERLINE, stipple);
438 gdk_pango_renderer_set_stipple (gdk_renderer, PANGO_RENDER_PART_STRIKETHROUGH, stipple);
440 if (embossed != gdk_renderer->priv->embossed)
442 gdk_renderer->priv->embossed = embossed;
446 if (!color_equal (&gdk_renderer->priv->emboss_color, &emboss_color))
448 gdk_renderer->priv->emboss_color = emboss_color;
453 pango_renderer_part_changed (renderer, PANGO_RENDER_PART_FOREGROUND);
455 PANGO_RENDERER_CLASS (gdk_pango_renderer_parent_class)->prepare_run (renderer, run);
457 for (i = 0; i <= MAX_RENDER_PART; i++)
459 if (gdk_renderer->priv->override_color_set[i])
460 pango_renderer_set_color (renderer, i, &gdk_renderer->priv->override_color[i]);
465 gdk_pango_renderer_set_property (GObject *object,
470 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (object);
475 gdk_renderer->priv->screen = g_value_get_object (value);
478 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
484 gdk_pango_renderer_get_property (GObject *object,
489 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (object);
494 g_value_set_object (value, gdk_renderer->priv->screen);
497 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
503 gdk_pango_renderer_init (GdkPangoRenderer *renderer)
505 renderer->priv = G_TYPE_INSTANCE_GET_PRIVATE (renderer,
506 GDK_TYPE_PANGO_RENDERER,
507 GdkPangoRendererPrivate);
509 renderer->priv->last_part = (PangoRenderPart)-1;
510 renderer->priv->gc_changed = TRUE;
514 gdk_pango_renderer_class_init (GdkPangoRendererClass *klass)
516 GObjectClass *object_class = G_OBJECT_CLASS (klass);
518 PangoRendererClass *renderer_class = PANGO_RENDERER_CLASS (klass);
520 renderer_class->draw_glyphs = gdk_pango_renderer_draw_glyphs;
521 renderer_class->draw_rectangle = gdk_pango_renderer_draw_rectangle;
522 renderer_class->draw_error_underline = gdk_pango_renderer_draw_error_underline;
523 renderer_class->draw_shape = gdk_pango_renderer_draw_shape;
524 renderer_class->part_changed = gdk_pango_renderer_part_changed;
525 renderer_class->begin = gdk_pango_renderer_begin;
526 renderer_class->end = gdk_pango_renderer_end;
527 renderer_class->prepare_run = gdk_pango_renderer_prepare_run;
529 object_class->finalize = gdk_pango_renderer_finalize;
530 object_class->constructor = gdk_pango_renderer_constructor;
531 object_class->set_property = gdk_pango_renderer_set_property;
532 object_class->get_property = gdk_pango_renderer_get_property;
534 g_object_class_install_property (object_class,
536 g_param_spec_object ("screen",
538 P_("the GdkScreen for the renderer"),
540 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
541 G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK |
542 G_PARAM_STATIC_BLURB));
544 g_type_class_add_private (object_class, sizeof (GdkPangoRendererPrivate));
548 * gdk_pango_renderer_new:
549 * @screen: a #GdkScreen
551 * Creates a new #PangoRenderer for @screen. Normally you can use the
552 * results of gdk_pango_renderer_get_default() rather than creating a new
555 * Return value: a newly created #PangoRenderer. Free with g_object_unref().
560 gdk_pango_renderer_new (GdkScreen *screen)
562 g_return_val_if_fail (screen != NULL, NULL);
564 return g_object_new (GDK_TYPE_PANGO_RENDERER,
570 on_renderer_display_closed (GdkDisplay *display,
572 GdkPangoRenderer *renderer)
574 g_signal_handlers_disconnect_by_func (display,
575 on_renderer_display_closed,
577 g_object_set_data (G_OBJECT (renderer->priv->screen),
578 g_intern_static_string ("gdk-pango-renderer"), NULL);
582 * gdk_pango_renderer_get_default:
583 * @screen: a #GdkScreen
585 * Gets the default #PangoRenderer for a screen. This default renderer
586 * is shared by all users of the display, so properties such as the color
587 * or transformation matrix set for the renderer may be overwritten
588 * by functions such as gdk_draw_layout().
590 * Before using the renderer, you need to call gdk_pango_renderer_set_drawable()
591 * and gdk_pango_renderer_set_gc() to set the drawable and graphics context
592 * to use for drawing.
594 * Return value: the default #PangoRenderer for @screen. The
595 * renderer is owned by GTK+ and will be kept around until the
601 gdk_pango_renderer_get_default (GdkScreen *screen)
603 PangoRenderer *renderer;
605 g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
607 renderer = g_object_get_data (G_OBJECT (screen), "gdk-pango-renderer");
610 renderer = gdk_pango_renderer_new (screen);
611 g_object_set_data_full (G_OBJECT (screen),
612 g_intern_static_string ("gdk-pango-renderer"), renderer,
613 (GDestroyNotify)g_object_unref);
615 g_signal_connect (gdk_screen_get_display (screen), "closed",
616 G_CALLBACK (on_renderer_display_closed), renderer);
623 * gdk_pango_renderer_set_drawable:
624 * @gdk_renderer: a #GdkPangoRenderer
625 * @drawable: (allow-none): the new target drawable, or %NULL
627 * Sets the drawable the renderer draws to.
632 gdk_pango_renderer_set_drawable (GdkPangoRenderer *gdk_renderer,
633 GdkDrawable *drawable)
635 GdkPangoRendererPrivate *priv;
637 g_return_if_fail (GDK_IS_PANGO_RENDERER (gdk_renderer));
638 g_return_if_fail (drawable == NULL || GDK_IS_DRAWABLE (drawable));
640 priv = gdk_renderer->priv;
642 if (priv->drawable != drawable)
645 g_object_unref (priv->drawable);
646 priv->drawable = drawable;
648 g_object_ref (priv->drawable);
653 * gdk_pango_renderer_set_gc:
654 * @gdk_renderer: a #GdkPangoRenderer
655 * @gc: (allow-none): the new GC to use for drawing, or %NULL
657 * Sets the GC the renderer draws with. Note that the GC must not be
658 * modified until it is unset by calling the function again with
659 * %NULL for the @gc parameter, since GDK may make internal copies
660 * of the GC which won't be updated to follow changes to the
666 gdk_pango_renderer_set_gc (GdkPangoRenderer *gdk_renderer,
669 GdkPangoRendererPrivate *priv;
671 g_return_if_fail (GDK_IS_PANGO_RENDERER (gdk_renderer));
672 g_return_if_fail (gc == NULL || GDK_IS_GC (gc));
674 priv = gdk_renderer->priv;
676 if (priv->base_gc != gc)
679 g_object_unref (priv->base_gc);
682 g_object_ref (priv->base_gc);
684 priv->gc_changed = TRUE;
690 * gdk_pango_renderer_set_stipple:
691 * @gdk_renderer: a #GdkPangoRenderer
692 * @part: the part to render with the stipple
693 * @stipple: the new stipple value.
695 * Sets the stipple for one render part (foreground, background, underline,
696 * etc.) Note that this is overwritten when iterating through the individual
697 * styled runs of a #PangoLayout or #PangoLayoutLine. This function is thus
698 * only useful when you call low level functions like pango_renderer_draw_glyphs()
699 * directly, or in the 'prepare_run' virtual function of a subclass of
705 gdk_pango_renderer_set_stipple (GdkPangoRenderer *gdk_renderer,
706 PangoRenderPart part,
709 g_return_if_fail (GDK_IS_PANGO_RENDERER (gdk_renderer));
711 if (part > MAX_RENDER_PART) /* Silently ignore unknown parts */
714 if (stipple != gdk_renderer->priv->stipple[part])
716 if (gdk_renderer->priv->stipple[part])
717 g_object_unref (gdk_renderer->priv->stipple[part]);
719 gdk_renderer->priv->stipple[part] = stipple;
721 if (gdk_renderer->priv->stipple[part])
722 g_object_ref (gdk_renderer->priv->stipple[part]);
724 pango_renderer_part_changed (PANGO_RENDERER (gdk_renderer), part);
729 * gdk_pango_renderer_set_override_color:
730 * @gdk_renderer: a #GdkPangoRenderer
731 * @part: the part to render to set the color of
732 * @color: (allow-none): the color to use, or %NULL to unset a previously
733 * set override color.
735 * Sets the color for a particular render part (foreground,
736 * background, underline, etc.), overriding any attributes on the layouts
737 * renderered with this renderer.
742 gdk_pango_renderer_set_override_color (GdkPangoRenderer *gdk_renderer,
743 PangoRenderPart part,
744 const GdkColor *color)
746 GdkPangoRendererPrivate *priv;
748 g_return_if_fail (GDK_IS_PANGO_RENDERER (gdk_renderer));
750 priv = gdk_renderer->priv;
752 if (part > MAX_RENDER_PART) /* Silently ignore unknown parts */
757 priv->override_color[part].red = color->red;
758 priv->override_color[part].green = color->green;
759 priv->override_color[part].blue = color->blue;
760 priv->override_color_set[part] = TRUE;
763 priv->override_color_set[part] = FALSE;
766 /* Gets a renderer to draw with, setting the properties of the
767 * renderer and activating it. Note that since we activate the
768 * renderer here, the implicit setting of the matrix that
769 * pango_renderer_draw_layout_[line] normally do when they
770 * activate the renderer is suppressed. */
771 static PangoRenderer *
772 get_renderer (GdkDrawable *drawable,
774 const GdkColor *foreground,
775 const GdkColor *background)
777 GdkScreen *screen = gdk_drawable_get_screen (drawable);
778 PangoRenderer *renderer = gdk_pango_renderer_get_default (screen);
779 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
781 gdk_pango_renderer_set_drawable (gdk_renderer, drawable);
782 gdk_pango_renderer_set_gc (gdk_renderer, gc);
784 gdk_pango_renderer_set_override_color (gdk_renderer,
785 PANGO_RENDER_PART_FOREGROUND,
787 gdk_pango_renderer_set_override_color (gdk_renderer,
788 PANGO_RENDER_PART_UNDERLINE,
790 gdk_pango_renderer_set_override_color (gdk_renderer,
791 PANGO_RENDER_PART_STRIKETHROUGH,
794 gdk_pango_renderer_set_override_color (gdk_renderer,
795 PANGO_RENDER_PART_BACKGROUND,
798 pango_renderer_activate (renderer);
803 /* Cleans up the renderer obtained with get_renderer() */
805 release_renderer (PangoRenderer *renderer)
807 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
809 pango_renderer_deactivate (renderer);
811 gdk_pango_renderer_set_override_color (gdk_renderer,
812 PANGO_RENDER_PART_FOREGROUND,
814 gdk_pango_renderer_set_override_color (gdk_renderer,
815 PANGO_RENDER_PART_UNDERLINE,
817 gdk_pango_renderer_set_override_color (gdk_renderer,
818 PANGO_RENDER_PART_STRIKETHROUGH,
820 gdk_pango_renderer_set_override_color (gdk_renderer,
821 PANGO_RENDER_PART_BACKGROUND,
824 gdk_pango_renderer_set_drawable (gdk_renderer, NULL);
825 gdk_pango_renderer_set_gc (gdk_renderer, NULL);
829 * gdk_draw_layout_line_with_colors:
830 * @drawable: the drawable on which to draw the line
831 * @gc: base graphics to use
832 * @x: the x position of start of string (in pixels)
833 * @y: the y position of baseline (in pixels)
834 * @line: a #PangoLayoutLine
835 * @foreground: (allow-none): foreground override color, or %NULL for none
836 * @background: (allow-none): background override color, or %NULL for none
838 * Render a #PangoLayoutLine onto a #GdkDrawable, overriding the
839 * layout's normal colors with @foreground and/or @background.
840 * @foreground and @background need not be allocated.
842 * If the layout's #PangoContext has a transformation matrix set, then
843 * @x and @y specify the position of the left edge of the baseline
844 * (left is in before-tranform user coordinates) in after-transform
845 * device coordinates.
848 gdk_draw_layout_line_with_colors (GdkDrawable *drawable,
852 PangoLayoutLine *line,
853 const GdkColor *foreground,
854 const GdkColor *background)
856 PangoRenderer *renderer;
857 const PangoMatrix *matrix;
859 g_return_if_fail (GDK_IS_DRAWABLE (drawable));
860 g_return_if_fail (GDK_IS_GC (gc));
861 g_return_if_fail (line != NULL);
863 renderer = get_renderer (drawable, gc, foreground, background);
865 /* When we have a matrix, we do positioning by adjusting the matrix, and
866 * clamp just pass x=0, y=0 to the lower levels. We don't want to introduce
867 * a matrix when the caller didn't provide one, however, since that adds
868 * lots of floating point arithmetic for each glyph.
870 matrix = pango_context_get_matrix (pango_layout_get_context (line->layout));
873 PangoMatrix tmp_matrix;
875 tmp_matrix = *matrix;
878 pango_renderer_set_matrix (renderer, &tmp_matrix);
883 /* Fall back to introduce a matrix if the coords would scale out of range.
884 * The x and y here will be added to in-layout coordinates. So we cannot
885 * support the entire range here safely. So, we just accept the middle half
886 * and use fallback for the rest. */
887 else if (GDK_PANGO_UNITS_OVERFLOWS (x, y))
889 PangoMatrix tmp_matrix = PANGO_MATRIX_INIT;
892 pango_renderer_set_matrix (renderer, &tmp_matrix);
898 pango_renderer_set_matrix (renderer, NULL);
900 pango_renderer_draw_layout_line (renderer, line, x * PANGO_SCALE, y * PANGO_SCALE);
902 release_renderer (renderer);
906 * gdk_draw_layout_with_colors:
907 * @drawable: the drawable on which to draw string
908 * @gc: base graphics context to use
909 * @x: the X position of the left of the layout (in pixels)
910 * @y: the Y position of the top of the layout (in pixels)
911 * @layout: a #PangoLayout
912 * @foreground: (allow-none): foreground override color, or %NULL for none
913 * @background: (allow-none): background override color, or %NULL for none
915 * Render a #PangoLayout onto a #GdkDrawable, overriding the
916 * layout's normal colors with @foreground and/or @background.
917 * @foreground and @background need not be allocated.
919 * If the layout's #PangoContext has a transformation matrix set, then
920 * @x and @y specify the position of the top left corner of the
921 * bounding box (in device space) of the transformed layout.
923 * If you're using GTK+, the ususal way to obtain a #PangoLayout
924 * is gtk_widget_create_pango_layout().
927 gdk_draw_layout_with_colors (GdkDrawable *drawable,
932 const GdkColor *foreground,
933 const GdkColor *background)
935 PangoRenderer *renderer;
936 const PangoMatrix *matrix;
938 g_return_if_fail (GDK_IS_DRAWABLE (drawable));
939 g_return_if_fail (GDK_IS_GC (gc));
940 g_return_if_fail (PANGO_IS_LAYOUT (layout));
942 renderer = get_renderer (drawable, gc, foreground, background);
944 /* When we have a matrix, we do positioning by adjusting the matrix, and
945 * clamp just pass x=0, y=0 to the lower levels. We don't want to introduce
946 * a matrix when the caller didn't provide one, however, since that adds
947 * lots of floating point arithmetic for each glyph.
949 matrix = pango_context_get_matrix (pango_layout_get_context (layout));
952 PangoMatrix tmp_matrix;
955 pango_layout_get_extents (layout, NULL, &rect);
956 pango_matrix_transform_rectangle (matrix, &rect);
957 pango_extents_to_pixels (&rect, NULL);
959 tmp_matrix = *matrix;
960 tmp_matrix.x0 += x - rect.x;
961 tmp_matrix.y0 += y - rect.y;
962 pango_renderer_set_matrix (renderer, &tmp_matrix);
967 else if (GDK_PANGO_UNITS_OVERFLOWS (x, y))
969 PangoMatrix tmp_matrix = PANGO_MATRIX_INIT;
972 pango_renderer_set_matrix (renderer, &tmp_matrix);
978 pango_renderer_set_matrix (renderer, NULL);
980 pango_renderer_draw_layout (renderer, layout, x * PANGO_SCALE, y * PANGO_SCALE);
982 release_renderer (renderer);
986 * gdk_draw_layout_line:
987 * @drawable: the drawable on which to draw the line
988 * @gc: base graphics to use
989 * @x: the x position of start of string (in pixels)
990 * @y: the y position of baseline (in pixels)
991 * @line: a #PangoLayoutLine
993 * Render a #PangoLayoutLine onto an GDK drawable
995 * If the layout's #PangoContext has a transformation matrix set, then
996 * @x and @y specify the position of the left edge of the baseline
997 * (left is in before-tranform user coordinates) in after-transform
998 * device coordinates.
1001 gdk_draw_layout_line (GdkDrawable *drawable,
1005 PangoLayoutLine *line)
1007 g_return_if_fail (GDK_IS_DRAWABLE (drawable));
1008 g_return_if_fail (GDK_IS_GC (gc));
1009 g_return_if_fail (line != NULL);
1011 gdk_draw_layout_line_with_colors (drawable, gc, x, y, line, NULL, NULL);
1016 * @drawable: the drawable on which to draw string
1017 * @gc: base graphics context to use
1018 * @x: the X position of the left of the layout (in pixels)
1019 * @y: the Y position of the top of the layout (in pixels)
1020 * @layout: a #PangoLayout
1022 * Render a #PangoLayout onto a GDK drawable
1024 * If the layout's #PangoContext has a transformation matrix set, then
1025 * @x and @y specify the position of the top left corner of the
1026 * bounding box (in device space) of the transformed layout.
1028 * If you're using GTK+, the usual way to obtain a #PangoLayout
1029 * is gtk_widget_create_pango_layout().
1032 gdk_draw_layout (GdkDrawable *drawable,
1036 PangoLayout *layout)
1038 g_return_if_fail (GDK_IS_DRAWABLE (drawable));
1039 g_return_if_fail (GDK_IS_GC (gc));
1040 g_return_if_fail (PANGO_IS_LAYOUT (layout));
1042 gdk_draw_layout_with_colors (drawable, gc, x, y, layout, NULL, NULL);
1045 /* GdkPangoAttrStipple */
1047 static PangoAttribute *
1048 gdk_pango_attr_stipple_copy (const PangoAttribute *attr)
1050 const GdkPangoAttrStipple *src = (const GdkPangoAttrStipple*) attr;
1052 return gdk_pango_attr_stipple_new (src->stipple);
1056 gdk_pango_attr_stipple_destroy (PangoAttribute *attr)
1058 GdkPangoAttrStipple *st = (GdkPangoAttrStipple*) attr;
1061 g_object_unref (st->stipple);
1067 gdk_pango_attr_stipple_compare (const PangoAttribute *attr1,
1068 const PangoAttribute *attr2)
1070 const GdkPangoAttrStipple *a = (const GdkPangoAttrStipple*) attr1;
1071 const GdkPangoAttrStipple *b = (const GdkPangoAttrStipple*) attr2;
1073 return a->stipple == b->stipple;
1077 * gdk_pango_attr_stipple_new:
1078 * @stipple: a bitmap to be set as stipple
1080 * Creates a new attribute containing a stipple bitmap to be used when
1081 * rendering the text.
1083 * Return value: new #PangoAttribute
1087 gdk_pango_attr_stipple_new (GdkBitmap *stipple)
1089 GdkPangoAttrStipple *result;
1091 static PangoAttrClass klass = {
1093 gdk_pango_attr_stipple_copy,
1094 gdk_pango_attr_stipple_destroy,
1095 gdk_pango_attr_stipple_compare
1099 klass.type = gdk_pango_attr_stipple_type =
1100 pango_attr_type_register ("GdkPangoAttrStipple");
1102 result = g_new (GdkPangoAttrStipple, 1);
1103 result->attr.klass = &klass;
1106 g_object_ref (stipple);
1108 result->stipple = stipple;
1110 return (PangoAttribute *)result;
1113 /* GdkPangoAttrEmbossed */
1115 static PangoAttribute *
1116 gdk_pango_attr_embossed_copy (const PangoAttribute *attr)
1118 const GdkPangoAttrEmbossed *e = (const GdkPangoAttrEmbossed*) attr;
1120 return gdk_pango_attr_embossed_new (e->embossed);
1124 gdk_pango_attr_embossed_destroy (PangoAttribute *attr)
1130 gdk_pango_attr_embossed_compare (const PangoAttribute *attr1,
1131 const PangoAttribute *attr2)
1133 const GdkPangoAttrEmbossed *e1 = (const GdkPangoAttrEmbossed*) attr1;
1134 const GdkPangoAttrEmbossed *e2 = (const GdkPangoAttrEmbossed*) attr2;
1136 return e1->embossed == e2->embossed;
1140 * gdk_pango_attr_embossed_new:
1141 * @embossed: if the region should be embossed
1143 * Creates a new attribute flagging a region as embossed or not.
1145 * Return value: new #PangoAttribute
1149 gdk_pango_attr_embossed_new (gboolean embossed)
1151 GdkPangoAttrEmbossed *result;
1153 static PangoAttrClass klass = {
1155 gdk_pango_attr_embossed_copy,
1156 gdk_pango_attr_embossed_destroy,
1157 gdk_pango_attr_embossed_compare
1161 klass.type = gdk_pango_attr_embossed_type =
1162 pango_attr_type_register ("GdkPangoAttrEmbossed");
1164 result = g_new (GdkPangoAttrEmbossed, 1);
1165 result->attr.klass = &klass;
1166 result->embossed = embossed;
1168 return (PangoAttribute *)result;
1171 /* GdkPangoAttrEmbossColor */
1173 static PangoAttribute *
1174 gdk_pango_attr_emboss_color_copy (const PangoAttribute *attr)
1176 const GdkPangoAttrEmbossColor *old = (const GdkPangoAttrEmbossColor*) attr;
1177 GdkPangoAttrEmbossColor *copy;
1179 copy = g_new (GdkPangoAttrEmbossColor, 1);
1180 copy->attr.klass = old->attr.klass;
1181 copy->color = old->color;
1183 return (PangoAttribute *) copy;
1187 gdk_pango_attr_emboss_color_destroy (PangoAttribute *attr)
1193 gdk_pango_attr_emboss_color_compare (const PangoAttribute *attr1,
1194 const PangoAttribute *attr2)
1196 const GdkPangoAttrEmbossColor *c1 = (const GdkPangoAttrEmbossColor*) attr1;
1197 const GdkPangoAttrEmbossColor *c2 = (const GdkPangoAttrEmbossColor*) attr2;
1199 return color_equal (&c1->color, &c2->color);
1203 * gdk_pango_attr_emboss_color_new:
1204 * @color: a GdkColor representing the color to emboss with
1206 * Creates a new attribute specifying the color to emboss text with.
1208 * Return value: new #PangoAttribute
1213 gdk_pango_attr_emboss_color_new (const GdkColor *color)
1215 GdkPangoAttrEmbossColor *result;
1217 static PangoAttrClass klass = {
1219 gdk_pango_attr_emboss_color_copy,
1220 gdk_pango_attr_emboss_color_destroy,
1221 gdk_pango_attr_emboss_color_compare
1225 klass.type = gdk_pango_attr_emboss_color_type =
1226 pango_attr_type_register ("GdkPangoAttrEmbossColor");
1228 result = g_new (GdkPangoAttrEmbossColor, 1);
1229 result->attr.klass = &klass;
1230 result->color.red = color->red;
1231 result->color.green = color->green;
1232 result->color.blue = color->blue;
1234 return (PangoAttribute *) result;
1237 /* Get a clip region to draw only part of a layout. index_ranges
1238 * contains alternating range starts/stops. The region is the
1239 * region which contains the given ranges, i.e. if you draw with the
1240 * region as clip, only the given ranges are drawn.
1242 static cairo_region_t*
1243 layout_iter_get_line_clip_region (PangoLayoutIter *iter,
1246 const gint *index_ranges,
1249 PangoLayoutLine *line;
1250 cairo_region_t *clip_region;
1251 PangoRectangle logical_rect;
1255 line = pango_layout_iter_get_line_readonly (iter);
1257 clip_region = cairo_region_create ();
1259 pango_layout_iter_get_line_extents (iter, NULL, &logical_rect);
1260 baseline = pango_layout_iter_get_baseline (iter);
1263 while (i < n_ranges)
1265 gint *pixel_ranges = NULL;
1266 gint n_pixel_ranges = 0;
1269 /* Note that get_x_ranges returns layout coordinates
1271 if (index_ranges[i*2+1] >= line->start_index &&
1272 index_ranges[i*2] < line->start_index + line->length)
1273 pango_layout_line_get_x_ranges (line,
1275 index_ranges[i*2+1],
1276 &pixel_ranges, &n_pixel_ranges);
1278 for (j = 0; j < n_pixel_ranges; j++)
1283 x_off = PANGO_PIXELS (pixel_ranges[2*j] - logical_rect.x);
1284 y_off = PANGO_PIXELS (baseline - logical_rect.y);
1286 rect.x = x_origin + x_off;
1287 rect.y = y_origin - y_off;
1288 rect.width = PANGO_PIXELS (pixel_ranges[2*j + 1] - logical_rect.x) - x_off;
1289 rect.height = PANGO_PIXELS (baseline - logical_rect.y + logical_rect.height) - y_off;
1291 cairo_region_union_rectangle (clip_region, &rect);
1294 g_free (pixel_ranges);
1301 * gdk_pango_layout_line_get_clip_region:
1302 * @line: a #PangoLayoutLine
1303 * @x_origin: X pixel where you intend to draw the layout line with this clip
1304 * @y_origin: baseline pixel where you intend to draw the layout line with this clip
1305 * @index_ranges: array of byte indexes into the layout, where even members of array are start indexes and odd elements are end indexes
1306 * @n_ranges: number of ranges in @index_ranges, i.e. half the size of @index_ranges
1308 * Obtains a clip region which contains the areas where the given
1309 * ranges of text would be drawn. @x_origin and @y_origin are the same
1310 * position you would pass to gdk_draw_layout_line(). @index_ranges
1311 * should contain ranges of bytes in the layout's text. The clip
1312 * region will include space to the left or right of the line (to the
1313 * layout bounding box) if you have indexes above or below the indexes
1314 * contained inside the line. This is to draw the selection all the way
1315 * to the side of the layout. However, the clip region is in line coordinates,
1316 * not layout coordinates.
1318 * Note that the regions returned correspond to logical extents of the text
1319 * ranges, not ink extents. So the drawn line may in fact touch areas out of
1320 * the clip region. The clip region is mainly useful for highlightling parts
1321 * of text, such as when text is selected.
1323 * Return value: a clip region containing the given ranges
1326 gdk_pango_layout_line_get_clip_region (PangoLayoutLine *line,
1329 const gint *index_ranges,
1332 cairo_region_t *clip_region;
1333 PangoLayoutIter *iter;
1335 g_return_val_if_fail (line != NULL, NULL);
1336 g_return_val_if_fail (index_ranges != NULL, NULL);
1338 iter = pango_layout_get_iter (line->layout);
1339 while (pango_layout_iter_get_line_readonly (iter) != line)
1340 pango_layout_iter_next_line (iter);
1342 clip_region = layout_iter_get_line_clip_region(iter, x_origin, y_origin, index_ranges, n_ranges);
1344 pango_layout_iter_free (iter);
1350 * gdk_pango_layout_get_clip_region:
1351 * @layout: a #PangoLayout
1352 * @x_origin: X pixel where you intend to draw the layout with this clip
1353 * @y_origin: Y pixel where you intend to draw the layout with this clip
1354 * @index_ranges: array of byte indexes into the layout, where even members of array are start indexes and odd elements are end indexes
1355 * @n_ranges: number of ranges in @index_ranges, i.e. half the size of @index_ranges
1357 * Obtains a clip region which contains the areas where the given ranges
1358 * of text would be drawn. @x_origin and @y_origin are the same position
1359 * you would pass to gdk_draw_layout_line(). @index_ranges should contain
1360 * ranges of bytes in the layout's text.
1362 * Note that the regions returned correspond to logical extents of the text
1363 * ranges, not ink extents. So the drawn layout may in fact touch areas out of
1364 * the clip region. The clip region is mainly useful for highlightling parts
1365 * of text, such as when text is selected.
1367 * Return value: a clip region containing the given ranges
1370 gdk_pango_layout_get_clip_region (PangoLayout *layout,
1373 const gint *index_ranges,
1376 PangoLayoutIter *iter;
1377 cairo_region_t *clip_region;
1379 g_return_val_if_fail (PANGO_IS_LAYOUT (layout), NULL);
1380 g_return_val_if_fail (index_ranges != NULL, NULL);
1382 clip_region = cairo_region_create ();
1384 iter = pango_layout_get_iter (layout);
1388 PangoRectangle logical_rect;
1389 cairo_region_t *line_region;
1392 pango_layout_iter_get_line_extents (iter, NULL, &logical_rect);
1393 baseline = pango_layout_iter_get_baseline (iter);
1395 line_region = layout_iter_get_line_clip_region(iter,
1396 x_origin + PANGO_PIXELS (logical_rect.x),
1397 y_origin + PANGO_PIXELS (baseline),
1401 cairo_region_union (clip_region, line_region);
1402 cairo_region_destroy (line_region);
1404 while (pango_layout_iter_next_line (iter));
1406 pango_layout_iter_free (iter);
1412 * gdk_pango_context_get:
1414 * Creates a #PangoContext for the default GDK screen.
1416 * The context must be freed when you're finished with it.
1418 * When using GTK+, normally you should use gtk_widget_get_pango_context()
1419 * instead of this function, to get the appropriate context for
1420 * the widget you intend to render text onto.
1422 * The newly created context will have the default font options (see
1423 * #cairo_font_options_t) for the default screen; if these options
1424 * change it will not be updated. Using gtk_widget_get_pango_context()
1425 * is more convenient if you want to keep a context around and track
1426 * changes to the screen's font rendering settings.
1428 * Return value: a new #PangoContext for the default display
1431 gdk_pango_context_get (void)
1433 return gdk_pango_context_get_for_screen (gdk_screen_get_default ());
1437 * gdk_pango_context_get_for_screen:
1438 * @screen: the #GdkScreen for which the context is to be created.
1440 * Creates a #PangoContext for @screen.
1442 * The context must be freed when you're finished with it.
1444 * When using GTK+, normally you should use gtk_widget_get_pango_context()
1445 * instead of this function, to get the appropriate context for
1446 * the widget you intend to render text onto.
1448 * The newly created context will have the default font options
1449 * (see #cairo_font_options_t) for the screen; if these options
1450 * change it will not be updated. Using gtk_widget_get_pango_context()
1451 * is more convenient if you want to keep a context around and track
1452 * changes to the screen's font rendering settings.
1454 * Return value: a new #PangoContext for @screen
1459 gdk_pango_context_get_for_screen (GdkScreen *screen)
1461 PangoFontMap *fontmap;
1462 PangoContext *context;
1463 const cairo_font_options_t *options;
1466 g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
1468 fontmap = pango_cairo_font_map_get_default ();
1470 context = pango_cairo_font_map_create_context (PANGO_CAIRO_FONT_MAP (fontmap));
1472 options = gdk_screen_get_font_options (screen);
1473 pango_cairo_context_set_font_options (context, options);
1475 dpi = gdk_screen_get_resolution (screen);
1476 pango_cairo_context_set_resolution (context, dpi);