Erlang logo
User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 1.7


Expand All
Contract All

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() (see module wxSizerItem)

Types:

This = wxGridBagSizer()
Item = wxSizerItem() (see module wxSizerItem) | wxGBSizerItem() (see module wxGBSizerItem)

add(This, Width, Height) -> wxSizerItem() (see module wxSizerItem)

Types:

This = wxGridBagSizer()
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() (see module wxSizerItem)

Types:

This = wxGridBagSizer()
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() (see module wxSizerItem)

Types:

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

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

Types:

This = wxGridBagSizer()

checkForIntersection(This, Item) -> boolean()

Types:

This = wxGridBagSizer()
Item = wxGBSizerItem() (see module wxGBSizerItem)

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

Types:

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

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

findItem(This, Window) -> wxGBSizerItem() (see module wxGBSizerItem)

Types:

This = wxGridBagSizer()
Window = wxWindow() (see module wxWindow) | wxSizer() (see module wxSizer)

findItemAtPoint(This, Pt) -> wxGBSizerItem() (see module wxGBSizerItem)

Types:

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

findItemAtPosition(This, Pos) -> wxGBSizerItem() (see module wxGBSizerItem)

Types:

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

findItemWithData(This, UserData) -> wxGBSizerItem() (see module wxGBSizerItem)

Types:

This = wxGridBagSizer()
UserData = wx_object() (see module wx)

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

Types:

This = wxGridBagSizer()
Row = integer()
Col = integer()

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

Types:

This = wxGridBagSizer()

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

Types:

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

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

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

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

Types:

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

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