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 \section{\class{wxHtmlPrintout}}\label{wxhtmlprintout}
   7
   8 This class serves as a printout class for HTML documents.
   9
  10 \wxheading{Derived from}
  11
  12 \helpref{wxPrintout}{wxprintout}
  13
  14 \latexignore{\rtfignore{\wxheading{Members}}}
  15
  16 \membersection{wxHtmlPrintout::wxHtmlPrintout}\label{wxhtmlprintoutwxhtmlprintout}
  17
  18 \func{}{wxHtmlPrintout}{\param{const wxString\& }{title = "Printout"}}
  19
  20 Constructor.
  21
  22 \membersection{wxHtmlPrintout::SetHtmlText}\label{wxhtmlprintoutsethtmltext}
  23
  24 \func{void}{SetHtmlText}{\param{const wxString\& }{html}, \param{const wxString\& }{basepath = wxEmptyString}, \param{bool }{isdir = TRUE}}
  25
  26 Prepare the class for printing this HTML text.
  27
  28 \wxheading{Parameters}
  29
  30 \docparam{html}{HTML text. (NOT file!)}
  31
  32 \docparam{basepath}{base directory (html string would be stored there if it was in
  33 file). It is used to determine path for loading images, for example.}
  34
  35 \docparam{isdir}{FALSE if basepath is filename, TRUE if it is directory name
  36 (see \helpref{wxFileSystem}{wxfilesystem} for detailed explanation)}
  37
  38 \membersection{wxHtmlPrintout::SetHtmlFile}\label{wxhtmlprintoutsethtmlfile}
  39
  40 \func{void}{SetHtmlFile}{\param{const wxString\& }{htmlfile}}
  41
  42 Prepare the class for printing this HTML {\bf file}. The file may be located on
  43 any virtual file system or it may be normal file.
  44
  45 \membersection{wxHtmlPrintout::SetHeader}\label{wxhtmlprintoutsetheader}
  46
  47 \func{void}{SetHeader}{\param{const wxString\& }{header}, \param{int }{pg = wxPAGE\_ALL}}
  48
  49 Sets page header.
  50
  51 \wxheading{Parameters}
  52
  53 \docparam{header}{HTML text to be used as header. You can use macros in it:
  54
  55 \begin{itemize}\itemsep=0pt
  56 \item @PAGENUM@ is replaced by page number
  57 \item @PAGESCNT@ is replaced by total number of pages
  58 \end{itemize}
  59 }
  60
  61 \docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
  62
  63
  64 \membersection{wxHtmlPrintout::SetFooter}\label{wxhtmlprintoutsetfooter}
  65
  66 \func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}}
  67
  68 Sets page footer.
  69
  70 \wxheading{Parameters}
  71
  72 \docparam{footer}{HTML text to be used as footer. You can use macros in it:
  73
  74 \begin{itemize}\itemsep=0pt
  75 \item @PAGENUM@ is replaced by page number
  76 \item @PAGESCNT@ is replaced by total number of pages
  77 \end{itemize}
  78 }
  79
  80 \docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
  81
  82 \membersection{wxHtmlPrintout::SetMargins}\label{wxhtmlprintoutsetmargins}
  83
  84 \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}}
  85
  86 Sets margins in milimeters. Defaults to 1 inch for margins and 0.5cm for space
  87 between text and header and/or footer
  88