php-doc-en/reference/printer/functions/printer-create-font.xml
Damien Seguy f188fe0f32 typo in argument
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@165829 c90b9560-bf6c-de11-be94-00142212c4b1
2004-08-09 16:23:47 +00:00

119 lines
4 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/printer.xml, last change in rev 1.6 -->
<refentry id="function.printer-create-font">
<refnamediv>
<refname>printer_create_font</refname>
<refpurpose>Create a new font</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>printer_create_font</methodname>
<methodparam><type>string</type><parameter>face</parameter></methodparam>
<methodparam><type>int</type><parameter>height</parameter></methodparam>
<methodparam><type>int</type><parameter>width</parameter></methodparam>
<methodparam><type>int</type><parameter>font_weight</parameter></methodparam>
<methodparam><type>bool</type><parameter>italic</parameter></methodparam>
<methodparam><type>bool</type><parameter>underline</parameter></methodparam>
<methodparam><type>bool</type><parameter>strikeout</parameter></methodparam>
<methodparam><type>int</type><parameter>orientation</parameter></methodparam>
</methodsynopsis>
<para>
The function creates a new font and returns a handle to it. A font is
used to draw text. For an example see
<function>printer_select_font</function>. <parameter>face</parameter>
must be a string specifying the font face. <parameter>height</parameter>
specifies the font height, and <parameter>width</parameter> the font
width. The <parameter>font_weight</parameter> specifies the font weight
(400 is normal), and can be one of the following predefined constants.
<itemizedlist>
<listitem>
<simpara>
<parameter>PRINTER_FW_THIN</parameter>:
sets the font weight to thin (100).
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>PRINTER_FW_ULTRALIGHT</parameter>:
sets the font weight to ultra light (200).
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>PRINTER_FW_LIGHT</parameter>:
sets the font weight to light (300).
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>PRINTER_FW_NORMAL</parameter>:
sets the font weight to normal (400).
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>PRINTER_FW_MEDIUM</parameter>:
sets the font weight to medium (500).
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>PRINTER_FW_BOLD</parameter>:
sets the font weight to bold (700).
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>PRINTER_FW_ULTRABOLD</parameter>:
sets the font weight to ultra bold (800).
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>PRINTER_FW_HEAVY</parameter>:
sets the font weight to heavy (900).
</simpara>
</listitem>
</itemizedlist>
</para>
<para>
<parameter>italic</parameter> can be &true; or &false;,
and sets whether the font should be italic.
</para>
<para>
<parameter>underline</parameter> can be &true; or &false;,
and sets whether the font should be underlined.
</para>
<para>
<parameter>strikeout</parameter> can be &true; or &false;,
and sets whether the font should be stroked out.
</para>
<para>
<parameter>orientation</parameter> specifies a rotation.
For an example see <function>printer_select_font</function>.
</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
-->