]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/htdcrend.tex
mention Watcom makefile for wxBase
[wxWidgets.git] / docs / latex / wx / htdcrend.tex
index 58ae47a2f9765249786650c6d94929a23cf42244..f36de1860d462014e549c8eb85946481eccef89c 100644 (file)
@@ -13,6 +13,10 @@ or \helpref{wxHtmlPrintout}{wxhtmlprintout} is strongly recommended.
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/html/htmprint.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxHtmlDCRenderer::wxHtmlDCRenderer}\label{wxhtmldcrendererwxhtmldcrenderer}
@@ -23,17 +27,17 @@ Constructor.
 
 \membersection{wxHtmlDCRenderer::SetDC}\label{wxhtmldcrenderersetdc}
 
-\func{void}{SetDC}{\param{wxDC* }{dc}, \param{double }{pixel_scale = 1.0}}
+\func{void}{SetDC}{\param{wxDC* }{dc}, \param{double }{pixel\_scale = 1.0}}
 
 Assign DC instance to the renderer.
 
-{\it pixel_scale} can be used when rendering to high-resolution DCs (e.g. printer) to adjust size of pixel metrics.
-(Many dimensions in HTML are given in pixels - e.g. image sizes. 300x300 image would be only one
-inch wide on typical printer. With pixel_scale = 3.0 it would be 3 inches.)
+{\it pixel\_scale} can be used when rendering to high-resolution DCs (e.g. printer) to adjust size of pixel metrics.
+(Many dimensions in HTML are given in pixels -- e.g. image sizes. 300x300 image would be only one
+inch wide on typical printer. With pixel\_scale = 3.0 it would be 3 inches.)
 
 \wxheading{Parameters}
 
-\docparam{maxwidth}{width of the area (on this DC) that is equivalent to screen's width, 
+\docparam{maxwidth}{width of the area (on this DC) that is equivalent to the screen's width, 
 in pixels (you should set it to page width minus margins). 
 
 {\bf Note:} In the current implementation
@@ -52,7 +56,7 @@ width of the rectangle between calls to \helpref{Render}{wxhtmldcrendererrender}
 
 \membersection{wxHtmlDCRenderer::SetHtmlText}\label{wxhtmldcrenderersethtmltext}
 
-\func{void}{SetHtmlText}{\param{const wxString\& }{html}, \param{const wxString\& }{basepath = wxEmptyString}, \param{bool }{isdir = TRUE}}
+\func{void}{SetHtmlText}{\param{const wxString\& }{html}, \param{const wxString\& }{basepath = wxEmptyString}, \param{bool }{isdir = true}}
 
 Assign text to the renderer. \helpref{Render}{wxhtmldcrendererrender} then draws 
 the text onto DC.
@@ -64,12 +68,12 @@ the text onto DC.
 \docparam{basepath}{base directory (html string would be stored there if it was in
 file). It is used to determine path for loading images, for example.}
 
-\docparam{isdir}{FALSE if basepath is filename, TRUE if it is directory name
+\docparam{isdir}{false if basepath is filename, true if it is directory name
 (see \helpref{wxFileSystem}{wxfilesystem} for detailed explanation)}
 
 \membersection{wxHtmlDCRenderer::Render}\label{wxhtmldcrendererrender}
 
-\func{int}{Render}{\param{int }{x}, \param{int }{y}, \param{int }{from = 0}, \param{int }{dont\_render = FALSE}}
+\func{int}{Render}{\param{int }{x}, \param{int }{y}, \param{int }{from = 0}, \param{int }{dont\_render = false}}
 
 Renders HTML text to the DC.
 
@@ -79,7 +83,7 @@ Renders HTML text to the DC.
 
 \docparam{from}{y-coordinate of the very first visible cell}
 
-\docparam{dont\_render}{if TRUE then this method only returns y coordinate of the next page
+\docparam{dont\_render}{if true then this method only returns y coordinate of the next page
 and does not output anything}
 
 Returned value is y coordinate of first cell than didn't fit onto page.