php-doc-en/reference/printer/functions/printer-create-font.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.printer-create-font" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>printer_create_font</refname>
  <refpurpose>Create a new font</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</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>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>face</parameter></term>
     <listitem>
      <para>
       <parameter>face</parameter> must be a string specifying the font face.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>height</parameter></term>
     <listitem>
      <para>
       <parameter>height</parameter> specifies the font height.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>width</parameter></term>
     <listitem>
      <para>
       <parameter>width</parameter> specifies the font width. 
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>font_weight</parameter></term>
     <listitem>
      <para>
       The <parameter>font_weight</parameter> specifies the font weight
       (400 is normal), and can be one of the following predefined constants.
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>PRINTER_FW_THIN</constant>:
          sets the font weight to thin (100).
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>PRINTER_FW_ULTRALIGHT</constant>:
          sets the font weight to ultra light (200).
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>PRINTER_FW_LIGHT</constant>:
          sets the font weight to light (300).
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>PRINTER_FW_NORMAL</constant>:
          sets the font weight to normal (400).
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>PRINTER_FW_MEDIUM</constant>:
          sets the font weight to medium (500).
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>PRINTER_FW_BOLD</constant>:
          sets the font weight to bold (700).
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>PRINTER_FW_ULTRABOLD</constant>:
          sets the font weight to ultra bold (800).
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>PRINTER_FW_HEAVY</constant>:
          sets the font weight to heavy (900).
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>italic</parameter></term>
     <listitem>
      <para>
       <parameter>italic</parameter> can be &true; or &false;,
       and sets whether the font should be italic.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>underline</parameter></term>
     <listitem>
      <para>
       <parameter>underline</parameter> can be &true; or &false;,
       and sets whether the font should be underlined.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>strikeout</parameter></term>
     <listitem>
      <para>
       <parameter>strikeout</parameter> can be &true; or &false;,
       and sets whether the font should be stroked out.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>orientaton</parameter></term>
     <listitem>
      <para>
       <parameter>orientation</parameter> specifies a rotation.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a font handle on success or &false; on error.
  </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:"~/.phpdoc/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
-->