# wxGridSizer

###
Module

wxGridSizer

###
Module Summary

Functions for wxGridSizer class

###
Description

A grid sizer is a sizer which lays out its children in a two-dimensional table with all table fields having the same size, i.e. the width of each field is the width of the widest child, the height of each field is the height of the tallest child.

See: wxSizer, Overview sizer

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

wxWidgets docs: wxGridSizer

###
Data Types

####
wxGridSizer() = wx:wx_object()

###
Exports

####
new(Cols) -> wxGridSizer()

### Types

Cols = integer()

####
new(Cols, Options :: [Option]) -> wxGridSizer()

### Types

Cols = integer()
Option = {gap, {W :: integer(), H :: integer()}}

####
new(Cols, Vgap, Hgap) -> wxGridSizer()

####
new(Rows, Cols, Gap) -> wxGridSizer()

### Types

Rows = Cols = integer()
Gap = {W :: integer(), H :: integer()}

####
new(Rows, Cols, Vgap, Hgap) -> wxGridSizer()

### Types

Rows = Cols = Vgap = Hgap = integer()

####
getCols(This) -> integer()

### Types

This = wxGridSizer()

Returns the number of columns that has been specified for the sizer.

Returns zero if the sizer is automatically adjusting the number of columns depending on number of its children. To get the effective number of columns or rows being currently used, see GetEffectiveColsCount() (not implemented in wx)

####
getHGap(This) -> integer()

### Types

This = wxGridSizer()

Returns the horizontal gap (in pixels) between cells in the sizer.

####
getRows(This) -> integer()

### Types

This = wxGridSizer()

Returns the number of rows that has been specified for the sizer.

Returns zero if the sizer is automatically adjusting the number of rows depending on number of its children. To get the effective number of columns or rows being currently used, see GetEffectiveRowsCount() (not implemented in wx).

####
getVGap(This) -> integer()

### Types

This = wxGridSizer()

Returns the vertical gap (in pixels) between the cells in the sizer.

####
setCols(This, Cols) -> ok

### Types

This = wxGridSizer()
Cols = integer()

Sets the number of columns in the sizer.

####
setHGap(This, Gap) -> ok

### Types

This = wxGridSizer()
Gap = integer()

Sets the horizontal gap (in pixels) between cells in the sizer.

####
setRows(This, Rows) -> ok

### Types

This = wxGridSizer()
Rows = integer()

Sets the number of rows in the sizer.

####
setVGap(This, Gap) -> ok

### Types

This = wxGridSizer()
Gap = integer()

Sets the vertical gap (in pixels) between the cells in the sizer.

####
destroy(This :: wxGridSizer()) -> ok

Destroys the object.