<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 -->
<refentry xml:id="function.ps-string-geometry" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_string_geometry</refname>
  <refpurpose>Gets geometry of a string</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>ps_string_geometry</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>
   This function is similar to <function>ps_stringwidth</function> but returns
   an array of dimensions containing the width, ascender, and descender
   of the text.
   </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 geometry 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>
   An array of the dimensions of a string. The element 'width' contains the
   width of the string as returned by <function>ps_stringwidth</function>. The
   element 'descender' contains the maximum descender and 'ascender' the
   maximum ascender of the string.
  </para>
 </refsect1>

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

