1wxHtmlEasyPrinting(3)      Erlang Module Definition      wxHtmlEasyPrinting(3)
2
3
4

NAME

6       wxHtmlEasyPrinting - Functions for wxHtmlEasyPrinting class
7

DESCRIPTION

9       This  class provides very simple interface to printing architecture. It
10       allows you to print HTML documents using only a few commands.
11
12       Note: Do not create this class on the stack only. You should create  an
13       instance  on  app startup and use this instance for all printing opera‐
14       tions. The reason is that this class stores various settings in it.
15
16       wxWidgets docs: wxHtmlEasyPrinting
17

DATA TYPES

19       wxHtmlEasyPrinting() = wx:wx_object()
20

EXPORTS

22       new() -> wxHtmlEasyPrinting()
23
24       new(Options :: [Option]) -> wxHtmlEasyPrinting()
25
26              Types:
27
28                 Option =
29                     {name, unicode:chardata()} |
30                     {parentWindow, wxWindow:wxWindow()}
31
32              Constructor.
33
34       getPrintData(This) -> wxPrintData:wxPrintData()
35
36              Types:
37
38                 This = wxHtmlEasyPrinting()
39
40              Returns pointer to wxPrintData instance used by this class.
41
42              You can set its parameters (via SetXXXX methods).
43
44       getPageSetupData(This) ->
45                           wxPageSetupDialogData:wxPageSetupDialogData()
46
47              Types:
48
49                 This = wxHtmlEasyPrinting()
50
51              Returns a pointer to wxPageSetupDialogData instance used by this
52              class.
53
54              You can set its parameters (via SetXXXX methods).
55
56       previewFile(This, Htmlfile) -> boolean()
57
58              Types:
59
60                 This = wxHtmlEasyPrinting()
61                 Htmlfile = unicode:chardata()
62
63              Preview HTML file.
64
65              Returns  false  in case of error - call wxPrinter:getLastError/0
66              to get detailed information about the kind of the error.
67
68       previewText(This, Htmltext) -> boolean()
69
70              Types:
71
72                 This = wxHtmlEasyPrinting()
73                 Htmltext = unicode:chardata()
74
75       previewText(This, Htmltext, Options :: [Option]) -> boolean()
76
77              Types:
78
79                 This = wxHtmlEasyPrinting()
80                 Htmltext = unicode:chardata()
81                 Option = {basepath, unicode:chardata()}
82
83              Preview HTML text (not file!).
84
85              Returns false in case of error -  call  wxPrinter:getLastError/0
86              to get detailed information about the kind of the error.
87
88       printFile(This, Htmlfile) -> boolean()
89
90              Types:
91
92                 This = wxHtmlEasyPrinting()
93                 Htmlfile = unicode:chardata()
94
95              Print HTML file.
96
97              Returns  false  in case of error - call wxPrinter:getLastError/0
98              to get detailed information about the kind of the error.
99
100       printText(This, Htmltext) -> boolean()
101
102              Types:
103
104                 This = wxHtmlEasyPrinting()
105                 Htmltext = unicode:chardata()
106
107       printText(This, Htmltext, Options :: [Option]) -> boolean()
108
109              Types:
110
111                 This = wxHtmlEasyPrinting()
112                 Htmltext = unicode:chardata()
113                 Option = {basepath, unicode:chardata()}
114
115              Print HTML text (not file!).
116
117              Returns false in case of error -  call  wxPrinter:getLastError/0
118              to get detailed information about the kind of the error.
119
120       pageSetup(This) -> ok
121
122              Types:
123
124                 This = wxHtmlEasyPrinting()
125
126              Display  page  setup  dialog  and allows the user to modify set‐
127              tings.
128
129       setFonts(This, Normal_face, Fixed_face) -> ok
130
131              Types:
132
133                 This = wxHtmlEasyPrinting()
134                 Normal_face = Fixed_face = unicode:chardata()
135
136       setFonts(This, Normal_face, Fixed_face, Options :: [Option]) -> ok
137
138              Types:
139
140                 This = wxHtmlEasyPrinting()
141                 Normal_face = Fixed_face = unicode:chardata()
142                 Option = {sizes, [integer()]}
143
144              Sets fonts.
145
146              See wxHtmlDCRenderer::SetFonts (not implemented in wx)  for  de‐
147              tailed description.
148
149       setHeader(This, Header) -> ok
150
151              Types:
152
153                 This = wxHtmlEasyPrinting()
154                 Header = unicode:chardata()
155
156       setHeader(This, Header, Options :: [Option]) -> ok
157
158              Types:
159
160                 This = wxHtmlEasyPrinting()
161                 Header = unicode:chardata()
162                 Option = {pg, integer()}
163
164              Set page header.
165
166              The following macros can be used inside it:
167
168       setFooter(This, Footer) -> ok
169
170              Types:
171
172                 This = wxHtmlEasyPrinting()
173                 Footer = unicode:chardata()
174
175       setFooter(This, Footer, Options :: [Option]) -> ok
176
177              Types:
178
179                 This = wxHtmlEasyPrinting()
180                 Footer = unicode:chardata()
181                 Option = {pg, integer()}
182
183              Set page footer.
184
185              The  following  macros can be used inside it: @DATE@ is replaced
186              by the current date in default format @PAGENUM@ is  replaced  by
187              page  number  @PAGESCNT@  is  replaced  by total number of pages
188              @TIME@ is replaced by the current time in default format @TITLE@
189              is replaced with the title of the document
190
191       destroy(This :: wxHtmlEasyPrinting()) -> ok
192
193              Destroys the object.
194
195
196
197wxWidgets team.                     wx 2.1               wxHtmlEasyPrinting(3)