doc-fr/reference/ps/functions/ps-begin-page.xml

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

<refentry xml:id="function.ps-begin-page" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ps_begin_page</refname>
  <refpurpose>Démarre une nouvelle page</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ps_begin_page</methodname>
   <methodparam><type>resource</type><parameter>psdoc</parameter></methodparam>
   <methodparam><type>float</type><parameter>width</parameter></methodparam>
   <methodparam><type>float</type><parameter>height</parameter></methodparam>
  </methodsynopsis>
  <para>
   Démarre une nouvelle page. Bien que les paramètres
   <parameter>width</parameter> et <parameter>height</parameter> implique une
   taille différente des feuilles pour chaque page, cela n'est pas possible
   dans PostScript. Le premier appel de <function>ps_begin_page</function>
   fixera la taille des pages pour le document entier. Des appels consécutifs
   n'auront aucun effet, à l'exception pour créer une nouvelle page. La
   situation est différente si vous tentez de convertir le document PostScript
   en PDF. Cette fonction place des marques pdf à l'intérieur du document qui
   peuvent fixer la taille pour chaque page individuellement. Le document PDF
   résultant aura différentes tailles de pages.
  </para>
  <para>
   Bien que le PostScript ne sait pas les tailles des différentes pages, pslib
   place une boîte de contour pour chaque page dans le document. La taille est
   évaluée par quelques lecteurs PostScript et aura précédence sur la
   BoundingBox dans l'en-tête du document. Ceci peut mener à des résultats non
   attendus lorsque vous fixez une BoundingBox dont le coin inférieur gauche n'est pas
   (0, 0), parce que la boîte de contour de la page aura toujours le coin
   inférieur gauche à (0, 0) et écrasera les configurations globales.
  </para>
  <para>
   Chaque page est encapsulée en sauvegarde/restauration. Cela signifie, que la
   plupart des configurations effectuées sur une page ne seront pas retenues sur
   la page suivante.
  </para>
  <para>
   S'il n'y a aucun appel de <function>ps_findfond</function> jusqu'au premier
   appel de <function>ps_begin_page</function>, alors l'en-tête du document
   PostScript sera affichée et le rectangle englobant sera fixé à la taille de
   la première page. Le coin inférieur gauche de la boîte de contour est fixée à
   (0, 0). Si <function>ps_findfont</function> était appelée avant
   que l'en-tête ne soit déjà affichée, le document n'aura pas un rectangle
   englobant valide. Afin de prévenir cela, vous devriez appeler
   <function>ps_set_info</function> pour fixer le champ d'information
   <literal>BoundingBox</literal> et possiblement
   <literal>Orientation</literal> avant d'appeler
   <function>ps_findfont</function> ou <function>ps_begin_page</function>.
  </para>
  <note>
   <para>
    Jusqu'à la version 0.2.6 de pslib, cette fonction écrasera toujours la
    BoundingBox et l'Orientation, si elle n'a pas été fixée avant avec la
    fonction <function>ps_set_info</function> et que la fonction
    <function>ps_findfont</function> n'ait jamais été appelée.
   </para>
  </note>
 </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>width</parameter></term>
     <listitem>
      <para>
       La largeur de la page en pixel, par exemple 596 pour le format A4.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>height</parameter></term>
     <listitem>
      <para>
       La hauteur de la page en pixel, par exemple 842 pour le format A4.
      </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_end_page</function></member>
    <member><function>ps_findfont</function></member>
    <member><function>ps_set_info</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
-->