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 \latexignore{\rtfignore{\wxheading{Members}}}
  21
  22
  23 \membersection{wxHtmlPrintout::wxHtmlPrintout}\label{wxhtmlprintoutwxhtmlprintout}
  24
  25 \func{}{wxHtmlPrintout}{\param{const wxString\& }{title = "Printout"}}
  26
  27 Constructor.
  28
  29
  30 \membersection{wxHtmlPrintout::AddFilter}\label{wxhtmlprintoutaddfilter}
  31
  32 \func{static void}{AddFilter}{\param{wxHtmlFilter* }{filter}}
  33
  34 Adds a filter to the static list of filters for wxHtmlPrintout. See \helpref{wxHtmlFilter}{wxhtmlfilter} for
  35 further information.
  36
  37 \membersection{wxHtmlPrintout::SetFonts}\label{wxhtmlprintoutsetfonts}
  38
  39 \func{void}{SetFonts}{\param{const wxString\& }{normal\_face}, \param{const wxString\& }{fixed\_face}, \param{const int }{*sizes = NULL}}
  40
  41 Sets fonts. See \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} for
  42 detailed description.
  43
  44 \membersection{wxHtmlPrintout::SetFooter}\label{wxhtmlprintoutsetfooter}
  45
  46 \func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}}
  47
  48 Sets page footer.
  49
  50 \wxheading{Parameters}
  51
  52 \docparam{footer}{HTML text to be used as footer. You can use macros in it:
  53 \begin{itemize}
  54 \item @PAGENUM@ is replaced by page number
  55 \item @PAGESCNT@ is replaced by total number of pages
  56 \end{itemize}
  57 }
  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 Sets page header.
  67
  68 \wxheading{Parameters}
  69
  70 \docparam{header}{HTML text to be used as header. You can use macros in it:
  71 \begin{itemize}
  72 \item @PAGENUM@ is replaced by page number
  73 \item @PAGESCNT@ is replaced by total number of pages
  74 \end{itemize}
  75 }
  76
  77 \docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
  78
  79
  80 \membersection{wxHtmlPrintout::SetHtmlFile}\label{wxhtmlprintoutsethtmlfile}
  81
  82 \func{void}{SetHtmlFile}{\param{const wxString\& }{htmlfile}}
  83
  84 Prepare the class for printing this HTML {\bf file}. The file may be located on
  85 any virtual file system or it may be normal file.
  86
  87
  88
  89 \membersection{wxHtmlPrintout::SetHtmlText}\label{wxhtmlprintoutsethtmltext}
  90
  91 \func{void}{SetHtmlText}{\param{const wxString\& }{html}, \param{const wxString\& }{basepath = wxEmptyString}, \param{bool }{isdir = true}}
  92
  93 Prepare the class for printing this HTML text.
  94
  95 \wxheading{Parameters}
  96
  97 \docparam{html}{HTML text. (NOT file!)}
  98
  99 \docparam{basepath}{base directory (html string would be stored there if it was in
 100 file). It is used to determine path for loading images, for example.}
 101
 102 \docparam{isdir}{false if basepath is filename, true if it is directory name
 103 (see \helpref{wxFileSystem}{wxfilesystem} for detailed explanation)}
 104
 105
 106
 107 \membersection{wxHtmlPrintout::SetMargins}\label{wxhtmlprintoutsetmargins}
 108
 109 \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}}
 110
 111 Sets margins in millimeters. Defaults to 1 inch for margins and 0.5cm for space
 112 between text and header and/or footer
 113