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