wxPrintData - Functions for wxPrintData class
Please see following description for synopsis
wxPrintData(3) Erlang Module Definition wxPrintData(3)
NAME
wxPrintData - Functions for wxPrintData class
DESCRIPTION
This class holds a variety of information related to printers and
printer device contexts. This class is used to create a wxPrinterDC
(not implemented in wx) and a wxPostScriptDC. It is also used as a data
member of wxPrintDialogData and wxPageSetupDialogData, as part of the
mechanism for transferring data between the print dialogs and the
application.
See: Overview printing, wxPrintDialog, wxPageSetupDialog, wxPrintDi-
alogData, wxPageSetupDialogData, Overview cmndlg, wxPrinterDC (not
implemented in wx), wxPostScriptDC
wxWidgets docs: wxPrintData
DATA TYPES
wxPrintData() = wx:wx_object()
EXPORTS
new() -> wxPrintData()
Default constructor.
new(Data) -> wxPrintData()
Types:
Data = wxPrintData()
Copy constructor.
destroy(This :: wxPrintData()) -> ok
Destructor.
getCollate(This) -> boolean()
Types:
This = wxPrintData()
Returns true if collation is on.
getBin(This) -> wx:wx_enum()
Types:
This = wxPrintData()
Returns the current bin (papersource).
By default, the system is left to select the bin (wxPRINT-
BIN_DEFAULT is returned).
See setBin/2 for the full list of bin values.
getColour(This) -> boolean()
Types:
This = wxPrintData()
Returns true if colour printing is on.
getDuplex(This) -> wx:wx_enum()
Types:
This = wxPrintData()
Returns the duplex mode.
One of wxDUPLEX_SIMPLEX, wxDUPLEX_HORIZONTAL, wxDUPLEX_VERTICAL.
getNoCopies(This) -> integer()
Types:
This = wxPrintData()
Returns the number of copies requested by the user.
getOrientation(This) -> wx:wx_enum()
Types:
This = wxPrintData()
Gets the orientation.
This can be wxLANDSCAPE or wxPORTRAIT.
getPaperId(This) -> wx:wx_enum()
Types:
This = wxPrintData()
Returns the paper size id.
See: setPaperId/2
getPrinterName(This) -> unicode:charlist()
Types:
This = wxPrintData()
Returns the printer name.
If the printer name is the empty string, it indicates that the
default printer should be used.
getQuality(This) -> integer()
Types:
This = wxPrintData()
Returns the current print quality.
This can be a positive integer, denoting the number of dots per
inch, or one of the following identifiers:
On input you should pass one of these identifiers, but on return
you may get back a positive integer indicating the current reso-
lution setting.
isOk(This) -> boolean()
Types:
This = wxPrintData()
Returns true if the print data is valid for using in print
dialogs.
This can return false on Windows if the current printer is not
set, for example. On all other platforms, it returns true.
setBin(This, Flag) -> ok
Types:
This = wxPrintData()
Flag = wx:wx_enum()
Sets the current bin.
setCollate(This, Flag) -> ok
Types:
This = wxPrintData()
Flag = boolean()
Sets collation to on or off.
setColour(This, Flag) -> ok
Types:
This = wxPrintData()
Flag = boolean()
Sets colour printing on or off.
setDuplex(This, Mode) -> ok
Types:
This = wxPrintData()
Mode = wx:wx_enum()
Returns the duplex mode.
One of wxDUPLEX_SIMPLEX, wxDUPLEX_HORIZONTAL, wxDUPLEX_VERTICAL.
setNoCopies(This, N) -> ok
Types:
This = wxPrintData()
N = integer()
Sets the default number of copies to be printed out.
setOrientation(This, Orientation) -> ok
Types:
This = wxPrintData()
Orientation = wx:wx_enum()
Sets the orientation.
This can be wxLANDSCAPE or wxPORTRAIT.
setPaperId(This, PaperId) -> ok
Types:
This = wxPrintData()
PaperId = wx:wx_enum()
Sets the paper id.
This indicates the type of paper to be used. For a mapping
between paper id, paper size and string name, see wxPrintPaper-
Database in "paper.h" (not yet documented).
See: SetPaperSize() (not implemented in wx)
setPrinterName(This, PrinterName) -> ok
Types:
This = wxPrintData()
PrinterName = unicode:chardata()
Sets the printer name.
This can be the empty string to indicate that the default
printer should be used.
setQuality(This, Quality) -> ok
Types:
This = wxPrintData()
Quality = integer()
Sets the desired print quality.
This can be a positive integer, denoting the number of dots per
inch, or one of the following identifiers:
On input you should pass one of these identifiers, but on return
you may get back a positive integer indicating the current reso-
lution setting.
wxWidgets team. wx 2.1.1 wxPrintData(3)