|
@@ -1,9 +1,9 @@
|
|
|
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
|
<head>
|
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
|
-<meta name="generator" content="Doxygen 1.8.13"/>
|
|
|
+<meta name="generator" content="Doxygen 1.8.17"/>
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
|
<title>libwkhtmltox: src/lib/pdf.h File Reference</title>
|
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
@@ -29,18 +29,21 @@
|
|
|
</table>
|
|
|
</div>
|
|
|
<!-- end header part -->
|
|
|
-<!-- Generated by Doxygen 1.8.13 -->
|
|
|
+<!-- Generated by Doxygen 1.8.17 -->
|
|
|
<script type="text/javascript">
|
|
|
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
|
+/* @license-end */
|
|
|
</script>
|
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
|
<script type="text/javascript">
|
|
|
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
|
$(function() {
|
|
|
initMenu('',true,false,'search.php','Search');
|
|
|
$(document).ready(function() { init_search(); });
|
|
|
});
|
|
|
-</script>
|
|
|
+/* @license-end */</script>
|
|
|
<div id="main-nav"></div>
|
|
|
<!-- window showing the filter options -->
|
|
|
<div id="MSearchSelectWindow"
|
|
@@ -88,34 +91,34 @@ typedef struct <a class="el" href="structwkhtmltopdf__object__settings.html">wkh
|
|
|
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="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="memdesc:a152eb52e87e7ab85533f44fcdc688d4e"><td class="mdescLeft"> </td><td class="mdescRight">Function pointer type used for the error and warning callbacks. <a href="pdf_8h.html#a152eb52e87e7ab85533f44fcdc688d4e">More...</a><br /></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="memdesc:a9eb2902934ed92714aaf48c4379ed5c4"><td class="mdescLeft"> </td><td class="mdescRight">Function pointer type used for the progress_changed and finished callbacks. <a href="pdf_8h.html#a9eb2902934ed92714aaf48c4379ed5c4">More...</a><br /></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="memdesc:a34f2b11de61fe99d8365dc5cf547609f"><td class="mdescLeft"> </td><td class="mdescRight">Function pointer type used for the phase_changed callback. <a href="pdf_8h.html#a34f2b11de61fe99d8365dc5cf547609f">More...</a><br /></td></tr>
|
|
|
<tr class="separator:a34f2b11de61fe99d8365dc5cf547609f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
</table><table class="memberdecls">
|
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
|
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="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="pdf_8h.html#aae464baff9fa6aa118278b80757066ce">More...</a><br /></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="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="pdf_8h.html#abf74cbcdfe94dc5bbfb35a4c83d3760b">More...</a><br /></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="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="pdf_8h.html#a5a4616a330a354c5951430057e355e7e">More...</a><br /></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="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="pdf_8h.html#ac05baf7b50071366b946038b4fa412a6">More...</a><br /></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="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="pdf_8h.html#ab0221a9deb308b653fdf114e1bdbf06f">More...</a><br /></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="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="pdf_8h.html#ade66be9513ad5b2390ae84a0a2e4e886">More...</a><br /></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 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>
|
|
@@ -218,8 +221,47 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
|
+<a id="abf74cbcdfe94dc5bbfb35a4c83d3760b"></a>
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#abf74cbcdfe94dc5bbfb35a4c83d3760b">◆ </a></span>CAPI() <span class="overload">[1/6]</span></h2>
|
|
|
+
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">CAPI </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype">const char * </td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+
|
|
|
+<p>Return a short utf8 description of a conversion phase. </p>
|
|
|
+<p>Return a short utf8 string indicating progress within a phase.</p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">converter</td><td>The converter to query </td></tr>
|
|
|
+ <tr><td class="paramname">phase</td><td>The number of the conversion step of which we want a description </td></tr>
|
|
|
+ </table>
|
|
|
+ </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>
|
|
|
+<p>Will typically return a string like "40%"</p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">converter</td><td>The converter to query </td></tr>
|
|
|
+ </table>
|
|
|
+ </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>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
<a id="aae464baff9fa6aa118278b80757066ce"></a>
|
|
|
-<h2 class="memtitle"><span class="permalink"><a href="#aae464baff9fa6aa118278b80757066ce">◆ </a></span>CAPI() <span class="overload">[1/6]</span></h2>
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#aae464baff9fa6aa118278b80757066ce">◆ </a></span>CAPI() <span class="overload">[2/6]</span></h2>
|
|
|
|
|
|
<div class="memitem">
|
|
|
<div class="memproto">
|
|
@@ -300,7 +342,7 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
|
</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>converter The converter to perform the conversion on.</p>
|
|
|
+<p>\paragm 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>
|
|
|
<p>Conversion is done in a number of named phases, this function will retrieve the number of the current conversion phase, which will be a number between 0 and wkhtmltopdf_phase_count(converter)-1.</p>
|
|
|
<p>The description (name) of any phase can be retrieved by calling the wkhtmltopdf_phase_description method.</p>
|
|
@@ -328,71 +370,10 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
|
</dl>
|
|
|
<dl class="section return"><dt>Returns</dt><dd>The HTTP error code. </dd></dl>
|
|
|
|
|
|
-</div>
|
|
|
-</div>
|
|
|
-<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="memproto">
|
|
|
- <table class="memname">
|
|
|
- <tr>
|
|
|
- <td class="memname">CAPI </td>
|
|
|
- <td>(</td>
|
|
|
- <td class="paramtype">const char * </td>
|
|
|
- <td class="paramname"></td><td>)</td>
|
|
|
- <td></td>
|
|
|
- </tr>
|
|
|
- </table>
|
|
|
-</div><div class="memdoc">
|
|
|
-
|
|
|
-<p>Return a short utf8 description of a conversion phase. </p>
|
|
|
-<p>Return a short utf8 string indicating progress within a phase.</p>
|
|
|
-<dl class="params"><dt>Parameters</dt><dd>
|
|
|
- <table class="params">
|
|
|
- <tr><td class="paramname">converter</td><td>The converter to query </td></tr>
|
|
|
- <tr><td class="paramname">phase</td><td>The number of the conversion step of which we want a description </td></tr>
|
|
|
- </table>
|
|
|
- </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>
|
|
|
-<p>Will typically return a string like "40%"</p>
|
|
|
-<dl class="params"><dt>Parameters</dt><dd>
|
|
|
- <table class="params">
|
|
|
- <tr><td class="paramname">converter</td><td>The converter to query </td></tr>
|
|
|
- </table>
|
|
|
- </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>
|
|
|
-
|
|
|
-</div>
|
|
|
-</div>
|
|
|
-<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="memproto">
|
|
|
- <table class="memname">
|
|
|
- <tr>
|
|
|
- <td class="memname">CAPI </td>
|
|
|
- <td>(</td>
|
|
|
- <td class="paramtype"><a class="el" href="structwkhtmltopdf__global__settings.html">wkhtmltopdf_global_settings</a> * </td>
|
|
|
- <td class="paramname"></td><td>)</td>
|
|
|
- <td></td>
|
|
|
- </tr>
|
|
|
- </table>
|
|
|
-</div><div class="memdoc">
|
|
|
-
|
|
|
-<p>Create a new global settings object for pdf conversion. </p>
|
|
|
-<p>Create a new global settings object for pdf conversion, settings can be altered with wkhtmltopdf_set_global_setting, and inspected with wkhtmltopdf_get_global_setting. Once the desired settings have been set a converter object can be created using wkhtmltopdf_create_converter.</p>
|
|
|
-<dl class="section return"><dt>Returns</dt><dd>A wkhtmltopdf global settings object </dd></dl>
|
|
|
-
|
|
|
</div>
|
|
|
</div>
|
|
|
<a id="ac05baf7b50071366b946038b4fa412a6"></a>
|
|
|
-<h2 class="memtitle"><span class="permalink"><a href="#ac05baf7b50071366b946038b4fa412a6">◆ </a></span>CAPI() <span class="overload">[4/6]</span></h2>
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#ac05baf7b50071366b946038b4fa412a6">◆ </a></span>CAPI() <span class="overload">[3/6]</span></h2>
|
|
|
|
|
|
<div class="memitem">
|
|
|
<div class="memproto">
|
|
@@ -465,8 +446,8 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
|
|
|
|
</div>
|
|
|
</div>
|
|
|
-<a id="ab0221a9deb308b653fdf114e1bdbf06f"></a>
|
|
|
-<h2 class="memtitle"><span class="permalink"><a href="#ab0221a9deb308b653fdf114e1bdbf06f">◆ </a></span>CAPI() <span class="overload">[5/6]</span></h2>
|
|
|
+<a id="ade66be9513ad5b2390ae84a0a2e4e886"></a>
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#ade66be9513ad5b2390ae84a0a2e4e886">◆ </a></span>CAPI() <span class="overload">[4/6]</span></h2>
|
|
|
|
|
|
<div class="memitem">
|
|
|
<div class="memproto">
|
|
@@ -474,21 +455,27 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
|
<tr>
|
|
|
<td class="memname">CAPI </td>
|
|
|
<td>(</td>
|
|
|
- <td class="paramtype"><a class="el" href="structwkhtmltopdf__object__settings.html">wkhtmltopdf_object_settings</a> * </td>
|
|
|
+ <td class="paramtype"><a class="el" href="structwkhtmltopdf__converter.html">wkhtmltopdf_converter</a> * </td>
|
|
|
<td class="paramname"></td><td>)</td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</div><div class="memdoc">
|
|
|
|
|
|
-<p>Create an object used to store object settings. </p>
|
|
|
-<p>Create a new Object settings object for pdf conversion, settings can be altered with wkhtmltopdf_set_object_setting, and inspected with wkhtmltopdf_get_object_setting. Once the desired settings have been set the object can be added to a converter by calling wkhtmltopdf_add_resource.</p>
|
|
|
-<dl class="section return"><dt>Returns</dt><dd>an object settings instance </dd></dl>
|
|
|
+<p>Create a wkhtmltopdf converter object. </p>
|
|
|
+<p>The converter object is used to convert one or more objects(web sides) into a single pdf. Once a settings object has been parsed, it may no longer be accessed, and will eventually be freed. The returned converter object must be freed by calling wkhtmltopdf_destroy_converter</p>
|
|
|
+<dl class="params"><dt>Parameters</dt><dd>
|
|
|
+ <table class="params">
|
|
|
+ <tr><td class="paramname">settings</td><td>The global settings to use during conversion. </td></tr>
|
|
|
+ </table>
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>A wkhtmltopdf converter object </dd></dl>
|
|
|
|
|
|
</div>
|
|
|
</div>
|
|
|
-<a id="ade66be9513ad5b2390ae84a0a2e4e886"></a>
|
|
|
-<h2 class="memtitle"><span class="permalink"><a href="#ade66be9513ad5b2390ae84a0a2e4e886">◆ </a></span>CAPI() <span class="overload">[6/6]</span></h2>
|
|
|
+<a id="a5a4616a330a354c5951430057e355e7e"></a>
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#a5a4616a330a354c5951430057e355e7e">◆ </a></span>CAPI() <span class="overload">[5/6]</span></h2>
|
|
|
|
|
|
<div class="memitem">
|
|
|
<div class="memproto">
|
|
@@ -496,22 +483,38 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
|
<tr>
|
|
|
<td class="memname">CAPI </td>
|
|
|
<td>(</td>
|
|
|
- <td class="paramtype"><a class="el" href="structwkhtmltopdf__converter.html">wkhtmltopdf_converter</a> * </td>
|
|
|
+ <td class="paramtype"><a class="el" href="structwkhtmltopdf__global__settings.html">wkhtmltopdf_global_settings</a> * </td>
|
|
|
<td class="paramname"></td><td>)</td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</div><div class="memdoc">
|
|
|
|
|
|
-<p>Create a wkhtmltopdf converter object. </p>
|
|
|
-<p>The converter object is used to convert one or more objects(web sides) into a single pdf. Once a settings object has been parsed, it may no longer be accessed, and will eventually be freed. The returned converter object must be freed by calling wkhtmltopdf_destroy_converter</p>
|
|
|
-<dl class="params"><dt>Parameters</dt><dd>
|
|
|
- <table class="params">
|
|
|
- <tr><td class="paramname">settings</td><td>The global settings to use during conversion. </td></tr>
|
|
|
- </table>
|
|
|
- </dd>
|
|
|
-</dl>
|
|
|
-<dl class="section return"><dt>Returns</dt><dd>A wkhtmltopdf converter object </dd></dl>
|
|
|
+<p>Create a new global settings object for pdf conversion. </p>
|
|
|
+<p>Create a new global settings object for pdf conversion, settings can be altered with wkhtmltopdf_set_global_setting, and inspected with wkhtmltopdf_get_global_setting. Once the desired settings have been set a converter object can be created using \reg wkhtmltopdf_create_converter.</p>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>A wkhtmltopdf global settings object </dd></dl>
|
|
|
+
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<a id="ab0221a9deb308b653fdf114e1bdbf06f"></a>
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#ab0221a9deb308b653fdf114e1bdbf06f">◆ </a></span>CAPI() <span class="overload">[6/6]</span></h2>
|
|
|
+
|
|
|
+<div class="memitem">
|
|
|
+<div class="memproto">
|
|
|
+ <table class="memname">
|
|
|
+ <tr>
|
|
|
+ <td class="memname">CAPI </td>
|
|
|
+ <td>(</td>
|
|
|
+ <td class="paramtype"><a class="el" href="structwkhtmltopdf__object__settings.html">wkhtmltopdf_object_settings</a> * </td>
|
|
|
+ <td class="paramname"></td><td>)</td>
|
|
|
+ <td></td>
|
|
|
+ </tr>
|
|
|
+ </table>
|
|
|
+</div><div class="memdoc">
|
|
|
+
|
|
|
+<p>Create an object used to store object settings. </p>
|
|
|
+<p>Create a new Object settings object for pdf conversion, settings can be altered with wkhtmltopdf_set_object_setting, and inspected with wkhtmltopdf_get_object_setting. Once the desired settings have been set the object can be added to a converter by calling wkhtmltopdf_add_resource.</p>
|
|
|
+<dl class="section return"><dt>Returns</dt><dd>an object settings instance </dd></dl>
|
|
|
|
|
|
</div>
|
|
|
</div>
|
|
@@ -527,7 +530,9 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</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>
|
|
|
<a id="a2acb6da069a6712a3f5ffc4a46715d6f"></a>
|
|
@@ -541,7 +546,12 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</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)-><span class="keyword">set</span>(name, QString::fromUtf8(value))</div></div><!-- fragment -->
|
|
|
+<b>Initial value:</b><div class="fragment"><div class="line">{</div>
|
|
|
+<div class="line"> <span class="keywordflow">if</span> (!strcmp(name, <span class="stringliteral">"web.printMediaType"</span>)) {</div>
|
|
|
+<div class="line"> name = <span class="stringliteral">"load.printMediaType"</span>;</div>
|
|
|
+<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, QString::fromUtf8(value))</div>
|
|
|
+</div><!-- fragment -->
|
|
|
</div>
|
|
|
</div>
|
|
|
<a id="a0470287e557638636ebc12b18b2e1229"></a>
|
|
@@ -555,7 +565,9 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</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)->get(name)</div>
|
|
|
+</div><!-- fragment -->
|
|
|
</div>
|
|
|
</div>
|
|
|
</div><!-- contents -->
|
|
@@ -563,7 +575,7 @@ int </td><td class="memItemRight" valign="bottom"><b>phase</b></td></tr>
|
|
|
<hr class="footer"/><address class="footer"><small>
|
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
|
-</a> 1.8.13
|
|
|
+</a> 1.8.17
|
|
|
</small></address>
|
|
|
</body>
|
|
|
</html>
|