wxPrintDialogData(3)

NAME
wxPrintDialogData - This class holds information related to the visual characteristics of wxPrintDialog.

DESCRIPTION

It contains a wxPrintData object with underlying printing settings.

See:

    • Overview printing

    • wxPrintDialog

    • Overview cmndlg

wxWidgets docs: wxPrintDialogData

DATA TYPES

wxPrintDialogData() :: wx:wx_object().

FUNCTIONS

destroy(This :: wxPrintDialogData()) -> ok.

    Destroys the object
enableHelp(This, Flag) -> ok when This :: wxPrintDialogData(), Flag :: boolean().

    Enables or disables the "Help" button.
enablePageNumbers(This, Flag) -> ok when This :: wxPrintDialogData(), Flag :: boolean().

    Enables or disables the "Page numbers" controls.
enablePrintToFile(This, Flag) -> ok when This :: wxPrintDialogData(), Flag :: boolean().

    Enables or disables the "Print to file" checkbox.
enableSelection(This, Flag) -> ok when This :: wxPrintDialogData(), Flag :: boolean().

    Enables or disables the "Selection" radio button.
getAllPages(This) -> boolean() when This :: wxPrintDialogData().

    Returns true if the user requested that all pages be printed.
getCollate(This) -> boolean() when This :: wxPrintDialogData().

    Returns true if the user requested that the document(s) be collated.
getFromPage(This) -> integer() when This :: wxPrintDialogData().

    Returns the from page number, as entered by the user.
getMaxPage(This) -> integer() when This :: wxPrintDialogData().

    Returns the maximum page number.
getMinPage(This) -> integer() when This :: wxPrintDialogData().

    Returns the minimum page number.
getNoCopies(This) -> integer() when This :: wxPrintDialogData().

    Returns the number of copies requested by the user.
getPrintData(This) -> wxPrintData:wxPrintData() when This :: wxPrintDialogData().

    Returns a reference to the internal wxPrintData object.
getPrintToFile(This) -> boolean() when This :: wxPrintDialogData().

    Returns true if the user has selected printing to a file.
getSelection(This) -> boolean() when This :: wxPrintDialogData().

    Returns true if the user requested that the selection be printed (where "selection" is a concept specific to the application).
getToPage(This) -> integer() when This :: wxPrintDialogData().

    Returns the "print to" page number, as entered by the user.
isOk(This) -> boolean() when This :: wxPrintDialogData().

    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.
new() -> wxPrintDialogData().

    Default constructor.
new(DialogData) -> wxPrintDialogData() when DialogData :: wxPrintDialogData:wxPrintDialogData() | wxPrintData:wxPrintData().

    Copy constructor.
setCollate(This, Flag) -> ok when This :: wxPrintDialogData(), Flag :: boolean().

    Sets the "Collate" checkbox to true or false.
setFromPage(This, Page) -> ok when This :: wxPrintDialogData(), Page :: integer().

    Sets the from page number.
setMaxPage(This, Page) -> ok when This :: wxPrintDialogData(), Page :: integer().

    Sets the maximum page number.
setMinPage(This, Page) -> ok when This :: wxPrintDialogData(), Page :: integer().

    Sets the minimum page number.
setNoCopies(This, N) -> ok when This :: wxPrintDialogData(), N :: integer().

    Sets the default number of copies the user has requested to be printed out.
setPrintData(This, PrintData) -> ok when This :: wxPrintDialogData(), PrintData :: wxPrintData:wxPrintData().

    Sets the internal wxPrintData.
setPrintToFile(This, Flag) -> ok when This :: wxPrintDialogData(), Flag :: boolean().

    Sets the "Print to file" checkbox to true or false.
setSelection(This, Flag) -> ok when This :: wxPrintDialogData(), Flag :: boolean().

    Selects the "Selection" radio button.

    The effect of printing the selection depends on how the application implements this command, if at all.
setToPage(This, Page) -> ok when This :: wxPrintDialogData(), Page :: integer().

    Sets the "print to" page number.