win32-fonts.xml

linux

<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>         the x position of start of string (in pixels)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara>         the y position of baseline (in pixels)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-win32-render-layout" role="function"/>pango_win32_render_layout ()</title>
<indexterm><primary>pango_win32_render_layout</primary></indexterm><programlisting><link linkend="void">void</link>                pango_win32_render_layout           (<link linkend="HDC:CAPS">HDC</link> hdc,
                                                         <link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="int">int</link> x,
                                                         <link linkend="int">int</link> y);</programlisting>
<para>
Render a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link> onto an X drawable</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>hdc</parameter>&nbsp;:</term>
<listitem><simpara>       HDC to use for uncolored drawing
</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>         the X position of the left of the layout (in pixels)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara>         the Y position of the top of the layout (in pixels)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-win32-get-unknown-glyph" role="function" condition="deprecated:"/>pango_win32_get_unknown_glyph ()</title>
<indexterm role="deprecated"><primary>pango_win32_get_unknown_glyph</primary></indexterm><programlisting><link linkend="PangoGlyph">PangoGlyph</link>          pango_win32_get_unknown_glyph       (<link linkend="PangoFont">PangoFont</link> *font,
                                                         <link linkend="gunichar">gunichar</link> wc);</programlisting>
<warning><para><literal>pango_win32_get_unknown_glyph</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Returns the index of a glyph suitable for drawing <parameter>wc</parameter> as an
unknown character.
</para>
<para>
Use <link linkend="PANGO-GET-UNKNOWN-GLYPH:CAPS"><function>PANGO_GET_UNKNOWN_GLYPH()</function></link> instead.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>font</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>wc</parameter>&nbsp;:</term>
<listitem><simpara> the Unicode character for which a glyph is needed.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a glyph index into <parameter>font</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-win32-font-get-glyph-index" role="function"/>pango_win32_font_get_glyph_index ()</title>
<indexterm><primary>pango_win32_font_get_glyph_index</primary></indexterm><programlisting><link linkend="gint">gint</link>                pango_win32_font_get_glyph_index    (<link linkend="PangoFont">PangoFont</link> *font,
                                                         <link linkend="gunichar">gunichar</link> wc);</programlisting>
<para>
Obtains the index of the glyph for <parameter>wc</parameter> in <parameter>font</parameter>, or 0, if not
covered.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>font</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>wc</parameter>&nbsp;:</term>
<listitem><simpara> a Unicode character.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the glyph index for <parameter>wc</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-win32-font-select-font" role="function"/>pango_win32_font_select_font ()</title>
<indexterm><primary>pango_win32_font_select_font</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_win32_font_select_font        (<link linkend="PangoFont">PangoFont</link> *font,
                                                         <link linkend="HDC:CAPS">HDC</link> hdc);</programlisting>
<para>
Selects the font into the specified DC and changes the mapping mode
and world transformation of the DC appropriately for the font.
You may want to surround the use of this function with calls
to <link linkend="SaveDC"><function>SaveDC()</function></link> and <link linkend="RestoreDC"><function>RestoreDC()</function></link>. Call <link linkend="pango-win32-font-done-font"><function>pango_win32_font_done_font()</function></link> when
you are done using the DC to release allocated resources.
</para>
<para>
See <link linkend="pango-win32-font-get-metrics-factor"><function>pango_win32_font_get_metrics_factor()</function></link> for information about
converting from the coordinate space used by this function
into Pango units.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>font</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link> from the Win32 backend
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hdc</parameter>&nbsp;:</term>
<listitem><simpara> a windows device context
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the operation succeeded.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-win32-font-done-font" role="function"/>pango_win32_font_done_font ()</title>
<indexterm><primary>pango_win32_font_done_font</primary></indexterm><programlisting><link linkend="void">void</link>                pango_win32_font_done_font          (<link linkend="PangoFont">PangoFont</link> *font);</programlisting>
<para>
Releases any resources allocated by <link linkend="pango-win32-font-done-font"><function>pango_win32_font_done_font()</function></link></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>font</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link> from the win32 backend
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-win32-font-get-metrics-factor" role="function"/>pango_win32_font_get_metrics_factor ()</title>
<indexterm><primary>pango_win32_font_get_metrics_factor</primary></indexterm><programlisting><link linkend="double">double</link>              pango_win32_font_get_metrics_factor (<link linkend="PangoFont">PangoFont</link> *font);</programlisting>
<para>
Returns the scale factor from logical units in the coordinate
space used by <link linkend="pango-win32-font-select-font"><function>pango_win32_font_select_font()</function></link> to Pango units
in user space.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>font</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link> from the win32 backend
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> factor to multiply logical units by to get Pango
              units.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-win32-get-debug-flag" role="function" condition="since:1.2"/>pango_win32_get_debug_flag ()</title>
<indexterm role="1.2"><primary>pango_win32_get_debug_flag</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_win32_get_debug_flag          (void);</programlisting>
<para>
Returns whether debugging is turned on.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if debugging is turned on.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.2
</para></refsect2>
<refsect2>
<title><anchor id="pango-win32-get-dc" role="function"/>pango_win32_get_dc ()</title>
<indexterm><primary>pango_win32_get_dc</primary></indexterm><programlisting><link linkend="HDC:CAPS">HDC</link>                 pango_win32_get_dc                  (void);</programlisting>
<para>
Obtains a handle to the Windows device context that is used by Pango.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A handle to the Windows device context that is used by Pango.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="PangoWin32FontCache" role="struct"/>PangoWin32FontCache</title>
<indexterm><primary>PangoWin32FontCache</primary></indexterm><programlisting>typedef struct _PangoWin32FontCache PangoWin32FontCache;</programlisting>
<para>
A <link linkend="PangoWin32FontCache"><type>PangoWin32FontCache</type></link> caches
HFONTs by their LOGFONT descriptions. 
</para></refsect2>
<refsect2>
<title><anchor id="pango-win32-font-cache-new" role="function"/>pango_win32_font_cache_new ()</title>
<indexterm><primary>pango_win32_font_cache_new</primary></indexterm><programlisting><link linkend="PangoWin32FontCache">PangoWin32FontCache</link>* pango_win32_font_cache_new         (void);</programlisting>
<para>
Creates a font cache.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The new font cache. This must be freed with
<link linkend="pango-win32-font-cache-free"><function>pango_win32_font_cache_free()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-win32-font-cache-free" role="function"/>pango_win32_font_cache_free ()</title>
<indexterm><primary>pango_win32_font_cache_free</primary></indexterm><programlisting><link linkend="void">void</link>                pango_win32_font_cache_free         (<link linkend="PangoWin32FontCache">PangoWin32FontCache</link> *cache);</programlisting>
<para>
Frees a <link linkend="PangoWin32FontCache"><type>PangoWin32FontCache</type></link> and all associated memory. All fonts loaded
through this font cache will be freed along with the cache.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>cache</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoWin32FontCache"><type>PangoWin32FontCache</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-win32-font-cache-load" role="function"/>pango_win32_font_cache_load ()</title>
<indexterm><primary>pango_win32_font_cache_load</primary></indexterm><programlisting><link linkend="HFONT:CAPS">HFONT</link>               pango_win32_font_cache_load         (<link linkend="PangoWin32FontCache">PangoWin32FontCache</link> *cache,
                                                         const <link linkend="LOGFONTA:CAPS">LOGFONTA</link> *logfont);</programlisting>
<para>
Creates a HFONT from a LOGFONTA. The