pango-renderer.xml

Pango is a library for layout and rendering of text, with an emphasis on internationalization. Pang

</varlistentry>
<varlistentry>
<term><structfield>draw_rectangle</structfield>&nbsp;()</term>
<listitem><simpara> draws a rectangle
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>draw_error_underline</structfield>&nbsp;()</term>
<listitem><simpara> draws a squiggly line that approximately
covers the given rectangle in the style of an underline used to
indicate a spelling error.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>draw_shape</structfield>&nbsp;()</term>
<listitem><simpara> draw content for a glyph shaped with <link linkend="PangoAttrShape"><type>PangoAttrShape</type></link>.
  <parameter>x</parameter>, <parameter>y</parameter> are the coordinates of the left edge of the baseline,
  in user coordinates.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>draw_trapezoid</structfield>&nbsp;()</term>
<listitem><simpara> draws a trapezoidal filled area
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>draw_glyph</structfield>&nbsp;()</term>
<listitem><simpara> draws a single glyph
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>part_changed</structfield>&nbsp;()</term>
<listitem><simpara> do renderer specific processing when rendering
 attributes change
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>begin</structfield>&nbsp;()</term>
<listitem><simpara> Do renderer-specific initialization before drawing
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>end</structfield>&nbsp;()</term>
<listitem><simpara> Do renderer-specific cleanup after drawing
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>prepare_run</structfield>&nbsp;()</term>
<listitem><simpara> updates the renderer for a new run
</simpara></listitem>
</varlistentry>
</variablelist><para role="since">Since  1.8
</para></refsect2>
<refsect2 id="pango-renderer-draw-layout" role="function" condition="since:1.8">
<title>pango_renderer_draw_layout ()</title>
<indexterm zone="pango-renderer-draw-layout" role="1.8"><primary>pango_renderer_draw_layout</primary></indexterm><programlisting><link linkend="void">void</link>                pango_renderer_draw_layout          (<link linkend="PangoRenderer">PangoRenderer</link> *renderer,
                                                         <link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="int">int</link> x,
                                                         <link linkend="int">int</link> y);</programlisting>
<para>
Draws <parameter>layout</parameter> with the specified <link linkend="PangoRenderer"><type>PangoRenderer</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoRenderer"><type>PangoRenderer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>layout</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoLayout"><type>PangoLayout</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara> X position of left edge of baseline, in user space coordinates
  in Pango units.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> Y position of left edge of baseline, in user space coordinates
   in Pango units.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.8
</para></refsect2>
<refsect2 id="pango-renderer-draw-layout-line" role="function" condition="since:1.8">
<title>pango_renderer_draw_layout_line ()</title>
<indexterm zone="pango-renderer-draw-layout-line" role="1.8"><primary>pango_renderer_draw_layout_line</primary></indexterm><programlisting><link linkend="void">void</link>                pango_renderer_draw_layout_line     (<link linkend="PangoRenderer">PangoRenderer</link> *renderer,
                                                         <link linkend="PangoLayoutLine">PangoLayoutLine</link> *line,
                                                         <link linkend="int">int</link> x,
                                                         <link linkend="int">int</link> y);</programlisting>
<para>
Draws <parameter>line</parameter> with the specified <link linkend="PangoRenderer"><type>PangoRenderer</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoRenderer"><type>PangoRenderer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>line</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara> X position of left edge of baseline, in user space coordinates
  in Pango units.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> Y position of left edge of baseline, in user space coordinates
   in Pango units.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.8
</para></refsect2>
<refsect2 id="pango-renderer-draw-glyphs" role="function" condition="since:1.8">
<title>pango_renderer_draw_glyphs ()</title>
<indexterm zone="pango-renderer-draw-glyphs" role="1.8"><primary>pango_renderer_draw_glyphs</primary></indexterm><programlisting><link linkend="void">void</link>                pango_renderer_draw_glyphs          (<link linkend="PangoRenderer">PangoRenderer</link> *renderer,
                                                         <link linkend="PangoFont">PangoFont</link> *font,
                                                         <link linkend="PangoGlyphString">PangoGlyphString</link> *glyphs,
                                                         <link linkend="int">int</link> x,
                                                         <link linkend="int">int</link> y);</programlisting>
<para>
Draws the glyphs in <parameter>glyphs</parameter> with the specified <link linkend="PangoRenderer"><type>PangoRenderer</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoRenderer"><type>PangoRenderer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>font</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>glyphs</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoGlyphString"><type>PangoGlyphString</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara> X position of left edge of baseline, in user space coordinates
  in Pango units.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> Y position of left edge of baseline, in user space coordinates
   in Pango units.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.8
</para></refsect2>
<refsect2 id="pango-renderer-draw-rectangle" role="function" condition="since:1.8">
<title>pango_renderer_draw_rectangle ()</title>
<indexterm zone="pango-renderer-draw-rectangle" role="1.8"><primary>pango_renderer_draw_rectangle</primary></indexterm><programlisting><link linkend="void">void</link>                pango_renderer_draw_rectangle       (<link linkend="PangoRenderer">PangoRenderer</link> *renderer,
                                                         <link linkend="PangoRenderPart">PangoRenderPart</link> part,
                                                         <link linkend="int">int</link> x,
                                                         <link linkend="int">int</link> y,
                                                         <link linkend="int">int</link> width,
                                                         <link linkend="int">int</link> height);</programlisting>
<para>
Draws an axis-aligned rectangle in user space coordinates with the
specified <link linkend="PangoRenderer"><type>PangoRenderer</type></link>.
</para>
<para>
This should be called while <parameter>renderer</parameter> is already active.  Use
<link linkend="pango-renderer-activate"><function>pango_renderer_activate()</function></link> to activate a renderer.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoRenderer"><type>PangoRenderer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>part</parameter>&nbsp;:</term>
<listitem><simpara> type of object this rectangle is part of
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara> X position at which to draw rectangle, in user space coordinates in Pango units
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> Y position at which to draw rectangle, in user space coordinates in Pango units
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> width of rectangle in Pango units in user space coordinates
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> height of rectangle in Pango units in user space coordinates
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.8
</para></refsect2>
<refsect2 id="pango-renderer-draw-error-underline" role="function" condition="since:1.8">
<title>pango_renderer_draw_error_underline ()</title>
<indexterm zone="pango-renderer-draw-error-underline" role="1.8"><primary>pango_renderer_draw_error_underline</primary></indexterm><programlisting><link linkend="void">void</link>                pango_renderer_draw_error_underline (<link linkend="PangoRenderer">PangoRenderer</link> *renderer,
                                                         <link linkend="int">int</link> x,
                                                         <link linkend="int">int</link> y,
                                                         <link linkend="int">int</link> width,
                                                         <link linkend="int">int</link> height);</programlisting>
<para>
Draw a squiggly line that approximately covers the given rectangle
in the style of an underline used to indicate a spelling error.
(The width of the underline is rounded to an integer number
of up/down segments and the resulting rectangle is centered
in the original rectangle)
</para>
<para>
This should be called while <parameter>renderer</parameter> is already active.  Use
<link linkend="pango-renderer-activate"><function>pango_renderer_activate()</function></link> to activate a renderer.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoRenderer"><type>PangoRenderer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara> X coordinate of underline, in Pango units in user coordinate system
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> Y coordinate of underline, in Pango units in user coordinate system
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> width of underline, in Pango units in user coordinate system
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> height of underline, in Pango units in user coordinate system
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.8
</para></refsect2>
<refsect2 id="pango-renderer-draw-trapezoid" role="function" condition="since:1.8">
<title>pango_renderer_draw_trapezoid ()</title>
<indexterm zone="pango-renderer-draw-trapezoid" role="1.8"><primary>pango_renderer_draw_trapezoid</primary></indexterm><programlisting><link linkend="void">void</link>                pango_renderer_draw_trapezoid       (<link linkend="PangoRenderer">PangoRenderer</link> *renderer,
                                                         <link linkend="PangoRenderPart">PangoRenderPart</link> part,
                                                         <link linkend="double">double</link> y1_,
                                                         <link linkend="double">double</link> x11,
                                                         <link linkend="double">double</link> x21,
                                                         <link linkend="double">double</link> y2,
                                                         <link linkend="double">double</link> x12,
                                                         <link linkend="double">double</link> x22);</programlisting>
<para>
Draws a trapezoid with the parallel sides aligned with the X axis
using the given <link linkend="PangoRenderer"><type>PangoRenderer</type></link>; coordinates are in device space.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoRenderer"><type>PangoRenderer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>part</parameter>&nbsp;:</term>
<listitem><simpara> type of object this trapezoid is part of
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y1_</parameter>&nbsp;:</term>
<listitem><simpara> Y coordinate of top of trapezoid
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x11</parameter>&nbsp;:</term>
<listitem><simpara> X coordinate of left end of top of trapezoid
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x21</parameter>&nbsp;:</term>