|
@@ -3,16 +3,15 @@
|
|
<head>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
-<meta name="generator" content="Doxygen 1.8.6"/>
|
|
|
|
|
|
+<meta name="generator" content="Doxygen 1.8.13"/>
|
|
|
|
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libwkhtmltox: src/lib/pdf.h File Reference</title>
|
|
<title>libwkhtmltox: src/lib/pdf.h File Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
|
|
+<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
-<script type="text/javascript">
|
|
|
|
- $(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
|
|
-</script>
|
|
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
</head>
|
|
<body>
|
|
<body>
|
|
@@ -21,7 +20,7 @@
|
|
<table cellspacing="0" cellpadding="0">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<tr style="height: 56px;">
|
|
- <td style="padding-left: 0.5em;">
|
|
|
|
|
|
+ <td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">libwkhtmltox
|
|
<div id="projectname">libwkhtmltox
|
|
</div>
|
|
</div>
|
|
</td>
|
|
</td>
|
|
@@ -30,46 +29,25 @@
|
|
</table>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- end header part -->
|
|
-<!-- Generated by Doxygen 1.8.6 -->
|
|
|
|
|
|
+<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
</script>
|
|
- <div id="navrow1" class="tabs">
|
|
|
|
- <ul class="tablist">
|
|
|
|
- <li><a href="index.html"><span>Main Page</span></a></li>
|
|
|
|
- <li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
|
|
- <li><a href="annotated.html"><span>Classes</span></a></li>
|
|
|
|
- <li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
|
|
- <li>
|
|
|
|
- <div id="MSearchBox" class="MSearchBoxInactive">
|
|
|
|
- <span class="left">
|
|
|
|
- <img id="MSearchSelect" src="search/mag_sel.png"
|
|
|
|
- onmouseover="return searchBox.OnSearchSelectShow()"
|
|
|
|
- onmouseout="return searchBox.OnSearchSelectHide()"
|
|
|
|
- alt=""/>
|
|
|
|
- <input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
|
|
- onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
|
|
- onblur="searchBox.OnSearchFieldFocus(false)"
|
|
|
|
- onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
|
|
- </span><span class="right">
|
|
|
|
- <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
|
|
- </span>
|
|
|
|
- </div>
|
|
|
|
- </li>
|
|
|
|
- </ul>
|
|
|
|
- </div>
|
|
|
|
- <div id="navrow2" class="tabs2">
|
|
|
|
- <ul class="tablist">
|
|
|
|
- <li><a href="files.html"><span>File List</span></a></li>
|
|
|
|
- <li><a href="globals.html"><span>File Members</span></a></li>
|
|
|
|
- </ul>
|
|
|
|
- </div>
|
|
|
|
|
|
+<script type="text/javascript" src="menudata.js"></script>
|
|
|
|
+<script type="text/javascript" src="menu.js"></script>
|
|
|
|
+<script type="text/javascript">
|
|
|
|
+$(function() {
|
|
|
|
+ initMenu('',true,false,'search.php','Search');
|
|
|
|
+ $(document).ready(function() { init_search(); });
|
|
|
|
+});
|
|
|
|
+</script>
|
|
|
|
+<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
-<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Pages</a></div>
|
|
|
|
|
|
+</div>
|
|
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResultsWindow">
|
|
@@ -95,60 +73,57 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
|
|
|
|
<p>Provides C bindings for pdf conversion.
|
|
<p>Provides C bindings for pdf conversion.
|
|
<a href="#details">More...</a></p>
|
|
<a href="#details">More...</a></p>
|
|
-<div class="textblock"><code>#include <wkhtmltox/dllbegin.inc></code><br/>
|
|
|
|
-<code>#include <wkhtmltox/dllend.inc></code><br/>
|
|
|
|
|
|
+<div class="textblock"><code>#include <wkhtmltox/dllbegin.inc></code><br />
|
|
|
|
+<code>#include <wkhtmltox/dllend.inc></code><br />
|
|
</div><table class="memberdecls">
|
|
</div><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
Typedefs</h2></td></tr>
|
|
-<tr class="memitem:a3b311e55a1eacb9f6a91541a0b0c0944"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b311e55a1eacb9f6a91541a0b0c0944"></a>
|
|
|
|
-typedef struct <br class="typebreak"/>
|
|
|
|
-<a class="el" href="structwkhtmltopdf__global__settings.html">wkhtmltopdf_global_settings</a> </td><td class="memItemRight" valign="bottom"><b>wkhtmltopdf_global_settings</b></td></tr>
|
|
|
|
|
|
+<tr class="memitem:a3b311e55a1eacb9f6a91541a0b0c0944"><td class="memItemLeft" align="right" valign="top"><a id="a3b311e55a1eacb9f6a91541a0b0c0944"></a>
|
|
|
|
+typedef struct <a class="el" href="structwkhtmltopdf__global__settings.html">wkhtmltopdf_global_settings</a> </td><td class="memItemRight" valign="bottom"><b>wkhtmltopdf_global_settings</b></td></tr>
|
|
<tr class="separator:a3b311e55a1eacb9f6a91541a0b0c0944"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:a3b311e55a1eacb9f6a91541a0b0c0944"><td class="memSeparator" colspan="2"> </td></tr>
|
|
-<tr class="memitem:a9ee63a9f472f30a6fc2d7480fd397724"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ee63a9f472f30a6fc2d7480fd397724"></a>
|
|
|
|
-typedef struct <br class="typebreak"/>
|
|
|
|
-<a class="el" href="structwkhtmltopdf__object__settings.html">wkhtmltopdf_object_settings</a> </td><td class="memItemRight" valign="bottom"><b>wkhtmltopdf_object_settings</b></td></tr>
|
|
|
|
|
|
+<tr class="memitem:a9ee63a9f472f30a6fc2d7480fd397724"><td class="memItemLeft" align="right" valign="top"><a id="a9ee63a9f472f30a6fc2d7480fd397724"></a>
|
|
|
|
+typedef struct <a class="el" href="structwkhtmltopdf__object__settings.html">wkhtmltopdf_object_settings</a> </td><td class="memItemRight" valign="bottom"><b>wkhtmltopdf_object_settings</b></td></tr>
|
|
<tr class="separator:a9ee63a9f472f30a6fc2d7480fd397724"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:a9ee63a9f472f30a6fc2d7480fd397724"><td class="memSeparator" colspan="2"> </td></tr>
|
|
-<tr class="memitem:aa9e3c5e3256dfda0979dfee953840a4b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9e3c5e3256dfda0979dfee953840a4b"></a>
|
|
|
|
-typedef struct <br class="typebreak"/>
|
|
|
|
-<a class="el" href="structwkhtmltopdf__converter.html">wkhtmltopdf_converter</a> </td><td class="memItemRight" valign="bottom"><b>wkhtmltopdf_converter</b></td></tr>
|
|
|
|
|
|
+<tr class="memitem:aa9e3c5e3256dfda0979dfee953840a4b"><td class="memItemLeft" align="right" valign="top"><a id="aa9e3c5e3256dfda0979dfee953840a4b"></a>
|
|
|
|
+typedef struct <a class="el" href="structwkhtmltopdf__converter.html">wkhtmltopdf_converter</a> </td><td class="memItemRight" valign="bottom"><b>wkhtmltopdf_converter</b></td></tr>
|
|
<tr class="separator:aa9e3c5e3256dfda0979dfee953840a4b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:aa9e3c5e3256dfda0979dfee953840a4b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
-<tr class="memitem:a152eb52e87e7ab85533f44fcdc688d4e"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="pdf_8h.html#a152eb52e87e7ab85533f44fcdc688d4e">wkhtmltopdf_str_callback</a> )(<a class="el" href="structwkhtmltopdf__converter.html">wkhtmltopdf_converter</a> *converter, const char *str)</td></tr>
|
|
|
|
-<tr class="memdesc:a152eb52e87e7ab85533f44fcdc688d4e"><td class="mdescLeft"> </td><td class="mdescRight">Function pointer type used for the error and warning callbacks. <a href="#a152eb52e87e7ab85533f44fcdc688d4e">More...</a><br/></td></tr>
|
|
|
|
|
|
+<tr class="memitem:a152eb52e87e7ab85533f44fcdc688d4e"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="pdf_8h.html#a152eb52e87e7ab85533f44fcdc688d4e">wkhtmltopdf_str_callback</a>) (<a class="el" href="structwkhtmltopdf__converter.html">wkhtmltopdf_converter</a> *converter, const char *str)</td></tr>
|
|
|
|
+<tr class="memdesc:a152eb52e87e7ab85533f44fcdc688d4e"><td class="mdescLeft"> </td><td class="mdescRight">Function pointer type used for the error and warning callbacks. <a href="#a152eb52e87e7ab85533f44fcdc688d4e">More...</a><br /></td></tr>
|
|
<tr class="separator:a152eb52e87e7ab85533f44fcdc688d4e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:a152eb52e87e7ab85533f44fcdc688d4e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
-<tr class="memitem:a9eb2902934ed92714aaf48c4379ed5c4"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="pdf_8h.html#a9eb2902934ed92714aaf48c4379ed5c4">wkhtmltopdf_int_callback</a> )(<a class="el" href="structwkhtmltopdf__converter.html">wkhtmltopdf_converter</a> *converter, const int val)</td></tr>
|
|
|
|
-<tr class="memdesc:a9eb2902934ed92714aaf48c4379ed5c4"><td class="mdescLeft"> </td><td class="mdescRight">Function pointer type used for the progress_changed and finished callbacks. <a href="#a9eb2902934ed92714aaf48c4379ed5c4">More...</a><br/></td></tr>
|
|
|
|
|
|
+<tr class="memitem:a9eb2902934ed92714aaf48c4379ed5c4"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="pdf_8h.html#a9eb2902934ed92714aaf48c4379ed5c4">wkhtmltopdf_int_callback</a>) (<a class="el" href="structwkhtmltopdf__converter.html">wkhtmltopdf_converter</a> *converter, const int val)</td></tr>
|
|
|
|
+<tr class="memdesc:a9eb2902934ed92714aaf48c4379ed5c4"><td class="mdescLeft"> </td><td class="mdescRight">Function pointer type used for the progress_changed and finished callbacks. <a href="#a9eb2902934ed92714aaf48c4379ed5c4">More...</a><br /></td></tr>
|
|
<tr class="separator:a9eb2902934ed92714aaf48c4379ed5c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:a9eb2902934ed92714aaf48c4379ed5c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
-<tr class="memitem:a34f2b11de61fe99d8365dc5cf547609f"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="pdf_8h.html#a34f2b11de61fe99d8365dc5cf547609f">wkhtmltopdf_void_callback</a> )(<a class="el" href="structwkhtmltopdf__converter.html">wkhtmltopdf_converter</a> *converter)</td></tr>
|
|
|
|
-<tr class="memdesc:a34f2b11de61fe99d8365dc5cf547609f"><td class="mdescLeft"> </td><td class="mdescRight">Function pointer type used for the phase_changed callback. <a href="#a34f2b11de61fe99d8365dc5cf547609f">More...</a><br/></td></tr>
|
|
|
|
|
|
+<tr class="memitem:a34f2b11de61fe99d8365dc5cf547609f"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="pdf_8h.html#a34f2b11de61fe99d8365dc5cf547609f">wkhtmltopdf_void_callback</a>) (<a class="el" href="structwkhtmltopdf__converter.html">wkhtmltopdf_converter</a> *converter)</td></tr>
|
|
|
|
+<tr class="memdesc:a34f2b11de61fe99d8365dc5cf547609f"><td class="mdescLeft"> </td><td class="mdescRight">Function pointer type used for the phase_changed callback. <a href="#a34f2b11de61fe99d8365dc5cf547609f">More...</a><br /></td></tr>
|
|
<tr class="separator:a34f2b11de61fe99d8365dc5cf547609f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:a34f2b11de61fe99d8365dc5cf547609f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:aae464baff9fa6aa118278b80757066ce"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="pdf_8h.html#aae464baff9fa6aa118278b80757066ce">CAPI</a> (int) wkhtmltopdf_init(int use_graphics)</td></tr>
|
|
<tr class="memitem:aae464baff9fa6aa118278b80757066ce"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="pdf_8h.html#aae464baff9fa6aa118278b80757066ce">CAPI</a> (int) wkhtmltopdf_init(int use_graphics)</td></tr>
|
|
-<tr class="memdesc:aae464baff9fa6aa118278b80757066ce"><td class="mdescLeft"> </td><td class="mdescRight">Setup wkhtmltopdf. <a href="#aae464baff9fa6aa118278b80757066ce">More...</a><br/></td></tr>
|
|
|
|
|
|
+<tr class="memdesc:aae464baff9fa6aa118278b80757066ce"><td class="mdescLeft"> </td><td class="mdescRight">Setup wkhtmltopdf. <a href="#aae464baff9fa6aa118278b80757066ce">More...</a><br /></td></tr>
|
|
<tr class="separator:aae464baff9fa6aa118278b80757066ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:aae464baff9fa6aa118278b80757066ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abf74cbcdfe94dc5bbfb35a4c83d3760b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="pdf_8h.html#abf74cbcdfe94dc5bbfb35a4c83d3760b">CAPI</a> (const char *) wkhtmltopdf_version()</td></tr>
|
|
<tr class="memitem:abf74cbcdfe94dc5bbfb35a4c83d3760b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="pdf_8h.html#abf74cbcdfe94dc5bbfb35a4c83d3760b">CAPI</a> (const char *) wkhtmltopdf_version()</td></tr>
|
|
-<tr class="memdesc:abf74cbcdfe94dc5bbfb35a4c83d3760b"><td class="mdescLeft"> </td><td class="mdescRight">Return a short utf8 description of a conversion phase. <a href="#abf74cbcdfe94dc5bbfb35a4c83d3760b">More...</a><br/></td></tr>
|
|
|
|
|
|
+<tr class="memdesc:abf74cbcdfe94dc5bbfb35a4c83d3760b"><td class="mdescLeft"> </td><td class="mdescRight">Return a short utf8 description of a conversion phase. <a href="#abf74cbcdfe94dc5bbfb35a4c83d3760b">More...</a><br /></td></tr>
|
|
<tr class="separator:abf74cbcdfe94dc5bbfb35a4c83d3760b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:abf74cbcdfe94dc5bbfb35a4c83d3760b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a4616a330a354c5951430057e355e7e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="pdf_8h.html#a5a4616a330a354c5951430057e355e7e">CAPI</a> (<a class="el" href="structwkhtmltopdf__global__settings.html">wkhtmltopdf_global_settings</a> *) wkhtmltopdf_create_global_settings()</td></tr>
|
|
<tr class="memitem:a5a4616a330a354c5951430057e355e7e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="pdf_8h.html#a5a4616a330a354c5951430057e355e7e">CAPI</a> (<a class="el" href="structwkhtmltopdf__global__settings.html">wkhtmltopdf_global_settings</a> *) wkhtmltopdf_create_global_settings()</td></tr>
|
|
-<tr class="memdesc:a5a4616a330a354c5951430057e355e7e"><td class="mdescLeft"> </td><td class="mdescRight">Create a new global settings object for pdf conversion. <a href="#a5a4616a330a354c5951430057e355e7e">More...</a><br/></td></tr>
|
|
|
|
|
|
+<tr class="memdesc:a5a4616a330a354c5951430057e355e7e"><td class="mdescLeft"> </td><td class="mdescRight">Create a new global settings object for pdf conversion. <a href="#a5a4616a330a354c5951430057e355e7e">More...</a><br /></td></tr>
|
|
<tr class="separator:a5a4616a330a354c5951430057e355e7e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:a5a4616a330a354c5951430057e355e7e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac05baf7b50071366b946038b4fa412a6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="pdf_8h.html#ac05baf7b50071366b946038b4fa412a6">CAPI</a> (void) wkhtmltopdf_destroy_global_settings(<a class="el" href="structwkhtmltopdf__global__settings.html">wkhtmltopdf_global_settings</a> *)</td></tr>
|
|
<tr class="memitem:ac05baf7b50071366b946038b4fa412a6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="pdf_8h.html#ac05baf7b50071366b946038b4fa412a6">CAPI</a> (void) wkhtmltopdf_destroy_global_settings(<a class="el" href="structwkhtmltopdf__global__settings.html">wkhtmltopdf_global_settings</a> *)</td></tr>
|
|
-<tr class="memdesc:ac05baf7b50071366b946038b4fa412a6"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a global settings object. <a href="#ac05baf7b50071366b946038b4fa412a6">More...</a><br/></td></tr>
|
|
|
|
|
|
+<tr class="memdesc:ac05baf7b50071366b946038b4fa412a6"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a global settings object. <a href="#ac05baf7b50071366b946038b4fa412a6">More...</a><br /></td></tr>
|
|
<tr class="separator:ac05baf7b50071366b946038b4fa412a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:ac05baf7b50071366b946038b4fa412a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab0221a9deb308b653fdf114e1bdbf06f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="pdf_8h.html#ab0221a9deb308b653fdf114e1bdbf06f">CAPI</a> (<a class="el" href="structwkhtmltopdf__object__settings.html">wkhtmltopdf_object_settings</a> *) wkhtmltopdf_create_object_settings()</td></tr>
|
|
<tr class="memitem:ab0221a9deb308b653fdf114e1bdbf06f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="pdf_8h.html#ab0221a9deb308b653fdf114e1bdbf06f">CAPI</a> (<a class="el" href="structwkhtmltopdf__object__settings.html">wkhtmltopdf_object_settings</a> *) wkhtmltopdf_create_object_settings()</td></tr>
|
|
-<tr class="memdesc:ab0221a9deb308b653fdf114e1bdbf06f"><td class="mdescLeft"> </td><td class="mdescRight">Create an object used to store object settings. <a href="#ab0221a9deb308b653fdf114e1bdbf06f">More...</a><br/></td></tr>
|
|
|
|
|
|
+<tr class="memdesc:ab0221a9deb308b653fdf114e1bdbf06f"><td class="mdescLeft"> </td><td class="mdescRight">Create an object used to store object settings. <a href="#ab0221a9deb308b653fdf114e1bdbf06f">More...</a><br /></td></tr>
|
|
<tr class="separator:ab0221a9deb308b653fdf114e1bdbf06f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:ab0221a9deb308b653fdf114e1bdbf06f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ade66be9513ad5b2390ae84a0a2e4e886"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="pdf_8h.html#ade66be9513ad5b2390ae84a0a2e4e886">CAPI</a> (<a class="el" href="structwkhtmltopdf__converter.html">wkhtmltopdf_converter</a> *) wkhtmltopdf_create_converter(<a class="el" href="structwkhtmltopdf__global__settings.html">wkhtmltopdf_global_settings</a> *settings)</td></tr>
|
|
<tr class="memitem:ade66be9513ad5b2390ae84a0a2e4e886"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="pdf_8h.html#ade66be9513ad5b2390ae84a0a2e4e886">CAPI</a> (<a class="el" href="structwkhtmltopdf__converter.html">wkhtmltopdf_converter</a> *) wkhtmltopdf_create_converter(<a class="el" href="structwkhtmltopdf__global__settings.html">wkhtmltopdf_global_settings</a> *settings)</td></tr>
|
|
-<tr class="memdesc:ade66be9513ad5b2390ae84a0a2e4e886"><td class="mdescLeft"> </td><td class="mdescRight">Create a wkhtmltopdf converter object. <a href="#ade66be9513ad5b2390ae84a0a2e4e886">More...</a><br/></td></tr>
|
|
|
|
|
|
+<tr class="memdesc:ade66be9513ad5b2390ae84a0a2e4e886"><td class="mdescLeft"> </td><td class="mdescRight">Create a wkhtmltopdf converter object. <a href="#ade66be9513ad5b2390ae84a0a2e4e886">More...</a><br /></td></tr>
|
|
<tr class="separator:ade66be9513ad5b2390ae84a0a2e4e886"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:ade66be9513ad5b2390ae84a0a2e4e886"><td class="memSeparator" colspan="2"> </td></tr>
|
|
-<tr class="memitem:a56fa0550c4b23be801ef990d8dfaf73a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56fa0550c4b23be801ef990d8dfaf73a"></a>
|
|
|
|
|
|
+<tr class="memitem:a56fa0550c4b23be801ef990d8dfaf73a"><td class="memItemLeft" align="right" valign="top"><a id="a56fa0550c4b23be801ef990d8dfaf73a"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>CAPI</b> (long) wkhtmltopdf_get_output(<a class="el" href="structwkhtmltopdf__converter.html">wkhtmltopdf_converter</a> *converter</td></tr>
|
|
 </td><td class="memItemRight" valign="bottom"><b>CAPI</b> (long) wkhtmltopdf_get_output(<a class="el" href="structwkhtmltopdf__converter.html">wkhtmltopdf_converter</a> *converter</td></tr>
|
|
<tr class="separator:a56fa0550c4b23be801ef990d8dfaf73a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:a56fa0550c4b23be801ef990d8dfaf73a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
Variables</h2></td></tr>
|
|
-<tr class="memitem:afcd1706c9144e6d6eee6127661ae3be2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afcd1706c9144e6d6eee6127661ae3be2"></a>
|
|
|
|
|
|
+<tr class="memitem:afcd1706c9144e6d6eee6127661ae3be2"><td class="memItemLeft" align="right" valign="top"><a id="afcd1706c9144e6d6eee6127661ae3be2"></a>
|
|
const char * </td><td class="memItemRight" valign="bottom"><b>name</b></td></tr>
|
|
const char * </td><td class="memItemRight" valign="bottom"><b>name</b></td></tr>
|
|
<tr class="separator:afcd1706c9144e6d6eee6127661ae3be2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:afcd1706c9144e6d6eee6127661ae3be2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2acb6da069a6712a3f5ffc4a46715d6f"><td class="memItemLeft" align="right" valign="top">const char const char * </td><td class="memItemRight" valign="bottom"><b>value</b></td></tr>
|
|
<tr class="memitem:a2acb6da069a6712a3f5ffc4a46715d6f"><td class="memItemLeft" align="right" valign="top">const char const char * </td><td class="memItemRight" valign="bottom"><b>value</b></td></tr>
|
|
@@ -157,21 +132,22 @@ const char * </td><td class="memItemRight" valign="bottom"><b>name</b></td>
|
|
<tr class="separator:a0470287e557638636ebc12b18b2e1229"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:a0470287e557638636ebc12b18b2e1229"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab6e2be62cf7773038f6b1e83de224a81"><td class="memItemLeft" align="right" valign="top"><a class="el" href="pdf_8h.html#a152eb52e87e7ab85533f44fcdc688d4e">wkhtmltopdf_str_callback</a> </td><td class="memItemRight" valign="bottom"><b>cb</b></td></tr>
|
|
<tr class="memitem:ab6e2be62cf7773038f6b1e83de224a81"><td class="memItemLeft" align="right" valign="top"><a class="el" href="pdf_8h.html#a152eb52e87e7ab85533f44fcdc688d4e">wkhtmltopdf_str_callback</a> </td><td class="memItemRight" valign="bottom"><b>cb</b></td></tr>
|
|
<tr class="separator:ab6e2be62cf7773038f6b1e83de224a81"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:ab6e2be62cf7773038f6b1e83de224a81"><td class="memSeparator" colspan="2"> </td></tr>
|
|
-<tr class="memitem:a169061a6cf49398b442bcd36cf17594d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a169061a6cf49398b442bcd36cf17594d"></a>
|
|
|
|
|
|
+<tr class="memitem:a169061a6cf49398b442bcd36cf17594d"><td class="memItemLeft" align="right" valign="top"><a id="a169061a6cf49398b442bcd36cf17594d"></a>
|
|
<a class="el" href="structwkhtmltopdf__object__settings.html">wkhtmltopdf_object_settings</a> * </td><td class="memItemRight" valign="bottom"><b>setting</b></td></tr>
|
|
<a class="el" href="structwkhtmltopdf__object__settings.html">wkhtmltopdf_object_settings</a> * </td><td class="memItemRight" valign="bottom"><b>setting</b></td></tr>
|
|
<tr class="separator:a169061a6cf49398b442bcd36cf17594d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:a169061a6cf49398b442bcd36cf17594d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
-<tr class="memitem:a2055ad7065ecc24f7600ee328c8bff2c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2055ad7065ecc24f7600ee328c8bff2c"></a>
|
|
|
|
-<a class="el" href="structwkhtmltopdf__object__settings.html">wkhtmltopdf_object_settings</a> <br class="typebreak"/>
|
|
|
|
-const char * </td><td class="memItemRight" valign="bottom"><b>data</b></td></tr>
|
|
|
|
|
|
+<tr class="memitem:a2055ad7065ecc24f7600ee328c8bff2c"><td class="memItemLeft" align="right" valign="top"><a id="a2055ad7065ecc24f7600ee328c8bff2c"></a>
|
|
|
|
+<a class="el" href="structwkhtmltopdf__object__settings.html">wkhtmltopdf_object_settings</a> const char * </td><td class="memItemRight" valign="bottom"><b>data</b></td></tr>
|
|
<tr class="separator:a2055ad7065ecc24f7600ee328c8bff2c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:a2055ad7065ecc24f7600ee328c8bff2c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
-<tr class="memitem:accf3aec63bc20b3c99ab4881cb07c05b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="accf3aec63bc20b3c99ab4881cb07c05b"></a>
|
|
|
|
|
|
+<tr class="memitem:accf3aec63bc20b3c99ab4881cb07c05b"><td class="memItemLeft" align="right" valign="top"><a id="accf3aec63bc20b3c99ab4881cb07c05b"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
<tr class="separator:accf3aec63bc20b3c99ab4881cb07c05b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:accf3aec63bc20b3c99ab4881cb07c05b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Provides C bindings for pdf conversion. </p>
|
|
<div class="textblock"><p>Provides C bindings for pdf conversion. </p>
|
|
</div><h2 class="groupheader">Typedef Documentation</h2>
|
|
</div><h2 class="groupheader">Typedef Documentation</h2>
|
|
-<a class="anchor" id="a9eb2902934ed92714aaf48c4379ed5c4"></a>
|
|
|
|
|
|
+<a id="a9eb2902934ed92714aaf48c4379ed5c4"></a>
|
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#a9eb2902934ed92714aaf48c4379ed5c4">◆ </a></span>wkhtmltopdf_int_callback</h2>
|
|
|
|
+
|
|
<div class="memitem">
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<table class="memname">
|
|
@@ -190,11 +166,13 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
</table>
|
|
</table>
|
|
</dd>
|
|
</dd>
|
|
</dl>
|
|
</dl>
|
|
-<dl class="section see"><dt>See Also</dt><dd>wkhtmltopdf_set_progress_changed, wkhtmltopdf_set_finished_callback </dd></dl>
|
|
|
|
|
|
+<dl class="section see"><dt>See also</dt><dd>wkhtmltopdf_set_progress_changed, wkhtmltopdf_set_finished_callback </dd></dl>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
-<a class="anchor" id="a152eb52e87e7ab85533f44fcdc688d4e"></a>
|
|
|
|
|
|
+<a id="a152eb52e87e7ab85533f44fcdc688d4e"></a>
|
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#a152eb52e87e7ab85533f44fcdc688d4e">◆ </a></span>wkhtmltopdf_str_callback</h2>
|
|
|
|
+
|
|
<div class="memitem">
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<table class="memname">
|
|
@@ -212,11 +190,13 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
</table>
|
|
</table>
|
|
</dd>
|
|
</dd>
|
|
</dl>
|
|
</dl>
|
|
-<dl class="section see"><dt>See Also</dt><dd>wkhtmltopdf_set_error_callback, wkhtmltopdf_set_warning_callback </dd></dl>
|
|
|
|
|
|
+<dl class="section see"><dt>See also</dt><dd>wkhtmltopdf_set_error_callback, wkhtmltopdf_set_warning_callback </dd></dl>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
-<a class="anchor" id="a34f2b11de61fe99d8365dc5cf547609f"></a>
|
|
|
|
|
|
+<a id="a34f2b11de61fe99d8365dc5cf547609f"></a>
|
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#a34f2b11de61fe99d8365dc5cf547609f">◆ </a></span>wkhtmltopdf_void_callback</h2>
|
|
|
|
+
|
|
<div class="memitem">
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<table class="memname">
|
|
@@ -233,12 +213,14 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
</table>
|
|
</table>
|
|
</dd>
|
|
</dd>
|
|
</dl>
|
|
</dl>
|
|
-<dl class="section see"><dt>See Also</dt><dd>wkhtmltopdf_set_phase_changed_callback </dd></dl>
|
|
|
|
|
|
+<dl class="section see"><dt>See also</dt><dd>wkhtmltopdf_set_phase_changed_callback </dd></dl>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
-<a class="anchor" id="aae464baff9fa6aa118278b80757066ce"></a>
|
|
|
|
|
|
+<a id="aae464baff9fa6aa118278b80757066ce"></a>
|
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#aae464baff9fa6aa118278b80757066ce">◆ </a></span>CAPI() <span class="overload">[1/6]</span></h2>
|
|
|
|
+
|
|
<div class="memitem">
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<table class="memname">
|
|
@@ -257,6 +239,7 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
<p>Get the total number of phases the conversion process will go trough.</p>
|
|
<p>Get the total number of phases the conversion process will go trough.</p>
|
|
<p>Get the number of the current conversion phase.</p>
|
|
<p>Get the number of the current conversion phase.</p>
|
|
<p>Convert the input objects into a pdf document.</p>
|
|
<p>Convert the input objects into a pdf document.</p>
|
|
|
|
+<p>Retrieve a setting in a object settings object.</p>
|
|
<p>Alter a setting in a object settings object.</p>
|
|
<p>Alter a setting in a object settings object.</p>
|
|
<p>Retrieve a setting in a global settings object.</p>
|
|
<p>Retrieve a setting in a global settings object.</p>
|
|
<p>Alter a setting in a global settings object.</p>
|
|
<p>Alter a setting in a global settings object.</p>
|
|
@@ -269,42 +252,53 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
</dd>
|
|
</dd>
|
|
</dl>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 on success and 0 otherwise</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 on success and 0 otherwise</dd></dl>
|
|
-<dl class="section see"><dt>See Also</dt><dd>wkhtmltopdf_deinit</dd></dl>
|
|
|
|
|
|
+<dl class="section see"><dt>See also</dt><dd>wkhtmltopdf_deinit</dd></dl>
|
|
<p>Free up resources used by wkhtmltopdf, when this has been called no other wkhtmltopdf function can be called.</p>
|
|
<p>Free up resources used by wkhtmltopdf, when this has been called no other wkhtmltopdf function can be called.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 on success and 0 otherwise</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 on success and 0 otherwise</dd></dl>
|
|
-<dl class="section see"><dt>See Also</dt><dd>wkhtmltopdf_init</dd>
|
|
|
|
|
|
+<dl class="section see"><dt>See also</dt><dd>wkhtmltopdf_init</dd>
|
|
<dd>
|
|
<dd>
|
|
<a class="el" href="pagesettings.html#pagePdfGlobal">Pdf global settings</a>, wkhtmltopdf_create_global_settings, wkhtmltopdf_get_global_setting</dd></dl>
|
|
<a class="el" href="pagesettings.html#pagePdfGlobal">Pdf global settings</a>, wkhtmltopdf_create_global_settings, wkhtmltopdf_get_global_setting</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<table class="params">
|
|
<tr><td class="paramname">settings</td><td>The settings object to change </td></tr>
|
|
<tr><td class="paramname">settings</td><td>The settings object to change </td></tr>
|
|
<tr><td class="paramname">name</td><td>The name of the setting </td></tr>
|
|
<tr><td class="paramname">name</td><td>The name of the setting </td></tr>
|
|
- <tr><td class="paramname">value</td><td>The new value for the setting </td></tr>
|
|
|
|
|
|
+ <tr><td class="paramname">value</td><td>The new value for the setting (encoded in UTF-8) </td></tr>
|
|
</table>
|
|
</table>
|
|
</dd>
|
|
</dd>
|
|
</dl>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 if the setting was updated successfully and 0 otherwise.</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 if the setting was updated successfully and 0 otherwise.</dd></dl>
|
|
-<dl class="section see"><dt>See Also</dt><dd><a class="el" href="pagesettings.html">Setting</a>, wkhtmltopdf_create_global_settings, wkhtmltopdf_set_global_setting</dd></dl>
|
|
|
|
|
|
+<dl class="section see"><dt>See also</dt><dd><a class="el" href="pagesettings.html">Setting</a>, wkhtmltopdf_create_global_settings, wkhtmltopdf_set_global_setting</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<table class="params">
|
|
<tr><td class="paramname">settings</td><td>The settings object to inspect </td></tr>
|
|
<tr><td class="paramname">settings</td><td>The settings object to inspect </td></tr>
|
|
<tr><td class="paramname">name</td><td>The name of the setting to read </td></tr>
|
|
<tr><td class="paramname">name</td><td>The name of the setting to read </td></tr>
|
|
- <tr><td class="paramname">value</td><td>A buffer of length at least <em>vs</em>, where the value is stored. </td></tr>
|
|
|
|
|
|
+ <tr><td class="paramname">value</td><td>A buffer of length at least <em>vs</em>, where the value (encoded in UTF-8) is stored. </td></tr>
|
|
<tr><td class="paramname">vs</td><td>The length of <em>value</em> </td></tr>
|
|
<tr><td class="paramname">vs</td><td>The length of <em>value</em> </td></tr>
|
|
</table>
|
|
</table>
|
|
</dd>
|
|
</dd>
|
|
</dl>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 If the the setting exists and was read successfully and 0 otherwise</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 If the the setting exists and was read successfully and 0 otherwise</dd></dl>
|
|
-<dl class="section see"><dt>See Also</dt><dd><a class="el" href="pagesettings.html">Setting</a>, wkhtmltopdf_create_object_settings, wkhtmltopdf_get_object_setting</dd></dl>
|
|
|
|
|
|
+<dl class="section see"><dt>See also</dt><dd><a class="el" href="pagesettings.html">Setting</a>, wkhtmltopdf_create_object_settings, wkhtmltopdf_get_object_setting</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<table class="params">
|
|
<tr><td class="paramname">settings</td><td>The settings object to change </td></tr>
|
|
<tr><td class="paramname">settings</td><td>The settings object to change </td></tr>
|
|
<tr><td class="paramname">name</td><td>The name of the setting </td></tr>
|
|
<tr><td class="paramname">name</td><td>The name of the setting </td></tr>
|
|
- <tr><td class="paramname">value</td><td>The new value for the setting </td></tr>
|
|
|
|
|
|
+ <tr><td class="paramname">value</td><td>The new value for the setting (encoded in UTF-8) </td></tr>
|
|
</table>
|
|
</table>
|
|
</dd>
|
|
</dd>
|
|
</dl>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 if the setting was updated successfully and 0 otherwise.</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 if the setting was updated successfully and 0 otherwise.</dd></dl>
|
|
|
|
+<dl class="section see"><dt>See also</dt><dd><a class="el" href="pagesettings.html">Setting</a>, wkhtmltopdf_create_global_settings, wkhtmltopdf_set_global_setting</dd></dl>
|
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
|
+ <table class="params">
|
|
|
|
+ <tr><td class="paramname">settings</td><td>The settings object to inspect </td></tr>
|
|
|
|
+ <tr><td class="paramname">name</td><td>The name of the setting to read </td></tr>
|
|
|
|
+ <tr><td class="paramname">value</td><td>A buffer of length at least <em>vs</em>, where the value is stored (encoded in UTF-8). </td></tr>
|
|
|
|
+ <tr><td class="paramname">vs</td><td>The length of <em>value</em> </td></tr>
|
|
|
|
+ </table>
|
|
|
|
+ </dd>
|
|
|
|
+</dl>
|
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>1 If the the setting exists and was read successfully and 0 otherwise</dd></dl>
|
|
<p>This is the main method for the conversion process, during conversion progress information warning, and errors are reported using the supplied call backs. Once the conversion is done the output pdf (or ps) file will be placed at the location of the "out" setting supplied in the global settings object during construction of the converter. If this setting is not supplied or set to the empty string, the output can be retrieved using the wkhtmltopdf_get_output function.</p>
|
|
<p>This is the main method for the conversion process, during conversion progress information warning, and errors are reported using the supplied call backs. Once the conversion is done the output pdf (or ps) file will be placed at the location of the "out" setting supplied in the global settings object during construction of the converter. If this setting is not supplied or set to the empty string, the output can be retrieved using the wkhtmltopdf_get_output function.</p>
|
|
<p>converter The converter to perform the conversion on.</p>
|
|
<p>converter The converter to perform the conversion on.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 on success and 0 otherwise</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 on success and 0 otherwise</dd></dl>
|
|
@@ -324,7 +318,7 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
</dd>
|
|
</dd>
|
|
</dl>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The total number of phases in the conversion process</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The total number of phases in the conversion process</dd></dl>
|
|
-<dl class="section see"><dt>See Also</dt><dd>wkhtmltopdf_current_phase, wkhtmltopdf_phase_description</dd></dl>
|
|
|
|
|
|
+<dl class="section see"><dt>See also</dt><dd>wkhtmltopdf_current_phase, wkhtmltopdf_phase_description</dd></dl>
|
|
<p>Return the largest HTTP code greater then or equal to 300 encountered during loading of any of the supplied objects, if no such error code is found 0 is returned. This function will only return a useful result after wkhtmltopdf_convert has been called.</p>
|
|
<p>Return the largest HTTP code greater then or equal to 300 encountered during loading of any of the supplied objects, if no such error code is found 0 is returned. This function will only return a useful result after wkhtmltopdf_convert has been called.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<table class="params">
|
|
@@ -336,7 +330,9 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
-<a class="anchor" id="abf74cbcdfe94dc5bbfb35a4c83d3760b"></a>
|
|
|
|
|
|
+<a id="abf74cbcdfe94dc5bbfb35a4c83d3760b"></a>
|
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#abf74cbcdfe94dc5bbfb35a4c83d3760b">◆ </a></span>CAPI() <span class="overload">[2/6]</span></h2>
|
|
|
|
+
|
|
<div class="memitem">
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<table class="memname">
|
|
@@ -360,7 +356,7 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
</dd>
|
|
</dd>
|
|
</dl>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A description of the conversion phase</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A description of the conversion phase</dd></dl>
|
|
-<dl class="section see"><dt>See Also</dt><dd>wkhtmltopdf_current_phase, wkhtmltopdf_phase_description</dd></dl>
|
|
|
|
|
|
+<dl class="section see"><dt>See also</dt><dd>wkhtmltopdf_current_phase, wkhtmltopdf_phase_description</dd></dl>
|
|
<p>Will typically return a string like "40%"</p>
|
|
<p>Will typically return a string like "40%"</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<table class="params">
|
|
@@ -369,11 +365,13 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
</dd>
|
|
</dd>
|
|
</dl>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A string containing a progress indication</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A string containing a progress indication</dd></dl>
|
|
-<dl class="section see"><dt>See Also</dt><dd>wkhtmltopdf_set_progress_changed_callback </dd></dl>
|
|
|
|
|
|
+<dl class="section see"><dt>See also</dt><dd>wkhtmltopdf_set_progress_changed_callback </dd></dl>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
-<a class="anchor" id="a5a4616a330a354c5951430057e355e7e"></a>
|
|
|
|
|
|
+<a id="a5a4616a330a354c5951430057e355e7e"></a>
|
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#a5a4616a330a354c5951430057e355e7e">◆ </a></span>CAPI() <span class="overload">[3/6]</span></h2>
|
|
|
|
+
|
|
<div class="memitem">
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<table class="memname">
|
|
@@ -393,7 +391,9 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
-<a class="anchor" id="ac05baf7b50071366b946038b4fa412a6"></a>
|
|
|
|
|
|
+<a id="ac05baf7b50071366b946038b4fa412a6"></a>
|
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#ac05baf7b50071366b946038b4fa412a6">◆ </a></span>CAPI() <span class="overload">[4/6]</span></h2>
|
|
|
|
+
|
|
<div class="memitem">
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<table class="memname">
|
|
@@ -412,18 +412,18 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
<p>Set the function that should be called once the conversion has finished.</p>
|
|
<p>Set the function that should be called once the conversion has finished.</p>
|
|
<p>Set the function that should be called when progress have been done during conversion.</p>
|
|
<p>Set the function that should be called when progress have been done during conversion.</p>
|
|
<p>Set the function that should be called whenever conversion changes phase.</p>
|
|
<p>Set the function that should be called whenever conversion changes phase.</p>
|
|
-<p>Set the function that should be called when an warning message is issued during conversion.</p>
|
|
|
|
<p>Set the function that should be called when an errors occurs during conversion.</p>
|
|
<p>Set the function that should be called when an errors occurs during conversion.</p>
|
|
|
|
+<p>Set the function that should be called when an warning message is issued during conversion.</p>
|
|
<p>Destroy a wkhtmltopdf converter object.</p>
|
|
<p>Destroy a wkhtmltopdf converter object.</p>
|
|
<p>Normally one would not need to call this since ownership of the settings object is transfarred to the converter.</p>
|
|
<p>Normally one would not need to call this since ownership of the settings object is transfarred to the converter.</p>
|
|
<p>An object must be destroyed to free up its memory, once it has been destroyed it may no longer be accessed.</p>
|
|
<p>An object must be destroyed to free up its memory, once it has been destroyed it may no longer be accessed.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<table class="params">
|
|
<tr><td class="paramname">settings</td><td>The converter object to destroy</td></tr>
|
|
<tr><td class="paramname">settings</td><td>The converter object to destroy</td></tr>
|
|
- <tr><td class="paramname">converter</td><td>The converter object on which errors we want the callback to be called </td></tr>
|
|
|
|
- <tr><td class="paramname">cb</td><td>The function to call when an error occurs</td></tr>
|
|
|
|
<tr><td class="paramname">converter</td><td>The converter object on which warnings we want the callback to be called </td></tr>
|
|
<tr><td class="paramname">converter</td><td>The converter object on which warnings we want the callback to be called </td></tr>
|
|
<tr><td class="paramname">cb</td><td>The function to call when warning message is issued</td></tr>
|
|
<tr><td class="paramname">cb</td><td>The function to call when warning message is issued</td></tr>
|
|
|
|
+ <tr><td class="paramname">converter</td><td>The converter object on which errors we want the callback to be called </td></tr>
|
|
|
|
+ <tr><td class="paramname">cb</td><td>The function to call when an error occurs</td></tr>
|
|
</table>
|
|
</table>
|
|
</dd>
|
|
</dd>
|
|
</dl>
|
|
</dl>
|
|
@@ -435,7 +435,7 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
</table>
|
|
</table>
|
|
</dd>
|
|
</dd>
|
|
</dl>
|
|
</dl>
|
|
-<dl class="section see"><dt>See Also</dt><dd>wkhtmltopdf_current_phase, wkhtmltopdf_phase_count, wkhtmltopdf_phase_description</dd></dl>
|
|
|
|
|
|
+<dl class="section see"><dt>See also</dt><dd>wkhtmltopdf_current_phase, wkhtmltopdf_phase_count, wkhtmltopdf_phase_description</dd></dl>
|
|
<p>The progress in percent within the current phase is given as an integer to the callback function.</p>
|
|
<p>The progress in percent within the current phase is given as an integer to the callback function.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<table class="params">
|
|
@@ -444,7 +444,7 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
</table>
|
|
</table>
|
|
</dd>
|
|
</dd>
|
|
</dl>
|
|
</dl>
|
|
-<dl class="section see"><dt>See Also</dt><dd>wkhtmltopdf_progress_description</dd></dl>
|
|
|
|
|
|
+<dl class="section see"><dt>See also</dt><dd>wkhtmltopdf_progress_description</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<table class="params">
|
|
<tr><td class="paramname">converter</td><td>The converter which finish events to call back from </td></tr>
|
|
<tr><td class="paramname">converter</td><td>The converter which finish events to call back from </td></tr>
|
|
@@ -452,20 +452,22 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
</table>
|
|
</table>
|
|
</dd>
|
|
</dd>
|
|
</dl>
|
|
</dl>
|
|
-<dl class="section see"><dt>See Also</dt><dd>wkhtmltopdf_convert</dd></dl>
|
|
|
|
|
|
+<dl class="section see"><dt>See also</dt><dd>wkhtmltopdf_convert</dd></dl>
|
|
<p>Add the object described by the supplied object settings to the list of objects (web pages to convert), objects are placed in the output pdf in the order of addition. Once the object has been added, the supplied settings may no longer be accessed, it Wit eventually be freed by wkhtmltopdf. If a none NULL and none empty utf8 encoded string is supplied to data, this HTML content will be converted instead of the content located at "page" setting of the supplied object settings instance.</p>
|
|
<p>Add the object described by the supplied object settings to the list of objects (web pages to convert), objects are placed in the output pdf in the order of addition. Once the object has been added, the supplied settings may no longer be accessed, it Wit eventually be freed by wkhtmltopdf. If a none NULL and none empty utf8 encoded string is supplied to data, this HTML content will be converted instead of the content located at "page" setting of the supplied object settings instance.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<table class="params">
|
|
<tr><td class="paramname">converter</td><td>The converter to add the object to </td></tr>
|
|
<tr><td class="paramname">converter</td><td>The converter to add the object to </td></tr>
|
|
<tr><td class="paramname">settings</td><td>The setting describing the object to add </td></tr>
|
|
<tr><td class="paramname">settings</td><td>The setting describing the object to add </td></tr>
|
|
- <tr><td class="paramname">data</td><td>HTML content of the object to convert or NULL </td></tr>
|
|
|
|
|
|
+ <tr><td class="paramname">data</td><td>HTML content of the object to convert (encoded in UTF-8) or NULL </td></tr>
|
|
</table>
|
|
</table>
|
|
</dd>
|
|
</dd>
|
|
</dl>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
-<a class="anchor" id="ab0221a9deb308b653fdf114e1bdbf06f"></a>
|
|
|
|
|
|
+<a id="ab0221a9deb308b653fdf114e1bdbf06f"></a>
|
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#ab0221a9deb308b653fdf114e1bdbf06f">◆ </a></span>CAPI() <span class="overload">[5/6]</span></h2>
|
|
|
|
+
|
|
<div class="memitem">
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<table class="memname">
|
|
@@ -485,7 +487,9 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
-<a class="anchor" id="ade66be9513ad5b2390ae84a0a2e4e886"></a>
|
|
|
|
|
|
+<a id="ade66be9513ad5b2390ae84a0a2e4e886"></a>
|
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#ade66be9513ad5b2390ae84a0a2e4e886">◆ </a></span>CAPI() <span class="overload">[6/6]</span></h2>
|
|
|
|
+
|
|
<div class="memitem">
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<table class="memname">
|
|
@@ -512,7 +516,9 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
-<a class="anchor" id="ab6e2be62cf7773038f6b1e83de224a81"></a>
|
|
|
|
|
|
+<a id="ab6e2be62cf7773038f6b1e83de224a81"></a>
|
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#ab6e2be62cf7773038f6b1e83de224a81">◆ </a></span>cb</h2>
|
|
|
|
+
|
|
<div class="memitem">
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<table class="memname">
|
|
@@ -521,12 +527,12 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
</tr>
|
|
</tr>
|
|
</table>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
</div><div class="memdoc">
|
|
-<b>Initial value:</b><div class="fragment"><div class="line">{</div>
|
|
|
|
-<div class="line"> <span class="keyword">reinterpret_cast<</span>MyPdfConverter *<span class="keyword">></span>(converter)->error_cb = cb</div>
|
|
|
|
-</div><!-- fragment -->
|
|
|
|
|
|
+<b>Initial value:</b><div class="fragment"><div class="line">{</div><div class="line"> <span class="keyword">reinterpret_cast<</span>MyPdfConverter *<span class="keyword">></span>(converter)->error_cb = cb</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
-<a class="anchor" id="a2acb6da069a6712a3f5ffc4a46715d6f"></a>
|
|
|
|
|
|
+<a id="a2acb6da069a6712a3f5ffc4a46715d6f"></a>
|
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#a2acb6da069a6712a3f5ffc4a46715d6f">◆ </a></span>value</h2>
|
|
|
|
+
|
|
<div class="memitem">
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<table class="memname">
|
|
@@ -535,12 +541,12 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
</tr>
|
|
</tr>
|
|
</table>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
</div><div class="memdoc">
|
|
-<b>Initial value:</b><div class="fragment"><div class="line">{</div>
|
|
|
|
-<div class="line"> <span class="keywordflow">return</span> <span class="keyword">reinterpret_cast<</span>settings::PdfObject *<span class="keyword">></span>(settings)->set(name, value)</div>
|
|
|
|
-</div><!-- fragment -->
|
|
|
|
|
|
+<b>Initial value:</b><div class="fragment"><div class="line">{</div><div class="line"> <span class="keywordflow">return</span> <span class="keyword">reinterpret_cast<</span>settings::PdfObject *<span class="keyword">></span>(settings)-><span class="keyword">set</span>(name, QString::fromUtf8(value))</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
-<a class="anchor" id="a0470287e557638636ebc12b18b2e1229"></a>
|
|
|
|
|
|
+<a id="a0470287e557638636ebc12b18b2e1229"></a>
|
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#a0470287e557638636ebc12b18b2e1229">◆ </a></span>vs</h2>
|
|
|
|
+
|
|
<div class="memitem">
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<table class="memname">
|
|
@@ -549,17 +555,15 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
</tr>
|
|
</tr>
|
|
</table>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
</div><div class="memdoc">
|
|
-<b>Initial value:</b><div class="fragment"><div class="line">{</div>
|
|
|
|
-<div class="line"> QString res = <span class="keyword">reinterpret_cast<</span>settings::PdfObject *<span class="keyword">></span>(settings)-><span class="keyword">get</span>(name)</div>
|
|
|
|
-</div><!-- fragment -->
|
|
|
|
|
|
+<b>Initial value:</b><div class="fragment"><div class="line">{</div><div class="line"> QString res = <span class="keyword">reinterpret_cast<</span>settings::PdfObject *<span class="keyword">></span>(settings)-><span class="keyword">get</span>(name)</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
<hr class="footer"/><address class="footer"><small>
|
|
-Generated on Wed Jun 4 2014 10:37:19 for libwkhtmltox by  <a href="http://www.doxygen.org/index.html">
|
|
|
|
|
|
+Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
-</a> 1.8.6
|
|
|
|
|
|
+</a> 1.8.13
|
|
</small></address>
|
|
</small></address>
|
|
</body>
|
|
</body>
|
|
</html>
|
|
</html>
|