mirror of
https://github.com/michaelrsweet/pdfio.git
synced 2025-04-19 23:16:48 +02:00
Update documentation.
This commit is contained in:
parent
c507cabbda
commit
c75611e274
100
doc/pdfio.3
100
doc/pdfio.3
@ -1,4 +1,4 @@
|
|||||||
.TH pdfio 3 "pdf read/write library" "2025-04-12" "pdf read/write library"
|
.TH pdfio 3 "pdf read/write library" "2025-04-13" "pdf read/write library"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
pdfio \- pdf read/write library
|
pdfio \- pdf read/write library
|
||||||
.SH Introduction
|
.SH Introduction
|
||||||
@ -2449,6 +2449,10 @@ PDFIO_CS_ADOBE
|
|||||||
.br
|
.br
|
||||||
AdobeRGB 1998
|
AdobeRGB 1998
|
||||||
.TP 5
|
.TP 5
|
||||||
|
PDFIO_CS_CGATS001
|
||||||
|
.br
|
||||||
|
CGATS001 (CMYK)
|
||||||
|
.TP 5
|
||||||
PDFIO_CS_P3_D65
|
PDFIO_CS_P3_D65
|
||||||
.br
|
.br
|
||||||
Display P3
|
Display P3
|
||||||
@ -2477,7 +2481,7 @@ PDFIO_ENCRYPTION_RC4_128
|
|||||||
.TP 5
|
.TP 5
|
||||||
PDFIO_ENCRYPTION_RC4_40
|
PDFIO_ENCRYPTION_RC4_40
|
||||||
.br
|
.br
|
||||||
40-bit RC4 encryption (PDF 1.3)
|
40-bit RC4 encryption (PDF 1.3, reading only)
|
||||||
.SS pdfio_filter_e
|
.SS pdfio_filter_e
|
||||||
Compression/decompression filters for streams
|
Compression/decompression filters for streams
|
||||||
.TP 5
|
.TP 5
|
||||||
@ -2838,7 +2842,8 @@ pdfio_array_t * pdfioArrayCreateColorFromStandard (
|
|||||||
.fi
|
.fi
|
||||||
.PP
|
.PP
|
||||||
This function creates a color array for a standard \fBPDFIO_CS_\fR enumerated color space.
|
This function creates a color array for a standard \fBPDFIO_CS_\fR enumerated color space.
|
||||||
The "num_colors" argument must be \fB1\fR for grayscale and \fB3\fR for RGB color.
|
The "num_colors" argument must be \fB1\fR for grayscale, \fB3\fR for RGB color, and
|
||||||
|
\fB4\fR for CMYK color.
|
||||||
.SS pdfioArrayGetArray
|
.SS pdfioArrayGetArray
|
||||||
Get an array value from an array.
|
Get an array value from an array.
|
||||||
.PP
|
.PP
|
||||||
@ -2947,6 +2952,8 @@ bool pdfioArrayRemove (
|
|||||||
size_t n
|
size_t n
|
||||||
);
|
);
|
||||||
.fi
|
.fi
|
||||||
|
.PP
|
||||||
|
|
||||||
.SS pdfioContentClip
|
.SS pdfioContentClip
|
||||||
Clip output to the current path.
|
Clip output to the current path.
|
||||||
.PP
|
.PP
|
||||||
@ -3083,6 +3090,8 @@ bool pdfioContentPathEnd (
|
|||||||
pdfio_stream_t *st
|
pdfio_stream_t *st
|
||||||
);
|
);
|
||||||
.fi
|
.fi
|
||||||
|
.PP
|
||||||
|
|
||||||
.SS pdfioContentPathLineTo
|
.SS pdfioContentPathLineTo
|
||||||
Add a straight line to the current path.
|
Add a straight line to the current path.
|
||||||
.PP
|
.PP
|
||||||
@ -3423,6 +3432,8 @@ double pdfioContentTextMeasure (
|
|||||||
This function measures the given text string "s" and returns its width based
|
This function measures the given text string "s" and returns its width based
|
||||||
on "size". The text string must always use the UTF-8 (Unicode) encoding but
|
on "size". The text string must always use the UTF-8 (Unicode) encoding but
|
||||||
any control characters (such as newlines) are ignored.
|
any control characters (such as newlines) are ignored.
|
||||||
|
|
||||||
|
|
||||||
.SS pdfioContentTextMoveLine
|
.SS pdfioContentTextMoveLine
|
||||||
Move to the next line and offset.
|
Move to the next line and offset.
|
||||||
.PP
|
.PP
|
||||||
@ -3451,6 +3462,8 @@ bool pdfioContentTextNewLine (
|
|||||||
pdfio_stream_t *st
|
pdfio_stream_t *st
|
||||||
);
|
);
|
||||||
.fi
|
.fi
|
||||||
|
.PP
|
||||||
|
|
||||||
.SS pdfioContentTextNewLineShow
|
.SS pdfioContentTextNewLineShow
|
||||||
Move to the next line and show text.
|
Move to the next line and show text.
|
||||||
.PP
|
.PP
|
||||||
@ -3468,6 +3481,8 @@ This function moves to the next line and then shows some text with optional
|
|||||||
word and character spacing in a PDF content stream. The "unicode" argument
|
word and character spacing in a PDF content stream. The "unicode" argument
|
||||||
specifies that the current font maps to full Unicode. The "s" argument
|
specifies that the current font maps to full Unicode. The "s" argument
|
||||||
specifies a UTF-8 encoded string.
|
specifies a UTF-8 encoded string.
|
||||||
|
|
||||||
|
|
||||||
.SS pdfioContentTextNewLineShowf
|
.SS pdfioContentTextNewLineShowf
|
||||||
Show formatted text.
|
Show formatted text.
|
||||||
.PP
|
.PP
|
||||||
@ -3486,6 +3501,8 @@ This function moves to the next line and shows some formatted text with
|
|||||||
optional word and character spacing in a PDF content stream. The "unicode"
|
optional word and character spacing in a PDF content stream. The "unicode"
|
||||||
argument specifies that the current font maps to full Unicode. The "format"
|
argument specifies that the current font maps to full Unicode. The "format"
|
||||||
argument specifies a UTF-8 encoded \fBprintf\fR-style format string.
|
argument specifies a UTF-8 encoded \fBprintf\fR-style format string.
|
||||||
|
|
||||||
|
|
||||||
.SS pdfioContentTextShow
|
.SS pdfioContentTextShow
|
||||||
Show text.
|
Show text.
|
||||||
.PP
|
.PP
|
||||||
@ -3536,6 +3553,8 @@ bool pdfioDictClear (
|
|||||||
const char *key
|
const char *key
|
||||||
);
|
);
|
||||||
.fi
|
.fi
|
||||||
|
.PP
|
||||||
|
|
||||||
.SS pdfioDictCopy
|
.SS pdfioDictCopy
|
||||||
Copy a dictionary to a PDF file.
|
Copy a dictionary to a PDF file.
|
||||||
.PP
|
.PP
|
||||||
@ -3608,6 +3627,8 @@ const char * pdfioDictGetKey (
|
|||||||
size_t n
|
size_t n
|
||||||
);
|
);
|
||||||
.fi
|
.fi
|
||||||
|
.PP
|
||||||
|
|
||||||
.SS pdfioDictGetName
|
.SS pdfioDictGetName
|
||||||
Get a key name value from a dictionary.
|
Get a key name value from a dictionary.
|
||||||
.PP
|
.PP
|
||||||
@ -3625,6 +3646,8 @@ size_t pdfioDictGetNumPairs (
|
|||||||
pdfio_dict_t *dict
|
pdfio_dict_t *dict
|
||||||
);
|
);
|
||||||
.fi
|
.fi
|
||||||
|
.PP
|
||||||
|
|
||||||
.SS pdfioDictGetNumber
|
.SS pdfioDictGetNumber
|
||||||
Get a key number value from a dictionary.
|
Get a key number value from a dictionary.
|
||||||
.PP
|
.PP
|
||||||
@ -3697,6 +3720,8 @@ function "cb":
|
|||||||
|
|
||||||
The iteration continues as long as the callback returns \fBtrue\fR or all keys
|
The iteration continues as long as the callback returns \fBtrue\fR or all keys
|
||||||
have been iterated.
|
have been iterated.
|
||||||
|
|
||||||
|
|
||||||
.SS pdfioDictSetArray
|
.SS pdfioDictSetArray
|
||||||
Set a key array in a dictionary.
|
Set a key array in a dictionary.
|
||||||
.PP
|
.PP
|
||||||
@ -3818,6 +3843,39 @@ bool pdfioDictSetStringf (
|
|||||||
...
|
...
|
||||||
);
|
);
|
||||||
.fi
|
.fi
|
||||||
|
.SS pdfioFileAddOutputIntent
|
||||||
|
Add an OutputIntent to a file.
|
||||||
|
.PP
|
||||||
|
.nf
|
||||||
|
void pdfioFileAddOutputIntent (
|
||||||
|
pdfio_file_t *pdf,
|
||||||
|
const char *subtype,
|
||||||
|
const char *condition,
|
||||||
|
const char *cond_id,
|
||||||
|
const char *reg_name,
|
||||||
|
const char *info,
|
||||||
|
pdfio_obj_t *profile
|
||||||
|
);
|
||||||
|
.fi
|
||||||
|
.PP
|
||||||
|
This function adds an OutputIntent dictionary to the PDF file catalog.
|
||||||
|
The "subtype" argument specifies the intent subtype and is typically
|
||||||
|
"GTS_PDFX" for PDF/X, "GTS_PDFA1" for PDF/A, or "ISO_PDFE1" for PDF/E.
|
||||||
|
Passing \fBNULL\fR defaults the subtype to "GTS_PDFA1".
|
||||||
|
.PP
|
||||||
|
The "condition" argument specifies a short name for the output intent, while
|
||||||
|
the "info" argument specifies a longer description for the output intent.
|
||||||
|
Both can be \fBNULL\fR to omit this information.
|
||||||
|
.PP
|
||||||
|
The "cond_id" argument specifies a unique identifier such as a registration
|
||||||
|
("CGATS001") or color space name ("sRGB"). The "reg_name" argument provides
|
||||||
|
a URL for the identifier.
|
||||||
|
.PP
|
||||||
|
The "profile" argument specifies an ICC profile object for the output
|
||||||
|
condition. If \fBNULL\fR, the PDF consumer will attempt to look up the correct
|
||||||
|
profile using the "cond_id" value.
|
||||||
|
|
||||||
|
|
||||||
.SS pdfioFileClose
|
.SS pdfioFileClose
|
||||||
Close a PDF file and free all memory used for it.
|
Close a PDF file and free all memory used for it.
|
||||||
.PP
|
.PP
|
||||||
@ -3911,8 +3969,27 @@ specifies the font nane:
|
|||||||
Aside from "Symbol" and "Zapf-Dingbats", Base fonts use the Windows CP1252
|
Aside from "Symbol" and "Zapf-Dingbats", Base fonts use the Windows CP1252
|
||||||
(ISO-8859-1 with additional characters such as the Euro symbol) subset of
|
(ISO-8859-1 with additional characters such as the Euro symbol) subset of
|
||||||
Unicode.
|
Unicode.
|
||||||
|
.SS pdfioFileCreateFontObjFromData
|
||||||
|
Add a font in memory to a PDF file.
|
||||||
|
.PP
|
||||||
|
.nf
|
||||||
|
pdfio_obj_t * pdfioFileCreateFontObjFromData (
|
||||||
|
pdfio_file_t *pdf,
|
||||||
|
const void *data,
|
||||||
|
size_t datasize,
|
||||||
|
bool unicode
|
||||||
|
);
|
||||||
|
.fi
|
||||||
|
.PP
|
||||||
|
This function embeds TrueType/OpenType font data into a PDF file. The
|
||||||
|
"unicode" parameter controls whether the font is encoded for two-byte
|
||||||
|
characters (potentially full Unicode, but more typically a subset)
|
||||||
|
or to only support the Windows CP1252 (ISO-8859-1 with additional
|
||||||
|
characters such as the Euro symbol) subset of Unicode.
|
||||||
|
|
||||||
|
|
||||||
.SS pdfioFileCreateFontObjFromFile
|
.SS pdfioFileCreateFontObjFromFile
|
||||||
Add a font object to a PDF file.
|
Add a font file to a PDF file.
|
||||||
.PP
|
.PP
|
||||||
.nf
|
.nf
|
||||||
pdfio_obj_t * pdfioFileCreateFontObjFromFile (
|
pdfio_obj_t * pdfioFileCreateFontObjFromFile (
|
||||||
@ -3922,7 +3999,7 @@ pdfio_obj_t * pdfioFileCreateFontObjFromFile (
|
|||||||
);
|
);
|
||||||
.fi
|
.fi
|
||||||
.PP
|
.PP
|
||||||
This function embeds a TrueType/OpenType font into a PDF file. The
|
This function embeds a TrueType/OpenType font file into a PDF file. The
|
||||||
"unicode" parameter controls whether the font is encoded for two-byte
|
"unicode" parameter controls whether the font is encoded for two-byte
|
||||||
characters (potentially full Unicode, but more typically a subset)
|
characters (potentially full Unicode, but more typically a subset)
|
||||||
or to only support the Windows CP1252 (ISO-8859-1 with additional
|
or to only support the Windows CP1252 (ISO-8859-1 with additional
|
||||||
@ -4011,6 +4088,8 @@ pdfio_obj_t * pdfioFileCreateNameObj (
|
|||||||
.PP
|
.PP
|
||||||
This function creates a new object with a name value in a PDF file.
|
This function creates a new object with a name value in a PDF file.
|
||||||
You must call \fIpdfioObjClose\fR to write the object to the file.
|
You must call \fIpdfioObjClose\fR to write the object to the file.
|
||||||
|
|
||||||
|
|
||||||
.SS pdfioFileCreateNumberObj
|
.SS pdfioFileCreateNumberObj
|
||||||
Create a new object in a PDF file containing a number.
|
Create a new object in a PDF file containing a number.
|
||||||
.PP
|
.PP
|
||||||
@ -4023,6 +4102,8 @@ pdfio_obj_t * pdfioFileCreateNumberObj (
|
|||||||
.PP
|
.PP
|
||||||
This function creates a new object with a number value in a PDF file.
|
This function creates a new object with a number value in a PDF file.
|
||||||
You must call \fIpdfioObjClose\fR to write the object to the file.
|
You must call \fIpdfioObjClose\fR to write the object to the file.
|
||||||
|
|
||||||
|
|
||||||
.SS pdfioFileCreateObj
|
.SS pdfioFileCreateObj
|
||||||
Create a new object in a PDF file.
|
Create a new object in a PDF file.
|
||||||
.PP
|
.PP
|
||||||
@ -4101,6 +4182,8 @@ pdfio_obj_t * pdfioFileCreateStringObj (
|
|||||||
.PP
|
.PP
|
||||||
This function creates a new object with a string value in a PDF file.
|
This function creates a new object with a string value in a PDF file.
|
||||||
You must call \fIpdfioObjClose\fR to write the object to the file.
|
You must call \fIpdfioObjClose\fR to write the object to the file.
|
||||||
|
|
||||||
|
|
||||||
.SS pdfioFileCreateTemporary
|
.SS pdfioFileCreateTemporary
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
@ -4474,6 +4557,8 @@ const char * pdfioObjGetName (
|
|||||||
pdfio_obj_t *obj
|
pdfio_obj_t *obj
|
||||||
);
|
);
|
||||||
.fi
|
.fi
|
||||||
|
.PP
|
||||||
|
|
||||||
.SS pdfioObjGetNumber
|
.SS pdfioObjGetNumber
|
||||||
Get the object's number.
|
Get the object's number.
|
||||||
.PP
|
.PP
|
||||||
@ -4677,8 +4762,9 @@ bool pdfioStreamPrintf (
|
|||||||
.fi
|
.fi
|
||||||
.PP
|
.PP
|
||||||
This function writes a formatted string to a stream. In addition to the
|
This function writes a formatted string to a stream. In addition to the
|
||||||
standard \fBprintf\fR format characters, you can use "%N" to format a PDF name
|
standard \fBprintf\fR format characters, you can use "%H" to format a HTML/XML
|
||||||
value ("/Name") and "%S" to format a PDF string ("(String)") value.
|
string value, "%N" to format a PDF name value ("/Name"), and "%S" to format
|
||||||
|
a PDF string ("(String)") value.
|
||||||
.SS pdfioStreamPutChar
|
.SS pdfioStreamPutChar
|
||||||
Write a single character to a stream.
|
Write a single character to a stream.
|
||||||
.PP
|
.PP
|
||||||
|
146
doc/pdfio.html
146
doc/pdfio.html
@ -1,13 +1,13 @@
|
|||||||
<!DOCTYPE html>
|
<!DOCTYPE html>
|
||||||
<html lang="en-US">
|
<html lang="en-US">
|
||||||
<head>
|
<head>
|
||||||
<title>PDFio Programming Manual v1.5.2</title>
|
<title>PDFio Programming Manual v1.6.0</title>
|
||||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
|
||||||
<meta name="generator" content="codedoc v3.8">
|
<meta name="generator" content="codedoc v3.8">
|
||||||
<meta name="author" content="Michael R Sweet">
|
<meta name="author" content="Michael R Sweet">
|
||||||
<meta name="language" content="en-US">
|
<meta name="language" content="en-US">
|
||||||
<meta name="copyright" content="Copyright © 2021-2025 by Michael R Sweet">
|
<meta name="copyright" content="Copyright © 2021-2025 by Michael R Sweet">
|
||||||
<meta name="version" content="1.5.2">
|
<meta name="version" content="1.6.0">
|
||||||
<style type="text/css"><!--
|
<style type="text/css"><!--
|
||||||
body {
|
body {
|
||||||
background: white;
|
background: white;
|
||||||
@ -251,7 +251,7 @@ span.string {
|
|||||||
<body>
|
<body>
|
||||||
<div class="header">
|
<div class="header">
|
||||||
<p><img class="title" src="pdfio-512.png"></p>
|
<p><img class="title" src="pdfio-512.png"></p>
|
||||||
<h1 class="title">PDFio Programming Manual v1.5.2</h1>
|
<h1 class="title">PDFio Programming Manual v1.6.0</h1>
|
||||||
<p>Michael R Sweet</p>
|
<p>Michael R Sweet</p>
|
||||||
<p>Copyright © 2021-2025 by Michael R Sweet</p>
|
<p>Copyright © 2021-2025 by Michael R Sweet</p>
|
||||||
</div>
|
</div>
|
||||||
@ -395,10 +395,12 @@ span.string {
|
|||||||
<li><a href="#pdfioDictSetRect">pdfioDictSetRect</a></li>
|
<li><a href="#pdfioDictSetRect">pdfioDictSetRect</a></li>
|
||||||
<li><a href="#pdfioDictSetString">pdfioDictSetString</a></li>
|
<li><a href="#pdfioDictSetString">pdfioDictSetString</a></li>
|
||||||
<li><a href="#pdfioDictSetStringf">pdfioDictSetStringf</a></li>
|
<li><a href="#pdfioDictSetStringf">pdfioDictSetStringf</a></li>
|
||||||
|
<li><a href="#pdfioFileAddOutputIntent">pdfioFileAddOutputIntent</a></li>
|
||||||
<li><a href="#pdfioFileClose">pdfioFileClose</a></li>
|
<li><a href="#pdfioFileClose">pdfioFileClose</a></li>
|
||||||
<li><a href="#pdfioFileCreate">pdfioFileCreate</a></li>
|
<li><a href="#pdfioFileCreate">pdfioFileCreate</a></li>
|
||||||
<li><a href="#pdfioFileCreateArrayObj">pdfioFileCreateArrayObj</a></li>
|
<li><a href="#pdfioFileCreateArrayObj">pdfioFileCreateArrayObj</a></li>
|
||||||
<li><a href="#pdfioFileCreateFontObjFromBase">pdfioFileCreateFontObjFromBase</a></li>
|
<li><a href="#pdfioFileCreateFontObjFromBase">pdfioFileCreateFontObjFromBase</a></li>
|
||||||
|
<li><a href="#pdfioFileCreateFontObjFromData">pdfioFileCreateFontObjFromData</a></li>
|
||||||
<li><a href="#pdfioFileCreateFontObjFromFile">pdfioFileCreateFontObjFromFile</a></li>
|
<li><a href="#pdfioFileCreateFontObjFromFile">pdfioFileCreateFontObjFromFile</a></li>
|
||||||
<li><a href="#pdfioFileCreateICCObjFromData">pdfioFileCreateICCObjFromData</a></li>
|
<li><a href="#pdfioFileCreateICCObjFromData">pdfioFileCreateICCObjFromData</a></li>
|
||||||
<li><a href="#pdfioFileCreateICCObjFromFile">pdfioFileCreateICCObjFromFile</a></li>
|
<li><a href="#pdfioFileCreateICCObjFromFile">pdfioFileCreateICCObjFromFile</a></li>
|
||||||
@ -2594,7 +2596,7 @@ dd->y = row_y - row->height;
|
|||||||
<tr><th>pdf</th>
|
<tr><th>pdf</th>
|
||||||
<td class="description">PDF file</td></tr>
|
<td class="description">PDF file</td></tr>
|
||||||
<tr><th>num_colors</th>
|
<tr><th>num_colors</th>
|
||||||
<td class="description">Number of colors (1 or 3)</td></tr>
|
<td class="description">Number of colors (1, 3, or 4)</td></tr>
|
||||||
<tr><th>cs</th>
|
<tr><th>cs</th>
|
||||||
<td class="description">Color space enumeration</td></tr>
|
<td class="description">Color space enumeration</td></tr>
|
||||||
</tbody></table>
|
</tbody></table>
|
||||||
@ -2602,7 +2604,8 @@ dd->y = row_y - row->height;
|
|||||||
<p class="description">Color array</p>
|
<p class="description">Color array</p>
|
||||||
<h4 class="discussion">Discussion</h4>
|
<h4 class="discussion">Discussion</h4>
|
||||||
<p class="discussion">This function creates a color array for a standard <code>PDFIO_CS_</code> enumerated color space.
|
<p class="discussion">This function creates a color array for a standard <code>PDFIO_CS_</code> enumerated color space.
|
||||||
The "num_colors" argument must be <code>1</code> for grayscale and <code>3</code> for RGB color.</p>
|
The "num_colors" argument must be <code>1</code> for grayscale, <code>3</code> for RGB color, and
|
||||||
|
<code>4</code> for CMYK color.</p>
|
||||||
<h3 class="function"><a id="pdfioArrayGetArray">pdfioArrayGetArray</a></h3>
|
<h3 class="function"><a id="pdfioArrayGetArray">pdfioArrayGetArray</a></h3>
|
||||||
<p class="description">Get an array value from an array.</p>
|
<p class="description">Get an array value from an array.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
@ -2746,7 +2749,7 @@ size_t pdfioArrayGetSize(<a href="#pdfio_array_t">pdfio_array_t</a> *a);</p>
|
|||||||
</tbody></table>
|
</tbody></table>
|
||||||
<h4 class="returnvalue">Return Value</h4>
|
<h4 class="returnvalue">Return Value</h4>
|
||||||
<p class="description">Value type</p>
|
<p class="description">Value type</p>
|
||||||
<h3 class="function"><a id="pdfioArrayRemove">pdfioArrayRemove</a></h3>
|
<h3 class="function"><span class="info"> PDFio v1.4 </span><a id="pdfioArrayRemove">pdfioArrayRemove</a></h3>
|
||||||
<p class="description">Remove an array entry.</p>
|
<p class="description">Remove an array entry.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
<span class="reserved">bool</span> pdfioArrayRemove(<a href="#pdfio_array_t">pdfio_array_t</a> *a, size_t n);</p>
|
<span class="reserved">bool</span> pdfioArrayRemove(<a href="#pdfio_array_t">pdfio_array_t</a> *a, size_t n);</p>
|
||||||
@ -2951,7 +2954,7 @@ using the <a href="#pdfioPageDictAddImage"><code>pdfioPageDictAddImage</code></a
|
|||||||
</tbody></table>
|
</tbody></table>
|
||||||
<h4 class="returnvalue">Return Value</h4>
|
<h4 class="returnvalue">Return Value</h4>
|
||||||
<p class="description"><code>true</code> on success, <code>false</code> on failure</p>
|
<p class="description"><code>true</code> on success, <code>false</code> on failure</p>
|
||||||
<h3 class="function"><a id="pdfioContentPathEnd">pdfioContentPathEnd</a></h3>
|
<h3 class="function"><span class="info"> PDFio v1.1 </span><a id="pdfioContentPathEnd">pdfioContentPathEnd</a></h3>
|
||||||
<p class="description">Clear the current path.</p>
|
<p class="description">Clear the current path.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
<span class="reserved">bool</span> pdfioContentPathEnd(<a href="#pdfio_stream_t">pdfio_stream_t</a> *st);</p>
|
<span class="reserved">bool</span> pdfioContentPathEnd(<a href="#pdfio_stream_t">pdfio_stream_t</a> *st);</p>
|
||||||
@ -3441,7 +3444,7 @@ are 0, a solid line is drawn.</p>
|
|||||||
</tbody></table>
|
</tbody></table>
|
||||||
<h4 class="returnvalue">Return Value</h4>
|
<h4 class="returnvalue">Return Value</h4>
|
||||||
<p class="description"><code>true</code> on success, <code>false</code> on failure</p>
|
<p class="description"><code>true</code> on success, <code>false</code> on failure</p>
|
||||||
<h3 class="function"><a id="pdfioContentTextMeasure">pdfioContentTextMeasure</a></h3>
|
<h3 class="function"><span class="info"> PDFio v1.2 </span><a id="pdfioContentTextMeasure">pdfioContentTextMeasure</a></h3>
|
||||||
<p class="description">Measure a text string and return its width.</p>
|
<p class="description">Measure a text string and return its width.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
<span class="reserved">double</span> pdfioContentTextMeasure(<a href="#pdfio_obj_t">pdfio_obj_t</a> *font, <span class="reserved">const</span> <span class="reserved">char</span> *s, <span class="reserved">double</span> size);</p>
|
<span class="reserved">double</span> pdfioContentTextMeasure(<a href="#pdfio_obj_t">pdfio_obj_t</a> *font, <span class="reserved">const</span> <span class="reserved">char</span> *s, <span class="reserved">double</span> size);</p>
|
||||||
@ -3459,7 +3462,9 @@ are 0, a solid line is drawn.</p>
|
|||||||
<h4 class="discussion">Discussion</h4>
|
<h4 class="discussion">Discussion</h4>
|
||||||
<p class="discussion">This function measures the given text string "s" and returns its width based
|
<p class="discussion">This function measures the given text string "s" and returns its width based
|
||||||
on "size". The text string must always use the UTF-8 (Unicode) encoding but
|
on "size". The text string must always use the UTF-8 (Unicode) encoding but
|
||||||
any control characters (such as newlines) are ignored.</p>
|
any control characters (such as newlines) are ignored.
|
||||||
|
|
||||||
|
</p>
|
||||||
<h3 class="function"><a id="pdfioContentTextMoveLine">pdfioContentTextMoveLine</a></h3>
|
<h3 class="function"><a id="pdfioContentTextMoveLine">pdfioContentTextMoveLine</a></h3>
|
||||||
<p class="description">Move to the next line and offset.</p>
|
<p class="description">Move to the next line and offset.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
@ -3490,7 +3495,7 @@ any control characters (such as newlines) are ignored.</p>
|
|||||||
</tbody></table>
|
</tbody></table>
|
||||||
<h4 class="returnvalue">Return Value</h4>
|
<h4 class="returnvalue">Return Value</h4>
|
||||||
<p class="description"><code>true</code> on success, <code>false</code> on failure</p>
|
<p class="description"><code>true</code> on success, <code>false</code> on failure</p>
|
||||||
<h3 class="function"><a id="pdfioContentTextNewLine">pdfioContentTextNewLine</a></h3>
|
<h3 class="function"><span class="info"> PDFio v1.2 </span><a id="pdfioContentTextNewLine">pdfioContentTextNewLine</a></h3>
|
||||||
<p class="description">Move to the next line.</p>
|
<p class="description">Move to the next line.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
<span class="reserved">bool</span> pdfioContentTextNewLine(<a href="#pdfio_stream_t">pdfio_stream_t</a> *st);</p>
|
<span class="reserved">bool</span> pdfioContentTextNewLine(<a href="#pdfio_stream_t">pdfio_stream_t</a> *st);</p>
|
||||||
@ -3501,7 +3506,7 @@ any control characters (such as newlines) are ignored.</p>
|
|||||||
</tbody></table>
|
</tbody></table>
|
||||||
<h4 class="returnvalue">Return Value</h4>
|
<h4 class="returnvalue">Return Value</h4>
|
||||||
<p class="description"><code>true</code> on success, <code>false</code> on failure</p>
|
<p class="description"><code>true</code> on success, <code>false</code> on failure</p>
|
||||||
<h3 class="function"><a id="pdfioContentTextNewLineShow">pdfioContentTextNewLineShow</a></h3>
|
<h3 class="function"><span class="info"> PDFio v1.2 </span><a id="pdfioContentTextNewLineShow">pdfioContentTextNewLineShow</a></h3>
|
||||||
<p class="description">Move to the next line and show text.</p>
|
<p class="description">Move to the next line and show text.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
<span class="reserved">bool</span> pdfioContentTextNewLineShow(<a href="#pdfio_stream_t">pdfio_stream_t</a> *st, <span class="reserved">double</span> ws, <span class="reserved">double</span> cs, <span class="reserved">bool</span> unicode, <span class="reserved">const</span> <span class="reserved">char</span> *s);</p>
|
<span class="reserved">bool</span> pdfioContentTextNewLineShow(<a href="#pdfio_stream_t">pdfio_stream_t</a> *st, <span class="reserved">double</span> ws, <span class="reserved">double</span> cs, <span class="reserved">bool</span> unicode, <span class="reserved">const</span> <span class="reserved">char</span> *s);</p>
|
||||||
@ -3524,8 +3529,10 @@ any control characters (such as newlines) are ignored.</p>
|
|||||||
<p class="discussion">This function moves to the next line and then shows some text with optional
|
<p class="discussion">This function moves to the next line and then shows some text with optional
|
||||||
word and character spacing in a PDF content stream. The "unicode" argument
|
word and character spacing in a PDF content stream. The "unicode" argument
|
||||||
specifies that the current font maps to full Unicode. The "s" argument
|
specifies that the current font maps to full Unicode. The "s" argument
|
||||||
specifies a UTF-8 encoded string.</p>
|
specifies a UTF-8 encoded string.
|
||||||
<h3 class="function"><a id="pdfioContentTextNewLineShowf">pdfioContentTextNewLineShowf</a></h3>
|
|
||||||
|
</p>
|
||||||
|
<h3 class="function"><span class="info"> PDFio v1.2 </span><a id="pdfioContentTextNewLineShowf">pdfioContentTextNewLineShowf</a></h3>
|
||||||
<p class="description">Show formatted text.</p>
|
<p class="description">Show formatted text.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
<span class="reserved">bool</span> pdfioContentTextNewLineShowf(<a href="#pdfio_stream_t">pdfio_stream_t</a> *st, <span class="reserved">double</span> ws, <span class="reserved">double</span> cs, <span class="reserved">bool</span> unicode, <span class="reserved">const</span> <span class="reserved">char</span> *format, ...);</p>
|
<span class="reserved">bool</span> pdfioContentTextNewLineShowf(<a href="#pdfio_stream_t">pdfio_stream_t</a> *st, <span class="reserved">double</span> ws, <span class="reserved">double</span> cs, <span class="reserved">bool</span> unicode, <span class="reserved">const</span> <span class="reserved">char</span> *format, ...);</p>
|
||||||
@ -3550,7 +3557,9 @@ specifies a UTF-8 encoded string.</p>
|
|||||||
<p class="discussion">This function moves to the next line and shows some formatted text with
|
<p class="discussion">This function moves to the next line and shows some formatted text with
|
||||||
optional word and character spacing in a PDF content stream. The "unicode"
|
optional word and character spacing in a PDF content stream. The "unicode"
|
||||||
argument specifies that the current font maps to full Unicode. The "format"
|
argument specifies that the current font maps to full Unicode. The "format"
|
||||||
argument specifies a UTF-8 encoded <code>printf</code>-style format string.</p>
|
argument specifies a UTF-8 encoded <code>printf</code>-style format string.
|
||||||
|
|
||||||
|
</p>
|
||||||
<h3 class="function"><a id="pdfioContentTextShow">pdfioContentTextShow</a></h3>
|
<h3 class="function"><a id="pdfioContentTextShow">pdfioContentTextShow</a></h3>
|
||||||
<p class="description">Show text.</p>
|
<p class="description">Show text.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
@ -3613,7 +3622,7 @@ argument specifies an array of UTF-8 encoded strings.</p>
|
|||||||
<p class="discussion">This function shows some formatted text in a PDF content stream. The
|
<p class="discussion">This function shows some formatted text in a PDF content stream. The
|
||||||
"unicode" argument specifies that the current font maps to full Unicode.
|
"unicode" argument specifies that the current font maps to full Unicode.
|
||||||
The "format" argument specifies a UTF-8 encoded <code>printf</code>-style format string.</p>
|
The "format" argument specifies a UTF-8 encoded <code>printf</code>-style format string.</p>
|
||||||
<h3 class="function"><a id="pdfioDictClear">pdfioDictClear</a></h3>
|
<h3 class="function"><span class="info"> PDFio v1.4 </span><a id="pdfioDictClear">pdfioDictClear</a></h3>
|
||||||
<p class="description">Remove a key/value pair from a dictionary.</p>
|
<p class="description">Remove a key/value pair from a dictionary.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
<span class="reserved">bool</span> pdfioDictClear(<a href="#pdfio_dict_t">pdfio_dict_t</a> *dict, <span class="reserved">const</span> <span class="reserved">char</span> *key);</p>
|
<span class="reserved">bool</span> pdfioDictClear(<a href="#pdfio_dict_t">pdfio_dict_t</a> *dict, <span class="reserved">const</span> <span class="reserved">char</span> *key);</p>
|
||||||
@ -3717,7 +3726,7 @@ time_t pdfioDictGetDate(<a href="#pdfio_dict_t">pdfio_dict_t</a> *dict, <span cl
|
|||||||
</tbody></table>
|
</tbody></table>
|
||||||
<h4 class="returnvalue">Return Value</h4>
|
<h4 class="returnvalue">Return Value</h4>
|
||||||
<p class="description">Value</p>
|
<p class="description">Value</p>
|
||||||
<h3 class="function"><a id="pdfioDictGetKey">pdfioDictGetKey</a></h3>
|
<h3 class="function"><span class="info"> PDFio v1.4 </span><a id="pdfioDictGetKey">pdfioDictGetKey</a></h3>
|
||||||
<p class="description">Get the key for the specified pair.</p>
|
<p class="description">Get the key for the specified pair.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
<span class="reserved">const</span> <span class="reserved">char</span> *pdfioDictGetKey(<a href="#pdfio_dict_t">pdfio_dict_t</a> *dict, size_t n);</p>
|
<span class="reserved">const</span> <span class="reserved">char</span> *pdfioDictGetKey(<a href="#pdfio_dict_t">pdfio_dict_t</a> *dict, size_t n);</p>
|
||||||
@ -3743,7 +3752,7 @@ time_t pdfioDictGetDate(<a href="#pdfio_dict_t">pdfio_dict_t</a> *dict, <span cl
|
|||||||
</tbody></table>
|
</tbody></table>
|
||||||
<h4 class="returnvalue">Return Value</h4>
|
<h4 class="returnvalue">Return Value</h4>
|
||||||
<p class="description">Value</p>
|
<p class="description">Value</p>
|
||||||
<h3 class="function"><a id="pdfioDictGetNumPairs">pdfioDictGetNumPairs</a></h3>
|
<h3 class="function"><span class="info"> PDFio v1.4 </span><a id="pdfioDictGetNumPairs">pdfioDictGetNumPairs</a></h3>
|
||||||
<p class="description">Get the number of key/value pairs in a dictionary.</p>
|
<p class="description">Get the number of key/value pairs in a dictionary.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
size_t pdfioDictGetNumPairs(<a href="#pdfio_dict_t">pdfio_dict_t</a> *dict);</p>
|
size_t pdfioDictGetNumPairs(<a href="#pdfio_dict_t">pdfio_dict_t</a> *dict);</p>
|
||||||
@ -3821,7 +3830,7 @@ size_t pdfioDictGetNumPairs(<a href="#pdfio_dict_t">pdfio_dict_t</a> *dict);</p>
|
|||||||
</tbody></table>
|
</tbody></table>
|
||||||
<h4 class="returnvalue">Return Value</h4>
|
<h4 class="returnvalue">Return Value</h4>
|
||||||
<p class="description">Value type</p>
|
<p class="description">Value type</p>
|
||||||
<h3 class="function"><a id="pdfioDictIterateKeys">pdfioDictIterateKeys</a></h3>
|
<h3 class="function"><span class="info"> PDFio v1.1 </span><a id="pdfioDictIterateKeys">pdfioDictIterateKeys</a></h3>
|
||||||
<p class="description">Iterate the keys in a dictionary.</p>
|
<p class="description">Iterate the keys in a dictionary.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
<span class="reserved">void</span> pdfioDictIterateKeys(<a href="#pdfio_dict_t">pdfio_dict_t</a> *dict, <a href="#pdfio_dict_cb_t">pdfio_dict_cb_t</a> cb, <span class="reserved">void</span> *cb_data);</p>
|
<span class="reserved">void</span> pdfioDictIterateKeys(<a href="#pdfio_dict_t">pdfio_dict_t</a> *dict, <a href="#pdfio_dict_cb_t">pdfio_dict_cb_t</a> cb, <span class="reserved">void</span> *cb_data);</p>
|
||||||
@ -3848,7 +3857,9 @@ my_dict_cb(pdfio_dict_t *dict, const char *key, void *cb_data)
|
|||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
The iteration continues as long as the callback returns <code>true</code> or all keys
|
The iteration continues as long as the callback returns <code>true</code> or all keys
|
||||||
have been iterated.</p>
|
have been iterated.
|
||||||
|
|
||||||
|
</p>
|
||||||
<h3 class="function"><a id="pdfioDictSetArray">pdfioDictSetArray</a></h3>
|
<h3 class="function"><a id="pdfioDictSetArray">pdfioDictSetArray</a></h3>
|
||||||
<p class="description">Set a key array in a dictionary.</p>
|
<p class="description">Set a key array in a dictionary.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
@ -4031,6 +4042,46 @@ have been iterated.</p>
|
|||||||
</tbody></table>
|
</tbody></table>
|
||||||
<h4 class="returnvalue">Return Value</h4>
|
<h4 class="returnvalue">Return Value</h4>
|
||||||
<p class="description"><code>true</code> on success, <code>false</code> on failure</p>
|
<p class="description"><code>true</code> on success, <code>false</code> on failure</p>
|
||||||
|
<h3 class="function"><span class="info"> PDFio 1.6 </span><a id="pdfioFileAddOutputIntent">pdfioFileAddOutputIntent</a></h3>
|
||||||
|
<p class="description">Add an OutputIntent to a file.</p>
|
||||||
|
<p class="code">
|
||||||
|
<span class="reserved">void</span> pdfioFileAddOutputIntent(<a href="#pdfio_file_t">pdfio_file_t</a> *pdf, <span class="reserved">const</span> <span class="reserved">char</span> *subtype, <span class="reserved">const</span> <span class="reserved">char</span> *condition, <span class="reserved">const</span> <span class="reserved">char</span> *cond_id, <span class="reserved">const</span> <span class="reserved">char</span> *reg_name, <span class="reserved">const</span> <span class="reserved">char</span> *info, <a href="#pdfio_obj_t">pdfio_obj_t</a> *profile);</p>
|
||||||
|
<h4 class="parameters">Parameters</h4>
|
||||||
|
<table class="list"><tbody>
|
||||||
|
<tr><th>pdf</th>
|
||||||
|
<td class="description">PDF file</td></tr>
|
||||||
|
<tr><th>subtype</th>
|
||||||
|
<td class="description">Intent subtype (standard)</td></tr>
|
||||||
|
<tr><th>condition</th>
|
||||||
|
<td class="description">Condition name or <code>NULL</code> for none</td></tr>
|
||||||
|
<tr><th>cond_id</th>
|
||||||
|
<td class="description">Identifier such as registration name or <code>NULL</code> for none</td></tr>
|
||||||
|
<tr><th>reg_name</th>
|
||||||
|
<td class="description">Registry URL or <code>NULL</code> for none</td></tr>
|
||||||
|
<tr><th>info</th>
|
||||||
|
<td class="description">Description or <code>NULL</code> for none</td></tr>
|
||||||
|
<tr><th>profile</th>
|
||||||
|
<td class="description">ICC profile object or <code>NULL</code> for none</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<h4 class="discussion">Discussion</h4>
|
||||||
|
<p class="discussion">This function adds an OutputIntent dictionary to the PDF file catalog.
|
||||||
|
The "subtype" argument specifies the intent subtype and is typically
|
||||||
|
"GTS_PDFX" for PDF/X, "GTS_PDFA1" for PDF/A, or "ISO_PDFE1" for PDF/E.
|
||||||
|
Passing <code>NULL</code> defaults the subtype to "GTS_PDFA1".<br>
|
||||||
|
<br>
|
||||||
|
The "condition" argument specifies a short name for the output intent, while
|
||||||
|
the "info" argument specifies a longer description for the output intent.
|
||||||
|
Both can be <code>NULL</code> to omit this information.<br>
|
||||||
|
<br>
|
||||||
|
The "cond_id" argument specifies a unique identifier such as a registration
|
||||||
|
("CGATS001") or color space name ("sRGB"). The "reg_name" argument provides
|
||||||
|
a URL for the identifier.<br>
|
||||||
|
<br>
|
||||||
|
The "profile" argument specifies an ICC profile object for the output
|
||||||
|
condition. If <code>NULL</code>, the PDF consumer will attempt to look up the correct
|
||||||
|
profile using the "cond_id" value.
|
||||||
|
|
||||||
|
</p>
|
||||||
<h3 class="function"><a id="pdfioFileClose">pdfioFileClose</a></h3>
|
<h3 class="function"><a id="pdfioFileClose">pdfioFileClose</a></h3>
|
||||||
<p class="description">Close a PDF file and free all memory used for it.</p>
|
<p class="description">Close a PDF file and free all memory used for it.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
@ -4143,8 +4194,33 @@ specifies the font nane:
|
|||||||
<p class="discussion">Aside from "Symbol" and "Zapf-Dingbats", Base fonts use the Windows CP1252
|
<p class="discussion">Aside from "Symbol" and "Zapf-Dingbats", Base fonts use the Windows CP1252
|
||||||
(ISO-8859-1 with additional characters such as the Euro symbol) subset of
|
(ISO-8859-1 with additional characters such as the Euro symbol) subset of
|
||||||
Unicode.</p>
|
Unicode.</p>
|
||||||
|
<h3 class="function"><span class="info"> PDFio v1.6 </span><a id="pdfioFileCreateFontObjFromData">pdfioFileCreateFontObjFromData</a></h3>
|
||||||
|
<p class="description">Add a font in memory to a PDF file.</p>
|
||||||
|
<p class="code">
|
||||||
|
<a href="#pdfio_obj_t">pdfio_obj_t</a> *pdfioFileCreateFontObjFromData(<a href="#pdfio_file_t">pdfio_file_t</a> *pdf, <span class="reserved">const</span> <span class="reserved">void</span> *data, size_t datasize, <span class="reserved">bool</span> unicode);</p>
|
||||||
|
<h4 class="parameters">Parameters</h4>
|
||||||
|
<table class="list"><tbody>
|
||||||
|
<tr><th>pdf</th>
|
||||||
|
<td class="description">PDF file</td></tr>
|
||||||
|
<tr><th>data</th>
|
||||||
|
<td class="description">Font data in memory</td></tr>
|
||||||
|
<tr><th>datasize</th>
|
||||||
|
<td class="description">Size of font in memory</td></tr>
|
||||||
|
<tr><th>unicode</th>
|
||||||
|
<td class="description">Force Unicode</td></tr>
|
||||||
|
</tbody></table>
|
||||||
|
<h4 class="returnvalue">Return Value</h4>
|
||||||
|
<p class="description">Font object</p>
|
||||||
|
<h4 class="discussion">Discussion</h4>
|
||||||
|
<p class="discussion">This function embeds TrueType/OpenType font data into a PDF file. The
|
||||||
|
"unicode" parameter controls whether the font is encoded for two-byte
|
||||||
|
characters (potentially full Unicode, but more typically a subset)
|
||||||
|
or to only support the Windows CP1252 (ISO-8859-1 with additional
|
||||||
|
characters such as the Euro symbol) subset of Unicode.
|
||||||
|
|
||||||
|
</p>
|
||||||
<h3 class="function"><a id="pdfioFileCreateFontObjFromFile">pdfioFileCreateFontObjFromFile</a></h3>
|
<h3 class="function"><a id="pdfioFileCreateFontObjFromFile">pdfioFileCreateFontObjFromFile</a></h3>
|
||||||
<p class="description">Add a font object to a PDF file.</p>
|
<p class="description">Add a font file to a PDF file.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
<a href="#pdfio_obj_t">pdfio_obj_t</a> *pdfioFileCreateFontObjFromFile(<a href="#pdfio_file_t">pdfio_file_t</a> *pdf, <span class="reserved">const</span> <span class="reserved">char</span> *filename, <span class="reserved">bool</span> unicode);</p>
|
<a href="#pdfio_obj_t">pdfio_obj_t</a> *pdfioFileCreateFontObjFromFile(<a href="#pdfio_file_t">pdfio_file_t</a> *pdf, <span class="reserved">const</span> <span class="reserved">char</span> *filename, <span class="reserved">bool</span> unicode);</p>
|
||||||
<h4 class="parameters">Parameters</h4>
|
<h4 class="parameters">Parameters</h4>
|
||||||
@ -4159,7 +4235,7 @@ Unicode.</p>
|
|||||||
<h4 class="returnvalue">Return Value</h4>
|
<h4 class="returnvalue">Return Value</h4>
|
||||||
<p class="description">Font object</p>
|
<p class="description">Font object</p>
|
||||||
<h4 class="discussion">Discussion</h4>
|
<h4 class="discussion">Discussion</h4>
|
||||||
<p class="discussion">This function embeds a TrueType/OpenType font into a PDF file. The
|
<p class="discussion">This function embeds a TrueType/OpenType font file into a PDF file. The
|
||||||
"unicode" parameter controls whether the font is encoded for two-byte
|
"unicode" parameter controls whether the font is encoded for two-byte
|
||||||
characters (potentially full Unicode, but more typically a subset)
|
characters (potentially full Unicode, but more typically a subset)
|
||||||
or to only support the Windows CP1252 (ISO-8859-1 with additional
|
or to only support the Windows CP1252 (ISO-8859-1 with additional
|
||||||
@ -4260,7 +4336,7 @@ image on the page.<br>
|
|||||||
Note: Currently PNG support is limited to grayscale, RGB, or indexed files
|
Note: Currently PNG support is limited to grayscale, RGB, or indexed files
|
||||||
without interlacing or alpha. Transparency (masking) based on color/index
|
without interlacing or alpha. Transparency (masking) based on color/index
|
||||||
is supported.</blockquote>
|
is supported.</blockquote>
|
||||||
<h3 class="function"><a id="pdfioFileCreateNameObj">pdfioFileCreateNameObj</a></h3>
|
<h3 class="function"><span class="info"> PDFio v1.4 </span><a id="pdfioFileCreateNameObj">pdfioFileCreateNameObj</a></h3>
|
||||||
<p class="description">Create a new object in a PDF file containing a name.</p>
|
<p class="description">Create a new object in a PDF file containing a name.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
<a href="#pdfio_obj_t">pdfio_obj_t</a> *pdfioFileCreateNameObj(<a href="#pdfio_file_t">pdfio_file_t</a> *pdf, <span class="reserved">const</span> <span class="reserved">char</span> *name);</p>
|
<a href="#pdfio_obj_t">pdfio_obj_t</a> *pdfioFileCreateNameObj(<a href="#pdfio_file_t">pdfio_file_t</a> *pdf, <span class="reserved">const</span> <span class="reserved">char</span> *name);</p>
|
||||||
@ -4275,8 +4351,10 @@ is supported.</blockquote>
|
|||||||
<p class="description">New object</p>
|
<p class="description">New object</p>
|
||||||
<h4 class="discussion">Discussion</h4>
|
<h4 class="discussion">Discussion</h4>
|
||||||
<p class="discussion">This function creates a new object with a name value in a PDF file.
|
<p class="discussion">This function creates a new object with a name value in a PDF file.
|
||||||
You must call <a href="#pdfioObjClose"><code>pdfioObjClose</code></a> to write the object to the file.</p>
|
You must call <a href="#pdfioObjClose"><code>pdfioObjClose</code></a> to write the object to the file.
|
||||||
<h3 class="function"><a id="pdfioFileCreateNumberObj">pdfioFileCreateNumberObj</a></h3>
|
|
||||||
|
</p>
|
||||||
|
<h3 class="function"><span class="info"> PDFio v1.2 </span><a id="pdfioFileCreateNumberObj">pdfioFileCreateNumberObj</a></h3>
|
||||||
<p class="description">Create a new object in a PDF file containing a number.</p>
|
<p class="description">Create a new object in a PDF file containing a number.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
<a href="#pdfio_obj_t">pdfio_obj_t</a> *pdfioFileCreateNumberObj(<a href="#pdfio_file_t">pdfio_file_t</a> *pdf, <span class="reserved">double</span> number);</p>
|
<a href="#pdfio_obj_t">pdfio_obj_t</a> *pdfioFileCreateNumberObj(<a href="#pdfio_file_t">pdfio_file_t</a> *pdf, <span class="reserved">double</span> number);</p>
|
||||||
@ -4291,7 +4369,9 @@ You must call <a href="#pdfioObjClose"><code>pdfioObjClose</code></a> to write t
|
|||||||
<p class="description">New object</p>
|
<p class="description">New object</p>
|
||||||
<h4 class="discussion">Discussion</h4>
|
<h4 class="discussion">Discussion</h4>
|
||||||
<p class="discussion">This function creates a new object with a number value in a PDF file.
|
<p class="discussion">This function creates a new object with a number value in a PDF file.
|
||||||
You must call <a href="#pdfioObjClose"><code>pdfioObjClose</code></a> to write the object to the file.</p>
|
You must call <a href="#pdfioObjClose"><code>pdfioObjClose</code></a> to write the object to the file.
|
||||||
|
|
||||||
|
</p>
|
||||||
<h3 class="function"><a id="pdfioFileCreateObj">pdfioFileCreateObj</a></h3>
|
<h3 class="function"><a id="pdfioFileCreateObj">pdfioFileCreateObj</a></h3>
|
||||||
<p class="description">Create a new object in a PDF file.</p>
|
<p class="description">Create a new object in a PDF file.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
@ -4372,7 +4452,7 @@ stored as indirect object references.</blockquote>
|
|||||||
</tbody></table>
|
</tbody></table>
|
||||||
<h4 class="returnvalue">Return Value</h4>
|
<h4 class="returnvalue">Return Value</h4>
|
||||||
<p class="description">Contents stream</p>
|
<p class="description">Contents stream</p>
|
||||||
<h3 class="function"><a id="pdfioFileCreateStringObj">pdfioFileCreateStringObj</a></h3>
|
<h3 class="function"><span class="info"> PDFio v1.2 </span><a id="pdfioFileCreateStringObj">pdfioFileCreateStringObj</a></h3>
|
||||||
<p class="description">Create a new object in a PDF file containing a string.</p>
|
<p class="description">Create a new object in a PDF file containing a string.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
<a href="#pdfio_obj_t">pdfio_obj_t</a> *pdfioFileCreateStringObj(<a href="#pdfio_file_t">pdfio_file_t</a> *pdf, <span class="reserved">const</span> <span class="reserved">char</span> *string);</p>
|
<a href="#pdfio_obj_t">pdfio_obj_t</a> *pdfioFileCreateStringObj(<a href="#pdfio_file_t">pdfio_file_t</a> *pdf, <span class="reserved">const</span> <span class="reserved">char</span> *string);</p>
|
||||||
@ -4387,7 +4467,9 @@ stored as indirect object references.</blockquote>
|
|||||||
<p class="description">New object</p>
|
<p class="description">New object</p>
|
||||||
<h4 class="discussion">Discussion</h4>
|
<h4 class="discussion">Discussion</h4>
|
||||||
<p class="discussion">This function creates a new object with a string value in a PDF file.
|
<p class="discussion">This function creates a new object with a string value in a PDF file.
|
||||||
You must call <a href="#pdfioObjClose"><code>pdfioObjClose</code></a> to write the object to the file.</p>
|
You must call <a href="#pdfioObjClose"><code>pdfioObjClose</code></a> to write the object to the file.
|
||||||
|
|
||||||
|
</p>
|
||||||
<h3 class="function"><a id="pdfioFileCreateTemporary">pdfioFileCreateTemporary</a></h3>
|
<h3 class="function"><a id="pdfioFileCreateTemporary">pdfioFileCreateTemporary</a></h3>
|
||||||
<p class="description"></p>
|
<p class="description"></p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
@ -4892,7 +4974,7 @@ size_t pdfioObjGetLength(<a href="#pdfio_obj_t">pdfio_obj_t</a> *obj);</p>
|
|||||||
</tbody></table>
|
</tbody></table>
|
||||||
<h4 class="returnvalue">Return Value</h4>
|
<h4 class="returnvalue">Return Value</h4>
|
||||||
<p class="description">Length in bytes or <code>0</code> for none</p>
|
<p class="description">Length in bytes or <code>0</code> for none</p>
|
||||||
<h3 class="function"><a id="pdfioObjGetName">pdfioObjGetName</a></h3>
|
<h3 class="function"><span class="info"> PDFio v1.4 </span><a id="pdfioObjGetName">pdfioObjGetName</a></h3>
|
||||||
<p class="description">Get the name value associated with an object.</p>
|
<p class="description">Get the name value associated with an object.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
<span class="reserved">const</span> <span class="reserved">char</span> *pdfioObjGetName(<a href="#pdfio_obj_t">pdfio_obj_t</a> *obj);</p>
|
<span class="reserved">const</span> <span class="reserved">char</span> *pdfioObjGetName(<a href="#pdfio_obj_t">pdfio_obj_t</a> *obj);</p>
|
||||||
@ -5168,8 +5250,9 @@ ssize_t pdfioStreamPeek(<a href="#pdfio_stream_t">pdfio_stream_t</a> *st, <span
|
|||||||
<p class="description"><code>true</code> on success, <code>false</code> on failure</p>
|
<p class="description"><code>true</code> on success, <code>false</code> on failure</p>
|
||||||
<h4 class="discussion">Discussion</h4>
|
<h4 class="discussion">Discussion</h4>
|
||||||
<p class="discussion">This function writes a formatted string to a stream. In addition to the
|
<p class="discussion">This function writes a formatted string to a stream. In addition to the
|
||||||
standard <code>printf</code> format characters, you can use "%N" to format a PDF name
|
standard <code>printf</code> format characters, you can use "%H" to format a HTML/XML
|
||||||
value ("/Name") and "%S" to format a PDF string ("(String)") value.</p>
|
string value, "%N" to format a PDF name value ("/Name"), and "%S" to format
|
||||||
|
a PDF string ("(String)") value.</p>
|
||||||
<h3 class="function"><a id="pdfioStreamPutChar">pdfioStreamPutChar</a></h3>
|
<h3 class="function"><a id="pdfioStreamPutChar">pdfioStreamPutChar</a></h3>
|
||||||
<p class="description">Write a single character to a stream.</p>
|
<p class="description">Write a single character to a stream.</p>
|
||||||
<p class="code">
|
<p class="code">
|
||||||
@ -5393,6 +5476,7 @@ typedef enum <a href="#pdfio_valtype_e">pdfio_valtype_e</a> pdfio_valtype_t;
|
|||||||
<h4 class="constants">Constants</h4>
|
<h4 class="constants">Constants</h4>
|
||||||
<table class="list"><tbody>
|
<table class="list"><tbody>
|
||||||
<tr><th>PDFIO_CS_ADOBE </th><td class="description">AdobeRGB 1998</td></tr>
|
<tr><th>PDFIO_CS_ADOBE </th><td class="description">AdobeRGB 1998</td></tr>
|
||||||
|
<tr><th>PDFIO_CS_CGATS001 </th><td class="description">CGATS001 (CMYK)</td></tr>
|
||||||
<tr><th>PDFIO_CS_P3_D65 </th><td class="description">Display P3</td></tr>
|
<tr><th>PDFIO_CS_P3_D65 </th><td class="description">Display P3</td></tr>
|
||||||
<tr><th>PDFIO_CS_SRGB </th><td class="description">sRGB</td></tr>
|
<tr><th>PDFIO_CS_SRGB </th><td class="description">sRGB</td></tr>
|
||||||
</tbody></table>
|
</tbody></table>
|
||||||
@ -5403,7 +5487,7 @@ typedef enum <a href="#pdfio_valtype_e">pdfio_valtype_e</a> pdfio_valtype_t;
|
|||||||
<tr><th>PDFIO_ENCRYPTION_AES_128 </th><td class="description">128-bit AES encryption (PDF 1.6)</td></tr>
|
<tr><th>PDFIO_ENCRYPTION_AES_128 </th><td class="description">128-bit AES encryption (PDF 1.6)</td></tr>
|
||||||
<tr><th>PDFIO_ENCRYPTION_NONE </th><td class="description">No encryption</td></tr>
|
<tr><th>PDFIO_ENCRYPTION_NONE </th><td class="description">No encryption</td></tr>
|
||||||
<tr><th>PDFIO_ENCRYPTION_RC4_128 </th><td class="description">128-bit RC4 encryption (PDF 1.4)</td></tr>
|
<tr><th>PDFIO_ENCRYPTION_RC4_128 </th><td class="description">128-bit RC4 encryption (PDF 1.4)</td></tr>
|
||||||
<tr><th>PDFIO_ENCRYPTION_RC4_40 </th><td class="description">40-bit RC4 encryption (PDF 1.3)</td></tr>
|
<tr><th>PDFIO_ENCRYPTION_RC4_40 </th><td class="description">40-bit RC4 encryption (PDF 1.3, reading only)</td></tr>
|
||||||
</tbody></table>
|
</tbody></table>
|
||||||
<h3 class="enumeration"><a id="pdfio_filter_e">pdfio_filter_e</a></h3>
|
<h3 class="enumeration"><a id="pdfio_filter_e">pdfio_filter_e</a></h3>
|
||||||
<p class="description">Compression/decompression filters for streams</p>
|
<p class="description">Compression/decompression filters for streams</p>
|
||||||
|
@ -640,6 +640,8 @@ _pdfioArrayRead(pdfio_file_t *pdf, // I - PDF file
|
|||||||
//
|
//
|
||||||
// 'pdfioArrayRemove()' - Remove an array entry.
|
// 'pdfioArrayRemove()' - Remove an array entry.
|
||||||
//
|
//
|
||||||
|
// @since PDFio v1.4@
|
||||||
|
//
|
||||||
|
|
||||||
bool // O - `true` on success, `false` otherwise
|
bool // O - `true` on success, `false` otherwise
|
||||||
pdfioArrayRemove(pdfio_array_t *a, // I - Array
|
pdfioArrayRemove(pdfio_array_t *a, // I - Array
|
||||||
|
@ -643,6 +643,8 @@ pdfioContentPathCurve23(
|
|||||||
//
|
//
|
||||||
// 'pdfioContentPathEnd()' - Clear the current path.
|
// 'pdfioContentPathEnd()' - Clear the current path.
|
||||||
//
|
//
|
||||||
|
// @since PDFio v1.1@
|
||||||
|
//
|
||||||
|
|
||||||
bool // O - `true` on success, `false` on failure
|
bool // O - `true` on success, `false` on failure
|
||||||
pdfioContentPathEnd(pdfio_stream_t *st) // I - Stream
|
pdfioContentPathEnd(pdfio_stream_t *st) // I - Stream
|
||||||
@ -1122,6 +1124,8 @@ pdfioContentTextEnd(pdfio_stream_t *st) // I - Stream
|
|||||||
// on "size". The text string must always use the UTF-8 (Unicode) encoding but
|
// on "size". The text string must always use the UTF-8 (Unicode) encoding but
|
||||||
// any control characters (such as newlines) are ignored.
|
// any control characters (such as newlines) are ignored.
|
||||||
//
|
//
|
||||||
|
// @since PDFio v1.2@
|
||||||
|
//
|
||||||
|
|
||||||
double // O - Width
|
double // O - Width
|
||||||
pdfioContentTextMeasure(
|
pdfioContentTextMeasure(
|
||||||
@ -1278,6 +1282,8 @@ pdfioContentTextMoveTo(
|
|||||||
//
|
//
|
||||||
// 'pdfioContentTextNewLine()' - Move to the next line.
|
// 'pdfioContentTextNewLine()' - Move to the next line.
|
||||||
//
|
//
|
||||||
|
// @since PDFio v1.2@
|
||||||
|
//
|
||||||
|
|
||||||
bool // O - `true` on success, `false` on failure
|
bool // O - `true` on success, `false` on failure
|
||||||
pdfioContentTextNewLine(
|
pdfioContentTextNewLine(
|
||||||
@ -1309,6 +1315,8 @@ pdfioContentTextNextLine(
|
|||||||
// specifies that the current font maps to full Unicode. The "s" argument
|
// specifies that the current font maps to full Unicode. The "s" argument
|
||||||
// specifies a UTF-8 encoded string.
|
// specifies a UTF-8 encoded string.
|
||||||
//
|
//
|
||||||
|
// @since PDFio v1.2@
|
||||||
|
//
|
||||||
|
|
||||||
bool // O - `true` on success, `false` on failure
|
bool // O - `true` on success, `false` on failure
|
||||||
pdfioContentTextNewLineShow(
|
pdfioContentTextNewLineShow(
|
||||||
@ -1357,6 +1365,8 @@ pdfioContentTextNewLineShow(
|
|||||||
// argument specifies that the current font maps to full Unicode. The "format"
|
// argument specifies that the current font maps to full Unicode. The "format"
|
||||||
// argument specifies a UTF-8 encoded `printf`-style format string.
|
// argument specifies a UTF-8 encoded `printf`-style format string.
|
||||||
//
|
//
|
||||||
|
// @since PDFio v1.2@
|
||||||
|
//
|
||||||
|
|
||||||
bool // O - `true` on success, `false` on failure
|
bool // O - `true` on success, `false` on failure
|
||||||
pdfioContentTextNewLineShowf(
|
pdfioContentTextNewLineShowf(
|
||||||
@ -1652,6 +1662,8 @@ pdfioFileCreateFontObjFromBase(
|
|||||||
// or to only support the Windows CP1252 (ISO-8859-1 with additional
|
// or to only support the Windows CP1252 (ISO-8859-1 with additional
|
||||||
// characters such as the Euro symbol) subset of Unicode.
|
// characters such as the Euro symbol) subset of Unicode.
|
||||||
//
|
//
|
||||||
|
// @since PDFio v1.6@
|
||||||
|
//
|
||||||
|
|
||||||
pdfio_obj_t * // O - Font object
|
pdfio_obj_t * // O - Font object
|
||||||
pdfioFileCreateFontObjFromData(
|
pdfioFileCreateFontObjFromData(
|
||||||
|
@ -20,6 +20,8 @@ static int compare_pairs(_pdfio_pair_t *a, _pdfio_pair_t *b);
|
|||||||
//
|
//
|
||||||
// 'pdfioDictClear()' - Remove a key/value pair from a dictionary.
|
// 'pdfioDictClear()' - Remove a key/value pair from a dictionary.
|
||||||
//
|
//
|
||||||
|
// @since PDFio v1.4@
|
||||||
|
//
|
||||||
|
|
||||||
bool // O - `true` if cleared, `false` otherwise
|
bool // O - `true` if cleared, `false` otherwise
|
||||||
pdfioDictClear(pdfio_dict_t *dict, // I - Dictionary
|
pdfioDictClear(pdfio_dict_t *dict, // I - Dictionary
|
||||||
@ -345,6 +347,8 @@ pdfioDictGetDict(pdfio_dict_t *dict, // I - Dictionary
|
|||||||
//
|
//
|
||||||
// 'pdfioDictGetKey()' - Get the key for the specified pair.
|
// 'pdfioDictGetKey()' - Get the key for the specified pair.
|
||||||
//
|
//
|
||||||
|
// @since PDFio v1.4@
|
||||||
|
//
|
||||||
|
|
||||||
const char * // O - Key for specified pair
|
const char * // O - Key for specified pair
|
||||||
pdfioDictGetKey(pdfio_dict_t *dict, // I - Dictionary
|
pdfioDictGetKey(pdfio_dict_t *dict, // I - Dictionary
|
||||||
@ -375,6 +379,8 @@ pdfioDictGetName(pdfio_dict_t *dict, // I - Dictionary
|
|||||||
//
|
//
|
||||||
// 'pdfioDictGetNumPairs()' - Get the number of key/value pairs in a dictionary.
|
// 'pdfioDictGetNumPairs()' - Get the number of key/value pairs in a dictionary.
|
||||||
//
|
//
|
||||||
|
// @since PDFio v1.4@
|
||||||
|
//
|
||||||
|
|
||||||
size_t // O - Number of pairs
|
size_t // O - Number of pairs
|
||||||
pdfioDictGetNumPairs(pdfio_dict_t *dict)// I - Dictionary
|
pdfioDictGetNumPairs(pdfio_dict_t *dict)// I - Dictionary
|
||||||
@ -562,6 +568,8 @@ _pdfioDictGetValue(pdfio_dict_t *dict, // I - Dictionary
|
|||||||
// The iteration continues as long as the callback returns `true` or all keys
|
// The iteration continues as long as the callback returns `true` or all keys
|
||||||
// have been iterated.
|
// have been iterated.
|
||||||
//
|
//
|
||||||
|
// @since PDFio v1.1@
|
||||||
|
//
|
||||||
|
|
||||||
void
|
void
|
||||||
pdfioDictIterateKeys(
|
pdfioDictIterateKeys(
|
||||||
|
@ -267,6 +267,8 @@ pdfioFileCreateArrayObj(
|
|||||||
// This function creates a new object with a name value in a PDF file.
|
// This function creates a new object with a name value in a PDF file.
|
||||||
// You must call @link pdfioObjClose@ to write the object to the file.
|
// You must call @link pdfioObjClose@ to write the object to the file.
|
||||||
//
|
//
|
||||||
|
// @since PDFio v1.4@
|
||||||
|
//
|
||||||
|
|
||||||
pdfio_obj_t * // O - New object
|
pdfio_obj_t * // O - New object
|
||||||
pdfioFileCreateNameObj(
|
pdfioFileCreateNameObj(
|
||||||
@ -296,6 +298,8 @@ pdfioFileCreateNameObj(
|
|||||||
// This function creates a new object with a number value in a PDF file.
|
// This function creates a new object with a number value in a PDF file.
|
||||||
// You must call @link pdfioObjClose@ to write the object to the file.
|
// You must call @link pdfioObjClose@ to write the object to the file.
|
||||||
//
|
//
|
||||||
|
// @since PDFio v1.2@
|
||||||
|
//
|
||||||
|
|
||||||
pdfio_obj_t * // O - New object
|
pdfio_obj_t * // O - New object
|
||||||
pdfioFileCreateNumberObj(
|
pdfioFileCreateNumberObj(
|
||||||
@ -526,6 +530,8 @@ pdfioFileCreatePage(pdfio_file_t *pdf, // I - PDF file
|
|||||||
// This function creates a new object with a string value in a PDF file.
|
// This function creates a new object with a string value in a PDF file.
|
||||||
// You must call @link pdfioObjClose@ to write the object to the file.
|
// You must call @link pdfioObjClose@ to write the object to the file.
|
||||||
//
|
//
|
||||||
|
// @since PDFio v1.2@
|
||||||
|
//
|
||||||
|
|
||||||
pdfio_obj_t * // O - New object
|
pdfio_obj_t * // O - New object
|
||||||
pdfioFileCreateStringObj(
|
pdfioFileCreateStringObj(
|
||||||
|
@ -330,6 +330,8 @@ pdfioObjGetLength(pdfio_obj_t *obj) // I - Object
|
|||||||
//
|
//
|
||||||
// 'pdfioObjGetName()' - Get the name value associated with an object.
|
// 'pdfioObjGetName()' - Get the name value associated with an object.
|
||||||
//
|
//
|
||||||
|
// @since PDFio v1.4@
|
||||||
|
//
|
||||||
|
|
||||||
const char * // O - Dictionary or `NULL` on error
|
const char * // O - Dictionary or `NULL` on error
|
||||||
pdfioObjGetName(pdfio_obj_t *obj) // I - Object
|
pdfioObjGetName(pdfio_obj_t *obj) // I - Object
|
||||||
|
Loading…
x
Reference in New Issue
Block a user