Files
doc-fr/reference/ps/functions/ps-set-info.xml
2010-03-29 00:47:47 +00:00

130 lines
4.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: jsgoupil Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.ps-set-info" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ps_set_info</refname>
<refpurpose>Assigne les champs d'informations d'un document</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ps_set_info</methodname>
<methodparam><type>resource</type><parameter>p</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>val</parameter></methodparam>
</methodsynopsis>
<para>
<function>ps_set_info</function> fixe certains champs d'informations du document.
Les champs seront montrés en tant que commentaire dans l'en-tête du fichier
PostScript. Si le document est converti en PDF, ces champs seront aussi
utilisés pour les informations du document.
</para>
<para>
Le <literal>BoundingBox</literal> est normalement fixé à la valeur donnée
par la première page. Cela fonctionne seulement si
<function>ps_findfont</function> n'a pas été appelée auparavant. Dans ces
cas, le BoundingBox sera laissé non fixé à moins que vous le fixé
explicitement avec cette fonction.
</para>
<para>
Cette fonction n'aura plus d'effet lorsque l'en-tête du fichier PostScript
a été déjà été écrit. Elle doit être appelée avant la première page ou le
premier appel de <function>ps_findfont</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>psdoc</parameter></term>
<listitem>
<para>
Identifiant de ressource PostScript,
retourné par <function>ps_new</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
Le nom du champ d'information à configurer. Les valeurs de noms
possibles sont <literal>Keywords</literal>, <literal>Subject</literal>,
<literal>Title</literal>, <literal>Creator</literal>,
<literal>Author</literal>, <literal>BoundingBox</literal> et
<literal>Orientation</literal>. Soyez attentifs, car certains champs
ont des significations spéciales pour les lecteurs PostScript.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
Les valeurs du champ d'information. Le champ
<literal>Orientation</literal> peut être fixé à soit
<literal>Portrait</literal> ou <literal>Landscape</literal>. Le
<literal>BoundingBox</literal> est une &string; contenant quatre
nombres. Les deux premiers sont les coordonnées du coin inférieur
gauche de la page. Les deux derniers sont les coordonnées du coin
supérieur droit.
</para>
<note>
<para>
Jusqu'à la version 0.2.6 de pslib, le BoundingBox et Orientation
seront toujours écrasés par <function>ps_begin_page</function>, à
moins que <function>ps_findfont</function> ait été appelée avant.
</para>
</note>
</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_findfont</function></member>
<member><function>ps_begin_page</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
-->