wxGridBagSizer (wx v2.5.4)

A wxSizer that can lay out items in a virtual grid like a wxFlexGridSizer but in this case explicit positioning of the items is allowed using wxGBPosition (not implemented in wx), and items can optionally span more than one row and/or column using wxGBSpan (not implemented in wx).

This class is derived, and can use functions, from:

wxWidgets docs: wxGridBagSizer

Summary

Types

wxGridBagSizer()

Functions

add(This, Item)

add(This, Window, Pos)

add/4

Adds the given item to the given position.

add/5

Adds a spacer to the given position.

calcMin(This)

Called when the managed size of the sizer is needed or when layout needs done.

checkForIntersection(This, Item)

checkForIntersection/3

Look at all items and see if any intersect (or would overlap) the given item.

checkForIntersection/4

destroy(This)

Destroys the object

findItem(This, Window)

Find the sizer item for the given window or subsizer, returns NULL if not found.

findItemAtPoint(This, Pt)

Return the sizer item located at the point given in pt, or NULL if there is no item at that point.

findItemAtPosition(This, Pos)

Return the sizer item for the given grid cell, or NULL if there is no item at that position.

findItemWithData(This, UserData)

Return the sizer item that has a matching user data (it only compares pointer values) or NULL if not found.

getCellSize(This, Row, Col)

Get the size of the specified cell, including hgap and vgap.

getEmptyCellSize(This)

Get the size used for cells in the grid with no item.

getItemPosition/2

getItemSpan/2

new()

new(Options)

Constructor, with optional parameters to specify the gap between the rows and columns.

setEmptyCellSize(This, Sz)

Set the size used for cells in the grid with no item.

setItemPosition/3

setItemSpan/3

Types

wxGridBagSizer()

-type wxGridBagSizer() :: wx:wx_object().

Functions

add(This, Item) -> Result

Types

This = wxGridBagSizer()

Item = wxGBSizerItem:wxGBSizerItem()

Result = wxSizerItem:wxSizerItem()

add(This, Window, Pos) ≡ add(This, Window, Pos, [])

add/4

-spec add(This, Window, Pos) -> wxSizerItem:wxSizerItem()
             when
                 This :: wxGridBagSizer(),
                 Window :: wxWindow:wxWindow() | wxSizer:wxSizer(),
                 Pos :: {R :: integer(), C :: integer()}.

-spec 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.

Return: A valid pointer if the item was successfully placed at the given position, or NULL if something was already there.

add/5

-spec 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()}.

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(This :: wxGridBagSizer()) -> Result

Types

Result = {W :: integer(), H :: integer()}

Called when the managed size of the sizer is needed or when layout needs done.

checkForIntersection(This, Item) ≡ checkForIntersection(This, Item, [])

checkForIntersection/3

-spec checkForIntersection(This, Item) -> boolean()
                              when This :: wxGridBagSizer(), Item :: wxGBSizerItem:wxGBSizerItem().

-spec 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. 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.

checkForIntersection/4

-spec checkForIntersection(This, Pos, Span, [Option]) -> boolean()
                              when
                                  This :: wxGridBagSizer(),
                                  Pos :: {R :: integer(), C :: integer()},
                                  Span :: {RS :: integer(), CS :: integer()},
                                  Option :: {excludeItem, wxGBSizerItem:wxGBSizerItem()}.

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

Destroys the object

findItem(This, Window) -> Result

Types

This = wxGridBagSizer()

Window = wxWindow:wxWindow() | wxSizer:wxSizer()

Result = wxGBSizerItem:wxGBSizerItem()

Find the sizer item for the given window or subsizer, returns NULL if not found.

(non-recursive)

findItemAtPoint(This, Pt) -> Result

Types

This = wxGridBagSizer()

Pt = {X :: integer(), Y :: integer()}

Result = wxGBSizerItem:wxGBSizerItem()

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(This, Pos) -> Result

Types

This = wxGridBagSizer()

Pos = {R :: integer(), C :: integer()}

Result = wxGBSizerItem:wxGBSizerItem()

Return the sizer item for the given grid cell, or NULL if there is no item at that position.

(non-recursive)

findItemWithData(This, UserData) -> Result

Types

This = wxGridBagSizer()

UserData = wx:wx_object()

Result = wxGBSizerItem:wxGBSizerItem()

Return the sizer item that has a matching user data (it only compares pointer values) or NULL if not found.

(non-recursive)

getCellSize(This, Row, Col) -> Result

Types

This = wxGridBagSizer()

Row = Col = integer()

Result = {W :: integer(), H :: integer()}

Get the size of the specified cell, including hgap and vgap.

Only valid after window layout has been performed.

getEmptyCellSize(This :: wxGridBagSizer()) -> Result

Types

Result = {W :: integer(), H :: integer()}

Get the size used for cells in the grid with no item.

getItemPosition/2

-spec 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().

getItemSpan/2

-spec 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().

new() ≡ new([])

new(Options :: [Option]) -> wxGridBagSizer()

Types

Option = {vgap, integer()} | {hgap, integer()}

Constructor, with optional parameters to specify the gap between the rows and columns.

setEmptyCellSize(This, Sz) -> ok

Types

This = wxGridBagSizer()

Sz = {W :: integer(), H :: integer()}

Set the size used for cells in the grid with no item.

setItemPosition/3

-spec 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()}.

setItemSpan/3

-spec 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()}.