1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-add-bookmark">
<refnamediv>
<refname>pdf_add_bookmark</refname>
<refpurpose>Adds bookmark for current page</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_add_bookmark</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>text</parameter></methodparam>
<methodparam><type>int</type><parameter>parent</parameter></methodparam>
<methodparam><type>int</type><parameter>open</parameter></methodparam>
</methodsynopsis>
<para>
Add a nested bookmark under <parameter>parent</parameter>, or a new top-level
bookmark if <parameter>parent</parameter> = 0. Returns a bookmark descriptor
which may be used as parent for subsequent nested bookmarks.
If <parameter>open</parameter> = 1, child bookmarks will be folded out, and
invisible if <parameter>open</parameter> = 0.
Parameters <parameter>parent</parameter> and <parameter>open</parameter>
were optional before PHP 5.
</para>
<para>
<example>
<title><function>pdf_add_bookmark</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// create a new PDF
$pdf = pdf_new();
pdf_open_file($pdf);
pdf_set_info($pdf, "Author", "Bob Nijman");
// begin a new page
pdf_begin_page($pdf, 300, 300);
// add a top-level bookmark
$bookmark = pdf_add_bookmark($pdf, "People");
// add a nested bookmark
pdf_add_bookmark($pdf, "Rasmus", $bookmark);
// and some text
pdf_set_font($pdf, "Helvetica", 20, "host");
$text = "This is R's page";
$width = pdf_stringwidth($pdf, $text);
pdf_set_text_pos($pdf, (300-$width)/2, 100);
pdf_show($pdf, $text);
// close the page and the PDF
pdf_end_page($pdf);
pdf_close($pdf);
?>
]]>
</programlisting>
</example>
</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
-->
|
