ps-set-value.xml

<?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-set-value" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_set_value</refname>
  <refpurpose>Sets certain values</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ps_set_value</methodname>
   <methodparam><type>resource</type><parameter>psdoc</parameter></methodparam>
   <methodparam><type>string</type><parameter>name</parameter></methodparam>
   <methodparam><type>float</type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
   Sets several values which are used by many functions. Parameters are by
   definition float values.
  </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>name</parameter></term>
     <listitem>
      <para>
       The <parameter>name</parameter> can be one of the following:
       <variablelist>
        <varlistentry>
         <term>textrendering</term>
         <listitem>
          <para>
           The way how text is shown.
          </para>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term>textx</term>
         <listitem>
          <para>
           The x coordinate for text output.
          </para>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term>texty</term>
         <listitem>
          <para>
           The y coordinate for text output.
          </para>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term>wordspacing</term>
         <listitem>
          <para>
           The distance between words relative to the width of a space.
          </para>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term>leading</term>
         <listitem>
          <para>
           The distance between lines in pixels.
          </para>
         </listitem>
        </varlistentry>
       </variablelist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       The value of the parameter.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

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