User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 0.98.4

Expand All
Contract All

Table of Contents

# wxPrintout

### MODULE

wxPrintout

### MODULE SUMMARY

See external documentation: wxPrintout.

### DESCRIPTION

See external documentation: wxPrintout.

### DATA TYPES

wxPrintout()

  An object reference, The representation is internal and can be changed without notice. It can't be used for comparsion stored on disc or distributed for use on other nodes.

### EXPORTS

new(Title::string(), OnPrintPage::function()) -> wxPrintout() (see module wxPrintout)

@equiv new(Title, OnPrintPage, [])

new(Title::string(), OnPrintPage::function(), Opts::[Option]) -> wxPrintout() (see module wxPrintout)

Types:

Option = {onPreparePrinting, OnPreparePrinting::function()} | {onBeginPrinting, OnBeginPrinting::function()} | {onEndPrinting, OnEndPrinting::function()} | {onBeginDocument, OnBeginDocument::function()} | {onEndDocument, OnEndDocument::function()} | {hasPage, HasPage::function()} | {getPageInfo, GetPageInfo::function()}

Creates a wxPrintout object with a callback fun and optionally other callback funs.

    OnPrintPage(This,Page) -> boolean()

    OnPreparePrinting(This) -> term()

    OnBeginPrinting(This) -> term()

    OnEndPrinting(This) -> term()

    OnBeginDocument(This,StartPage,EndPage) -> boolean()

    OnEndDocument(This) -> term()

    HasPage(This,Page)} -> boolean()

    GetPageInfo(This) -> {MinPage:.integer(), MaxPage::integer(), PageFrom::integer(), PageTo::integer()}

The This argument is the wxPrintout object reference to this object
NOTE: The callbacks may not call other processes.

getDC(This::wxPrintout()) -> wxDC() (see module wxDC)

See external documentation.

getPageSizeMM(This::wxPrintout()) -> {W::integer(), H::integer()}

See external documentation.

getPageSizePixels(This::wxPrintout()) -> {W::integer(), H::integer()}

See external documentation.

getPaperRectPixels(This::wxPrintout()) -> {X::integer(), Y::integer(), W::integer(), H::integer()}

See external documentation.

getPPIPrinter(This::wxPrintout()) -> {X::integer(), Y::integer()}

See external documentation.

getPPIScreen(This::wxPrintout()) -> {X::integer(), Y::integer()}

See external documentation.

getTitle(This::wxPrintout()) -> string()

See external documentation.

isPreview(This::wxPrintout()) -> bool()

See external documentation.

fitThisSizeToPaper(This::wxPrintout(), ImageSize::{W::integer(), H::integer()}) -> ok

See external documentation.

fitThisSizeToPage(This::wxPrintout(), ImageSize::{W::integer(), H::integer()}) -> ok

See external documentation.

fitThisSizeToPageMargins(This::wxPrintout(), ImageSize::{W::integer(), H::integer()}, PageSetupData::wxPageSetupDialogData() (see module wxPageSetupDialogData)) -> ok

See external documentation.

mapScreenSizeToPaper(This::wxPrintout()) -> ok

See external documentation.

mapScreenSizeToPage(This::wxPrintout()) -> ok

See external documentation.

mapScreenSizeToPageMargins(This::wxPrintout(), PageSetupData::wxPageSetupDialogData() (see module wxPageSetupDialogData)) -> ok

See external documentation.

mapScreenSizeToDevice(This::wxPrintout()) -> ok

See external documentation.

getLogicalPaperRect(This::wxPrintout()) -> {X::integer(), Y::integer(), W::integer(), H::integer()}

See external documentation.

getLogicalPageRect(This::wxPrintout()) -> {X::integer(), Y::integer(), W::integer(), H::integer()}

See external documentation.

getLogicalPageMarginsRect(This::wxPrintout(), PageSetupData::wxPageSetupDialogData() (see module wxPageSetupDialogData)) -> {X::integer(), Y::integer(), W::integer(), H::integer()}

See external documentation.

setLogicalOrigin(This::wxPrintout(), X::integer(), Y::integer()) -> ok

See external documentation.

offsetLogicalOrigin(This::wxPrintout(), Xoff::integer(), Yoff::integer()) -> ok

See external documentation.

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

Destroys this object, do not use object again