Files
doc-fr/reference/ps/functions/ps-add-bookmark.xml
T
2014-09-05 20:58:33 +00:00

115 lines
3.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 14af302c9c0e561fa6f9cdd956268758ba9a89c5 Maintainer: dams Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.ps-add-bookmark" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ps_add_bookmark</refname>
<refpurpose>Ajoute un signet à la page courante</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ps_add_bookmark</methodname>
<methodparam><type>resource</type><parameter>psdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>text</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>parent</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>open</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Ajoute un signet pour la page courante. Les signets apparaissent
normalement dans les lecteurs PDF sur la gauche de la page dans un arbre
hiérarchique. Cliquer sur un signet sautera à la page donnée.
</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>text</parameter></term>
<listitem>
<para>
Le texte utilisé pour afficher le signet.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>parent</parameter></term>
<listitem>
<para>
Un signet précédemment créé par cette fonction qui est
utilisé comme parent du nouveau signet.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>open</parameter></term>
<listitem>
<para>
Si <parameter>open</parameter> n'est pas égal à zéro, le signet sera
montré ouvert dans le lecteur PDF.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
La valeur retournée est une référence pour le signet. Cela est utilisé
seulement si le signet doit être utilisé en tant que parent. La valeur est
supérieure à zéro si la fonction réussit. En cas d'erreur, &zero; sera
retourné.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ps_add_launchlink</function></member>
<member><function>ps_add_pdflink</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:"~/.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
-->