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

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

<refentry xml:id="function.ps-get-parameter" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_get_parameter</refname>
  <refpurpose>Récupère certains paramètres</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>ps_get_parameter</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 paramètres qui ont été fixés directement par
   <function>ps_set_parameter</function> ou indirectement par une ou d'autres
   fonctions. Les paramètres sont, par définition,
   des valeurs de &string;. Cette fonction ne peut être utilisée pour
   récupérer les ressources qui ont été aussi fixées par
   <function>ps_set_parameter</function>.
  </para>
  <para>
   Le paramètre <parameter>name</parameter> peut avoir une des valeurs
   suivantes.
  </para>
  <para>
   <variablelist>
    <varlistentry>
     <term><literal>fontname</literal></term>
     <listitem>
      <para>
       Le nom 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>fontencoding</literal></term>
     <listitem>
      <para>
       L'encodage de la police présentement active.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>dottedversion</literal></term>
     <listitem>
      <para>
       La version la bibliothèque sous-jacente pslib dans le format
       &lt;majeur&gt;.&lt;mineur&gt;.&lt;sousmineur&gt;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>scope</literal></term>
     <listitem>
      <para>
       La portée courante du dessin. Peut être un objet, un document, &null;,
       une page, un motif, un chemin, un modèle, un prolog, une police, un
       glyphe.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>ligaturedisolvechar</literal></term>
     <listitem>
      <para>
       Le caractère qui détache une ligature. Si vous utilisez une police qui
       contient une ligature `ff' et `|` est le caractère à détacher la
       ligature, alors `f|f' donnera deux `f' au lieu de la ligature `ff'.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>imageencoding</literal></term>
     <listitem>
      <para>
       L'encodage utilisé pour encoder les images. Peut être soit
       <literal>hex</literal> ou <literal>85</literal>. L'encodage hex utilise
       deux octets dans le fichier PostScript, chaque octet dans une image. 
       85 représente l'encodage Ascii85.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>linenumbermode</literal></term>
     <listitem>
      <para>
       Fixe à <literal>paragraph</literal> si des lignes sont numérotées à
       l'intérieur d'un paragraphe ou <literal>box</literal> si elles sont
       numérotées dans une boîte qui l'entoure.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>linebreak</literal></term>
     <listitem>
      <para>
       Seulement utilisé si le texte est affiché avec
       <function>ps_show_boxed</function>. Si fixé à &true;, un retour au
       chariot ajoutera un saut de ligne.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>parbreak</literal></term>
     <listitem>
      <para>
       Seulement utilisé si le texte est affiché avec
       <function>ps_show_boxed</function>. Si fixé à &true;, un retour au
       chariot démarrera un nouveau paragraphe.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>hyphenation</literal></term>
     <listitem>
      <para>
       Seulement utilisé si le texte est affiché avec
       <function>ps_show_boxed</function>. Si fixé à &true;, le paragraphe
       sera divisé si un dictionnaire de trait d'union est fixé et existe.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><literal>hyphendict</literal></term>
     <listitem>
      <para>
       Nom du fichier du dictionnaire utilisé pour le motif de trait d'union.
      </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 du paramètre.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>modifier</parameter></term>
     <listitem>
      <para>
       Un identifiant requis si le paramètre d'une ressource est requis,
       par exemple, la taille d'une image. Dans ce cas, l'identifiant de la
       ressource est passé.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne la valeur du paramètre &return.falseforfailure;.
  </para>
 </refsect1>

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