wxHtmlEasyPrinting(3)

NAME
wxHtmlEasyPrinting - This class provides very simple interface to printing architecture.

DESCRIPTION

It allows you to print HTML documents using only a few commands.

Note: Do not create this class on the stack only. You should create an instance on app startup and use this instance for all printing operations. The reason is that this class stores various settings in it.

wxWidgets docs: wxHtmlEasyPrinting

DATA TYPES

wxHtmlEasyPrinting() :: wx:wx_object().

FUNCTIONS

destroy(This :: wxHtmlEasyPrinting()) -> ok.

    Destroys the object
getPageSetupData(This) -> wxPageSetupDialogData:wxPageSetupDialogData() when This :: wxHtmlEasyPrinting().

    Returns a pointer to wxPageSetupDialogData instance used by this class.

    You can set its parameters (via SetXXXX methods).
getPrintData(This) -> wxPrintData:wxPrintData() when This :: wxHtmlEasyPrinting().

    Returns pointer to wxPrintData instance used by this class.

    You can set its parameters (via SetXXXX methods).
new([Option]) -> wxHtmlEasyPrinting() when Option :: {name, unicode:chardata()} | {parentWindow, wxWindow:wxWindow()}.

    Constructor.
pageSetup(This) -> ok when This :: wxHtmlEasyPrinting().

    Display page setup dialog and allows the user to modify settings.
previewFile(This, Htmlfile) -> boolean() when This :: wxHtmlEasyPrinting(), Htmlfile :: unicode:chardata().

    Preview HTML file.

    Returns false in case of error - call wxPrinter:getLastError/0 to get detailed information about the kind of the error.
previewText(This, Htmltext, [Option]) -> boolean() when This :: wxHtmlEasyPrinting(), Htmltext :: unicode:chardata(), Option :: {basepath, unicode:chardata()}.

    Preview HTML text (not file!).

    Returns false in case of error - call wxPrinter:getLastError/0 to get detailed information about the kind of the error.
printFile(This, Htmlfile) -> boolean() when This :: wxHtmlEasyPrinting(), Htmlfile :: unicode:chardata().

    Print HTML file.

    Returns false in case of error - call wxPrinter:getLastError/0 to get detailed information about the kind of the error.
printText(This, Htmltext, [Option]) -> boolean() when This :: wxHtmlEasyPrinting(), Htmltext :: unicode:chardata(), Option :: {basepath, unicode:chardata()}.

    Print HTML text (not file!).

    Returns false in case of error - call wxPrinter:getLastError/0 to get detailed information about the kind of the error.
setFonts(This, Normal_face, Fixed_face, [Option]) -> ok when This :: wxHtmlEasyPrinting(), Normal_face :: unicode:chardata(), Fixed_face :: unicode:chardata(), Option :: {sizes, [integer()]}.

    Sets fonts.

    See wxHtmlDCRenderer::SetFonts (not implemented in wx) for detailed description.
setFooter(This, Footer, [Option]) -> ok when This :: wxHtmlEasyPrinting(), Footer :: unicode:chardata(), Option :: {pg, integer()}.

    Set page footer.

    The following macros can be used inside it: @DATE@ is replaced by the current date in default format @PAGENUM@ is replaced by page number @PAGESCNT@ is replaced by total number of pages @TIME@ is replaced by the current time in default format @TITLE@ is replaced with the title of the document
setHeader(This, Header, [Option]) -> ok when This :: wxHtmlEasyPrinting(), Header :: unicode:chardata(), Option :: {pg, integer()}.

    Set page header.

    The following macros can be used inside it:

        • @DATE@ is replaced by the current date in default format

        • @PAGENUM@ is replaced by page number

        • @PAGESCNT@ is replaced by total number of pages

        • @TIME@ is replaced by the current time in default format

        • @TITLE@ is replaced with the title of the document