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>
25 #include "gdkinternals.h"
28 #include "gdkprivate.h"
29 #include "gdkscreen.h"
32 /* This is for P_() ... a bit non-kosher, but works fine */
33 #include "gtk/gtkintl.h"
35 #define GDK_INFO_KEY "gdk-info"
37 /* We have various arrays indexed by render part; if PangoRenderPart
38 * is extended, we want to make sure not to overwrite the end of
41 #define MAX_RENDER_PART PANGO_RENDER_PART_STRIKETHROUGH
43 struct _GdkPangoRendererPrivate
47 /* GdkPangoRenderer specific state */
48 PangoColor override_color[MAX_RENDER_PART + 1];
49 gboolean override_color_set[MAX_RENDER_PART + 1];
51 GdkBitmap *stipple[MAX_RENDER_PART + 1];
55 PangoRenderPart last_part;
58 GdkDrawable *drawable;
62 static PangoAttrType gdk_pango_attr_stipple_type;
63 static PangoAttrType gdk_pango_attr_embossed_type;
70 G_DEFINE_TYPE (GdkPangoRenderer, gdk_pango_renderer, PANGO_TYPE_RENDERER)
73 gdk_pango_renderer_finalize (GObject *object)
75 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (object);
76 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
80 g_object_unref (priv->base_gc);
82 g_object_unref (priv->drawable);
84 for (i = 0; i <= MAX_RENDER_PART; i++)
86 g_object_unref (priv->stipple[i]);
88 G_OBJECT_CLASS (gdk_pango_renderer_parent_class)->finalize (object);
92 gdk_pango_renderer_constructor (GType type,
93 guint n_construct_properties,
94 GObjectConstructParam *construct_params)
97 GdkPangoRenderer *gdk_renderer;
99 object = (* G_OBJECT_CLASS (gdk_pango_renderer_parent_class)->constructor) (type,
100 n_construct_properties,
103 gdk_renderer = GDK_PANGO_RENDERER (object);
105 if (!gdk_renderer->priv->screen)
107 g_warning ("Screen must be specified at construct time for GdkPangoRenderer");
108 gdk_renderer->priv->screen = gdk_screen_get_default ();
114 /* Adjusts matrix and color for the renderer to draw the secondary
115 * "shadow" copy for embossed text */
117 emboss_context (cairo_t *cr)
119 cairo_matrix_t tmp_matrix;
121 /* The gymnastics here to adjust the matrix are because we want
122 * to offset by +1,+1 in device-space, not in user-space,
123 * so we can't just draw the layout at x + 1, y + 1
125 cairo_get_matrix (cr, &tmp_matrix);
126 tmp_matrix.x0 += 1.0;
127 tmp_matrix.y0 += 1.0;
128 cairo_set_matrix (cr, &tmp_matrix);
130 cairo_set_source_rgb (cr, 1.0, 1.0, 1.0);
134 get_cairo_context (GdkPangoRenderer *gdk_renderer,
135 PangoRenderPart part)
137 PangoRenderer *renderer = PANGO_RENDERER (gdk_renderer);
138 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
142 const PangoMatrix *matrix;
144 priv->cr = gdk_drawable_create_cairo_context (priv->drawable);
146 matrix = pango_renderer_get_matrix (renderer);
149 cairo_matrix_t cairo_matrix;
151 cairo_matrix_init (&cairo_matrix,
152 matrix->xx, matrix->yx,
153 matrix->xy, matrix->yy,
154 matrix->x0, matrix->y0);
155 cairo_set_matrix (priv->cr, &cairo_matrix);
159 priv->last_part = (PangoRenderPart)-1;
160 if (part != priv->last_part)
162 PangoColor *pango_color = pango_renderer_get_color (renderer,
164 GdkColor *color = NULL;
168 tmp_color.red = pango_color->red;
169 tmp_color.green = pango_color->green;
170 tmp_color.blue = pango_color->blue;
175 _gdk_gc_update_context (priv->base_gc,
178 priv->stipple[part]);
179 priv->last_part = part;
186 gdk_pango_renderer_draw_glyphs (PangoRenderer *renderer,
188 PangoGlyphString *glyphs,
192 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
193 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
196 cr = get_cairo_context (gdk_renderer,
197 PANGO_RENDER_PART_FOREGROUND);
203 cairo_move_to (cr, x / PANGO_SCALE, y / PANGO_SCALE);
204 pango_cairo_show_glyph_string (cr, font, glyphs);
208 cairo_move_to (cr, x / PANGO_SCALE, y / PANGO_SCALE);
209 pango_cairo_show_glyph_string (cr, font, glyphs);
212 /* Draws an error underline that looks like one of:
215 * A/ \ / \ / \ A/ \ / \ |
216 * \ \ / \ / /D \ \ / \ |
217 * \ \/ C \/ / \ \/ C \ | height = HEIGHT_SQUARES * square
218 * \ /\ F / \ F /\ \ |
224 * unit_width = (HEIGHT_SQUARES - 1) * square
226 * The x, y, width, height passed in give the desired bounding box;
227 * x/width are adjusted to make the underline a integer number of units
230 #define HEIGHT_SQUARES 2.5
233 draw_error_underline (cairo_t *cr,
239 double square = height / HEIGHT_SQUARES;
240 double unit_width = (HEIGHT_SQUARES - 1) * square;
241 int width_units = (width + unit_width / 2) / unit_width;
242 double y_top, y_bottom;
245 x += (width - width_units * unit_width);
246 width = width_units * unit_width;
249 y_bottom = y + height;
251 /* Bottom of squiggle */
252 cairo_move_to (cr, x - square / 2, y_top + square / 2); /* A */
253 for (i = 0; i < width_units; i += 2)
255 double x_middle = x + (i + 1) * unit_width;
256 double x_right = x + (i + 2) * unit_width;
258 cairo_line_to (cr, x_middle, y_bottom); /* B */
260 if (i + 1 == width_units)
262 else if (i + 2 == width_units)
263 cairo_line_to (cr, x_right + square / 2, y_top + square / 2); /* D */
265 cairo_line_to (cr, x_right, y_top + square); /* C */
268 /* Top of squiggle */
269 for (i -= 2; i >= 0; i -= 2)
271 double x_left = x + i * unit_width;
272 double x_middle = x + (i + 1) * unit_width;
273 double x_right = x + (i + 2) * unit_width;
275 if (i + 1 == width_units)
276 cairo_line_to (cr, x_middle + square / 2, y_bottom - square / 2); /* G */
278 if (i + 2 == width_units)
279 cairo_line_to (cr, x_right, y_top); /* E */
280 cairo_line_to (cr, x_middle, y_bottom - square); /* F */
283 cairo_line_to (cr, x_left, y_top); /* H */
286 cairo_close_path (cr);
291 gdk_pango_renderer_draw_rectangle (PangoRenderer *renderer,
292 PangoRenderPart part,
298 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
299 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
302 cr = get_cairo_context (gdk_renderer, part);
304 if (priv->embossed && part != PANGO_RENDER_PART_BACKGROUND)
309 (double)x / PANGO_SCALE, (double)y / PANGO_SCALE,
310 (double)width / PANGO_SCALE, (double)height / PANGO_SCALE);
317 (double)x / PANGO_SCALE, (double)y / PANGO_SCALE,
318 (double)width / PANGO_SCALE, (double)height / PANGO_SCALE);
323 gdk_pango_renderer_draw_error_underline (PangoRenderer *renderer,
329 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
330 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
333 cr = get_cairo_context (gdk_renderer, PANGO_RENDER_PART_UNDERLINE);
339 draw_error_underline (cr,
340 (double)x / PANGO_SCALE, (double)y / PANGO_SCALE,
341 (double)width / PANGO_SCALE, (double)height / PANGO_SCALE);
345 draw_error_underline (cr,
346 (double)x / PANGO_SCALE, (double)y / PANGO_SCALE,
347 (double)width / PANGO_SCALE, (double)height / PANGO_SCALE);
351 gdk_pango_renderer_part_changed (PangoRenderer *renderer,
352 PangoRenderPart part)
354 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
356 if (gdk_renderer->priv->last_part == part)
357 gdk_renderer->priv->last_part = (PangoRenderPart)-1;
361 gdk_pango_renderer_begin (PangoRenderer *renderer)
363 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
364 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
366 if (!priv->drawable || !priv->base_gc)
368 g_warning ("gdk_pango_renderer_set_drawable() and gdk_pango_renderer_set_drawable()"
369 "must be used to set the target drawable and GC before using the renderer\n");
374 gdk_pango_renderer_end (PangoRenderer *renderer)
376 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
377 GdkPangoRendererPrivate *priv = gdk_renderer->priv;
381 cairo_destroy (priv->cr);
384 priv->last_part = (PangoRenderPart)-1;
388 gdk_pango_renderer_prepare_run (PangoRenderer *renderer,
391 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
392 gboolean embossed = FALSE;
393 GdkBitmap *stipple = NULL;
400 for (l = run->item->analysis.extra_attrs; l; l = l->next)
402 PangoAttribute *attr = l->data;
404 /* stipple_type and embossed_type aren't necessarily
405 * initialized, but they are 0, which is an
406 * invalid type so won't occur.
408 if (attr->klass->type == gdk_pango_attr_stipple_type)
410 stipple = ((GdkPangoAttrStipple*)attr)->stipple;
412 else if (attr->klass->type == gdk_pango_attr_embossed_type)
414 embossed = ((GdkPangoAttrEmbossed*)attr)->embossed;
418 gdk_pango_renderer_set_stipple (gdk_renderer, PANGO_RENDER_PART_FOREGROUND, stipple);
419 gdk_pango_renderer_set_stipple (gdk_renderer, PANGO_RENDER_PART_BACKGROUND, stipple);
420 gdk_pango_renderer_set_stipple (gdk_renderer, PANGO_RENDER_PART_UNDERLINE, stipple);
421 gdk_pango_renderer_set_stipple (gdk_renderer, PANGO_RENDER_PART_STRIKETHROUGH, stipple);
423 if (embossed != gdk_renderer->priv->embossed)
425 gdk_renderer->priv->embossed = embossed;
426 pango_renderer_part_changed (renderer, PANGO_RENDER_PART_FOREGROUND);
429 PANGO_RENDERER_CLASS (gdk_pango_renderer_parent_class)->prepare_run (renderer, run);
431 for (i = 0; i <= MAX_RENDER_PART; i++)
433 if (gdk_renderer->priv->override_color_set[i])
434 pango_renderer_set_color (renderer, i, &gdk_renderer->priv->override_color[i]);
439 gdk_pango_renderer_set_property (GObject *object,
444 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (object);
449 gdk_renderer->priv->screen = g_value_get_object (value);
452 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
458 gdk_pango_renderer_get_property (GObject *object,
463 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (object);
468 g_value_set_object (value, gdk_renderer->priv->screen);
471 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
477 gdk_pango_renderer_init (GdkPangoRenderer *renderer)
479 renderer->priv = G_TYPE_INSTANCE_GET_PRIVATE (renderer,
480 GDK_TYPE_PANGO_RENDERER,
481 GdkPangoRendererPrivate);
483 renderer->priv->last_part = (PangoRenderPart)-1;
487 gdk_pango_renderer_class_init (GdkPangoRendererClass *klass)
489 GObjectClass *object_class = G_OBJECT_CLASS (klass);
491 PangoRendererClass *renderer_class = PANGO_RENDERER_CLASS (klass);
493 renderer_class->draw_glyphs = gdk_pango_renderer_draw_glyphs;
494 renderer_class->draw_rectangle = gdk_pango_renderer_draw_rectangle;
495 renderer_class->draw_error_underline = gdk_pango_renderer_draw_error_underline;
496 renderer_class->part_changed = gdk_pango_renderer_part_changed;
497 renderer_class->begin = gdk_pango_renderer_begin;
498 renderer_class->end = gdk_pango_renderer_end;
499 renderer_class->prepare_run = gdk_pango_renderer_prepare_run;
501 object_class->finalize = gdk_pango_renderer_finalize;
502 object_class->constructor = gdk_pango_renderer_constructor;
503 object_class->set_property = gdk_pango_renderer_set_property;
504 object_class->get_property = gdk_pango_renderer_get_property;
506 g_object_class_install_property (object_class,
508 g_param_spec_object ("screen",
510 P_("the GdkScreen for the renderer"),
512 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
513 G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK |
514 G_PARAM_STATIC_BLURB));
516 g_type_class_add_private (object_class, sizeof (GdkPangoRendererPrivate));
520 * gdk_pango_renderer_new:
521 * @screen: a #GdkScreen
523 * Creates a new #PangoRenderer for @screen. Normally you can use the
524 * results of gdk_pango_renderer_get_default() rather than creating a new
527 * Return value: a newly created #PangoRenderer. Free with g_object_unref().
532 gdk_pango_renderer_new (GdkScreen *screen)
534 g_return_val_if_fail (screen != NULL, NULL);
536 return g_object_new (GDK_TYPE_PANGO_RENDERER,
542 on_renderer_display_closed (GdkDisplay *display,
543 GdkPangoRenderer *renderer)
545 g_signal_handlers_disconnect_by_func (renderer->priv->screen,
546 (gpointer)on_renderer_display_closed,
548 g_object_set_data (G_OBJECT (renderer->priv->screen), "gdk-pango-renderer", NULL);
552 * gdk_pango_renderer_get_default:
553 * @screen: a #GdkScreen
555 * Gets the default #PangoRenderer for a screen. This default renderer
556 * is shared by all users of the display, so properties such as the color
557 * or transformation matrix set for the renderer may be overwritten
558 * by functions such as gdk_draw_layout().
560 * Before using the renderer, you need to call gdk_pango_renderer_set_drawable()
561 * and gdk_pango_renderer_set_drawable() to set the drawable and graphics context
562 * to use for drawing.
564 * Return value: the default #PangoRenderer for @screen. The
565 * renderer is owned by GTK+ and will be kept around until the
571 gdk_pango_renderer_get_default (GdkScreen *screen)
573 PangoRenderer *renderer;
575 g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
577 renderer = g_object_get_data (G_OBJECT (screen), "gdk-pango-renderer");
580 renderer = gdk_pango_renderer_new (screen);
581 g_object_set_data_full (G_OBJECT (screen), "gdk-pango-renderer", renderer,
582 (GDestroyNotify)g_object_unref);
584 g_signal_connect (gdk_screen_get_display (screen), "closed",
585 G_CALLBACK (on_renderer_display_closed), renderer);
592 * gdk_pango_renderer_set_drawable:
593 * @gdk_renderer: a #GdkPangoRenderer
594 * @drawable: the new target drawable, or %NULL
596 * Sets the drawable the renderer draws to.
601 gdk_pango_renderer_set_drawable (GdkPangoRenderer *gdk_renderer,
602 GdkDrawable *drawable)
604 GdkPangoRendererPrivate *priv;
606 g_return_if_fail (GDK_IS_PANGO_RENDERER (gdk_renderer));
607 g_return_if_fail (drawable == NULL || GDK_IS_DRAWABLE (drawable));
609 priv = gdk_renderer->priv;
611 if (priv->drawable != drawable)
614 g_object_unref (priv->drawable);
615 priv->drawable = drawable;
617 g_object_ref (priv->drawable);
622 * gdk_pango_renderer_set_gc:
623 * @gdk_renderer: a #GdkPangoRenderer
624 * @gc: the new GC to use for drawing, or %NULL
626 * Sets the GC the renderer draws with. Note that the GC must not be
627 * modified until it is unset by calling the function again with
628 * %NULL for the @gc parameter, since GDK may make internal copies
629 * of the GC which won't be updated to follow changes to the
635 gdk_pango_renderer_set_gc (GdkPangoRenderer *gdk_renderer,
638 GdkPangoRendererPrivate *priv;
640 g_return_if_fail (GDK_IS_PANGO_RENDERER (gdk_renderer));
641 g_return_if_fail (gc == NULL || GDK_IS_GC (gc));
643 priv = gdk_renderer->priv;
645 if (priv->base_gc != gc)
648 g_object_unref (priv->base_gc);
651 g_object_ref (priv->base_gc);
657 * gdk_pango_renderer_set_stipple:
658 * @gdk_renderer: a #GdkPangoRenderer
659 * @part: the part to render with the stipple
660 * @stipple: the new stipple value.
662 * Sets the stipple for one render part (foreground, background, underline,
663 * etc.) Note that this is overwritten when iterating through the individual
664 * styled runs of a #PangoLayout or #PangoLayoutLine. This function is thus
665 * only useful when you call low level functions like pango_renderer_draw_glyphs()
666 * directly, or in the 'prepare_run' virtual function of a subclass of
672 gdk_pango_renderer_set_stipple (GdkPangoRenderer *gdk_renderer,
673 PangoRenderPart part,
676 g_return_if_fail (GDK_IS_PANGO_RENDERER (gdk_renderer));
678 if (part > MAX_RENDER_PART) /* Silently ignore unknown parts */
681 if (stipple != gdk_renderer->priv->stipple[part])
683 if (gdk_renderer->priv->stipple[part])
684 g_object_unref (gdk_renderer->priv->stipple[part]);
686 gdk_renderer->priv->stipple[part] = stipple;
688 if (gdk_renderer->priv->stipple[part])
689 g_object_ref (gdk_renderer->priv->stipple[part]);
691 pango_renderer_part_changed (PANGO_RENDERER (gdk_renderer), part);
696 * gdk_pango_renderer_set_override_color:
697 * @gdk_renderer: a #GdkPangoRenderer
698 * @part: the part to render to set the color of
699 * @color: the color to use, or %NULL to unset a previously
700 * set override color.
702 * Sets the color for a particular render part (foreground,
703 * background, underline, etc.), overriding any attributes on the layouts
704 * renderered with this renderer.
709 gdk_pango_renderer_set_override_color (GdkPangoRenderer *gdk_renderer,
710 PangoRenderPart part,
711 const GdkColor *color)
713 GdkPangoRendererPrivate *priv;
715 g_return_if_fail (GDK_IS_PANGO_RENDERER (gdk_renderer));
717 priv = gdk_renderer->priv;
719 if (part > MAX_RENDER_PART) /* Silently ignore unknown parts */
724 priv->override_color[part].red = color->red;
725 priv->override_color[part].green = color->green;
726 priv->override_color[part].blue = color->blue;
727 priv->override_color_set[part] = TRUE;
730 priv->override_color_set[part] = FALSE;
734 * gdk_pango_context_set_colormap:
735 * @context: a #PangoContext
736 * @colormap: a #GdkColormap
738 * This function used to set the colormap to be used for drawing with
739 * @context. The colormap is now always derived from the graphics
740 * context used for drawing, so calling this function is no longer
744 gdk_pango_context_set_colormap (PangoContext *context,
745 GdkColormap *colormap)
747 g_return_if_fail (PANGO_IS_CONTEXT (context));
748 g_return_if_fail (colormap == NULL || GDK_IS_COLORMAP (colormap));
751 /* Gets a renderer to draw with, setting the properties of the
752 * renderer and activating it. Note that since we activate the
753 * renderer here, the implicit setting of the matrix that
754 * pango_renderer_draw_layout_[line] normally do when they
755 * activate the renderer is suppressed. */
756 static PangoRenderer *
757 get_renderer (GdkDrawable *drawable,
759 const GdkColor *foreground,
760 const GdkColor *background)
762 GdkScreen *screen = gdk_drawable_get_screen (drawable);
763 PangoRenderer *renderer = gdk_pango_renderer_get_default (screen);
764 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
766 gdk_pango_renderer_set_drawable (gdk_renderer, drawable);
767 gdk_pango_renderer_set_gc (gdk_renderer, gc);
769 gdk_pango_renderer_set_override_color (gdk_renderer,
770 PANGO_RENDER_PART_FOREGROUND,
772 gdk_pango_renderer_set_override_color (gdk_renderer,
773 PANGO_RENDER_PART_UNDERLINE,
775 gdk_pango_renderer_set_override_color (gdk_renderer,
776 PANGO_RENDER_PART_STRIKETHROUGH,
779 gdk_pango_renderer_set_override_color (gdk_renderer,
780 PANGO_RENDER_PART_BACKGROUND,
783 pango_renderer_activate (renderer);
788 /* Cleans up the renderer obtained with get_renderer() */
790 release_renderer (PangoRenderer *renderer)
792 GdkPangoRenderer *gdk_renderer = GDK_PANGO_RENDERER (renderer);
794 pango_renderer_deactivate (renderer);
796 gdk_pango_renderer_set_override_color (gdk_renderer,
797 PANGO_RENDER_PART_FOREGROUND,
799 gdk_pango_renderer_set_override_color (gdk_renderer,
800 PANGO_RENDER_PART_UNDERLINE,
802 gdk_pango_renderer_set_override_color (gdk_renderer,
803 PANGO_RENDER_PART_STRIKETHROUGH,
805 gdk_pango_renderer_set_override_color (gdk_renderer,
806 PANGO_RENDER_PART_BACKGROUND,
809 gdk_pango_renderer_set_drawable (gdk_renderer, NULL);
810 gdk_pango_renderer_set_gc (gdk_renderer, NULL);
814 * gdk_draw_layout_line_with_colors:
815 * @drawable: the drawable on which to draw the line
816 * @gc: base graphics to use
817 * @x: the x position of start of string (in pixels)
818 * @y: the y position of baseline (in pixels)
819 * @line: a #PangoLayoutLine
820 * @foreground: foreground override color, or %NULL for none
821 * @background: background override color, or %NULL for none
823 * Render a #PangoLayoutLine onto a #GdkDrawable, overriding the
824 * layout's normal colors with @foreground and/or @background.
825 * @foreground and @background need not be allocated.
827 * If the layout's #PangoContext has a transformation matrix set, then
828 * @x and @y specify the position of the left edge of the baseline
829 * (left is in before-tranform user coordinates) in after-transform
830 * device coordinates.
833 gdk_draw_layout_line_with_colors (GdkDrawable *drawable,
837 PangoLayoutLine *line,
838 const GdkColor *foreground,
839 const GdkColor *background)
841 PangoRenderer *renderer;
842 const PangoMatrix *matrix;
844 g_return_if_fail (GDK_IS_DRAWABLE (drawable));
845 g_return_if_fail (GDK_IS_GC (gc));
846 g_return_if_fail (line != NULL);
848 renderer = get_renderer (drawable, gc, foreground, background);
850 /* When we have a matrix, we do positioning by adjusting the matrix, and
851 * clamp just pass x=0, y=0 to the lower levels. We don't want to introduce
852 * a matrix when the caller didn't provide one, however, since that adds
853 * lots of floating point arithmetic for each glyph.
855 matrix = pango_context_get_matrix (pango_layout_get_context (line->layout));
858 PangoMatrix tmp_matrix;
860 tmp_matrix = *matrix;
863 pango_renderer_set_matrix (renderer, &tmp_matrix);
869 pango_renderer_set_matrix (renderer, NULL);
871 pango_renderer_draw_layout_line (renderer, line, x * PANGO_SCALE, y * PANGO_SCALE);
873 release_renderer (renderer);
876 /* Gets the bounds of a layout in device coordinates. Note cut-and-paste
877 * between here and gtklabel.c */
879 get_rotated_layout_bounds (PangoLayout *layout,
882 PangoContext *context = pango_layout_get_context (layout);
883 const PangoMatrix *matrix = pango_context_get_matrix (context);
884 gdouble x_min = 0, x_max = 0, y_min = 0, y_max = 0; /* quiet gcc */
885 PangoRectangle logical_rect;
888 pango_layout_get_extents (layout, NULL, &logical_rect);
890 for (i = 0; i < 2; i++)
892 gdouble x = (i == 0) ? logical_rect.x : logical_rect.x + logical_rect.width;
893 for (j = 0; j < 2; j++)
895 gdouble y = (j == 0) ? logical_rect.y : logical_rect.y + logical_rect.height;
897 gdouble xt = (x * matrix->xx + y * matrix->xy) / PANGO_SCALE + matrix->x0;
898 gdouble yt = (x * matrix->yx + y * matrix->yy) / PANGO_SCALE + matrix->y0;
900 if (i == 0 && j == 0)
919 rect->x = floor (x_min);
920 rect->width = ceil (x_max) - rect->x;
921 rect->y = floor (y_min);
922 rect->height = floor (y_max) - rect->y;
926 * gdk_draw_layout_with_colors:
927 * @drawable: the drawable on which to draw string
928 * @gc: base graphics context to use
929 * @x: the X position of the left of the layout (in pixels)
930 * @y: the Y position of the top of the layout (in pixels)
931 * @layout: a #PangoLayout
932 * @foreground: foreground override color, or %NULL for none
933 * @background: background override color, or %NULL for none
935 * Render a #PangoLayout onto a #GdkDrawable, overriding the
936 * layout's normal colors with @foreground and/or @background.
937 * @foreground and @background need not be allocated.
939 * If the layout's #PangoContext has a transformation matrix set, then
940 * @x and @y specify the position of the top left corner of the
941 * bounding box (in device space) of the transformed layout.
943 * If you're using GTK+, the ususal way to obtain a #PangoLayout
944 * is gtk_widget_create_pango_layout().
947 gdk_draw_layout_with_colors (GdkDrawable *drawable,
952 const GdkColor *foreground,
953 const GdkColor *background)
955 PangoRenderer *renderer;
956 const PangoMatrix *matrix;
958 g_return_if_fail (GDK_IS_DRAWABLE (drawable));
959 g_return_if_fail (GDK_IS_GC (gc));
960 g_return_if_fail (PANGO_IS_LAYOUT (layout));
962 renderer = get_renderer (drawable, gc, foreground, background);
964 /* When we have a matrix, we do positioning by adjusting the matrix, and
965 * clamp just pass x=0, y=0 to the lower levels. We don't want to introduce
966 * a matrix when the caller didn't provide one, however, since that adds
967 * lots of floating point arithmetic for each glyph.
969 matrix = pango_context_get_matrix (pango_layout_get_context (layout));
972 PangoMatrix tmp_matrix;
975 get_rotated_layout_bounds (layout, &rect);
977 tmp_matrix = *matrix;
978 tmp_matrix.x0 += x - rect.x;
979 tmp_matrix.y0 += y - rect.y;
980 pango_renderer_set_matrix (renderer, &tmp_matrix);
986 pango_renderer_set_matrix (renderer, NULL);
988 pango_renderer_draw_layout (renderer, layout, x * PANGO_SCALE, y * PANGO_SCALE);
990 release_renderer (renderer);
994 * gdk_draw_layout_line:
995 * @drawable: the drawable on which to draw the line
996 * @gc: base graphics to use
997 * @x: the x position of start of string (in pixels)
998 * @y: the y position of baseline (in pixels)
999 * @line: a #PangoLayoutLine
1001 * Render a #PangoLayoutLine onto an GDK drawable
1003 * If the layout's #PangoContext has a transformation matrix set, then
1004 * @x and @y specify the position of the left edge of the baseline
1005 * (left is in before-tranform user coordinates) in after-transform
1006 * device coordinates.
1009 gdk_draw_layout_line (GdkDrawable *drawable,
1013 PangoLayoutLine *line)
1015 g_return_if_fail (GDK_IS_DRAWABLE (drawable));
1016 g_return_if_fail (GDK_IS_GC (gc));
1017 g_return_if_fail (line != NULL);
1019 gdk_draw_layout_line_with_colors (drawable, gc, x, y, line, NULL, NULL);
1024 * @drawable: the drawable on which to draw string
1025 * @gc: base graphics context to use
1026 * @x: the X position of the left of the layout (in pixels)
1027 * @y: the Y position of the top of the layout (in pixels)
1028 * @layout: a #PangoLayout
1030 * Render a #PangoLayout onto a GDK drawable
1032 * If the layout's #PangoContext has a transformation matrix set, then
1033 * @x and @y specify the position of the top left corner of the
1034 * bounding box (in device space) of the transformed layout.
1036 * If you're using GTK+, the usual way to obtain a #PangoLayout
1037 * is gtk_widget_create_pango_layout().
1040 gdk_draw_layout (GdkDrawable *drawable,
1044 PangoLayout *layout)
1046 g_return_if_fail (GDK_IS_DRAWABLE (drawable));
1047 g_return_if_fail (GDK_IS_GC (gc));
1048 g_return_if_fail (PANGO_IS_LAYOUT (layout));
1050 gdk_draw_layout_with_colors (drawable, gc, x, y, layout, NULL, NULL);
1053 static PangoAttribute *
1054 gdk_pango_attr_stipple_copy (const PangoAttribute *attr)
1056 const GdkPangoAttrStipple *src = (const GdkPangoAttrStipple*) attr;
1058 return gdk_pango_attr_stipple_new (src->stipple);
1062 gdk_pango_attr_stipple_destroy (PangoAttribute *attr)
1064 GdkPangoAttrStipple *st = (GdkPangoAttrStipple*) attr;
1067 g_object_unref (st->stipple);
1073 gdk_pango_attr_stipple_compare (const PangoAttribute *attr1,
1074 const PangoAttribute *attr2)
1076 const GdkPangoAttrStipple *a = (const GdkPangoAttrStipple*) attr1;
1077 const GdkPangoAttrStipple *b = (const GdkPangoAttrStipple*) attr2;
1079 return a->stipple == b->stipple;
1083 * gdk_pango_attr_stipple_new:
1084 * @stipple: a bitmap to be set as stipple
1086 * Creates a new attribute containing a stipple bitmap to be used when
1087 * rendering the text.
1089 * Return value: new #PangoAttribute
1093 gdk_pango_attr_stipple_new (GdkBitmap *stipple)
1095 GdkPangoAttrStipple *result;
1097 static PangoAttrClass klass = {
1099 gdk_pango_attr_stipple_copy,
1100 gdk_pango_attr_stipple_destroy,
1101 gdk_pango_attr_stipple_compare
1105 klass.type = gdk_pango_attr_stipple_type =
1106 pango_attr_type_register ("GdkPangoAttrStipple");
1108 result = g_new (GdkPangoAttrStipple, 1);
1109 result->attr.klass = &klass;
1112 g_object_ref (stipple);
1114 result->stipple = stipple;
1116 return (PangoAttribute *)result;
1119 static PangoAttribute *
1120 gdk_pango_attr_embossed_copy (const PangoAttribute *attr)
1122 const GdkPangoAttrEmbossed *e = (const GdkPangoAttrEmbossed*) attr;
1124 return gdk_pango_attr_embossed_new (e->embossed);
1128 gdk_pango_attr_embossed_destroy (PangoAttribute *attr)
1134 gdk_pango_attr_embossed_compare (const PangoAttribute *attr1,
1135 const PangoAttribute *attr2)
1137 const GdkPangoAttrEmbossed *e1 = (const GdkPangoAttrEmbossed*) attr1;
1138 const GdkPangoAttrEmbossed *e2 = (const GdkPangoAttrEmbossed*) attr2;
1140 return e1->embossed == e2->embossed;
1144 * gdk_pango_attr_embossed_new:
1145 * @embossed: a bitmap to be set as embossed
1147 * Creates a new attribute containing a embossed bitmap to be used when
1148 * rendering the text.
1150 * Return value: new #PangoAttribute
1154 gdk_pango_attr_embossed_new (gboolean embossed)
1156 GdkPangoAttrEmbossed *result;
1158 static PangoAttrClass klass = {
1160 gdk_pango_attr_embossed_copy,
1161 gdk_pango_attr_embossed_destroy,
1162 gdk_pango_attr_embossed_compare
1166 klass.type = gdk_pango_attr_embossed_type =
1167 pango_attr_type_register ("GdkPangoAttrEmbossed");
1169 result = g_new (GdkPangoAttrEmbossed, 1);
1170 result->attr.klass = &klass;
1171 result->embossed = embossed;
1173 return (PangoAttribute *)result;
1176 /* Get a clip region to draw only part of a layout. index_ranges
1177 * contains alternating range starts/stops. The region is the
1178 * region which contains the given ranges, i.e. if you draw with the
1179 * region as clip, only the given ranges are drawn.
1183 * gdk_pango_layout_line_get_clip_region:
1184 * @line: a #PangoLayoutLine
1185 * @x_origin: X pixel where you intend to draw the layout line with this clip
1186 * @y_origin: baseline pixel where you intend to draw the layout line with this clip
1187 * @index_ranges: array of byte indexes into the layout, where even members of array are start indexes and odd elements are end indexes
1188 * @n_ranges: number of ranges in @index_ranges, i.e. half the size of @index_ranges
1190 * Obtains a clip region which contains the areas where the given
1191 * ranges of text would be drawn. @x_origin and @y_origin are the same
1192 * position you would pass to gdk_draw_layout_line(). @index_ranges
1193 * should contain ranges of bytes in the layout's text. The clip
1194 * region will include space to the left or right of the line (to the
1195 * layout bounding box) if you have indexes above or below the indexes
1196 * contained inside the line. This is to draw the selection all the way
1197 * to the side of the layout. However, the clip region is in line coordinates,
1198 * not layout coordinates.
1200 * Return value: a clip region containing the given ranges
1203 gdk_pango_layout_line_get_clip_region (PangoLayoutLine *line,
1209 GdkRegion *clip_region;
1211 PangoRectangle logical_rect;
1212 PangoLayoutIter *iter;
1215 g_return_val_if_fail (line != NULL, NULL);
1216 g_return_val_if_fail (index_ranges != NULL, NULL);
1218 clip_region = gdk_region_new ();
1220 iter = pango_layout_get_iter (line->layout);
1221 while (pango_layout_iter_get_line (iter) != line)
1222 pango_layout_iter_next_line (iter);
1224 pango_layout_iter_get_line_extents (iter, NULL, &logical_rect);
1225 baseline = pango_layout_iter_get_baseline (iter);
1227 pango_layout_iter_free (iter);
1230 while (i < n_ranges)
1232 gint *pixel_ranges = NULL;
1233 gint n_pixel_ranges = 0;
1236 /* Note that get_x_ranges returns layout coordinates
1238 pango_layout_line_get_x_ranges (line,
1240 index_ranges[i*2+1],
1241 &pixel_ranges, &n_pixel_ranges);
1243 for (j=0; j < n_pixel_ranges; j++)
1247 rect.x = x_origin + pixel_ranges[2*j] / PANGO_SCALE - logical_rect.x / PANGO_SCALE;
1248 rect.y = y_origin - (baseline / PANGO_SCALE - logical_rect.y / PANGO_SCALE);
1249 rect.width = (pixel_ranges[2*j + 1] - pixel_ranges[2*j]) / PANGO_SCALE;
1250 rect.height = logical_rect.height / PANGO_SCALE;
1252 gdk_region_union_with_rect (clip_region, &rect);
1255 g_free (pixel_ranges);
1263 * gdk_pango_layout_get_clip_region:
1264 * @layout: a #PangoLayout
1265 * @x_origin: X pixel where you intend to draw the layout with this clip
1266 * @y_origin: Y pixel where you intend to draw the layout with this clip
1267 * @index_ranges: array of byte indexes into the layout, where even members of array are start indexes and odd elements are end indexes
1268 * @n_ranges: number of ranges in @index_ranges, i.e. half the size of @index_ranges
1270 * Obtains a clip region which contains the areas where the given ranges
1271 * of text would be drawn. @x_origin and @y_origin are the same position
1272 * you would pass to gdk_draw_layout_line(). @index_ranges should contain
1273 * ranges of bytes in the layout's text.
1275 * Return value: a clip region containing the given ranges
1278 gdk_pango_layout_get_clip_region (PangoLayout *layout,
1284 PangoLayoutIter *iter;
1285 GdkRegion *clip_region;
1287 g_return_val_if_fail (PANGO_IS_LAYOUT (layout), NULL);
1288 g_return_val_if_fail (index_ranges != NULL, NULL);
1290 clip_region = gdk_region_new ();
1292 iter = pango_layout_get_iter (layout);
1296 PangoRectangle logical_rect;
1297 PangoLayoutLine *line;
1298 GdkRegion *line_region;
1301 line = pango_layout_iter_get_line (iter);
1303 pango_layout_iter_get_line_extents (iter, NULL, &logical_rect);
1304 baseline = pango_layout_iter_get_baseline (iter);
1306 line_region = gdk_pango_layout_line_get_clip_region (line,
1307 x_origin + logical_rect.x / PANGO_SCALE,
1308 y_origin + baseline / PANGO_SCALE,
1312 gdk_region_union (clip_region, line_region);
1313 gdk_region_destroy (line_region);
1315 while (pango_layout_iter_next_line (iter));
1317 pango_layout_iter_free (iter);
1323 * gdk_pango_context_get:
1325 * Creates a #PangoContext for the default GDK screen.
1327 * The context must be freed when you're finished with it.
1329 * When using GTK+, normally you should use gtk_widget_get_pango_context()
1330 * instead of this function, to get the appropriate context for
1331 * the widget you intend to render text onto.
1333 * Return value: a new #PangoContext for the default display
1336 gdk_pango_context_get (void)
1338 return gdk_pango_context_get_for_screen (gdk_screen_get_default ());
1342 * gdk_pango_context_get_for_screen:
1343 * @screen: the #GdkScreen for which the context is to be created.
1345 * Creates a #PangoContext for @screen.
1347 * The context must be freed when you're finished with it.
1349 * When using GTK+, normally you should use gtk_widget_get_pango_context()
1350 * instead of this function, to get the appropriate context for
1351 * the widget you intend to render text onto.
1353 * Return value: a new #PangoContext for @screen
1358 gdk_pango_context_get_for_screen (GdkScreen *screen)
1360 PangoFontMap *fontmap;
1362 g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
1364 fontmap = pango_cairo_font_map_get_default ();
1366 return pango_cairo_font_map_create_context (PANGO_CAIRO_FONT_MAP (fontmap));
1369 #define __GDK_PANGO_C__
1370 #include "gdkaliasdef.c"