]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/htprint.tex
don't make read-only text controls editable when enabled
[wxWidgets.git] / docs / latex / wx / htprint.tex
CommitLineData
3ce369e6
VS
1%
2% automatically generated by HelpGen from
3% htmprint.h at 17/Oct/99 12:48:02
4%
5
09397bc6 6
3ce369e6
VS
7\section{\class{wxHtmlPrintout}}\label{wxhtmlprintout}
8
09397bc6 9This class serves as printout class for HTML documents.
3ce369e6
VS
10
11\wxheading{Derived from}
12
13\helpref{wxPrintout}{wxprintout}
14
09397bc6 15
9704b250
VS
16\wxheading{Include files}
17
18<wx/html/htmprint.h>
19
3ce369e6
VS
20\latexignore{\rtfignore{\wxheading{Members}}}
21
09397bc6 22
3ce369e6
VS
23\membersection{wxHtmlPrintout::wxHtmlPrintout}\label{wxhtmlprintoutwxhtmlprintout}
24
25\func{}{wxHtmlPrintout}{\param{const wxString\& }{title = "Printout"}}
26
27Constructor.
28
3ce369e6 29
fa10c70c
JS
30\membersection{wxHtmlPrintout::AddFilter}\label{wxhtmlprintoutaddfilter}
31
32\func{static void}{AddFilter}{\param{wxHtmlFilter* }{filter}}
33
34Adds a filter to the static list of filters for wxHtmlPrintout. See \helpref{wxHtmlFilter}{wxhtmlfilter} for
35further information.
36
4eecf115
VS
37\membersection{wxHtmlPrintout::SetFonts}\label{wxhtmlprintoutsetfonts}
38
fbfb8bcc 39\func{void}{SetFonts}{\param{const wxString\& }{normal\_face}, \param{const wxString\& }{fixed\_face}, \param{const int }{*sizes = NULL}}
4eecf115
VS
40
41Sets fonts. See \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} for
42detailed description.
3ce369e6 43
09397bc6 44\membersection{wxHtmlPrintout::SetFooter}\label{wxhtmlprintoutsetfooter}
3ce369e6 45
09397bc6 46\func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}}
3ce369e6 47
309b26a7
VZ
48Set page footer. The following macros can be used inside it:
49\input htprintmacros.inc
3ce369e6 50
09397bc6 51\wxheading{Parameters}
3ce369e6 52
309b26a7 53\docparam{footer}{HTML text to be used as footer.}
3ce369e6 54
09397bc6 55\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
3ce369e6 56
3ce369e6 57
3ce369e6
VS
58\membersection{wxHtmlPrintout::SetHeader}\label{wxhtmlprintoutsetheader}
59
60\func{void}{SetHeader}{\param{const wxString\& }{header}, \param{int }{pg = wxPAGE\_ALL}}
61
309b26a7
VZ
62Set page header. The following macros can be used inside it:
63\input htprintmacros.inc
3ce369e6
VS
64
65\wxheading{Parameters}
66
309b26a7 67\docparam{header}{HTML text to be used as header.}
3ce369e6
VS
68
69\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
70
71
09397bc6 72\membersection{wxHtmlPrintout::SetHtmlFile}\label{wxhtmlprintoutsethtmlfile}
3ce369e6 73
09397bc6 74\func{void}{SetHtmlFile}{\param{const wxString\& }{htmlfile}}
3ce369e6 75
09397bc6
VS
76Prepare the class for printing this HTML {\bf file}. The file may be located on
77any virtual file system or it may be normal file.
78
79
80
81\membersection{wxHtmlPrintout::SetHtmlText}\label{wxhtmlprintoutsethtmltext}
82
cc81d32f 83\func{void}{SetHtmlText}{\param{const wxString\& }{html}, \param{const wxString\& }{basepath = wxEmptyString}, \param{bool }{isdir = true}}
09397bc6
VS
84
85Prepare the class for printing this HTML text.
3ce369e6
VS
86
87\wxheading{Parameters}
88
09397bc6
VS
89\docparam{html}{HTML text. (NOT file!)}
90
91\docparam{basepath}{base directory (html string would be stored there if it was in
92file). It is used to determine path for loading images, for example.}
93
cc81d32f 94\docparam{isdir}{false if basepath is filename, true if it is directory name
09397bc6 95(see \helpref{wxFileSystem}{wxfilesystem} for detailed explanation)}
448af9a4 96
3ce369e6 97
3ce369e6 98
3ce369e6
VS
99\membersection{wxHtmlPrintout::SetMargins}\label{wxhtmlprintoutsetmargins}
100
101\func{void}{SetMargins}{\param{float }{top = 25.2}, \param{float }{bottom = 25.2}, \param{float }{left = 25.2}, \param{float }{right = 25.2}, \param{float }{spaces = 5}}
102
2edb0bde 103Sets margins in millimeters. Defaults to 1 inch for margins and 0.5cm for space
3ce369e6
VS
104between text and header and/or footer
105