doc-fr/reference/ps/functions/ps-add-note.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.8 $ -->
<!-- EN-Revision: 1.9 Maintainer: dams Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="function.ps-add-note" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_add_note</refname>
  <refpurpose>Ajoute une note à la page courante</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ps_add_note</methodname>
   <methodparam><type>resource</type><parameter>psdoc</parameter></methodparam>
   <methodparam><type>float</type><parameter>llx</parameter></methodparam>
   <methodparam><type>float</type><parameter>lly</parameter></methodparam>
   <methodparam><type>float</type><parameter>urx</parameter></methodparam>
   <methodparam><type>float</type><parameter>ury</parameter></methodparam>
   <methodparam><type>string</type><parameter>contents</parameter></methodparam>
   <methodparam><type>string</type><parameter>title</parameter></methodparam>
   <methodparam><type>string</type><parameter>icon</parameter></methodparam>
   <methodparam><type>int</type><parameter>open</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>ps_add_note</function> ajoute une note à une certaine position sur 
   la page. Les notes sont comme de petites feuilles rectangulaires avec du texte
   par dessus, qui peut être placé n'importe où sur une page. Elles sont affichées
   soit pliées ou dépliées. Si elles sont dépliées, l'icône spécifiée est utilisée
   comme un marqueur.
  </para>
  &ps.note.visible;
 </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>llx</parameter></term>
     <listitem>
      <para>
       La position x du coin inférieur gauche.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>lly</parameter></term>
     <listitem>
      <para>
       La position y du coin inférieur gauche.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>urx</parameter></term>
     <listitem>
      <para>
       La position x du coin supérieur droit.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>ury</parameter></term>
     <listitem>
      <para>
       La position y du coin supérieur droit.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>contents</parameter></term>
     <listitem>
      <para>
       Le texte de la note.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>title</parameter></term>
     <listitem>
      <para>
       Le titre de la note affiché en tant qu'en-tête de la note.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>icon</parameter></term>
     <listitem>
      <para>
       L'icône montrée si la note est pliée. Le paramètre peut être fixé à
       <literal>comment</literal>, <literal>insert</literal>,
       <literal>note</literal>, <literal>paragraph</literal>,
       <literal>newparagraph</literal>, <literal>key</literal> ou
       <literal>help</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>open</parameter></term>
     <listitem>
      <para>
       Si <parameter>open</parameter> n'est pas égal à zéro, la note sera
       affichée dépliée après l'ouverture du document dans un visualisateur PDF.
      </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_add_pdflink</function></member>
    <member><function>ps_add_launchlink</function></member>
    <member><function>ps_add_locallink</function></member>
    <member><function>ps_add_weblink</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:"../../../../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
-->