-
Notifications
You must be signed in to change notification settings - Fork 2.9k
/
wxHtmlEasyPrinting.erl
281 lines (242 loc) · 11.8 KB
/
wxHtmlEasyPrinting.erl
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2008-2024. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% %CopyrightEnd%
%% This file is generated DO NOT EDIT
-module(wxHtmlEasyPrinting).
-moduledoc """
Functions for wxHtmlEasyPrinting class
This class provides very simple interface to printing architecture. It allows
you to print HTML documents using only a few commands.
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.
wxWidgets docs:
[wxHtmlEasyPrinting](https://docs.wxwidgets.org/3.1/classwx_html_easy_printing.html)
""".
-include("wxe.hrl").
-export([destroy/1,getPageSetupData/1,getPrintData/1,new/0,new/1,pageSetup/1,
previewFile/2,previewText/2,previewText/3,printFile/2,printText/2,
printText/3,setFonts/3,setFonts/4,setFooter/2,setFooter/3,setHeader/2,
setHeader/3]).
%% inherited exports
-export([parent_class/1]).
-type wxHtmlEasyPrinting() :: wx:wx_object().
-export_type([wxHtmlEasyPrinting/0]).
%% @hidden
-doc false.
parent_class(_Class) -> erlang:error({badtype, ?MODULE}).
%% @equiv new([])
-spec new() -> wxHtmlEasyPrinting().
new() ->
new([]).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxhtmleasyprinting.html#wxhtmleasyprintingwxhtmleasyprinting">external documentation</a>.
-doc "Constructor.".
-spec new([Option]) -> wxHtmlEasyPrinting() when
Option :: {'name', unicode:chardata()}
| {'parentWindow', wxWindow:wxWindow()}.
new(Options)
when is_list(Options) ->
MOpts = fun({name, Name}) -> Name_UC = unicode:characters_to_binary(Name),{name,Name_UC};
({parentWindow, #wx_ref{type=ParentWindowT}} = Arg) -> ?CLASS(ParentWindowT,wxWindow),Arg;
(BadOpt) -> erlang:error({badoption, BadOpt}) end,
Opts = lists:map(MOpts, Options),
wxe_util:queue_cmd(Opts,?get_env(),?wxHtmlEasyPrinting_new),
wxe_util:rec(?wxHtmlEasyPrinting_new).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxhtmleasyprinting.html#wxhtmleasyprintinggetprintdata">external documentation</a>.
-doc """
Returns pointer to `m:wxPrintData` instance used by this class.
You can set its parameters (via SetXXXX methods).
""".
-spec getPrintData(This) -> wxPrintData:wxPrintData() when
This::wxHtmlEasyPrinting().
getPrintData(#wx_ref{type=ThisT}=This) ->
?CLASS(ThisT,wxHtmlEasyPrinting),
wxe_util:queue_cmd(This,?get_env(),?wxHtmlEasyPrinting_GetPrintData),
wxe_util:rec(?wxHtmlEasyPrinting_GetPrintData).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxhtmleasyprinting.html#wxhtmleasyprintinggetpagesetupdata">external documentation</a>.
-doc """
Returns a pointer to `m:wxPageSetupDialogData` instance used by this class.
You can set its parameters (via SetXXXX methods).
""".
-spec getPageSetupData(This) -> wxPageSetupDialogData:wxPageSetupDialogData() when
This::wxHtmlEasyPrinting().
getPageSetupData(#wx_ref{type=ThisT}=This) ->
?CLASS(ThisT,wxHtmlEasyPrinting),
wxe_util:queue_cmd(This,?get_env(),?wxHtmlEasyPrinting_GetPageSetupData),
wxe_util:rec(?wxHtmlEasyPrinting_GetPageSetupData).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxhtmleasyprinting.html#wxhtmleasyprintingpreviewfile">external documentation</a>.
-doc """
Preview HTML file.
Returns false in case of error - call `wxPrinter:getLastError/0` to get detailed
information about the kind of the error.
""".
-spec previewFile(This, Htmlfile) -> boolean() when
This::wxHtmlEasyPrinting(), Htmlfile::unicode:chardata().
previewFile(#wx_ref{type=ThisT}=This,Htmlfile)
when ?is_chardata(Htmlfile) ->
?CLASS(ThisT,wxHtmlEasyPrinting),
Htmlfile_UC = unicode:characters_to_binary(Htmlfile),
wxe_util:queue_cmd(This,Htmlfile_UC,?get_env(),?wxHtmlEasyPrinting_PreviewFile),
wxe_util:rec(?wxHtmlEasyPrinting_PreviewFile).
%% @equiv previewText(This,Htmltext, [])
-spec previewText(This, Htmltext) -> boolean() when
This::wxHtmlEasyPrinting(), Htmltext::unicode:chardata().
previewText(This,Htmltext)
when is_record(This, wx_ref),?is_chardata(Htmltext) ->
previewText(This,Htmltext, []).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxhtmleasyprinting.html#wxhtmleasyprintingpreviewtext">external documentation</a>.
-doc """
Preview HTML text (not file\!).
Returns false in case of error - call `wxPrinter:getLastError/0` to get detailed
information about the kind of the error.
""".
-spec previewText(This, Htmltext, [Option]) -> boolean() when
This::wxHtmlEasyPrinting(), Htmltext::unicode:chardata(),
Option :: {'basepath', unicode:chardata()}.
previewText(#wx_ref{type=ThisT}=This,Htmltext, Options)
when ?is_chardata(Htmltext),is_list(Options) ->
?CLASS(ThisT,wxHtmlEasyPrinting),
Htmltext_UC = unicode:characters_to_binary(Htmltext),
MOpts = fun({basepath, Basepath}) -> Basepath_UC = unicode:characters_to_binary(Basepath),{basepath,Basepath_UC};
(BadOpt) -> erlang:error({badoption, BadOpt}) end,
Opts = lists:map(MOpts, Options),
wxe_util:queue_cmd(This,Htmltext_UC, Opts,?get_env(),?wxHtmlEasyPrinting_PreviewText),
wxe_util:rec(?wxHtmlEasyPrinting_PreviewText).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxhtmleasyprinting.html#wxhtmleasyprintingprintfile">external documentation</a>.
-doc """
Print HTML file.
Returns false in case of error - call `wxPrinter:getLastError/0` to get detailed
information about the kind of the error.
""".
-spec printFile(This, Htmlfile) -> boolean() when
This::wxHtmlEasyPrinting(), Htmlfile::unicode:chardata().
printFile(#wx_ref{type=ThisT}=This,Htmlfile)
when ?is_chardata(Htmlfile) ->
?CLASS(ThisT,wxHtmlEasyPrinting),
Htmlfile_UC = unicode:characters_to_binary(Htmlfile),
wxe_util:queue_cmd(This,Htmlfile_UC,?get_env(),?wxHtmlEasyPrinting_PrintFile),
wxe_util:rec(?wxHtmlEasyPrinting_PrintFile).
%% @equiv printText(This,Htmltext, [])
-spec printText(This, Htmltext) -> boolean() when
This::wxHtmlEasyPrinting(), Htmltext::unicode:chardata().
printText(This,Htmltext)
when is_record(This, wx_ref),?is_chardata(Htmltext) ->
printText(This,Htmltext, []).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxhtmleasyprinting.html#wxhtmleasyprintingprinttext">external documentation</a>.
-doc """
Print HTML text (not file\!).
Returns false in case of error - call `wxPrinter:getLastError/0` to get detailed
information about the kind of the error.
""".
-spec printText(This, Htmltext, [Option]) -> boolean() when
This::wxHtmlEasyPrinting(), Htmltext::unicode:chardata(),
Option :: {'basepath', unicode:chardata()}.
printText(#wx_ref{type=ThisT}=This,Htmltext, Options)
when ?is_chardata(Htmltext),is_list(Options) ->
?CLASS(ThisT,wxHtmlEasyPrinting),
Htmltext_UC = unicode:characters_to_binary(Htmltext),
MOpts = fun({basepath, Basepath}) -> Basepath_UC = unicode:characters_to_binary(Basepath),{basepath,Basepath_UC};
(BadOpt) -> erlang:error({badoption, BadOpt}) end,
Opts = lists:map(MOpts, Options),
wxe_util:queue_cmd(This,Htmltext_UC, Opts,?get_env(),?wxHtmlEasyPrinting_PrintText),
wxe_util:rec(?wxHtmlEasyPrinting_PrintText).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxhtmleasyprinting.html#wxhtmleasyprintingpagesetup">external documentation</a>.
-doc "Display page setup dialog and allows the user to modify settings.".
-spec pageSetup(This) -> 'ok' when
This::wxHtmlEasyPrinting().
pageSetup(#wx_ref{type=ThisT}=This) ->
?CLASS(ThisT,wxHtmlEasyPrinting),
wxe_util:queue_cmd(This,?get_env(),?wxHtmlEasyPrinting_PageSetup).
%% @equiv setFonts(This,Normal_face,Fixed_face, [])
-spec setFonts(This, Normal_face, Fixed_face) -> 'ok' when
This::wxHtmlEasyPrinting(), Normal_face::unicode:chardata(), Fixed_face::unicode:chardata().
setFonts(This,Normal_face,Fixed_face)
when is_record(This, wx_ref),?is_chardata(Normal_face),?is_chardata(Fixed_face) ->
setFonts(This,Normal_face,Fixed_face, []).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxhtmleasyprinting.html#wxhtmleasyprintingsetfonts">external documentation</a>.
-doc """
Sets fonts.
See `wxHtmlDCRenderer::SetFonts` (not implemented in wx) for detailed
description.
""".
-spec setFonts(This, Normal_face, Fixed_face, [Option]) -> 'ok' when
This::wxHtmlEasyPrinting(), Normal_face::unicode:chardata(), Fixed_face::unicode:chardata(),
Option :: {'sizes', [integer()]}.
setFonts(#wx_ref{type=ThisT}=This,Normal_face,Fixed_face, Options)
when ?is_chardata(Normal_face),?is_chardata(Fixed_face),is_list(Options) ->
?CLASS(ThisT,wxHtmlEasyPrinting),
Normal_face_UC = unicode:characters_to_binary(Normal_face),
Fixed_face_UC = unicode:characters_to_binary(Fixed_face),
MOpts = fun({sizes, _sizes} = Arg) -> Arg;
(BadOpt) -> erlang:error({badoption, BadOpt}) end,
Opts = lists:map(MOpts, Options),
wxe_util:queue_cmd(This,Normal_face_UC,Fixed_face_UC, Opts,?get_env(),?wxHtmlEasyPrinting_SetFonts).
%% @equiv setHeader(This,Header, [])
-spec setHeader(This, Header) -> 'ok' when
This::wxHtmlEasyPrinting(), Header::unicode:chardata().
setHeader(This,Header)
when is_record(This, wx_ref),?is_chardata(Header) ->
setHeader(This,Header, []).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxhtmleasyprinting.html#wxhtmleasyprintingsetheader">external documentation</a>.
-doc """
Set page header.
The following macros can be used inside it:
""".
-spec setHeader(This, Header, [Option]) -> 'ok' when
This::wxHtmlEasyPrinting(), Header::unicode:chardata(),
Option :: {'pg', integer()}.
setHeader(#wx_ref{type=ThisT}=This,Header, Options)
when ?is_chardata(Header),is_list(Options) ->
?CLASS(ThisT,wxHtmlEasyPrinting),
Header_UC = unicode:characters_to_binary(Header),
MOpts = fun({pg, _pg} = Arg) -> Arg;
(BadOpt) -> erlang:error({badoption, BadOpt}) end,
Opts = lists:map(MOpts, Options),
wxe_util:queue_cmd(This,Header_UC, Opts,?get_env(),?wxHtmlEasyPrinting_SetHeader).
%% @equiv setFooter(This,Footer, [])
-spec setFooter(This, Footer) -> 'ok' when
This::wxHtmlEasyPrinting(), Footer::unicode:chardata().
setFooter(This,Footer)
when is_record(This, wx_ref),?is_chardata(Footer) ->
setFooter(This,Footer, []).
%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxhtmleasyprinting.html#wxhtmleasyprintingsetfooter">external documentation</a>.
-doc """
Set page footer.
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
""".
-spec setFooter(This, Footer, [Option]) -> 'ok' when
This::wxHtmlEasyPrinting(), Footer::unicode:chardata(),
Option :: {'pg', integer()}.
setFooter(#wx_ref{type=ThisT}=This,Footer, Options)
when ?is_chardata(Footer),is_list(Options) ->
?CLASS(ThisT,wxHtmlEasyPrinting),
Footer_UC = unicode:characters_to_binary(Footer),
MOpts = fun({pg, _pg} = Arg) -> Arg;
(BadOpt) -> erlang:error({badoption, BadOpt}) end,
Opts = lists:map(MOpts, Options),
wxe_util:queue_cmd(This,Footer_UC, Opts,?get_env(),?wxHtmlEasyPrinting_SetFooter).
%% @doc Destroys this object, do not use object again
-doc "Destroys the object.".
-spec destroy(This::wxHtmlEasyPrinting()) -> 'ok'.
destroy(Obj=#wx_ref{type=Type}) ->
?CLASS(Type,wxHtmlEasyPrinting),
wxe_util:queue_cmd(Obj, ?get_env(), ?DESTROY_OBJECT),
ok.