X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/448af9a46eb58ae17616a4d5e76884dc519f5523..6c4fc6a8e3bea19621a328e66b3857ab01a5c15a:/docs/latex/wx/htdcrend.tex diff --git a/docs/latex/wx/htdcrend.tex b/docs/latex/wx/htdcrend.tex index 0c02abc77a..f7623eb322 100644 --- a/docs/latex/wx/htdcrend.tex +++ b/docs/latex/wx/htdcrend.tex @@ -13,6 +13,10 @@ or \helpref{wxHtmlPrintout}{wxhtmlprintout} is strongly recommended. \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxHtmlDCRenderer::wxHtmlDCRenderer}\label{wxhtmldcrendererwxhtmldcrenderer} @@ -23,18 +27,20 @@ Constructor. \membersection{wxHtmlDCRenderer::SetDC}\label{wxhtmldcrenderersetdc} -\func{void}{SetDC}{\param{wxDC* }{dc}, \param{int }{maxwidth}} +\func{void}{SetDC}{\param{wxDC* }{dc}, \param{double }{pixel\_scale = 1.0}} Assign DC instance to the renderer. -\wxheading{Parameters} +{\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.) + +\membersection{wxHtmlDCRenderer::SetFonts}\label{wxhtmldcrenderersetfonts} -\docparam{maxwidth}{width of the area (on this DC) that is equivalent to screen's width, -in pixels (you should set it to page width minus margins). +\func{void}{SetFonts}{\param{const wxString\& }{normal\_face}, \param{const wxString\& }{fixed\_face}, \param{const int }{*sizes = NULL}} -{\bf Note:} In the current implementation -the screen width is always 800 pixels: it gives best results and ensures (almost) same printed outputs -across platforms and differently configured desktops.} +Sets fonts. See \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} for +detailed description. See also \helpref{SetSize}{wxhtmldcrenderersetsize}. @@ -45,13 +51,10 @@ See also \helpref{SetSize}{wxhtmldcrenderersetsize}. Set size of output rectangle, in pixels. Note that you {\bf can't} change width of the rectangle between calls to \helpref{Render}{wxhtmldcrendererrender}! (You can freely change height.) -If you set width equal to maxwidth then HTML is rendered as if it were displayed in fullscreen. -If you set width = 1/2 maxwidth the it is rendered as if it covered half the screen -and so on. \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. @@ -63,12 +66,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. @@ -78,7 +81,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.