structwkhtmltopdf_1_1settings_1_1PdfGlobal.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>libwkhtmltox: wkhtmltopdf::settings::PdfGlobal Struct Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">libwkhtmltox
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.17 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. <div id="nav-path" class="navpath">
  61. <ul>
  62. <li class="navelem"><b>wkhtmltopdf</b></li><li class="navelem"><b>settings</b></li><li class="navelem"><a class="el" href="structwkhtmltopdf_1_1settings_1_1PdfGlobal.html">PdfGlobal</a></li> </ul>
  63. </div>
  64. </div><!-- top -->
  65. <div class="header">
  66. <div class="summary">
  67. <a href="#pub-methods">Public Member Functions</a> &#124;
  68. <a href="#pub-attribs">Public Attributes</a> &#124;
  69. <a href="structwkhtmltopdf_1_1settings_1_1PdfGlobal-members.html">List of all members</a> </div>
  70. <div class="headertitle">
  71. <div class="title">wkhtmltopdf::settings::PdfGlobal Struct Reference</div> </div>
  72. </div><!--header-->
  73. <div class="contents">
  74. <p>Class holding all user setting. This class holds all the user settings, settings can be filled in by hand, or with other methods.
  75. <a href="structwkhtmltopdf_1_1settings_1_1PdfGlobal.html#details">More...</a></p>
  76. <p><code>#include &lt;pdfsettings.hh&gt;</code></p>
  77. <table class="memberdecls">
  78. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  79. Public Member Functions</h2></td></tr>
  80. <tr class="memitem:ad461142d342d88c47642cd92cacf7d00"><td class="memItemLeft" align="right" valign="top"><a id="ad461142d342d88c47642cd92cacf7d00"></a>
  81. QString&#160;</td><td class="memItemRight" valign="bottom"><b>get</b> (const char *name)</td></tr>
  82. <tr class="separator:ad461142d342d88c47642cd92cacf7d00"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:ad5c9d5278f54febdc7bc03e8dcf61aa4"><td class="memItemLeft" align="right" valign="top"><a id="ad5c9d5278f54febdc7bc03e8dcf61aa4"></a>
  84. bool&#160;</td><td class="memItemRight" valign="bottom"><b>set</b> (const char *name, const QString &amp;value)</td></tr>
  85. <tr class="separator:ad5c9d5278f54febdc7bc03e8dcf61aa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. </table><table class="memberdecls">
  87. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  88. Public Attributes</h2></td></tr>
  89. <tr class="memitem:aeea9003f7853aade329e514b8ad8ab0b"><td class="memItemLeft" align="right" valign="top"><a id="aeea9003f7853aade329e514b8ad8ab0b"></a>
  90. <a class="el" href="structwkhtmltopdf_1_1settings_1_1Size.html">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwkhtmltopdf_1_1settings_1_1PdfGlobal.html#aeea9003f7853aade329e514b8ad8ab0b">size</a></td></tr>
  91. <tr class="memdesc:aeea9003f7853aade329e514b8ad8ab0b"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structwkhtmltopdf_1_1settings_1_1Size.html" title="Settings considering page size.">Size</a> related settings. <br /></td></tr>
  92. <tr class="separator:aeea9003f7853aade329e514b8ad8ab0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a3a9312ea9fa7f0e540d03f481270bac0"><td class="memItemLeft" align="right" valign="top"><a id="a3a9312ea9fa7f0e540d03f481270bac0"></a>
  94. LogLevel&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwkhtmltopdf_1_1settings_1_1PdfGlobal.html#a3a9312ea9fa7f0e540d03f481270bac0">logLevel</a></td></tr>
  95. <tr class="memdesc:a3a9312ea9fa7f0e540d03f481270bac0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Log level. <br /></td></tr>
  96. <tr class="separator:a3a9312ea9fa7f0e540d03f481270bac0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a57fce0e3b77088a84db11cf5061075d8"><td class="memItemLeft" align="right" valign="top"><a id="a57fce0e3b77088a84db11cf5061075d8"></a>
  98. bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwkhtmltopdf_1_1settings_1_1PdfGlobal.html#a57fce0e3b77088a84db11cf5061075d8">useGraphics</a></td></tr>
  99. <tr class="memdesc:a57fce0e3b77088a84db11cf5061075d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Should we use the graphics system. <br /></td></tr>
  100. <tr class="separator:a57fce0e3b77088a84db11cf5061075d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a7a920d7a4efce72de7824ff77c58e5f6"><td class="memItemLeft" align="right" valign="top"><a id="a7a920d7a4efce72de7824ff77c58e5f6"></a>
  102. bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwkhtmltopdf_1_1settings_1_1PdfGlobal.html#a7a920d7a4efce72de7824ff77c58e5f6">resolveRelativeLinks</a></td></tr>
  103. <tr class="memdesc:a7a920d7a4efce72de7824ff77c58e5f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Should relative links be resolved or kept as-is. <br /></td></tr>
  104. <tr class="separator:a7a920d7a4efce72de7824ff77c58e5f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:adf37aecaad36ac88016bf348fa1d72b4"><td class="memItemLeft" align="right" valign="top"><a id="adf37aecaad36ac88016bf348fa1d72b4"></a>
  106. QPrinter::Orientation&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwkhtmltopdf_1_1settings_1_1PdfGlobal.html#adf37aecaad36ac88016bf348fa1d72b4">orientation</a></td></tr>
  107. <tr class="memdesc:adf37aecaad36ac88016bf348fa1d72b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Should we orientate in landscape or portrate. <br /></td></tr>
  108. <tr class="separator:adf37aecaad36ac88016bf348fa1d72b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a2c3d4211dfdcdbf51da7aca719ca817b"><td class="memItemLeft" align="right" valign="top"><a id="a2c3d4211dfdcdbf51da7aca719ca817b"></a>
  110. QPrinter::ColorMode&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwkhtmltopdf_1_1settings_1_1PdfGlobal.html#a2c3d4211dfdcdbf51da7aca719ca817b">colorMode</a></td></tr>
  111. <tr class="memdesc:a2c3d4211dfdcdbf51da7aca719ca817b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Color or grayscale. <br /></td></tr>
  112. <tr class="separator:a2c3d4211dfdcdbf51da7aca719ca817b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:ab947556944e641fc0115decace1daa63"><td class="memItemLeft" align="right" valign="top"><a id="ab947556944e641fc0115decace1daa63"></a>
  114. QPrinter::PrinterMode&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwkhtmltopdf_1_1settings_1_1PdfGlobal.html#ab947556944e641fc0115decace1daa63">resolution</a></td></tr>
  115. <tr class="memdesc:ab947556944e641fc0115decace1daa63"><td class="mdescLeft">&#160;</td><td class="mdescRight">What overall resolution should we use. <br /></td></tr>
  116. <tr class="separator:ab947556944e641fc0115decace1daa63"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a6ac3b0d2ac9badfd1b7cb7131e9c27a6"><td class="memItemLeft" align="right" valign="top"><a id="a6ac3b0d2ac9badfd1b7cb7131e9c27a6"></a>
  118. int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwkhtmltopdf_1_1settings_1_1PdfGlobal.html#a6ac3b0d2ac9badfd1b7cb7131e9c27a6">dpi</a></td></tr>
  119. <tr class="memdesc:a6ac3b0d2ac9badfd1b7cb7131e9c27a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">What dpi should be used when printing. <br /></td></tr>
  120. <tr class="separator:a6ac3b0d2ac9badfd1b7cb7131e9c27a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:ae4d80feedaa7dbbebc480e68274703cc"><td class="memItemLeft" align="right" valign="top"><a id="ae4d80feedaa7dbbebc480e68274703cc"></a>
  122. int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwkhtmltopdf_1_1settings_1_1PdfGlobal.html#ae4d80feedaa7dbbebc480e68274703cc">pageOffset</a></td></tr>
  123. <tr class="memdesc:ae4d80feedaa7dbbebc480e68274703cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">When pagenumbers are printed, apply this offset to them all. <br /></td></tr>
  124. <tr class="separator:ae4d80feedaa7dbbebc480e68274703cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a8b75449e38b6281d9d439cdd1561f71b"><td class="memItemLeft" align="right" valign="top"><a id="a8b75449e38b6281d9d439cdd1561f71b"></a>
  126. int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwkhtmltopdf_1_1settings_1_1PdfGlobal.html#a8b75449e38b6281d9d439cdd1561f71b">copies</a></td></tr>
  127. <tr class="memdesc:a8b75449e38b6281d9d439cdd1561f71b"><td class="mdescLeft">&#160;</td><td class="mdescRight">How many copies do we wan to print. <br /></td></tr>
  128. <tr class="separator:a8b75449e38b6281d9d439cdd1561f71b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:ab94cd2a40a20b414ca47ca411328fd49"><td class="memItemLeft" align="right" valign="top"><a id="ab94cd2a40a20b414ca47ca411328fd49"></a>
  130. bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwkhtmltopdf_1_1settings_1_1PdfGlobal.html#ab94cd2a40a20b414ca47ca411328fd49">collate</a></td></tr>
  131. <tr class="memdesc:ab94cd2a40a20b414ca47ca411328fd49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Should be print a whole copy before beginning the next. <br /></td></tr>
  132. <tr class="separator:ab94cd2a40a20b414ca47ca411328fd49"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:aad97d68c4b97852389fbb773a7336a46"><td class="memItemLeft" align="right" valign="top"><a id="aad97d68c4b97852389fbb773a7336a46"></a>
  134. bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwkhtmltopdf_1_1settings_1_1PdfGlobal.html#aad97d68c4b97852389fbb773a7336a46">outline</a></td></tr>
  135. <tr class="memdesc:aad97d68c4b97852389fbb773a7336a46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Should we generate an outline and put it into the pdf file. <br /></td></tr>
  136. <tr class="separator:aad97d68c4b97852389fbb773a7336a46"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a5b627a48324a0b97894dc531a467f42d"><td class="memItemLeft" align="right" valign="top"><a id="a5b627a48324a0b97894dc531a467f42d"></a>
  138. int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwkhtmltopdf_1_1settings_1_1PdfGlobal.html#a5b627a48324a0b97894dc531a467f42d">outlineDepth</a></td></tr>
  139. <tr class="memdesc:a5b627a48324a0b97894dc531a467f42d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximal depth of the generated outline. <br /></td></tr>
  140. <tr class="separator:a5b627a48324a0b97894dc531a467f42d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a2249033d0eebc6ce0e9c0d331251de1d"><td class="memItemLeft" align="right" valign="top"><a id="a2249033d0eebc6ce0e9c0d331251de1d"></a>
  142. QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwkhtmltopdf_1_1settings_1_1PdfGlobal.html#a2249033d0eebc6ce0e9c0d331251de1d">dumpOutline</a></td></tr>
  143. <tr class="memdesc:a2249033d0eebc6ce0e9c0d331251de1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">dump outline to this filename <br /></td></tr>
  144. <tr class="separator:a2249033d0eebc6ce0e9c0d331251de1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a35f7b3f025a269d1011e829031e79172"><td class="memItemLeft" align="right" valign="top"><a id="a35f7b3f025a269d1011e829031e79172"></a>
  146. QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwkhtmltopdf_1_1settings_1_1PdfGlobal.html#a35f7b3f025a269d1011e829031e79172">out</a></td></tr>
  147. <tr class="memdesc:a35f7b3f025a269d1011e829031e79172"><td class="mdescLeft">&#160;</td><td class="mdescRight">The file where in to store the output. <br /></td></tr>
  148. <tr class="separator:a35f7b3f025a269d1011e829031e79172"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:aa943c9aed6f276e77a00390822b1dc5d"><td class="memItemLeft" align="right" valign="top"><a id="aa943c9aed6f276e77a00390822b1dc5d"></a>
  150. QString&#160;</td><td class="memItemRight" valign="bottom"><b>documentTitle</b></td></tr>
  151. <tr class="separator:aa943c9aed6f276e77a00390822b1dc5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:ac0fce655e33e13a21792c996711aa602"><td class="memItemLeft" align="right" valign="top"><a id="ac0fce655e33e13a21792c996711aa602"></a>
  153. bool&#160;</td><td class="memItemRight" valign="bottom"><b>useCompression</b></td></tr>
  154. <tr class="separator:ac0fce655e33e13a21792c996711aa602"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a5134abc2cf21870b455416d5efc466f6"><td class="memItemLeft" align="right" valign="top"><a id="a5134abc2cf21870b455416d5efc466f6"></a>
  156. <a class="el" href="structwkhtmltopdf_1_1settings_1_1Margin.html">Margin</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwkhtmltopdf_1_1settings_1_1PdfGlobal.html#a5134abc2cf21870b455416d5efc466f6">margin</a></td></tr>
  157. <tr class="memdesc:a5134abc2cf21870b455416d5efc466f6"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structwkhtmltopdf_1_1settings_1_1Margin.html" title="Settings considering margins.">Margin</a> related settings. <br /></td></tr>
  158. <tr class="separator:a5134abc2cf21870b455416d5efc466f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:a7c66224ff74fe3b32ef713d7cd9ee968"><td class="memItemLeft" align="right" valign="top"><a id="a7c66224ff74fe3b32ef713d7cd9ee968"></a>
  160. QString&#160;</td><td class="memItemRight" valign="bottom"><b>viewportSize</b></td></tr>
  161. <tr class="separator:a7c66224ff74fe3b32ef713d7cd9ee968"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:a447091329137a889390a04000281e08e"><td class="memItemLeft" align="right" valign="top"><a id="a447091329137a889390a04000281e08e"></a>
  163. int&#160;</td><td class="memItemRight" valign="bottom"><b>imageDPI</b></td></tr>
  164. <tr class="separator:a447091329137a889390a04000281e08e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:a179e9d372c80f86136db7e440f9cbdbd"><td class="memItemLeft" align="right" valign="top"><a id="a179e9d372c80f86136db7e440f9cbdbd"></a>
  166. int&#160;</td><td class="memItemRight" valign="bottom"><b>imageQuality</b></td></tr>
  167. <tr class="separator:a179e9d372c80f86136db7e440f9cbdbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:a8b8523748330fa37f080b72db11bc223"><td class="memItemLeft" align="right" valign="top"><a id="a8b8523748330fa37f080b72db11bc223"></a>
  169. LoadGlobal&#160;</td><td class="memItemRight" valign="bottom"><b>load</b></td></tr>
  170. <tr class="separator:a8b8523748330fa37f080b72db11bc223"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. </table>
  172. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  173. <div class="textblock"><p>Class holding all user setting. This class holds all the user settings, settings can be filled in by hand, or with other methods. </p>
  174. <dl class="section see"><dt>See also</dt><dd>CommandLineParser::parse() </dd></dl>
  175. </div><hr/>The documentation for this struct was generated from the following files:<ul>
  176. <li>src/lib/pdfsettings.hh</li>
  177. <li>src/lib/pdfsettings.cc</li>
  178. </ul>
  179. </div><!-- contents -->
  180. <!-- start footer part -->
  181. <hr class="footer"/><address class="footer"><small>
  182. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  183. <img class="footer" src="doxygen.png" alt="doxygen"/>
  184. </a> 1.8.17
  185. </small></address>
  186. </body>
  187. </html>