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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision: 288721 $ -->
<!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 -->
<refentry xml:id="function.ps-add-note" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ps_add_note</refname>
<refpurpose>Adds note to current page</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>
Adds a note at a certain position on the page. Notes are like little
rectangular sheets with text on it, which can be placed anywhere on
a page. They
are shown either folded or unfolded. If unfolded, the specified icon
is used as a placeholder.
</para>
&ps.note.visible;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>psdoc</parameter></term>
<listitem>
<para>
Resource identifier of the postscript file
as returned by <function>ps_new</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>llx</parameter></term>
<listitem>
<para>
The x-coordinate of the lower left corner.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>lly</parameter></term>
<listitem>
<para>
The y-coordinate of the lower left corner.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>urx</parameter></term>
<listitem>
<para>
The x-coordinate of the upper right corner.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ury</parameter></term>
<listitem>
<para>
The y-coordinate of the upper right corner.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>contents</parameter></term>
<listitem>
<para>
The text of the note.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>title</parameter></term>
<listitem>
<para>
The title of the note as displayed in the header of the note.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>icon</parameter></term>
<listitem>
<para>
The icon shown if the note is folded. This parameter can be set
to <literal>comment</literal>, <literal>insert</literal>,
<literal>note</literal>, <literal>paragraph</literal>,
<literal>newparagraph</literal>, <literal>key</literal>, or
<literal>help</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>open</parameter></term>
<listitem>
<para>
If <parameter>open</parameter> is unequal to zero the note will
be shown unfolded after opening the document with a pdf viewer.
</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:"~/.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
-->
|
