docs/latex/wx/hteasypr.tex

   1 %
   2 % automatically generated by HelpGen from
   3 % htmprint.h at 17/Oct/99 12:48:02
   4 %
   5
   6 \section{\class{wxHtmlEasyPrinting}}\label{wxhtmleasyprinting}
   7
   8 This class provides very simple interface to printing
   9 architecture. It allows you to print HTML documents using
  10 only a few commands.
  11
  12 \wxheading{Note}
  13
  14 Do not create this class on the stack only. You should create an instance on app
  15 startup and use this instance for all printing operations. The reason is that
  16 this class stores various settings in it.
  17
  18 \wxheading{Derived from}
  19
  20 \helpref{wxObject}{wxobject}
  21
  22 \latexignore{\rtfignore{\wxheading{Members}}}
  23
  24 \membersection{wxHtmlEasyPrinting::wxHtmlEasyPrinting}\label{wxhtmleasyprintingwxhtmleasyprinting}
  25
  26 \func{}{wxHtmlEasyPrinting}{\param{const wxString\& }{name = "Printing"}, \param{wxFrame* }{parent\_frame = NULL}}
  27
  28 Constructor.
  29
  30 \wxheading{Parameters}
  31
  32 \docparam{name}{Name of the printing. Used by preview frames and setup dialogs.}
  33
  34 \docparam{parent\_frame}{pointer to the frame that will own preview frame and setup dialogs. May be NULL.}
  35
  36
  37 \membersection{wxHtmlEasyPrinting::PreviewFile}\label{wxhtmleasyprintingpreviewfile}
  38
  39 \func{void}{PreviewFile}{\param{const wxString\& }{htmlfile}}
  40
  41 Previews HTML file.
  42
  43 \membersection{wxHtmlEasyPrinting::PreviewText}\label{wxhtmleasyprintingpreviewtext}
  44
  45 \func{void}{PreviewText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}
  46
  47 Previews HTML text (not file!).
  48
  49 \wxheading{Parameters}
  50
  51 \docparam{htmltext}{HTML text.}
  52
  53 \docparam{basepath}{base directory (html string would be stored there if it was in
  54 file). It is used to determine path for loading images, for example.}
  55
  56 \membersection{wxHtmlEasyPrinting::PrintFile}\label{wxhtmleasyprintingprintfile}
  57
  58 \func{void}{PrintFile}{\param{const wxString\& }{htmlfile}}
  59
  60 Prints HTML file.
  61
  62 \membersection{wxHtmlEasyPrinting::PrintText}\label{wxhtmleasyprintingprinttext}
  63
  64 \func{void}{PrintText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}
  65
  66 Prints HTML text (not file!).
  67
  68 \wxheading{Parameters}
  69
  70 \docparam{htmltext}{HTML text.}
  71
  72 \docparam{basepath}{base directory (html string would be stored there if it was in
  73 file). It is used to determine path for loading images, for example.}
  74
  75 \membersection{wxHtmlEasyPrinting::PrinterSetup}\label{wxhtmleasyprintingprintersetup}
  76
  77 \func{void}{PrinterSetup}{\void}
  78
  79 Displays printer setup dialog and allows the user to modify settings.
  80
  81 \membersection{wxHtmlEasyPrinting::PageSetup}\label{wxhtmleasyprintingpagesetup}
  82
  83 \func{void}{PageSetup}{\void}
  84
  85 Displays page setup dialog and allows the user to modify settings.
  86
  87 \membersection{wxHtmlEasyPrinting::SetHeader}\label{wxhtmleasyprintingsetheader}
  88
  89 \func{void}{SetHeader}{\param{const wxString\& }{header}, \param{int }{pg = wxPAGE\_ALL}}
  90
  91 Sets page header.
  92
  93 \wxheading{Parameters}
  94
  95 \docparam{header}{HTML text to be used as header. You can use macros in it:
  96
  97 \begin{itemize}\itemsep=0pt
  98 \item @PAGENUM@ is replaced by page number
  99 \item @PAGESCNT@ is replaced by total number of pages
 100 \end{itemize}
 101 }
 102
 103 \docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
 104
 105 \membersection{wxHtmlEasyPrinting::SetFooter}\label{wxhtmleasyprintingsetfooter}
 106
 107 \func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}}
 108
 109 Sets page footer.
 110
 111 \wxheading{Parameters}
 112
 113 \docparam{footer}{HTML text to be used as footer. You can use macros in it:
 114
 115 \begin{itemize}\itemsep=0pt
 116 \item @PAGENUM@ is replaced by page number
 117 \item @PAGESCNT@ is replaced by total number of pages
 118 \end{itemize}
 119 }
 120
 121 \docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
 122
 123 \membersection{wxHtmlEasyPrinting::GetPrintData}\label{wxhtmleasyprintinggetprintdata}
 124
 125 \func{wxPrintData*}{GetPrintData}{\void}
 126
 127 Returns pointer to \helpref{wxPrintData}{wxprintdata} instance used by this class. You can
 128 set its parameters (via SetXXXX methods).
 129
 130 \membersection{wxHtmlEasyPrinting::GetPageSetupData}\label{wxhtmleasyprintinggetpagesetupdata}
 131
 132 \func{wxPageSetupDialogData*}{GetPageSetupData}{\void}
 133
 134 Returns a pointer to \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata} instance used by
 135 this class. You can set its parameters (via SetXXXX methods).
 136