wxPanel(3erl)

okay so bestie 💖 this is wxPanel(3erl), the Erlang Module Definition page, and we're folding the manual-name header in right here like a cute little name tag. It's all about wxPanel, no cap.

🌸 NAME 🌸

wxPanel - Functions for wxPanel class

💅 DESCRIPTION 💅

A panel is literally a window on which controls are placed. It's usually placed within a frame. Its main feature over its parent class wxWindow is code for handling child windows and TAB traversal, which is implemented natively if possible (e.g. in wxGTK) or by wxWidgets itself otherwise. Slay.

Note: Tab traversal is implemented through an otherwise undocumented intermediate wxControlContainer class from which any class can derive in addition to the normal wxWindow base class. Please see and to find out how this is achieved.

Note: if not all characters are being intercepted by your OnKeyDown or OnChar handler, it may be because you are using the wxTAB_TRAVERSAL style, which grabs some keypresses for use by child controls.

Remark: By default, a panel has the same colouring as a dialog.

See: wxDialog

This class is derived (and can use functions) from:

• wxWindow
• wxEvtHandler

wxWidgets docs: wxPanel

🔥 EVENTS 🔥

Event types emitted from this class: navigation_key

🎀 DATA TYPES 🎀

wxPanel() = wx:wx_object()

👑 EXPORTS 👑

✨ new()

new() -> wxPanel()

Default constructor. The no-args classic, bestie.

💖 new(Parent)

new(Parent) -> wxPanel()

Types:

Parent = wxWindow:wxWindow()

🌟 new(Parent, Options :: [Option])

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

Types:

Parent = wxWindow:wxWindow()
Option =
    {winid, integer()} |
    {pos, {X :: integer(), Y :: integer()}} |
    {size, {W :: integer(), H :: integer()}} |
    {style, integer()}

Constructor.

The Option values are exactly these, periodt:

• {winid, integer()}
• {pos, {X :: integer(), Y :: integer()}}
• {size, {W :: integer(), H :: integer()}}
• {style, integer()}

See: Create() (not implemented in wx)

💀 destroy(This :: wxPanel())

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

Destructor.

Deletes any child windows before deleting the physical window. Heads up, bestie — child windows get deleted first, that's the whole vibe.

🦋 initDialog(This)

initDialog(This) -> ok

Types:

This = wxPanel()

Sends a wxInitDialogEvent, which in turn transfers data to the dialog via validators.

See: wxInitDialogEvent

🌈 setFocusIgnoringChildren(This)

setFocusIgnoringChildren(This) -> ok

Types:

This = wxPanel()

In contrast to wxWindow:setFocus/1 (see above) this will set the focus to the panel even if there are child windows in the panel.

This is only rarely needed.

Sign-off from the wxWidgets team 🫶 — page wxPanel(3erl), version wx 2.2.2.1.