wxPageSetupDialog(3erl)

πŸŽ€ NAME πŸŽ€

hii bestie πŸ’– welcome to wxPageSetupDialog(3erl), straight outta the Erlang Module Definition corner of the manual. This page is all about wxPageSetupDialog β€” literally functions for the wxPageSetupDialog class. slay. ✨


✨ DESCRIPTION ✨

okay so this class represents the page setup common dialog. main character energy fr fr. πŸ’…

The page setup dialog contains controls for paper size (letter, A4, A5 etc.), orientation (landscape or portrait), and β€” only under Windows currently β€” controls for setting left, top, right and bottom margin sizes in millimetres. not me knowing all the margin vibes 😭

The exact appearance of this dialog varies among the platforms as a native dialog is used when available (currently the case for all major platforms). it's giving β€œplatform-dependent glow-up,” and honestly? iconic. 🌈

When the dialog has been closed, you need to query the wxPageSetupDialogData object associated with the dialog. don't forget, bestie β€” that's the whole post-dialog vibe check. πŸ¦‹

⚠️ Note that the OK and Cancel buttons do not destroy the dialog; this must be done by the application. like, the dialog does NOT clean itself up. you gotta do it. no cap.

See: πŸ‘€

  • Overview printing
  • wxPrintDialog
  • wxPageSetupDialogData
  • wxWidgets docs: wxPageSetupDialog

🧚 DATA TYPES 🧚

  • wxPageSetupDialog() = wx:wx_object() β€” yup, that's the whole type, and it's giving object-type realness. πŸ’œ

πŸ”₯ EXPORTS πŸ”₯

new(Parent) -> wxPageSetupDialog()

Types:

Parent = wxWindow:wxWindow()

this is the new/1 export, bestie. parent window goes in, wxPageSetupDialog() comes out. simple as that. ✨

new(Parent, Options :: [Option]) -> wxPageSetupDialog()

Types:

Parent = wxWindow:wxWindow()
Option = {data, wxPageSetupDialogData:wxPageSetupDialogData()}

Constructor. πŸŽ€

Pass a parent window, and optionally a pointer to a block of page setup data, which will be copied to the print dialog's internal data. yes, copied β€” the internal data is getting its own little copy, iykyk. 🫢

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

Destructor. bye bestie πŸ‘‹πŸ’€

getPageSetupData(This) -> wxPageSetupDialogData:wxPageSetupDialogData()

Types:

This = wxPageSetupDialog()

Returns the wxPageSetupDialogData object associated with the dialog. it's literally the data object handoff moment. 🎁

showModal(This) -> integer()

Types:

This = wxPageSetupDialog()

Shows the dialog, returning wxID_OK if the user pressed OK, and wxID_CANCEL otherwise. that's the whole β€œdid they press OK or Cancel?” tea. β˜•βœ¨


mwah πŸ’‹ that's the page! cute little sign-off from the wxWidgets team, with version wx 2.2.2.1, and the footer stamp wxPageSetupDialog(3erl) β€” source/version/date-corner vibes, all wrapped up with a bow. πŸŽ€πŸ«ΆπŸ’–

πŸ“¦ where this page comes from