wxSizer(3)
💖 wxSizer — Erlang Module Definition 💖
okay bestie, welcome to wxSizer(3), we are SO back 💅
✨ NAME ✨
wxSizer — wxSizer is the abstract base class used for laying out subwindows in a window. yes that's the whole name section, she's a base class, she's abstract, she contains multitudes 🎀
🌸 DESCRIPTION 🌸
okay so first things first: you can NOT use wxSizer directly. like, at all. it's abstract, it's giving "concept, not content" energy. instead you use one of the sizer classes derived from it. currently there's wxBoxSizer, wxStaticBoxSizer, wxGridSizer, wxFlexGridSizer, wxWrapSizer (not implemented in wx — sad, ik) and wxGridBagSizer. pick your fighter ✨
The layout algorithm used by sizers in wxWidgets is closely related to layout in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit. and the way it works?? it's based upon the idea of the individual subwindows reporting their minimal required size and their ability to get stretched if the size of the parent window has changed. slay, self-reporting icons 🫶
This will most often mean that the programmer does not set the original size of a dialog in the beginning — rather the dialog will be assigned a sizer and this sizer will be queried about the recommended size. The sizer in turn will query its children, which can be normal windows, empty space or other sizers, so that a hierarchy of sizers can be constructed. it's giving russian nesting dolls but make it UI 💀 Note that wxSizer does not derive from wxWindow and thus does not interfere with tab ordering and requires very little resources compared to a real window on screen. lowkey efficient queen 👑
What makes sizers so well fitted for use in wxWidgets is the fact that every control reports its own minimal size and the algorithm can handle differences in font sizes or different window (dialog item) sizes on different platforms without problems. If e.g. the standard font as well as the overall design of Motif widgets requires more space than on Windows, the initial dialog size will automatically be bigger on Motif than on Windows. no cap, it just adapts 🌈
Sizers may also be used to control the layout of custom drawn items on the window. The add/4, insert/5, and prepend/4 functions return a pointer to the newly added wxSizerItem. Just add empty space of the desired size and attributes, and then use the wxSizerItem:getRect/1 method to determine where the drawing operations should take place. artsy bestie behavior fr 🎨
⚠️ PLEASE NOTICE, this one matters: sizers, like child windows, are owned by the library and will be deleted by it, which implies that they must be allocated on the heap. However if you create a sizer and do not add it to another sizer or window, the library wouldn't be able to delete such an orphan sizer and in this, and only this, case it should be deleted explicitly. don't leave orphan sizers just vibing in the heap bestie 😭
🎀 wxSizer flags 🎀
The "flag" argument accepted by wxSizerItem constructors and other functions, e.g. add/4, is an OR-combination of the following flags. Two main behaviours are defined using these flags. One is the border around a window: the border parameter determines the border width whereas the flags given here determine which side(s) of the item that the border will be added. The other flags determine how the sizer item behaves when the space allotted to the sizer changes, and is somewhat dependent on the specific kind of sizer used.
See: Overview sizer
wxWidgets docs: wxSizer
💜 DATA TYPES 💜
wxSizer() :: wx:wx_object().🔥 FUNCTIONS 🔥
💫 add(This, Width, Height) -> wxSizerItem:wxSizerItem()
add(This, Width, Height) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Width :: integer(),
Height :: integer();
(This, Window, Flags) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Window :: wxWindow:wxWindow() | wxSizer:wxSizer(),
Flags :: wxSizerFlags:wxSizerFlags();
(This, Window, [Option]) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Window :: wxWindow:wxWindow() | wxSizer:wxSizer(),
Option ::
{proportion, integer()} |
{flag, integer()} |
{border, integer()} |
{userData, wx:wx_object()}.Appends a child to the sizer. adding a little baby to the family 🍼
wxSizer itself is an abstract class, but the parameters are equivalent in the derived classes that you will instantiate to use it so they are described here:
💫 add(This, Width, Height, [Option]) -> wxSizerItem:wxSizerItem()
add(This, Width, Height, [Option]) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Width :: integer(),
Height :: integer(),
Option ::
{proportion, integer()} |
{flag, integer()} |
{border, integer()} |
{userData, wx:wx_object()};
(This, Width, Height, Flags) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Width :: integer(),
Height :: integer(),
Flags :: wxSizerFlags:wxSizerFlags().Appends a spacer child to the sizer. empty space but make it a family member 🌫️
💫 addSpacer(This, Size) -> wxSizerItem:wxSizerItem()
addSpacer(This, Size) -> wxSizerItem:wxSizerItem()
when This :: wxSizer(), Size :: integer().This base function adds non-stretchable space to both the horizontal and vertical orientation of the sizer. it's space that will NOT grow, okay? it knows its limits and respects them 💅
More readable way of calling:
See: addSpacer/2
💫 addStretchSpacer(This, [Option]) -> wxSizerItem:wxSizerItem()
addStretchSpacer(This, [Option]) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Option :: {prop, integer()}.Adds stretchable space to the sizer. this one WILL grow, she's ambitious ✨
More readable way of calling:
💫 calcMin(This) -> {W :: integer(), H :: integer()}
calcMin(This) -> {W :: integer(), H :: integer()}
when This :: wxSizer().This method is abstract and has to be overwritten by any derived class. (yes, overwritten, that's what it says, don't come for me 😭)
Here, the sizer will do the actual calculation of its children's minimal sizes. math queen 🧮
💫 clear(This, [Option]) -> ok
clear(This, [Option]) -> ok
when
This :: wxSizer(),
Option :: {delete_windows, boolean()}.Detaches all children from the sizer. everybody out, the party's over 🙈
If delete_windows is true then child windows will also be deleted.
Notice that child sizers are always deleted, as a general consequence of the principle that sizers own their sizer children, but don't own their window children (because they are already owned by their parent windows). the family tree is complicated, don't think about it too hard 🌳
💫 detach(This, Window) -> boolean()
detach(This, Window) -> boolean()
when
This :: wxSizer(),
Window :: wxWindow:wxWindow() | wxSizer:wxSizer();
(This, Index) -> boolean()
when This :: wxSizer(), Index :: integer().Detach a item at position index from the sizer without destroying it. no murder, just distance 🦋
This method does not cause any layout or resizing to take place, call layout/1 to update the layout "on screen" after detaching a child from the sizer. Returns true if the child item was found and detached, false otherwise.
See: remove/2
💫 fit(This, Window) -> {W :: integer(), H :: integer()}
fit(This, Window) -> {W :: integer(), H :: integer()}
when This :: wxSizer(), Window :: wxWindow:wxWindow().Tell the sizer to resize the window so that its client area matches the sizer's minimal size (ComputeFittingClientSize() (not implemented in wx) is called to determine it). get it?? the sizer is telling the window what to do, main character energy fr 👑
This is commonly done in the constructor of the window itself, see sample in the description of wxBoxSizer.
Return: The new window size.
💫 fitInside(This, Window) -> ok
fitInside(This, Window) -> ok
when This :: wxSizer(), Window :: wxWindow:wxWindow().Tell the sizer to resize the virtual size of the window to match the sizer's minimal size. virtual, not on-screen — important distinction bestie, don't get it twisted 🫶
This will not alter the on screen size of the window, but may cause the addition/removal/alteration of scrollbars required to view the virtual area in windows which manage it.
See:
wxScrolledWindow:setScrollbars/6setVirtualSizeHints/2
💫 getChildren(This) -> [wxSizerItem:wxSizerItem()]
getChildren(This) -> [wxSizerItem:wxSizerItem()]
when This :: wxSizer().💫 getItem(This, Window) -> wxSizerItem:wxSizerItem()
getItem(This, Window) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Window :: wxWindow:wxWindow() | wxSizer:wxSizer();
(This, Index) -> wxSizerItem:wxSizerItem()
when This :: wxSizer(), Index :: integer().Finds wxSizerItem which is located in the sizer at position index. ✨
Use parameter recursive to search in subsizers too. Returns pointer to item or NULL.
💫 getItem(This, Window, [Option]) -> wxSizerItem:wxSizerItem()
getItem(This, Window, [Option]) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Window :: wxWindow:wxWindow() | wxSizer:wxSizer(),
Option :: {recursive, boolean()}.Finds wxSizerItem which holds the given window. 🔍
Use parameter recursive to search in subsizers too. Returns pointer to item or NULL.
💫 getMinSize(This) -> {W :: integer(), H :: integer()}
getMinSize(This) -> {W :: integer(), H :: integer()}
when This :: wxSizer().Returns the minimal size of the sizer. tiny but mighty 🧚
This is either the combined minimal size of all the children and their borders or the minimal size set by setMinSize/3, depending on which is bigger. Note that the returned value is client size, not window size. In particular, if you use the value to set toplevel window's minimal or actual size, use wxWindow::SetMinClientSize() (not implemented in wx) or wxWindow:setClientSize/3, not wxWindow:setMinSize/2 or wxWindow:setSize/6. no cap, that distinction is load-bearing 🚨
💫 getPosition(This) -> {X :: integer(), Y :: integer()}
getPosition(This) -> {X :: integer(), Y :: integer()}
when This :: wxSizer().Returns the current position of the sizer. where she at 📍
💫 getSize(This) -> {W :: integer(), H :: integer()}
getSize(This) -> {W :: integer(), H :: integer()}
when This :: wxSizer().Returns the current size of the sizer. how big is she 📏
💫 hide(This, Window) -> boolean()
hide(This, Window) -> boolean()
when
This :: wxSizer(),
Window :: wxWindow:wxWindow() | wxSizer:wxSizer();
(This, Index) -> boolean()
when This :: wxSizer(), Index :: integer().Hides the item at position index. peekaboo but the opposite 🙈
To make a sizer item disappear, use hide/3 followed by layout/1.
Use parameter recursive to hide elements found in subsizers. Returns true if the child item was found, false otherwise.
See:
isShown/2show/3
💫 hide(This, Window, [Option]) -> boolean()
hide(This, Window, [Option]) -> boolean()
when
This :: wxSizer(),
Window :: wxWindow:wxWindow() | wxSizer:wxSizer(),
Option :: {recursive, boolean()}.Hides the child window. that's it, that's the whole sentence, she's brief and she knows it 💜
and that's part 1 bestie!! more incoming, don't go anywhere 🦋💖
To make a sizer item disappear, you hit hide/3 and then layout/1. both steps, bestie, the layout one is not optional 💅
Pass the recursive parameter if you want to hide elements chillin' inside subsizers too. It returns true if the child item was found, and false if it wasn't (rip).
See also:
isShown/2show/3
insert 🌸
insert(This, Index, Item) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Index :: integer(),
Item :: wxSizerItem:wxSizerItem().Then there's the whole posse of other shapes:
insert(This, Index, Width, Height) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Index :: integer(),
Width :: integer(),
Height :: integer();
(This, Index, Window, Flags) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Index :: integer(),
Window :: wxWindow:wxWindow() | wxSizer:wxSizer(),
Flags :: wxSizerFlags:wxSizerFlags();
(This, Index, Window, [Option]) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Index :: integer(),
Window :: wxWindow:wxWindow() | wxSizer:wxSizer(),
Option ::
{proportion, integer()} |
{flag, integer()} |
{border, integer()} |
{userData, wx:wx_object()}.So the vibe here: it inserts a child into the sizer before any existing item at index. Line-cut energy, but make it a sizer.
And for what all those other parameters even mean? Slip over to add/4, it explains everything, no gatekeeping 🫶
insert (the width + height edition) ✨
insert(This, Index, Width, Height, [Option]) ->
wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Index :: integer(),
Width :: integer(),
Height :: integer(),
Option ::
{proportion, integer()} |
{flag, integer()} |
{border, integer()} |
{userData, wx:wx_object()};
(This, Index, Width, Height, Flags) ->
wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Index :: integer(),
Width :: integer(),
Height :: integer(),
Flags :: wxSizerFlags:wxSizerFlags().Same deal, same words: it inserts a child into the sizer before any existing item at index, and the meaning of the other parameters lives in add/4. Periodt.
The [Option] choices, for the record:
{proportion, integer()}{flag, integer()}{border, integer()}{userData, wx:wx_object()}
insertSpacer 🎀
insertSpacer(This, Index, Size) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Index :: integer(),
Size :: integer().Inserts non-stretchable space into the sizer. It is, and I quote the concept, just a more readable way of calling wxSizer::Insert(index, size, size). Glow-up through naming, honestly 👑
insertStretchSpacer 🦋
insertStretchSpacer(This, Index, [Option]) ->
wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Index :: integer(),
Option :: {prop, integer()}.Inserts stretchable space into the sizer — the flexible kind, the one that actually grows. Also a more readable way of calling wxSizer::Insert(0, 0, prop).
Option list:
{prop, integer()}
isShown 😭
isShown(This, Window) -> boolean()
when
This :: wxSizer(),
Window :: wxWindow:wxWindow() | wxSizer:wxSizer();
(This, Index) -> boolean()
when This :: wxSizer(), Index :: integer().Returns true if the item at index is shown. That's it. That's the whole function. iconic.
See also:
hide/3show/3wxSizerItem:isShown/1
layout 💖
layout(This) -> ok when This :: wxSizer().Call this when you need to force the layout of the children anew — say, right after you added a child to the sizer, or removed one (window, other sizer, or just space) from it, while keeping the current dimension. Basically: nothing moves until you tell it to move. shake it into place bestie.
prepend 🌈
prepend(This, Item) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Item :: wxSizerItem:wxSizerItem().prepend(This, Width, Height) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Width :: integer(),
Height :: integer();
(This, Window, Flags) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Window :: wxWindow:wxWindow() | wxSizer:wxSizer(),
Flags :: wxSizerFlags:wxSizerFlags();
(This, Window, [Option]) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Window :: wxWindow:wxWindow() | wxSizer:wxSizer(),
Option ::
{proportion, integer()} |
{flag, integer()} |
{border, integer()} |
{userData, wx:wx_object()}.Literally the same as add/4, except it prepends the items to the beginning of the list of items (windows, subsizers or spaces) owned by this sizer. Front of the line behavior, main character placement, no waiting 💅
The [Option] values, same little family:
{proportion, integer()}{flag, integer()}{border, integer()}{userData, wx:wx_object()}
prepend (width + height, with the extras) 🍓
prepend(This, Width, Height, [Option]) ->
wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Width :: integer(),
Height :: integer(),
Option ::
{proportion, integer()} |
{flag, integer()} |
{border, integer()} |
{userData, wx:wx_object()};
(This, Width, Height, Flags) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Width :: integer(),
Height :: integer(),
Flags :: wxSizerFlags:wxSizerFlags().Yeah — same as add/4, but prepends the items to the beginning of the list of items (windows, subsizers or spaces) owned by this sizer. I said what I said.
prependSpacer 🧚
prependSpacer(This, Size) -> wxSizerItem:wxSizerItem()
when This :: wxSizer(), Size :: integer().Prepends non-stretchable space to the sizer. And again, it's just a more readable way of calling wxSizer::Prepend(size, size, 0). Sparkle on ✨
prependStretchSpacer 🌸
prependStretchSpacer(This, [Option]) -> wxSizerItem:wxSizerItem()
when
This :: wxSizer(),
Option :: {prop, integer()}.Prepends stretchable space to the sizer. A more readable way of calling wxSizer::Prepend(0, 0, prop).
Options:
{prop, integer()}
recalcSizes 💀
recalcSizes(This) -> ok when This :: wxSizer().Equivalent to: layout/1. That's the entire description, no notes, we move.
remove 🙈
remove(This, Index) -> boolean()
when This :: wxSizer(), Index :: integer();
(This, Sizer) -> boolean()
when This :: wxSizer(), Sizer :: wxSizer().Removes a sizer child from the sizer and destroys it. gone, deleted, no trace.
⚠️ Heads up bestie: this method does not cause any layout or resizing to take place. Call layout/1 to update the layout "on screen" after removing a child from the sizer, or nothing visibly changes and you'll be staring at your screen like 😭
Return: true if the child item was found and removed, false otherwise.
replace 🦋
replace(This, Oldwin, Newwin) -> boolean()
when
This :: wxSizer(),
Oldwin :: wxWindow:wxWindow() | wxSizer:wxSizer(),
Newwin :: wxWindow:wxWindow() | wxSizer:wxSizer();
(This, Index, Newitem) -> boolean()
when
This :: wxSizer(),
Index :: integer(),
Newitem :: wxSizerItem:wxSizerItem().Detaches the given item at position index from the sizer and replaces it with the given wxSizerItem newitem. Out with the old, in with the new, but make it sizer-coded.
The detached child gets deleted only if it is a sizer or a spacer — not if it is a wxWindow, because windows are owned by their parent window, not the sizer. Let the parent handle its own kids, not your business 🫶
⚠️ And again: this method does not cause any layout or resizing to take place. Call layout/1 to update the layout "on screen" after replacing a child from the sizer. fr fr.
Returns true if the child item was found and removed, false otherwise.
replace(This, Oldwin, Newwin, [Option]) -> boolean()
when
This :: wxSizer(),
Oldwin :: wxWindow:wxWindow() | wxSizer:wxSizer(),
Newwin :: wxWindow:wxWindow() | wxSizer:wxSizer(),
Option :: {recursive, boolean()}.Detaches the given oldwin from the sizer and replaces it with the given newwin.
The detached child window is not deleted (because windows are owned by their parent window, not the sizer). Say it with me one more time for the people in the back.
Use the parameter recursive to search the given element recursively in subsizers — digging through the subsizer stack, lowkey detective work 🔍
⚠️ Same warning, same drama: no layout or resizing happens here. Call layout/1 to update the layout "on screen" after replacing a child from the sizer.
Returns true if the child item was found and removed, false otherwise.
The option:
{recursive, boolean()}
setDimension ⭐
setDimension(This, Pos, Size) -> ok
when
This :: wxSizer(),
Pos :: {X :: integer(), Y :: integer()},
Size :: {W :: integer(), H :: integer()}.This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. convenient queen 👑
setDimension (the five-arg one) 🌟
setDimension(This, X, Y, Width, Height) -> ok
when
This :: wxSizer(),
X :: integer(),
Y :: integer(),
Width :: integer(),
Height :: integer().Call this to force the sizer to take the given dimension, and therefore force the items owned by the sizer to resize themselves according to the rules defined by the parameters in the add/4 and prepend/4 methods. It's giving absolute control. It's giving authority. Slay 💅
setItemMinSize overloads — the receipts 🧾✨
setItemMinSize(This, Window, Size) -> boolean()
when
This :: wxSizer(),
Window ::
wxWindow:wxWindow() | wxSizer:wxSizer(),
Size :: {W :: integer(), H :: integer()};
(This, Index, Size) -> boolean()
when
This :: wxSizer(),
Index :: integer(),
Size :: {W :: integer(), H :: integer()}.
setItemMinSize(This, Window, Width, Height) -> boolean()
when
This :: wxSizer(),
Window ::
wxWindow:wxWindow() | wxSizer:wxSizer(),
Width :: integer(),
Height :: integer();
(This, Index, Width, Height) -> boolean()
when
This :: wxSizer(),
Index :: integer(),
Width :: integer(),
Height :: integer().bestie, these are just the overloaded signatures — the manual gives no extra prose here, so we're not inventing any. periodt. 💅
setMinSize — hand it a minimum size 💖
setMinSize(This, Size) -> ok
when
This :: wxSizer(),
Size :: {W :: integer(), H :: integer()}.okay so call this to give the sizer a minimal size. Normally, the sizer will calculate its minimal size based purely on how much space its children need. After calling this method, getMinSize/1 will return either the minimal size as requested by its children or the minimal size set here, depending on which is bigger. lowkey iconic 👑
setMinSize overload — width and height edition 🎀
setMinSize(This, Width, Height) -> ok
when
This :: wxSizer(),
Width :: integer(),
Height :: integer().This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. So same energy, just different params. ✨
setSizeHints — fit first, then hint 👑
setSizeHints(This, Window) -> ok
when
This :: wxSizer(),
Window :: wxWindow:wxWindow().This method first calls fit/2 and then setSizeHints/2 on the window passed to it.
This only makes sense when window is actually a wxTopLevelWindow such as a wxFrame or a wxDialog, since SetSizeHints only has any effect in these classes. It does nothing in normal windows or controls. no cap, it literally does nothing there 💀
This method is implicitly used by wxWindow:setSizerAndFit/3 which is commonly invoked in the constructor of a toplevel window itself (see the sample in the description of wxBoxSizer) if the toplevel window is resizable. iykyk 🦋
setVirtualSizeHints — equivalent to fitInside/2 🌈
setVirtualSizeHints(This, Window) -> ok
when
This :: wxSizer(),
Window :: wxWindow:wxWindow().Equivalent to: fitInside/2
show — show/hide an item or everything 🌸
show(This, Window) -> boolean()
when
This :: wxSizer(),
Window :: wxWindow:wxWindow() | wxSizer:wxSizer();
(This, Index) -> boolean()
when This :: wxSizer(), Index :: integer();
(This, Show) -> ok when This :: wxSizer(), Show :: boolean().
show(This, Window, [Option]) -> boolean()
when
This :: wxSizer(),
Window :: wxWindow:wxWindow() | wxSizer:wxSizer(),
Option :: {show, boolean()} | {recursive, boolean()};
(This, Index, [Option]) -> boolean()
when
This :: wxSizer(),
Index :: integer(),
Option :: {show, boolean()}.Shows the item at index. the way that this just works 💅
To make a sizer item disappear or reappear, use show/3 followed by layout/1.
Returns true if the child item was found, false otherwise.
See:
hide/3isShown/2
showItems — show or hide all items 🔥
showItems(This, Show) -> ok
when This :: wxSizer(), Show :: boolean().Show or hide all items managed by the sizer. all of them, bestie 🫶
shoutout to Ericsson AB for this wx 2.6 manual page, and it's wxSizer(3) — the date isn't in the footer, so we're not making one up. catch you in the next man page, bestie! 💖✨🎀
📦 where this page comes from
- ubuntu stonking: erlang-doc 1:29.0.6+dfsg-1 · Apache-2.0
- 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms