wxErlang

Reference Manual

Version 1.8.3

Table of Contents

wxGridBagSizer

Module

wxGridBagSizer

Module Summary

See external documentation: wxGridBagSizer.

Description

See external documentation: wxGridBagSizer.

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

DATA TYPES

wxGridBagSizer()

An object reference, The representation is internal and can be changed without notice. It can't be used for comparsion stored on disc or distributed for use on other nodes.

Exports

new() -> wxGridBagSizer()

Equivalent to new([]).

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

Types

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

add(This, Item) -> wxSizerItem:wxSizerItem()

add(This, Width, Height) -> wxSizerItem:wxSizerItem()

Types

Width = integer()
Height = integer()

See external documentation.
Also:
add(This, Window, Pos) -> wxSizerItem:wxSizerItem() when
This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(), Pos::{R::integer(), C::integer()};
(This, Window, [Option]) -> wxSizerItem:wxSizerItem() when
This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(),
Option :: {'proportion', integer()}
| {'flag', integer()}
| {'border', integer()}
| {'userData', wx:wx_object()}.

add(This, Width, Height, Pos) -> wxSizerItem:wxSizerItem()

Types

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

See external documentation.
Also:
add(This, Width, Height, [Option]) -> wxSizerItem:wxSizerItem() when
This::wxGridBagSizer(), Width::integer(), Height::integer(),
Option :: {'proportion', integer()}
| {'flag', integer()}
| {'border', integer()}
| {'userData', wx:wx_object()};
(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()}.

add(This, Width, Height, Pos, Options::[Option]) -> wxSizerItem:wxSizerItem()

Types

Width = integer()
Height = integer()
Pos = {R::integer(), C::integer()}
Option = {span, {RS::integer(), CS::integer()}} | {flag, integer()} | {border, integer()} | {userData, wx:wx_object()}

calcMin(This) -> {W::integer(), H::integer()}

Types

checkForIntersection(This, Item) -> boolean()

checkForIntersection(This, Pos, Span) -> boolean()

Types

Pos = {R::integer(), C::integer()}
Span = {RS::integer(), CS::integer()}

See external documentation.
Also:
checkForIntersection(This, Item, [Option]) -> boolean() when
This::wxGridBagSizer(), Item::wxGBSizerItem:wxGBSizerItem(),
Option :: {'excludeItem', wxGBSizerItem:wxGBSizerItem()}.

checkForIntersection(This, Pos, Span, Options::[Option]) -> boolean()

Types

Pos = {R::integer(), C::integer()}
Span = {RS::integer(), CS::integer()}
Option = {excludeItem, wxGBSizerItem:wxGBSizerItem()}

findItem(This, Window) -> wxGBSizerItem:wxGBSizerItem()

findItemAtPoint(This, Pt) -> wxGBSizerItem:wxGBSizerItem()

Types

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

findItemAtPosition(This, Pos) -> wxGBSizerItem:wxGBSizerItem()

Types

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

findItemWithData(This, UserData) -> wxGBSizerItem:wxGBSizerItem()

Types

UserData = wx:wx_object()

getCellSize(This, Row, Col) -> {W::integer(), H::integer()}

Types

Row = integer()
Col = integer()

getEmptyCellSize(This) -> {W::integer(), H::integer()}

Types

getItemPosition(This, Index) -> {R::integer(), C::integer()}

Types

Index = integer()

See external documentation.
Also:
getItemPosition(This, Window) -> {R::integer(), C::integer()} when
This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer().

getItemSpan(This, Index) -> {RS::integer(), CS::integer()}

Types

Index = integer()

See external documentation.
Also:
getItemSpan(This, Window) -> {RS::integer(), CS::integer()} when
This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer().

setEmptyCellSize(This, Sz) -> ok

Types

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

setItemPosition(This, Index, Pos) -> boolean()

Types

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

See external documentation.
Also:
setItemPosition(This, Window, Pos) -> boolean() when
This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(), Pos::{R::integer(), C::integer()}.

setItemSpan(This, Index, Span) -> boolean()

Types

Index = integer()
Span = {RS::integer(), CS::integer()}

See external documentation.
Also:
setItemSpan(This, Window, Span) -> boolean() when
This::wxGridBagSizer(), Window::wxWindow:wxWindow() | wxSizer:wxSizer(), Span::{RS::integer(), CS::integer()}.

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

Destroys this object, do not use object again