php-doc-en/reference/haru/functions/harudoc-loadttc.xml
Hannes Magnusson c030e2adf7 Upgrade to DocBook5:
- All id attributes are now xml:id
 - Add docbook namespace to all root elements
 - Replace <ulink /> with <link xlink:href />
 - Minor markup fixes here and there


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
2007-06-20 22:25:43 +00:00

100 lines
2.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.harudoc-loadttc" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::loadTTC</refname>
<refpurpose>Load the font with the specified index from TTC file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>HaruDoc::loadTTC</methodname>
<methodparam><type>string</type><parameter>fontfile</parameter></methodparam>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>embed</parameter></methodparam>
</methodsynopsis>
<para>
Loads the TrueType font with the specified index from a TrueType collection
file.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fontfile</parameter></term>
<listitem>
<para>
The TrueType collection file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>index</parameter></term>
<listitem>
<para>
The index of the font in the collection file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>embed</parameter></term>
<listitem>
<para>
When set to &true;, the glyph data of the font is embedded into the PDF
file, otherwise only the matrix data is included. Defaults to &false;.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the name of the loaded font on success.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>HaruException</classname> on error.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link linkend="function.harudoc-loadttf"><classname>HaruDoc</classname>::<function>loadTTF</function></link></member>
<member><link linkend="function.harudoc-loadtype1"><classname>HaruDoc</classname>::<function>loadType1</function></link></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->