blob: e8430e07b16eff95fa058cc4026f80aef16a21cf (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">
<!-- THIS FILE IS GENERATED DO NOT EDIT -->
<erlref>
<header>
<copyright>
<year>2020</year>
<holder>wxWidgets team.</holder></copyright>
<legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
</legalnotice>
<title>wxHtmlEasyPrinting</title>
</header>
<module>wxHtmlEasyPrinting</module>
<modulesummary>Functions for wxHtmlEasyPrinting class</modulesummary>
<description><p>This class provides very simple interface to printing architecture. It allows you to print HTML documents using only a few commands.
</p><p>Note: Do not create this class on the stack only. You should create an instance on app startup and use this instance for all printing operations. The reason is that this class stores various settings in it.
</p>
<p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_html_easy_printing.html">wxHtmlEasyPrinting</url></p>
</description>
<datatypes><datatype><name name="wxHtmlEasyPrinting"/></datatype></datatypes>
<funcs>
<func>
<name name="new" arity="0" clause_i="1" since=""/>
<fsummary>See: <c>new/1</c></fsummary>
</func>
<func>
<name name="new" arity="1" clause_i="1" since=""/>
<fsummary>Constructor. </fsummary>
<desc><p>Constructor.
</p></desc>
</func>
<func>
<name name="getPrintData" arity="1" clause_i="1" since=""/>
<fsummary>Returns pointer to <c>wxPrintData</c> instance used by this class. </fsummary>
<desc><p>Returns pointer to <seeerl marker="wxPrintData"><c>wxPrintData</c></seeerl> instance used by this class.
</p><p>You can set its parameters (via SetXXXX methods).
</p></desc>
</func>
<func>
<name name="getPageSetupData" arity="1" clause_i="1" since=""/>
<fsummary>Returns a pointer to <c>wxPageSetupDialogData</c> instance used by this class. </fsummary>
<desc><p>Returns a pointer to <seeerl marker="wxPageSetupDialogData"><c>wxPageSetupDialogData</c></seeerl> instance used by this class.
</p><p>You can set its parameters (via SetXXXX methods).
</p></desc>
</func>
<func>
<name name="previewFile" arity="2" clause_i="1" since=""/>
<fsummary>Preview HTML file. </fsummary>
<desc><p>Preview HTML file.
</p><p>Returns false in case of error - call <seemfa marker="wxPrinter#getLastError/0"><c>wxPrinter:getLastError/0</c></seemfa> to get detailed information about the kind of the error.
</p></desc>
</func>
<func>
<name name="previewText" arity="2" clause_i="1" since=""/>
<fsummary>See: <c>previewText/3</c></fsummary>
</func>
<func>
<name name="previewText" arity="3" clause_i="1" since=""/>
<fsummary>Preview HTML text (not file!). </fsummary>
<desc><p>Preview HTML text (not file!).
</p><p>Returns false in case of error - call <seemfa marker="wxPrinter#getLastError/0"><c>wxPrinter:getLastError/0</c></seemfa> to get detailed information about the kind of the error.
</p></desc>
</func>
<func>
<name name="printFile" arity="2" clause_i="1" since=""/>
<fsummary>Print HTML file. </fsummary>
<desc><p>Print HTML file.
</p><p>Returns false in case of error - call <seemfa marker="wxPrinter#getLastError/0"><c>wxPrinter:getLastError/0</c></seemfa> to get detailed information about the kind of the error.
</p></desc>
</func>
<func>
<name name="printText" arity="2" clause_i="1" since=""/>
<fsummary>See: <c>printText/3</c></fsummary>
</func>
<func>
<name name="printText" arity="3" clause_i="1" since=""/>
<fsummary>Print HTML text (not file!). </fsummary>
<desc><p>Print HTML text (not file!).
</p><p>Returns false in case of error - call <seemfa marker="wxPrinter#getLastError/0"><c>wxPrinter:getLastError/0</c></seemfa> to get detailed information about the kind of the error.
</p></desc>
</func>
<func>
<name name="pageSetup" arity="1" clause_i="1" since=""/>
<fsummary>Display page setup dialog and allows the user to modify settings. </fsummary>
<desc><p>Display page setup dialog and allows the user to modify settings.
</p></desc>
</func>
<func>
<name name="setFonts" arity="3" clause_i="1" since=""/>
<fsummary>See: <c>setFonts/4</c></fsummary>
</func>
<func>
<name name="setFonts" arity="4" clause_i="1" since=""/>
<fsummary>Sets fonts. </fsummary>
<desc><p>Sets fonts.
</p><p>See <c>wxHtmlDCRenderer::SetFonts</c> (not implemented in wx) for detailed description.
</p></desc>
</func>
<func>
<name name="setHeader" arity="2" clause_i="1" since=""/>
<fsummary>See: <c>setHeader/3</c></fsummary>
</func>
<func>
<name name="setHeader" arity="3" clause_i="1" since=""/>
<fsummary>Set page header. </fsummary>
<desc><p>Set page header.
</p><p>The following macros can be used inside it:
</p></desc>
</func>
<func>
<name name="setFooter" arity="2" clause_i="1" since=""/>
<fsummary>See: <c>setFooter/3</c></fsummary>
</func>
<func>
<name name="setFooter" arity="3" clause_i="1" since=""/>
<fsummary>Set page footer. </fsummary>
<desc><p>Set page footer.
</p><p>The following macros can be used inside it: @DATE@ is replaced by the current date in default format @PAGENUM@ is replaced by page number @PAGESCNT@ is replaced by total number of pages @TIME@ is replaced by the current time in default format @TITLE@ is replaced with the title of the document
</p></desc>
</func>
<func>
<name name="destroy" arity="1" clause_i="1" since=""/>
<fsummary>Destructor</fsummary>
<desc><p>Destroys the object.</p></desc>
</func>
</funcs>
</erlref>
|
