wxHtmlEasyPrinting — wx v2.6

Search documentation of wx

# wxHtmlEasyPrinting (wx v2.6)

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()

Equivalent to `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)

Equivalent to `previewText(This, Htmltext, [])`.

previewText/3

Preview HTML text (not file!).

printFile(This, Htmlfile)

Print HTML file.

printText(This, Htmltext)

Equivalent to `printText(This, Htmltext, [])`.

printText/3

Print HTML text (not file!).

setFonts(This, Normal_face, Fixed_face)

Equivalent to `setFonts(This, Normal_face, Fixed_face, [])`.

setFonts/4

Sets fonts.

setFooter(This, Footer)

Equivalent to `setFooter(This, Footer, [])`.

setFooter/3

Set page footer.

setHeader(This, Header)

Equivalent to `setHeader(This, Header, [])`.

setHeader/3

Set page header.

## Types

# wxHtmlEasyPrinting()

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

## Functions

# destroy(This)

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

Destroys the object

# getPageSetupData(This)

    -spec 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)

    -spec 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()

    -spec new() -> wxHtmlEasyPrinting().

Equivalent to `new([])`.

# new(Options)

    -spec new([Option]) -> wxHtmlEasyPrinting()
                 when Option :: {name, unicode:chardata()} | {parentWindow, wxWindow:wxWindow()}.

Constructor.

# pageSetup(This)

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

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

# previewFile(This, Htmlfile)

    -spec 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)

    -spec previewText(This, Htmltext) -> boolean()
                         when This :: wxHtmlEasyPrinting(), Htmltext :: unicode:chardata().

Equivalent to `previewText(This, Htmltext, [])`.

# previewText/3

    -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)

    -spec 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)

    -spec printText(This, Htmltext) -> boolean()
                       when This :: wxHtmlEasyPrinting(), Htmltext :: unicode:chardata().

Equivalent to `printText(This, Htmltext, [])`.

# printText/3

    -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)

    -spec setFonts(This, Normal_face, Fixed_face) -> ok
                      when
                          This :: wxHtmlEasyPrinting(),
                          Normal_face :: unicode:chardata(),
                          Fixed_face :: unicode:chardata().

Equivalent to `setFonts(This, Normal_face, Fixed_face, [])`.

# setFonts/4

    -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)

    -spec setFooter(This, Footer) -> ok when This :: wxHtmlEasyPrinting(), Footer :: unicode:chardata().

Equivalent to `setFooter(This, Footer, [])`.

# setFooter/3

    -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)

    -spec setHeader(This, Header) -> ok when This :: wxHtmlEasyPrinting(), Header :: unicode:chardata().

Equivalent to `setHeader(This, Header, [])`.

# setHeader/3

    -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