cvs: peardoc /en/pecl ps.xml

steinm Thu Apr 29 08:36:16 2004 EDT Modified files: /peardoc/en/pecl ps.xml Log: - added documentation for ps_set_text_pos(), ps_symbol(), ps_symbol_name(), and ps_symbol_width() http://cvs.php.net/diff.php/peardoc/en/pecl/ps.xml?r1=1.6&r2=1.7&ty=u Index: peardoc/en/pecl/ps.xml diff -u peardoc/en/pecl/ps.xml:1.6 peardoc/en/pecl/ps.xml:1.7 --- peardoc/en/pecl/ps.xml:1.6 Tue Apr 27 04:19:09 2004 +++ peardoc/en/pecl/ps.xml Thu Apr 29 08:36:16 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- Author: Uwe Steinmann <steinm@php.net> --> <reference id="pecl.ps"> <title>PostScript document creation</title> @@ -999,8 +999,12 @@ </funcprototype> </funcsynopsis> - <para>Gets several valus which were set by <function>ps_set_value</function>. - Parameters are by definition float values.</para> + <para>Gets several values which were set by + <function>ps_set_value</function>. + Parameters are by definition float values.</para> + <para>The parameter <parameter>modifier</parameter> specifies the + resource for which the value is to be retrieved. This can be the + id of a font or an image. It must be 0.0 if not used.</para> </refsect1> <refsect1> @@ -1165,7 +1169,8 @@ </funcsynopsis> <para>Creates a new file on disk and writes the PostScript document into - it. The file will be closed when <function>ps_close</function> is called. If filename is + it. The file will be closed when <function>ps_close</function> is called. + If filename is not passed the document will be created in memory and all output will go straight to the browser.</para> @@ -1890,6 +1895,38 @@ </refsect1> </refentry> +<refentry id="pecl.ps.ps-set-text-pos"> + <refnamediv> + <refname>ps_set_test_pos</refname> + + <refpurpose>Sets position for text output</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>bool <function>ps_set_test_pos</function></funcdef> + <paramdef>resource <parameter>psdoc</parameter></paramdef> + <paramdef>float <parameter>x</parameter></paramdef> + <paramdef>float <parameter>y</parameter></paramdef> + + </funcprototype> + </funcsynopsis> + + <para>Set the postion for the next text output. You may alternatively + set the x and y value separately by calling + <function>ps_set_value</function> and choosing 'textx' respectively + 'texty' as the value name.</para> + + </refsect1> + <refsect1> + <title>See also</title> + + <para><function>ps_show</function>, <function>ps_set_value</function></para> + + </refsect1> +</refentry> + <refentry id="pecl.ps.ps-set-value"> <refnamediv> <refname>ps_set_value</refname> @@ -2356,6 +2393,109 @@ </refsect1> </refentry> +<refentry id="pecl.ps.ps-symbol"> + <refnamediv> + <refname>ps_symbol</refname> + + <refpurpose>Output a glyph</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>bool <function>ps_symbol</function></funcdef> + <paramdef>resource <parameter>psdoc</parameter></paramdef> + <paramdef>int <parameter>ord</parameter></paramdef> + + </funcprototype> + </funcsynopsis> + + <para></para> + + </refsect1> + <refsect1> + <title>See also</title> + + <para><function>ps_symbol_width</function>, <function>ps_symbol_name</function></para> + + </refsect1> +</refentry> + +<refentry id="pecl.ps.ps-symbol-name"> + <refnamediv> + <refname>ps_symbol_name</refname> + + <refpurpose>Gets width of a glyph</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>ps_symbol_name</function></funcdef> + <paramdef>resource <parameter>psdoc</parameter></paramdef> + <paramdef>int <parameter>ord</parameter></paramdef> + <paramdef>int <parameter>fontid</parameter></paramdef> + + </funcprototype> + </funcsynopsis> + + <para>Returns the name of a glyph in the given font. + This function needs an Adobe font + metrics file to calculate the precise width. The parameter + <parameter>ord</parameter> is the position of the glyph in the font + encoding vector.</para> + + </refsect1> + <refsect1> + <title>Return value</title> + <para>Name of a glyph.</para> + </refsect1> + <refsect1> + <title>See also</title> + + <para><function>ps_symbol</function>, <function>ps_symbol_width</function></para> + + </refsect1> +</refentry> + +<refentry id="pecl.ps.ps-symbol-width"> + <refnamediv> + <refname>ps_symbol_width</refname> + + <refpurpose>Gets width of a glyph</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>float <function>ps_symbol_width</function></funcdef> + <paramdef>resource <parameter>psdoc</parameter></paramdef> + <paramdef>int <parameter>ord</parameter></paramdef> + <paramdef>int <parameter>fontid</parameter></paramdef> + <paramdef>float <parameter>size</parameter></paramdef> + + </funcprototype> + </funcsynopsis> + + <para>Calculates the width of a glyph 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. The parameter + <parameter>ord</parameter> is the position of the glyph in the font + encoding vector.</para> + + </refsect1> + <refsect1> + <title>Return value</title> + <para>Width of a glyph in points.</para> + </refsect1> + <refsect1> + <title>See also</title> + + <para><function>ps_symbol</function>, <function>ps_symbol_name</function></para> + + </refsect1> +</refentry> + <refentry id="pecl.ps.ps-translate"> <refnamediv> <refname>ps_translate</refname>