wxMDIClientWindow(3erl)

💅 wxMDIClientWindow 💅

okay bestie, welcome to the wxMDIClientWindow page — the Erlang module definition for the wxMDIClientWindow class. yes, it's an Erlang module doc, and yes, you're gonna get it. sit down, hydrate, let's go 🫶

---

✨ NAME ✨

wxMDIClientWindow — literally just the functions for the wxMDIClientWindow class. that's the whole vibe. 🎀

---

🌸 DESCRIPTION 🌸

okay so picture this: an MDI client window is a child of wxMDIParentFrame, and it manages zero or more wxMDIChildFrame objects. like a very organized babysitter for windows. 👑

the client window is the area where MDI child windows exist. it doesn't have to cover the whole parent frame — ngl, other windows such as toolbars and a help window might coexist with it. there can be scrollbars on a client window, and those are controlled by the parent window style. iykyk. ✨

the wxMDIClientWindow class is usually adequate without further derivation, and honestly? it gets created automatically when the MDI parent frame is created. no cap. but if your application needs to derive a new class, the function wxMDIParentFrame::OnCreateClient() (not implemented in wx — important!!) must be overridden in order to give an opportunity to use a different class of client window.

under wxMSW, the client window will automatically have a sunken border style when the active child is not maximized, and no border style when a child is maximized. it's giving adaptive. 🌈

See: wxMDIChildFrame, wxMDIParentFrame, wxFrame

this class is derived (and can use functions) from: wxWindow wxEvtHandler — so it's got main character energy and an inheritance tree. 💅

wxWidgets docs: wxMDIClientWindow

---

🦋 DATA TYPES 🦋

• wxMDIClientWindow() = wx:wx_object() — yep, that's the type. it's an object. slay.

---

🔥 EXPORTS 🔥

⭐ new() -> wxMDIClientWindow()

the default constructor, bestie.

heads up: objects of this class are only created by wxMDIParentFrame, which uses the default constructor and calls createClient/3 immediately afterwards. so like... you don't really call this yourself. it's not me being gatekeepy, that's just the rules. 🙈

⭐ createClient(This, Parent) -> boolean()

Types:

This = wxMDIClientWindow()
Parent = wxMDIParentFrame:wxMDIParentFrame()

⭐ createClient(This, Parent, Options :: [Option]) -> boolean()

Types:

This = wxMDIClientWindow()
Parent = wxMDIParentFrame:wxMDIParentFrame()
Option = {style, integer()}

called by wxMDIParentFrame immediately after creating the client window. like, immediately immediately. 🔥

this function may be overridden in the derived class — but the base class version must usually be called first to actually create the window. fr fr, don't skip the base call, that's the whole point. 😭

⭐ destroy(This :: wxMDIClientWindow()) -> ok

destroys the object. bye bestie 💀👋 returns ok, because of course it does.

---

⚠️ quick vibe check: wxMDIParentFrame::OnCreateClient() is not implemented in wx — the docs say so, and i'm not about to start lying to you. 🫶

---

okay that's the whole page!! written by the wxWidgets team, version wx 2.2.2.1, and it's the wxMDIClientWindow(3erl) man page — mwah, go build something iconic 💖✨🎀