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::GetParentWindow}\label{wxhtmleasyprintinggetparentwindow}
  46
  47 \constfunc{wxWindow*}{GetParentWindow}{\void}
  48
  49 Gets the parent window for dialogs.
  50
  51 \membersection{wxHtmlEasyPrinting::GetPrintData}\label{wxhtmleasyprintinggetprintdata}
  52
  53 \func{wxPrintData*}{GetPrintData}{\void}
  54
  55 Returns pointer to \helpref{wxPrintData}{wxprintdata} instance used by this class. You can
  56 set its parameters (via SetXXXX methods).
  57
  58 \membersection{wxHtmlEasyPrinting::GetPageSetupData}\label{wxhtmleasyprintinggetpagesetupdata}
  59
  60 \func{wxPageSetupDialogData*}{GetPageSetupData}{\void}
  61
  62 Returns a pointer to \helpref{wxPageSetupDialogData}{wxpagesetupdialogdata} instance used by
  63 this class. You can set its parameters (via SetXXXX methods).
  64
  65 \membersection{wxHtmlEasyPrinting::PreviewFile}\label{wxhtmleasyprintingpreviewfile}
  66
  67 \func{bool}{PreviewFile}{\param{const wxString\& }{htmlfile}}
  68
  69 Preview HTML file.
  70
  71 Returns false in case of error -- call
  72 \helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
  73 information about the kind of the error.
  74
  75
  76 \membersection{wxHtmlEasyPrinting::PreviewText}\label{wxhtmleasyprintingpreviewtext}
  77
  78 \func{bool}{PreviewText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}
  79
  80 Preview HTML text (not file!).
  81
  82 Returns false in case of error -- call
  83 \helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
  84 information about the kind of the error.
  85
  86 \wxheading{Parameters}
  87
  88 \docparam{htmltext}{HTML text.}
  89
  90 \docparam{basepath}{base directory (html string would be stored there if it was in
  91 file). It is used to determine path for loading images, for example.}
  92
  93 \membersection{wxHtmlEasyPrinting::PrintFile}\label{wxhtmleasyprintingprintfile}
  94
  95 \func{bool}{PrintFile}{\param{const wxString\& }{htmlfile}}
  96
  97 Print HTML file.
  98
  99 Returns false in case of error -- call
 100 \helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
 101 information about the kind of the error.
 102
 103 \membersection{wxHtmlEasyPrinting::PrintText}\label{wxhtmleasyprintingprinttext}
 104
 105 \func{bool}{PrintText}{\param{const wxString\& }{htmltext}, \param{const wxString\& }{basepath = wxEmptyString}}
 106
 107 Print HTML text (not file!).
 108
 109 Returns false in case of error -- call
 110 \helpref{wxPrinter::GetLastError}{wxprintergetlasterror} to get detailed
 111 information about the kind of the error.
 112
 113 \wxheading{Parameters}
 114
 115 \docparam{htmltext}{HTML text.}
 116
 117 \docparam{basepath}{base directory (html string would be stored there if it was in
 118 file). It is used to determine path for loading images, for example.}
 119
 120 \membersection{wxHtmlEasyPrinting::PageSetup}\label{wxhtmleasyprintingpagesetup}
 121
 122 \func{void}{PageSetup}{\void}
 123
 124 Display page setup dialog and allows the user to modify settings.
 125
 126 \membersection{wxHtmlEasyPrinting::SetFonts}\label{wxhtmleasyprintingsetfonts}
 127
 128 \func{void}{SetFonts}{\param{const wxString\& }{normal\_face}, \param{const wxString\& }{fixed\_face}, \param{const int }{*sizes = NULL}}
 129
 130 Sets fonts. See \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} for
 131 detailed description.
 132
 133 \membersection{wxHtmlEasyPrinting::SetHeader}\label{wxhtmleasyprintingsetheader}
 134
 135 \func{void}{SetHeader}{\param{const wxString\& }{header}, \param{int }{pg = wxPAGE\_ALL}}
 136
 137 Set page header. The following macros can be used inside it:
 138 \input htprintmacros.inc
 139
 140 \wxheading{Parameters}
 141
 142 \docparam{header}{HTML text to be used as header.}
 143
 144 \docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
 145
 146 \membersection{wxHtmlEasyPrinting::SetFooter}\label{wxhtmleasyprintingsetfooter}
 147
 148 \func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}}
 149
 150 Set page footer. The following macros can be used inside it:
 151 \input htprintmacros.inc
 152
 153 \wxheading{Parameters}
 154
 155 \docparam{footer}{HTML text to be used as footer.}
 156
 157 \docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
 158
 159 \membersection{wxHtmlEasyPrinting::SetParentWindow}\label{wxhtmleasyprintingsetparentwindow}
 160
 161 \func{void}{SetParentWindow}{\param{wxWindow*}{ window}}
 162
 163 Sets the parent window for dialogs.
 164