php-doc-en/reference/ps/functions/ps-get-value.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 -->
<refentry xml:id="function.ps-get-value" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_get_value</refname>
  <refpurpose>Gets certain values</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>float</type><methodname>ps_get_value</methodname>
   <methodparam><type>resource</type><parameter>psdoc</parameter></methodparam>
   <methodparam><type>string</type><parameter>name</parameter></methodparam>
   <methodparam choice="opt"><type>float</type><parameter>modifier</parameter></methodparam>
  </methodsynopsis>
  <para>Gets several values which were set by
   <function>ps_set_value</function>. Values are by definition float values.
  </para>
  <para>
   The parameter <parameter>name</parameter> can have the following values.
  </para>
  <para>
   <variablelist>
    <varlistentry>
     <term><literal>fontsize</literal></term>
     <listitem>
      <para>
       The size of the currently active font or the font whose
       identifier is passed in parameter <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>font</literal></term>
     <listitem>
      <para>
       The currently active font itself.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>imagewidth</literal></term>
     <listitem>
      <para>
       The width of the image whose id is passed in the parameter
       <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>imageheight</literal></term>
     <listitem>
      <para>
       The height of the image whose id is passed in the parameter
       <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>capheight</literal></term>
     <listitem>
      <para>
       The height of a capital M in the currently active font or the font
       whose identifier is passed in parameter
       <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>ascender</literal></term>
     <listitem>
      <para>
       The ascender of the currently active font or the font
       whose identifier is passed in parameter
       <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>descender</literal></term>
     <listitem>
      <para>
       The descender of the currently active font or the font
       whose identifier is passed in parameter
       <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>italicangle</literal></term>
     <listitem>
      <para>
       The italicangle of the currently active font or the font
       whose identifier is passed in parameter
       <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>underlineposition</literal></term>
     <listitem>
      <para>
       The underlineposition of the currently active font or the font
       whose identifier is passed in parameter
       <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>underlinethickness</literal></term>
     <listitem>
      <para>
       The underlinethickness of the currently active font or the font
       whose identifier is passed in parameter
       <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>textx</literal></term>
     <listitem>
      <para>
       The current x-position for text output.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>texty</literal></term>
     <listitem>
      <para>
       The current y-position for text output.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>textrendering</literal></term>
     <listitem>
      <para>
       The current mode for text rendering.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>textrise</literal></term>
     <listitem>
      <para>
       The space by which text is risen above the base line.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>leading</literal></term>
     <listitem>
      <para>
       The distance between text lines in points.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>wordspacing</literal></term>
     <listitem>
      <para>
       The space between words as a multiple of the width of a space char.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>charspacing</literal></term>
     <listitem>
      <para>
       The space between chars. If charspacing is != 0.0 ligatures will
       always be dissolved.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>hyphenminchars</literal></term>
     <listitem>
      <para>
       Minimum number of chars hyphenated at the end of a word.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>parindent</literal></term>
     <listitem>
      <para>
       Indention of the first n line in a paragraph.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>numindentlines</literal></term>
     <listitem>
      <para>
       Number of line in a paragraph to indent if parindent != 0.0.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>parskip</literal></term>
     <listitem>
      <para>
       Distance between paragraphs.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>linenumberspace</literal></term>
     <listitem>
      <para>
       Overall space in front of each line for the line number.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>linenumbersep</literal></term>
     <listitem>
      <para>
       Space between the line and the line number.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>major</literal></term>
     <listitem>
      <para>
       The major version number of pslib.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>minor</literal></term>
     <listitem>
      <para>
       The minor version number of pslib.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>subminor</literal>, <literal>revision</literal></term>
     <listitem>
      <para>
       The subminor version number of pslib.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </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>
       Name of the value.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>modifier</parameter></term>
     <listitem>
      <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.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the value of the parameter or &false;.
  </para>
 </refsect1>

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