wxPrintDialogData(3)

💖 wxPrintDialogData 💖

okay bestie, so this is a manual page for the Erlang module wxPrintDialogData — yep, module definition energy, section 3, the whole thing. sit down, grab a lil snack, we're gonna get into it 🍓

---

🌸 NAME 🌸

wxPrintDialogData — literally the class that holds all the info about the visual characteristics of wxPrintDialog. it's the vibes-holder for your print dialog, no cap.

---

✨ DESCRIPTION ✨

so basically: it contains a wxPrintData object with the underlying printing settings. that's the whole situation. 💅

See also, bestie:

• Overview printing
• wxPrintDialog
• Overview cmndlg

wxWidgets docs: wxPrintDialogData

---

🦋 DATA TYPES 🦋

• wxPrintDialogData() :: wx:wx_object().

---

🎀 FUNCTIONS 🎀

destroy/1

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

Destroys the object. bye bestie 👋

enableHelp/2

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

Enables or disables the "Help" button. the lil question-mark bestie.

enablePageNumbers/2

enablePageNumbers(This, Flag) -> ok
    when This :: wxPrintDialogData(), Flag :: boolean().

Enables or disables the "Page numbers" controls.

enablePrintToFile/2

enablePrintToFile(This, Flag) -> ok
    when This :: wxPrintDialogData(), Flag :: boolean().

Enables or disables the "Print to file" checkbox.

enableSelection/2

enableSelection(This, Flag) -> ok
    when This :: wxPrintDialogData(), Flag :: boolean().

Enables or disables the "Selection" radio button.

getAllPages/1

getAllPages(This) -> boolean() when This :: wxPrintDialogData().

Returns true if the user requested that all pages be printed. iconique.

getCollate/1

getCollate(This) -> boolean() when This :: wxPrintDialogData().

Returns true if the user requested that the document(s) be collated.

getFromPage/1

getFromPage(This) -> integer() when This :: wxPrintDialogData().

Returns the from page number, as entered by the user.

getMaxPage/1

getMaxPage(This) -> integer() when This :: wxPrintDialogData().

Returns the maximum page number.

getMinPage/1

getMinPage(This) -> integer() when This :: wxPrintDialogData().

Returns the minimum page number.

getNoCopies/1

getNoCopies(This) -> integer() when This :: wxPrintDialogData().

Returns the number of copies requested by the user. yes queen, print it 47 times.

getPrintData/1

getPrintData(This) -> wxPrintData:wxPrintData()
    when This :: wxPrintDialogData().

Returns a reference to the internal wxPrintData object.

getPrintToFile/1

getPrintToFile(This) -> boolean() when This :: wxPrintDialogData().

Returns true if the user has selected printing to a file.

getSelection/1

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, so like, that's on your app to define, iykyk.

getToPage/1

getToPage(This) -> integer() when This :: wxPrintDialogData().

Returns the "print to" page number, as entered by the user.

isOk/1

isOk(This) -> boolean() when This :: wxPrintDialogData().

Returns true if the print data is valid for using in print dialogs.

heads up bestie: this can return false on Windows if the current printer is not set, for example. on all other platforms, it returns true. so don't panic if it's giving false on Windows — that's just the printer situation.

new/0

new() -> wxPrintDialogData().

Default constructor. the classic no-args entrance. 💅

new/1

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

Copy constructor. it copies. that's the vibe.

setCollate/2

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

Sets the "Collate" checkbox to true or false.

setFromPage/2

setFromPage(This, Page) -> ok
    when This :: wxPrintDialogData(), Page :: integer().

Sets the from page number.

setMaxPage/2

setMaxPage(This, Page) -> ok
    when This :: wxPrintDialogData(), Page :: integer().

Sets the maximum page number.

setMinPage/2

setMinPage(This, Page) -> ok
    when This :: wxPrintDialogData(), Page :: integer().

Sets the minimum page number.

setNoCopies/2

setNoCopies(This, N) -> ok
    when This :: wxPrintDialogData(), N :: integer().

Sets the default number of copies the user has requested to be printed out.

setPrintData/2

setPrintData(This, PrintData) -> ok
    when
        This :: wxPrintDialogData(),
        PrintData :: wxPrintData:wxPrintData().

Sets the internal wxPrintData.

setPrintToFile/2

setPrintToFile(This, Flag) -> ok
    when
        This :: wxPrintDialogData(),
        Flag :: boolean().

Sets the "Print to file" checkbox to true or false.

setSelection/2

setSelection(This, Flag) -> ok
    when
        This :: wxPrintDialogData(), Flag :: boolean().

Selects the "Selection" radio button.

fr fr: the effect of printing the selection depends on how the application implements this command — if it does at all. so like, don't assume it does a thing. 👀

setToPage/2

setToPage(This, Page) -> ok
    when This :: wxPrintDialogData(), Page :: integer().

Sets the "print to" page number.

---

and that's the whole page bestie, we ate that up 👑✨ this lil slice of documentation comes from Ericsson AB, for wx 2.6, and it's the wxPrintDialogData(3) page — periodt 💖🦋