wxGridBagSizer(3)
✨ NAME ✨
okay so bestie, welcome to wxGridBagSizer(3), the Erlang module definition 💖
wxGridBagSizer — it's a wxSizer that can lay out items in a virtual grid, kinda like a wxFlexGridSizer, except here you get explicit positioning of the items using wxGBPosition (which, heads up, is not implemented in wx 🙈), and items can optionally span more than one row and/or column using wxGBSpan (also not implemented in wx 😭).
🦋 DESCRIPTION 🦋
This class is derived from — so it can use all the functions of — these lil guys:
wxFlexGridSizerwxGridSizerwxSizer
wxWidgets docs: wxGridBagSizer — that's where the source of truth lives, iykyk 🫶
🎀 DATA TYPES 🎀
wxGridBagSizer()::wx:wx_object().
💅 FUNCTIONS 💅
add
add(This, Item) -> wxSizerItem:wxSizerItem()
when
This :: wxGridBagSizer(),
Item :: wxGBSizerItem:wxGBSizerItem().
add(This, Width, Height, Pos) -> wxSizerItem:wxSizerItem()
when
This :: wxGridBagSizer(),
Width :: integer(),
Height :: integer(),
Pos :: {R :: integer(), C :: integer()};
(This, Window, Pos, [Option]) -> wxSizerItem:wxSizerItem()
when
This :: wxGridBagSizer(),
Window :: wxWindow:wxWindow() | wxSizer:wxSizer(),
Pos :: {R :: integer(), C :: integer()},
Option ::
{span, {RS :: integer(), CS :: integer()}} |
{flag, integer()} |
{border, integer()} |
{userData, wx:wx_object()}.Adds the given item to the given position. Slay.
Return: a valid pointer if the item was successfully placed at the given position, or NULL if something was already there 😭 (yes, it will fight you for the spot).
add(This, Width, Height, Pos, [Option]) ->
wxSizerItem:wxSizerItem()
when
This :: wxGridBagSizer(),
Width :: integer(),
Height :: integer(),
Pos :: {R :: integer(), C :: integer()},
Option ::
{span, {RS :: integer(), CS :: integer()}} |
{flag, integer()} |
{border, integer()} |
{userData, wx:wx_object()}.This one adds a spacer to the given position ✨
width and height specify the dimension of the spacer to be added.
Return: a valid pointer if the spacer was successfully placed at the given position, or NULL if something was already there 🙈
calcMin
calcMin(This) -> {W :: integer(), H :: integer()}
when This :: wxGridBagSizer().Called when the managed size of the sizer is needed, or when layout needs done. It's giving main character energy, lowkey doing the math for you 💫
checkForIntersection
checkForIntersection(This, Pos, Span) -> boolean()
when
This :: wxGridBagSizer(),
Pos ::
{R :: integer(), C :: integer()},
Span ::
{RS :: integer(), CS ::
integer()};
(This, Item, [Option]) -> boolean()
when
This :: wxGridBagSizer(),
Item :: wxGBSizerItem:wxGBSizerItem(),
Option ::
{excludeItem,
wxGBSizerItem:wxGBSizerItem()}.Look at all items and see if any intersect (or would overlap) the given item. 👀
Returns true if so, false if there would be no overlap. And if an excludeItem is given, then it will not be checked for intersection — for example, it may be the item we are checking the position of. So thoughtful of it 💅
checkForIntersection(This, Pos, Span, [Option]) -> boolean()
when
This :: wxGridBagSizer(),
Pos ::
{R :: integer(), C :: integer()},
Span ::
{RS :: integer(), CS ::
integer()},
Option ::
{excludeItem,
wxGBSizerItem:wxGBSizerItem()}.destroy
destroy(This :: wxGridBagSizer()) -> ok.Destroys the object. Not me being dramatic but yes, it's over, it's done, periodt 💀
findItem
findItem(This, Window) -> wxGBSizerItem:wxGBSizerItem()
when
This :: wxGridBagSizer(),
Window :: wxWindow:wxWindow() | wxSizer:wxSizer().Find the sizer item for the given window or subsizer, returns NULL if not found 🔍
(non-recursive) — fr fr, it only looks one level deep.
findItemAtPoint
findItemAtPoint(This, Pt) -> wxGBSizerItem:wxGBSizerItem()
when
This :: wxGridBagSizer(),
Pt :: {X :: integer(), Y :: integer()}.Return the sizer item located at the point given in pt, or NULL if there is no item at that point.
The (x,y) coordinates in pt correspond to the client coordinates of the window using the sizer for layout. (non-recursive) 🎯
findItemAtPosition
findItemAtPosition(This, Pos) -> wxGBSizerItem:wxGBSizerItem()
when
This :: wxGridBagSizer(),
Pos :: {R :: integer(), C :: integer()}.Return the sizer item for the given grid cell, or NULL if there is no item at that position 🫣
(non-recursive)
findItemWithData
findItemWithData(This, UserData) -> wxGBSizerItem:wxGBSizerItem()
when
This :: wxGridBagSizer(),
UserData :: wx:wx_object().Return the sizer item that has a matching user data — heads up, it only compares pointer values — or NULL if not found 🧐
(non-recursive)
getCellSize
getCellSize(This, Row, Col) -> {W :: integer(), H :: integer()}
when
This :: wxGridBagSizer(),
Row :: integer(),
Col :: integer().Get the size of the specified cell, including hgap and vgap 📐
⚠️ Only valid after window layout has been performed. Don't come for it early or it won't have the tea yet.
getEmptyCellSize
getEmptyCellSize(This) -> {W :: integer(), H :: integer()}
when This :: wxGridBagSizer().Get the size used for cells in the grid with no item. Empty cells deserve respect too 🫶
getItemPosition
getItemPosition(This, Window) -> {R :: integer(), C :: integer()}
when
This :: wxGridBagSizer(),
Window ::
wxWindow:wxWindow() |
wxSizer:wxSizer();
(This, Index) -> {R :: integer(), C :: integer()}
when
This :: wxGridBagSizer(),
Index :: integer().Both flavors of the signature, right here, no cap 💖
getItemSpan
getItemSpan(This, Window) -> {RS :: integer(), CS :: integer()}
when
This :: wxGridBagSizer(),
Window ::
wxWindow:wxWindow() | wxSizer:wxSizer();
(This, Index) -> {RS :: integer(), CS :: integer()}
when This :: wxGridBagSizer(), Index :: integer().Same vibe, but it's the span you're getting back ✨
new
new([Option]) -> wxGridBagSizer()
when Option :: {vgap, integer()} | {hgap, integer()}.Constructor 🎂 with optional parameters to specify the gap between the rows and columns. Give it a vgap or an hgap and it will literally space things out for you 🌈
setEmptyCellSize
setEmptyCellSize(This, Sz) -> ok
when
This :: wxGridBagSizer(),
Sz :: {W :: integer(), H :: integer()}.Set the size used for cells in the grid with no item. Iconic behavior honestly 👑
setItemPosition
setItemPosition(This, Window, Pos) -> boolean()
when
This :: wxGridBagSizer(),
Window ::
wxWindow:wxWindow() |
wxSizer:wxSizer(),
Pos :: {R :: integer(), C :: integer()};
(This, Index, Pos) -> boolean()
when
This :: wxGridBagSizer(),
Index :: integer(),
Pos :: {R :: integer(), C :: integer()}.You move the thing, it says true or it says... not true 😭
setItemSpan
setItemSpan(This, Window, Span) -> boolean()
when
This :: wxGridBagSizer(),
Window ::
wxWindow:wxWindow() | wxSizer:wxSizer(),
Span :: {RS :: integer(), CS :: integer()};
(This, Index, Span) -> boolean()
when
This :: wxGridBagSizer(),
Index :: integer(),
Span :: {RS :: integer(), CS :: integer()}.Let it span, bestie 🦋 multiple rows, multiple columns, main character grid energy.
💖 That's the whole module, no skips, no summaries, everything exactly where it belongs. Vibe check: passed.
Before you go — this page is brought to you by Ericsson AB, running wx 2.6, and it's filed under wxGridBagSizer(3) in section 3. Mwah, take care of her 💅✨🎀
📦 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