pangofc-font.xml

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

<refentry id="PangoFcFont">
<refmeta>
<refentrytitle role="top_of_page" id="PangoFcFont.top_of_page">PangoFcFont</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>PANGO Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>PangoFcFont</refname>
<refpurpose>Base font class for Fontconfig-based backends</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="PangoFcFont.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="PangoFcFont-struct">PangoFcFont</link>;
                    <link linkend="PangoFcFontClass">PangoFcFontClass</link>;
#define             <link linkend="PANGO-RENDER-TYPE-FC:CAPS">PANGO_RENDER_TYPE_FC</link>
<link linkend="FT-Face">FT_Face</link>             <link linkend="pango-fc-font-lock-face">pango_fc_font_lock_face</link>             (<link linkend="PangoFcFont">PangoFcFont</link> *font);
<link linkend="void">void</link>                <link linkend="pango-fc-font-unlock-face">pango_fc_font_unlock_face</link>           (<link linkend="PangoFcFont">PangoFcFont</link> *font);
<link linkend="gboolean">gboolean</link>            <link linkend="pango-fc-font-has-char">pango_fc_font_has_char</link>              (<link linkend="PangoFcFont">PangoFcFont</link> *font,
                                                         <link linkend="gunichar">gunichar</link> wc);
<link linkend="guint">guint</link>               <link linkend="pango-fc-font-get-glyph">pango_fc_font_get_glyph</link>             (<link linkend="PangoFcFont">PangoFcFont</link> *font,
                                                         <link linkend="gunichar">gunichar</link> wc);
<link linkend="PangoGlyph">PangoGlyph</link>          <link linkend="pango-fc-font-get-unknown-glyph">pango_fc_font_get_unknown_glyph</link>     (<link linkend="PangoFcFont">PangoFcFont</link> *font,
                                                         <link linkend="gunichar">gunichar</link> wc);
<link linkend="void">void</link>                <link linkend="pango-fc-font-kern-glyphs">pango_fc_font_kern_glyphs</link>           (<link linkend="PangoFcFont">PangoFcFont</link> *font,
                                                         <link linkend="PangoGlyphString">PangoGlyphString</link> *glyphs);
</synopsis>
</refsynopsisdiv>

<refsect1 id="PangoFcFont.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="PangoFont">PangoFont</link>
         +----PangoFcFont
               +----<link linkend="PangoXftFont">PangoXftFont</link>
</synopsis>

</refsect1>





<refsect1 id="PangoFcFont.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="PangoFcFont--pattern">pattern</link>&quot;                  <link linkend="gpointer">gpointer</link>              : Write / Construct Only
</synopsis>
</refsect1>



<refsect1 id="PangoFcFont.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="PangoFcFont"><type>PangoFcFont</type></link> is a base class for font implementation using the
Fontconfig and FreeType libraries. It is used in the
<link linkend="pango-Xft-Fonts-and-Rendering">Xft</link> and
<link linkend="pango-FreeType-Fonts-and-Rendering">FreeType</link>
backends shipped with Pango, but can also be used when creating
new backends. Any backend deriving from this base class will 
take advantage of the wide range of shapers implemented using
FreeType that come with Pango.
</para>
</refsect1>

<refsect1 id="PangoFcFont.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="PangoFcFont-struct" role="struct">
<title>PangoFcFont</title>
<indexterm zone="PangoFcFont-struct"><primary>PangoFcFont</primary></indexterm><programlisting>typedef struct _PangoFcFont PangoFcFont;</programlisting>
<para>
<link linkend="PangoFcFont"><type>PangoFcFont</type></link> is a base class for font implementations
using the Fontconfig and FreeType libraries and is used in
conjunction with <link linkend="PangoFcFontMap"><type>PangoFcFontMap</type></link>. When deriving from this
class, you need to implement all of its virtual functions
other than <link linkend="shutdown"><function>shutdown()</function></link> along with the <link linkend="get-glyph-extents"><function>get_glyph_extents()</function></link>
virtual function from <link linkend="PangoFont"><type>PangoFont</type></link>.</para>
<para>

</para></refsect2>
<refsect2 id="PangoFcFontClass" role="struct">
<title>PangoFcFontClass</title>
<indexterm zone="PangoFcFontClass"><primary>PangoFcFontClass</primary></indexterm><programlisting>typedef struct {
  FT_Face    (*lock_face)         (PangoFcFont      *font);
  void       (*unlock_face)       (PangoFcFont      *font);
  gboolean   (*has_char)          (PangoFcFont      *font,
				   gunichar          wc);
  guint      (*get_glyph)         (PangoFcFont      *font,
				   gunichar          wc);
  PangoGlyph (*get_unknown_glyph) (PangoFcFont      *font,
				   gunichar          wc);
  void       (*shutdown)          (PangoFcFont      *font);
} PangoFcFontClass;
</programlisting>
<para>
Class structure for <link linkend="PangoFcFont"><type>PangoFcFont</type></link>.</para>
<para>

</para><variablelist role="struct">
<varlistentry>
<term><structfield>lock_face</structfield>&nbsp;()</term>
<listitem><simpara> Returns the FT_Face of the font and increases
 the reference count for the face by one.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>unlock_face</structfield>&nbsp;()</term>
<listitem><simpara> Decreases the reference count for the
 FT_Face of the font by one. When the count is zero,
 the <link linkend="PangoFcFont"><type>PangoFcFont</type></link> subclass is allowed to free the
 FT_Face.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>has_char</structfield>&nbsp;()</term>
<listitem><simpara> Return <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the the font contains a glyph
  corresponding to the specified character.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>get_glyph</structfield>&nbsp;()</term>
<listitem><simpara> Gets the glyph that corresponds to the given
  Unicode character.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>get_unknown_glyph</structfield>&nbsp;()</term>
<listitem><simpara> Gets the glyph that should be used to
  display an unknown-glyph indication for the specified
  Unicode character.
  May be <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><structfield>shutdown</structfield>&nbsp;()</term>
<listitem><simpara> Performs any font-specific shutdown code that
  needs to be done when pango_fc_font_map_shutdown is called.
  May be <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="PANGO-RENDER-TYPE-FC:CAPS" role="macro">
<title>PANGO_RENDER_TYPE_FC</title>
<indexterm zone="PANGO-RENDER-TYPE-FC:CAPS"><primary>PANGO_RENDER_TYPE_FC</primary></indexterm><programlisting>#define PANGO_RENDER_TYPE_FC "PangoRenderFc"
</programlisting>
<para>
A string constant used to identify shape engines that work
with the fontconfig based backends. See the <parameter>engine_type</parameter> field