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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
<!doctype HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>CD_PDF</title>
<link rel="stylesheet" type="text/css" href="../../style.css">
</head>
<body>
<h2 style="text-align: left">CD_PDF - PDF Driver (cdpdf.h)</h2>
<p>This drivers allows generating a PDF file. This format developed for representing documents in a manner that is
independent of the original application software, hardware, and operating system used to create those documents. The
format's copyrights are property of <a href="http://www.adobe.com" target="_top">Adobe Systems</a>. </p>
<p>This driver is very similar to the PS driver but it uses the PDFlib library to generate the PDF (<a href="http://www.pdflib.com/">http://www.pdflib.com/</a>).
There are two PDFlib licenses available, one commercial and one free with a flexible license, see
<a href="http://www.pdflib.com/products/pdflib-family/pdflib-lite/pdflib-lite-licensing/">PDFlib Lite License</a>. The CD_PDF driver works with both
versions. </p>
<p>By default the pre-compiled library in the distribution uses the PDF Lite version code. The configuration of the PDF Lite code
included does not supports image
file formats. The current PDF Lite version is 7.0.4p4.</p>
<p>PDFlib Copyright (c) 1997-2009 Thomas Merz and PDFlib GmbH. All rights reserved. Applications that use this driver
are subject to the <a href="../../download/PDFlib-Lite-license.pdf">PDFlib GmbH License Agreement</a>.</p>
<h3>Use</h3>
<p>The file is created and opened by calling function <font face="Courier">
<a href="../func/init.html#cdCreateCanvas"><strong>cdCreateCanvas</strong></a>(CD_PDF,
Data)</font>, in which <font face="Courier">Data</font> contains the filename and canvas dimensions. This function
opens the file and writes its header. Then, other functions in the CD library can be called as usual. The
<font face="Courier">Data</font> parameter string has the following format:</p>
<pre>"<em>filename -p[paper] -w[width] -h[height] -s[resolution] [-o]</em>"
or in C<em>
"<strong><tt>%s -p%d -w%g -h%g -s%d -o</tt></strong>"</em></pre>
<p>The filename must be inside double quotes (") if it has spaces. Any amount of such canvases may exist
simultaneously. It is important to note that a call to function
<a href="../func/init.html#cdKillCanvas"><font face="Courier"><strong>
cdKillCanvas</strong></font></a> is required to <b>close</b> the file properly.</p>
<p>To use this driver, the application must be linked with the "<strong>cdpdf</strong>"
and "<strong>pdflib</strong>" libraries. </p>
<p><b>Paper Size - </b>The default paper size is A4. It is possible to change it by using one of the predefined sizes
- <strong><tt>CD_A0</tt></strong>, <strong><tt>CD_A1</tt></strong>, <strong><tt>CD_A2</tt></strong>, <strong><tt>CD_A3</tt></strong>,
<strong><tt>CD_A4</tt></strong>, <strong><tt>CD_A5</tt></strong>, <strong><tt>CD_LETTER</tt></strong> and <strong><tt>
CD_LEGAL</tt></strong> - with parameter "<font face="Courier">-p</font>". It is also possible to define a paper in a
particular size by using parameters "<font face="Courier">-w</font>" e "<font face="Courier">-h</font>". Values are
provided in millimeters.</p>
<div align="center">
<center>
<table border="1" cellpadding="3">
<caption valign="top"><font size="4">Default Paper Sizes</font></caption>
<tr>
<td> </td>
<th>Width (mm)</th>
<th>Length (mm)</th>
</tr>
<tr>
<td><strong>A0</strong></td>
<td align="center">841</td>
<td align="center">1187</td>
</tr>
<tr>
<td><strong>A1</strong></td>
<td align="center">594</td>
<td align="center">841</td>
</tr>
<tr>
<td><strong>A2</strong></td>
<td align="center">420</td>
<td align="center">594</td>
</tr>
<tr>
<td><strong>A3</strong></td>
<td align="center">297</td>
<td align="center">420</td>
</tr>
<tr>
<td><strong>A4</strong></td>
<td align="center">210</td>
<td align="center">297</td>
</tr>
<tr>
<td><strong>A5</strong></td>
<td align="center">148</td>
<td align="center">210</td>
</tr>
<tr>
<td><strong>Letter</strong></td>
<td align="center">216</td>
<td align="center">279</td>
</tr>
<tr>
<td><strong>Legal</strong></td>
<td align="center">216</td>
<td align="center">356</td>
</tr>
</table>
</center>
</div>
<p><b>Resolution -</b> Resolution is used to convert values from millimeters to pixels (the same as points, but the
number of points is per inch - DPI). Use parameter "<font face="Courier">-s</font>" to configure the resolution. The
default value is 300 DPI.</p>
<p><b>Orientation -</b> The page can be oriented as portrait or landscape. The default value is portrait, but when the
parameter "-o" is used, the horizontal and vertical values are switched.</p>
<p>In Lua, it is necessary to call function <strong><font face="Courier">cdluapdf_open() </strong> </font>after a call
to function <strong><font face="Courier">cdlua_open()</font></strong>, apart from linkediting with the "<strong><font face="Courier">cdluapdf</font></strong>"
library.</p>
<h3>Behavior of Functions</h3>
<h4>Control</h4>
<ul>
<li><a href="../func/other.html#cdPlay"><font face="Courier"><strong>Play</strong></font></a>:
does nothing, returns <font face="Courier">CD_ERROR</font>. </li>
<li><a href="../func/control.html#cdFlush"><font face="Courier"><strong>Flush</strong></font></a>:
changes to a new page, preserving the previous one. </li>
<li><a href="../func/control.html#cdClear"><font face="Courier"><strong>Clear</strong></font></a>:
does nothing.</li>
</ul>
<h4>Coordinate System & Clipping</h4>
<ul>
<li><a href="../func/coordinates.html#cdUpdateYAxis"><font face="Courier">
<strong>UpdateYAxis</strong></font></a>: does nothing.</li>
<li><b>Complex Regions</b>: not supported.</li>
</ul>
<h4>Attributes</h4>
<ul>
<li><a href="../func/attributes.html#cdBackground"><font face="Courier">
<strong>
Background</strong></font></a> does nothing, returns <font face="Courier">CD_WHITE</font>.</li>
<li><a href="../func/filled.html#cdBackOpacity"><font face="Courier"><strong>
BackOpacity</strong></font></a>: does nothing, returns <font face="Courier">CD_TRANSPARENT</font>.</li>
<li><a href="../func/attributes.html#cdWriteMode"><font face="Courier">
<strong>
WriteMode</strong></font></a>: does nothing, returns <font face="Courier">CD_REPLACE</font>.</li>
<li><a href="../func/filled.html#cdHatch"><font face="Courier"><strong>Hatch</strong></font></a>:
is always opaque.</li>
<li><a href="../func/filled.html#cdStipple"><font face="Courier"><strong>
Stipple</strong></font></a>: is always opaque.</li>
<li><a href="../func/text.html#cdFont"><font face="Courier"><strong>Font</strong></font></a>:
the old "System" font is mapped to the "Courier" font. For
the PDF core fonts styles are added to the font name, for other fonts styles
are simulated by PDFlib. Underline and Strikeout are supported. Following is the core fonts:</li>
</ul>
<pre>Courier, Courier-Bold, Courier-Oblique, Courier-BoldOblique,
Helvetica, Helvetica-Bold, Helvetica-Oblique, Helvetica-BoldOblique,
Times-Roman, Times-Bold, Times-Italic, Times-BoldItalic,
Symbol,
ZapfDingbats</pre>
<h4>Colors </h4>
<ul>
<li><a href="../func/color.html#cdGetColorPlanes"><font face="Courier">
<strong>
GetColorPlanes</strong></font></a>: returns 24.</li>
<li><a href="../func/color.html#cdPalette"><font face="Courier"><strong>Palette</strong></font></a>:
does nothing. </li>
</ul>
<h4>Client Images</h4>
<ul>
<li><a href="../func/client.html#cdGetImageRGB"><font face="Courier"><strong>
GetImageRGB</strong></font></a>: does nothing.</li>
<li><font face="Courier"><strong><a href="../func/client.html#cdPutImageMap">
PutImageMap</a></strong></font>: stores an RGB image.</li>
</ul>
<h4>Primitives</h4>
<ul>
<li><font face="Courier"><strong><a href="../func/marks.html#cdPixel">Pixel</a></strong></font>:
does not exist in PDF, is simulated using a circle with radius=1.</li>
<li>Floating point primitives are supported.</li>
<li>Filled primitves do not include the line at the edges of the filled area.</li>
</ul>
<h4>Server Images</h4>
<ul>
<li>All functions do nothing.</li>
</ul>
<h4>Exclusive Attributes</h4>
<ul>
<li><strong><font face="Courier">"POLYHOLE"</font></strong>: defines the index of
the vertex where there is a hole in a
closed polygon. It will affect the next <strong>cdEnd</strong>. Can be called several times between
<strong>cdBegin</strong> and <strong>cdEnd</strong> to define holes. The value passed must
be a string containing an integer ("%d"). If the value of the attribute passed is NULL, all holes will no longer be
considered. When consulted returns the current number of holes ("%d"). It can have a maximum of 500 holes.
Default: NULL.</li>
</ul>
<ul>
<li><strong><span style="font-family: Courier">"HATCHBOXSIZE"</span></strong>:
defines the size of smallest hatch box pattern. This affects the spacing
between the hatch lines. The value passed must be a string containing an
integer ("%d"). If the value of the attribute passed is NULL, the value is
rest to the default. When consulted returns the current value ("%d"). Default:
"8".</li>
</ul>
<ul>
<li>"<b><font face="Courier">ROTATE</font></b>": allows the usage of 1 angle and 1 coordinate (x, y), that
define a global rotation transformation centered in the specified coordinate. Use 1 real and 2 integer values inside a
string ("%g %d %d" = angle x y).</li>
</ul>
<ul>
<li>"<b><font face="Courier">OPAQUE</font></b>": allows the usage of a global
opacity value. The value passed must be a string containing an integer
("%d") [0=full transparent, 255=full opaque]. Use NULL to reset to the
default. Default: 255.</li>
</ul>
<ul>
<li>"<b><font face="Courier">PATTERN</font></b>": creates a pattern with
regular primitives (except images). The value passed must be a string
containing two integeres with the pattern size ("%dx%d") [widthxheight].
Just call regular primitives. Use NULL to end the pattern creation and set
the interior style.</li>
</ul>
<ul>
<li>"<b><font face="Courier">PDF</font></b>": Returns the "PDF*" handle
of the PDFLib.</li>
</ul>
<ul>
<li><b><font face="Courier">"SUBJECT","TITLE","CREATOR","AUTHOR","KEYWORDS"</font></b>: write
only attributes that allows to set a description string for the respective
document information field.</li>
</ul>
</body>
</html>
|
