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 \wxheading{Include files}
  23
  24 <wx/html/htmprint.h>
  25
  26 \wxheading{Library}
  27
  28 \helpref{wxHtml}{librarieslist}
  29
  30
  31 \latexignore{\rtfignore{\wxheading{Members}}}
  32
  33 \membersection{wxHtmlEasyPrinting::wxHtmlEasyPrinting}\label{wxhtmleasyprintingwxhtmleasyprinting}
  34
  35 \func{}{wxHtmlEasyPrinting}{\param{const wxString\& }{name = "Printing"}, \param{wxWindow* }{parentWindow = NULL}}
  36
  37 Constructor.
  38
  39 \wxheading{Parameters}
  40
  41 \docparam{name}{Name of the printing object. Used by preview frames and setup dialogs.}
  42
  43 \docparam{parentWindow}{pointer to the window that will own the preview frame and setup dialogs. May be NULL.}
  44
  45 \membersection{wxHtmlEasyPrinting::PreviewFile}\label{wxhtmleasyprintingpreviewfile}
  46
  47 \func{bool}{PreviewFile}{\param{const wxString\& }{htmlfile}}
  48
  49 Preview HTML file.
  50
  51 Returns false in case of error -- call
  52 \helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
  53 information about the kind of the error.
  54
  55
  56 \membersection{wxHtmlEasyPrinting::PreviewText}\label{wxhtmleasyprintingpreviewtext}
  57
  58 \func{bool}{PreviewText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}
  59
  60 Preview HTML text (not file!).
  61
  62 Returns false in case of error -- call
  63 \helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
  64 information about the kind of the error.
  65
  66 \wxheading{Parameters}
  67
  68 \docparam{htmltext}{HTML text.}
  69
  70 \docparam{basepath}{base directory (html string would be stored there if it was in
  71 file). It is used to determine path for loading images, for example.}
  72
  73 \membersection{wxHtmlEasyPrinting::PrintFile}\label{wxhtmleasyprintingprintfile}
  74
  75 \func{bool}{PrintFile}{\param{const wxString\& }{htmlfile}}
  76
  77 Print HTML file.
  78
  79 Returns false in case of error -- call
  80 \helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
  81 information about the kind of the error.
  82
  83 \membersection{wxHtmlEasyPrinting::PrintText}\label{wxhtmleasyprintingprinttext}
  84
  85 \func{bool}{PrintText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}
  86
  87 Print HTML text (not file!).
  88
  89 Returns false in case of error -- call
  90 \helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
  91 information about the kind of the error.
  92
  93 \wxheading{Parameters}
  94
  95 \docparam{htmltext}{HTML text.}
  96
  97 \docparam{basepath}{base directory (html string would be stored there if it was in
  98 file). It is used to determine path for loading images, for example.}
  99
 100 \membersection{wxHtmlEasyPrinting::PageSetup}\label{wxhtmleasyprintingpagesetup}
 101
 102 \func{void}{PageSetup}{\void}
 103
 104 Display page setup dialog and allows the user to modify settings.
 105
 106 \membersection{wxHtmlEasyPrinting::SetFonts}\label{wxhtmleasyprintingsetfonts}
 107
 108 \func{void}{SetFonts}{\param{const wxString\& }{normal\_face}, \param{const wxString\& }{fixed\_face}, \param{const int }{*sizes = NULL}}
 109
 110 Sets fonts. See \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} for
 111 detailed description.
 112
 113 \membersection{wxHtmlEasyPrinting::SetHeader}\label{wxhtmleasyprintingsetheader}
 114
 115 \func{void}{SetHeader}{\param{const wxString\& }{header}, \param{int }{pg = wxPAGE\_ALL}}
 116
 117 Set page header. The following macros can be used inside it:
 118 \input htprintmacros.inc
 119
 120 \wxheading{Parameters}
 121
 122 \docparam{header}{HTML text to be used as header.}
 123
 124 \docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
 125
 126 \membersection{wxHtmlEasyPrinting::SetFooter}\label{wxhtmleasyprintingsetfooter}
 127
 128 \func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}}
 129
 130 Set page footer. The following macros can be used inside it:
 131 \input htprintmacros.inc
 132
 133 \wxheading{Parameters}
 134
 135 \docparam{footer}{HTML text to be used as footer.}
 136
 137 \docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
 138
 139 \membersection{wxHtmlEasyPrinting::GetPrintData}\label{wxhtmleasyprintinggetprintdata}
 140
 141 \func{wxPrintData*}{GetPrintData}{\void}
 142
 143 Returns pointer to \helpref{wxPrintData}{wxprintdata} instance used by this class. You can
 144 set its parameters (via SetXXXX methods).
 145
 146 \membersection{wxHtmlEasyPrinting::GetPageSetupData}\label{wxhtmleasyprintinggetpagesetupdata}
 147
 148 \func{wxPageSetupDialogData*}{GetPageSetupData}{\void}
 149
 150 Returns a pointer to \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata} instance used by
 151 this class. You can set its parameters (via SetXXXX methods).
 152