doc-fr/reference/ps/functions/ps-get-value.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4754397753fd79f1c846868b66a2448babab1c54 Maintainer: jsgoupil Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.ps-get-value" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_get_value</refname>
  <refpurpose>Récupère certaines valeurs</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>
   Récupère plusieurs valeurs qui ont été fixées par
   <function>ps_set_value</function>. Les valeurs sont par définition des
   valeurs de &float;.
  </para>
  <para>
   Le paramètre <parameter>name</parameter> peut avoir une des valeurs
   suivantes.
  </para>
  <para>
   <variablelist>
    <varlistentry>
     <term><literal>fontsize</literal></term>
     <listitem>
      <para>
       La taille de la police présentement active ou la police dont
       l'identifiant est passé dans le paramètre
       <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>font</literal></term>
     <listitem>
      <para>
       La police présentement active en elle-même.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>imagewidth</literal></term>
     <listitem>
      <para>
       La largeur de l'image dont l'identifiant est passé dans le paramètre
       <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>imageheight</literal></term>
     <listitem>
      <para>
       La hauteur de l'image dont l'identifiant est passé dans le paramètre
       <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>capheight</literal></term>
     <listitem>
      <para>
       La hauteur d'une capitale M dans la police présentement active ou la
       police dont l'identifiant est passé dans le paramètre 
       <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>ascender</literal></term>
     <listitem>
      <para>
       La hampe de la police présentement active ou la police dont
       l'identifiant est passé dans le paramètre
       <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>descender</literal></term>
     <listitem>
      <para>
       Le jambage de la police présentement active ou la police dont
       l'identifiant est passé dans le paramètre
       <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>italicangle</literal></term>
     <listitem>
      <para>
       Le paramètre italicangle de la police présentement active ou la police
       dont l'identifiant est passé dans le paramètre 
       <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>underlineposition</literal></term>
     <listitem>
      <para>
       Le paramètre underlineposition de la police présentement active ou la
       police dont l'identifiant est passé dans le paramètre
       <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>underlinethickness</literal></term>
     <listitem>
      <para>
       Le paramètre underlinethickness de la police présentement active ou la
       police dont l'identifiant est passé dans le paramètre
       <parameter>modifier</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>textx</literal></term>
     <listitem>
      <para>
       La position x courante d'affichage du texte.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>texty</literal></term>
     <listitem>
      <para>
       La position y courante d'affichage du texte.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>textrendering</literal></term>
     <listitem>
      <para>
       Le mode courant pour le rendu du texte.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>textrise</literal></term>
     <listitem>
      <para>
       L'espace par lequel le texte est augmenté au dessus de la ligne de
       base.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>leading</literal></term>
     <listitem>
      <para>
       La distance entre les lignes de texte en points.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>wordspacing</literal></term>
     <listitem>
      <para>
       L'espace entre les mots en tant que multiple de la largeur d'un
       caractère d'espace.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>charspacing</literal></term>
     <listitem>
      <para>
       L'espace entre les caractères. Si charspacing est != 0.0, les ligatures
       seront toujours détachées.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>hyphenminchars</literal></term>
     <listitem>
      <para>
       Nombre minimal de caractères avant un trait d'union à la fin d'un mot.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>parindent</literal></term>
     <listitem>
      <para>
       L'indentation des premières n lignes dans un paragraphe.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>numindentlines</literal></term>
     <listitem>
      <para>
       Nombre de ligne dans un paragraphe à indenter si paraindent != 0.0.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>parskip</literal></term>
     <listitem>
      <para>
       Distance entre les paragraphes.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>linenumberspace</literal></term>
     <listitem>
      <para>
       Espace général en face de chaque ligne pour le numéro de ligne.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>linenumbersep</literal></term>
     <listitem>
      <para>
       Espace entre les lignes et les numéros de lignes.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>major</literal></term>
     <listitem>
      <para>
       Le numéro de version majeur de pslib.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>minor</literal></term>
     <listitem>
      <para>
       Le numéro de version mineur de pslib.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>subminor</literal>, <literal>revision</literal></term>
     <listitem>
      <para>
       Le numéro de version sous mineur de pslib.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>psdoc</parameter></term>
     <listitem>
      <para>
       Identifiant d'un fichier postscript retourné par
       <function>ps_new</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       Nom de la valeur. 
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>modifier</parameter></term>
     <listitem>
      <para>
       Le paramètre <parameter>modifier</parameter> spécifie la ressource pour
       laquelle la valeur sera récupérée. Cela peut être l'ID de la police ou
       une image.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne la valeur du paramètre ou &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
-->