docs/latex/wx/htprint.tex

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