ps-stringwidth.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/ps.xml, last change in rev  -->
<refentry xml:id="function.ps-stringwidth" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_stringwidth</refname>
  <refpurpose>Gets width of a string</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>float</type><methodname>ps_stringwidth</methodname>
   <methodparam><type>resource</type><parameter>psdoc</parameter></methodparam>
   <methodparam><type>string</type><parameter>text</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>fontid</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>float</type><parameter>size</parameter><initializer>0.0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Calculates the width of a string in points if it was output
   in the given font and font size.
   This function needs an Adobe font
   metrics file to calculate the precise width. If kerning is turned on,
   it will be taken into account.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>psdoc</parameter></term>
     <listitem>
      <para>
       Resource identifier of the postscript file
       as returned by <function>ps_new</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>text</parameter></term>
     <listitem>
      <para>
       The text for which the width is to be calculated.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>fontid</parameter></term>
     <listitem>
      <para>
       The identifier of the font to be used. If not font is specified
       the current font will be used.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>size</parameter></term>
     <listitem>
      <para>
       The size of the font. If no size is specified the current size
       is used.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Width of a string in points.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ps_string_geometry</function></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:"~/.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
-->