wxErlang

Reference Manual

Version 1.9.3.1

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

@equiv new(Title, OnPrintPage, [])

new(Title::string(), OnPrintPage::function(), Opts::[Option]) -> wxPrintout: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) -> wxDC:wxDC()

Types

This = wxPrintout()

See external documentation.

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

Types

This = wxPrintout()

See external documentation.

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

Types

This = wxPrintout()

See external documentation.

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

Types

This = wxPrintout()

See external documentation.

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

Types

This = wxPrintout()

See external documentation.

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

Types

This = wxPrintout()

See external documentation.

getTitle(This) -> unicode:charlist()

Types

This = wxPrintout()

See external documentation.

isPreview(This) -> boolean()

Types

This = wxPrintout()

See external documentation.

fitThisSizeToPaper(This, ImageSize) -> ok

Types

This = wxPrintout()
ImageSize = {W::integer(), H::integer()}

See external documentation.

fitThisSizeToPage(This, ImageSize) -> ok

Types

This = wxPrintout()
ImageSize = {W::integer(), H::integer()}

See external documentation.

fitThisSizeToPageMargins(This, ImageSize, PageSetupData) -> ok

Types

This = wxPrintout()
ImageSize = {W::integer(), H::integer()}
PageSetupData = wxPageSetupDialogData:wxPageSetupDialogData()

See external documentation.

mapScreenSizeToPaper(This) -> ok

Types

This = wxPrintout()

See external documentation.

mapScreenSizeToPage(This) -> ok

Types

This = wxPrintout()

See external documentation.

mapScreenSizeToPageMargins(This, PageSetupData) -> ok

Types

This = wxPrintout()
PageSetupData = wxPageSetupDialogData:wxPageSetupDialogData()

See external documentation.

mapScreenSizeToDevice(This) -> ok

Types

This = wxPrintout()

See external documentation.

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

Types

This = wxPrintout()

See external documentation.

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

Types

This = wxPrintout()

See external documentation.

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

Types

This = wxPrintout()
PageSetupData = wxPageSetupDialogData:wxPageSetupDialogData()

See external documentation.

setLogicalOrigin(This, X, Y) -> ok

Types

This = wxPrintout()
X = integer()
Y = integer()

See external documentation.

offsetLogicalOrigin(This, Xoff, Yoff) -> ok

Types

This = wxPrintout()
Xoff = integer()
Yoff = integer()

See external documentation.

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

Destroys this object, do not use object again

Copyright © 2009-2021 Ericsson AB. All Rights Reserved.