wxHtmlEasyPrinting (wx v2.5.4)

Copy Markdown View Source

This class provides very simple interface to printing architecture.

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

Summary

Types

wxHtmlEasyPrinting()

Functions

destroy(This)

Destroys the object

getPageSetupData(This)

Returns a pointer to wxPageSetupDialogData instance used by this class.

getPrintData(This)

Returns pointer to wxPrintData instance used by this class.

new()
new(Options)

Constructor.

pageSetup(This)

Display page setup dialog and allows the user to modify settings.

previewFile(This, Htmlfile)

Preview HTML file.

previewText(This, Htmltext)
previewText/3

Preview HTML text (not file!).

printFile(This, Htmlfile)

Print HTML file.

printText(This, Htmltext)
printText/3

Print HTML text (not file!).

setFonts(This, Normal_face, Fixed_face)
setFonts/4

Sets fonts.

setFooter(This, Footer)
setFooter/3

Set page footer.

setHeader(This, Header)
setHeader/3

Set page header.

Types

wxHtmlEasyPrinting()

-type wxHtmlEasyPrinting() :: wx:wx_object().

Functions

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

Destroys the object

getPageSetupData(This) -> Result

Types

This = wxHtmlEasyPrinting()
Result = wxPageSetupDialogData:wxPageSetupDialogData()

Returns a pointer to wxPageSetupDialogData instance used by this class.

You can set its parameters (via SetXXXX methods).

getPrintData(This :: wxHtmlEasyPrinting()) -> Result

Types

Result = wxPrintData:wxPrintData()

Returns pointer to wxPrintData instance used by this class.

You can set its parameters (via SetXXXX methods).

new() ≡ new([])

new(Options :: [Option]) -> Result

Types

Result = wxHtmlEasyPrinting()
Option = {name, unicode:chardata()} | {parentWindow, wxWindow:wxWindow()}

Constructor.

pageSetup(This :: wxHtmlEasyPrinting()) -> ok

Display page setup dialog and allows the user to modify settings.

previewFile(This, Htmlfile) -> boolean()

Types

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) ≡ previewText(This, Htmltext, [])

previewText/3

-spec previewText(This, Htmltext) -> boolean()
                     when This :: wxHtmlEasyPrinting(), Htmltext :: unicode:chardata().
-spec 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()

Types

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) ≡ printText(This, Htmltext, [])

printText/3

-spec printText(This, Htmltext) -> boolean()
                   when This :: wxHtmlEasyPrinting(), Htmltext :: unicode:chardata().
-spec 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) ≡ setFonts(This, Normal_face, Fixed_face, [])

setFonts/4

-spec setFonts(This, Normal_face, Fixed_face) -> ok
                  when
                      This :: wxHtmlEasyPrinting(),
                      Normal_face :: unicode:chardata(),
                      Fixed_face :: unicode:chardata().
-spec 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) ≡ setFooter(This, Footer, [])

setFooter/3

-spec setFooter(This, Footer) -> ok when This :: wxHtmlEasyPrinting(), Footer :: unicode:chardata().
-spec 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) ≡ setHeader(This, Header, [])

setHeader/3

-spec setHeader(This, Header) -> ok when This :: wxHtmlEasyPrinting(), Header :: unicode:chardata().
-spec 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