wxPreviewFrame(3)

💅 wxPreviewFrame — the Erlang module, bestie

okay so this is wxPreviewFrame(3) from the Erlang Module Definition section of the wx docs, and it's literally the class that handles your print preview interface for you. no cap.

---

✨ NAME ✨

wxPreviewFrame — this class provides the default method of managing the print preview interface. it's giving "i got you, you don't have to build this from scratch." 🎀

---

🌸 DESCRIPTION 🌸

okay so the vibe here is: member functions may be overridden to replace functionality, or the class may be used without derivation. your choice, bestie, both are valid. 💖

See also, because these are the girlies it hangs out with:

• wxPreviewCanvas
• wxPreviewControlBar
• wxPrintPreview

This class is derived, and can use functions, from (her ancestry is iconic, periodt):

• wxFrame
• wxTopLevelWindow
• wxWindow
• wxEvtHandler

also, heads up: the wxWidgets docs for this are at wxPreviewFrame. 🦋

---

🧚 DATA TYPES 🧚

• wxPreviewFrame() :: wx:wx_object().

like, that's the whole type. she's an object. slay.

---

🔥 FUNCTIONS 🔥

createCanvas/1

createCanvas(This) -> ok when This :: wxPreviewFrame().

Creates a wxPreviewCanvas. ✨

Override this function if you want a user-defined preview canvas object to be created instead. yes ma'am, you can absolutely customize this. 💅

createControlBar/1

createControlBar(This) -> ok when This :: wxPreviewFrame().

Creates a wxPreviewControlBar. 💖

Same deal, lowkey: override this function to allow a user-defined preview control bar object to be created. go off, you control the bar now. 👑

destroy/1

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

Destroys the object. rip bestie 😭💀 but like, respectfully, she's done.

initialize/1

initialize(This) -> ok when This :: wxPreviewFrame().

Initializes the frame elements and prepares for showing it. getting her ready for her main character moment. 🌈

Calling this method is equivalent to calling InitializeWithModality() (not implemented in wx, so don't go looking for it) with the wxPreviewFrame_AppModal argument — please see its documentation for more details. iykyk. 💜

Please notice that this function is virtual mostly for backwards compatibility only, there is no real need to override it as it's never called by wxWidgets itself. fr fr, don't waste your time overriding this one, it's just there for the old times. no real need!

new/3

new(Preview, Parent, [Option]) -> wxPreviewFrame()
                    when
                        Preview :: wxPrintPreview:wxPrintPreview(),
                        Parent :: wxWindow:wxWindow(),
                        Option ::
                            {title, unicode:chardata()} |
                            {pos, {X :: integer(), Y :: integer()}} |
                            {size, {W :: integer(), H :: integer()}} |
                            {style, integer()}.

Constructor. 🎀

Pass a print preview object plus other normal frame arguments.

⚠️ heads up: the print preview object will be destroyed by the frame when it closes. she does not let go, bestie. it's hers now. 💀

onCloseWindow/2

onCloseWindow(This, Event) -> ok
                              when
                                  This :: wxPreviewFrame(),
                                  Event :: wxCloseEvent:wxCloseEvent().

Enables any disabled frames in the application, and deletes the print preview object — which implicitly deletes any printout objects associated with the print preview object. so like, one close and everything in that little print world gets cleaned up. iconic behaviour, honestly. 🫶

---

and that's the whole page, bestie! no notes, ate and left no crumbs. 💅

this whole thing comes to you from Ericsson AB, wx 2.6, and the page is wxPreviewFrame(3). mwah, see you next manpage. 💖✨🎀🦋🌸🫶😭🔥👑🌈⭐💀🙈🍓🧚💜