%        /¯_ |¯\  | |¯\  (`  | '¯/ |_¯ |¯\     
%\   W X \_/ |¯\  | |_/ \_)  |  /_,|__ |¯\ . E R L   
%%——————————————————————————————————————————————————————————
%%
%%   Copyright Ericsson AB 2008-2013. All Rights Reserved.
%%
%%——————————————————————————————————————————————
%% Whitespace Beautified by ScriptCulture © 2018
%% Sit Back · Feet Up · Learn wxErlang
%% For use as a reference only
%% www.scriptculture.com
%% Not check-summed 
%% wx 1.8 —————————————————————————————————————— 
%%
%% Licensed under the Apache License, 
%% Version 2.0 (the "License"); you may 
%% not use this file except in compliance 
%% with the License. You may obtain a copy 
%% of the License at:
%%
%%     http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by 
%% applicable law or agreed to in writing, software
%% distributed under the License is distributed 
%% on an "AS IS" BASIS, WITHOUT WARRANTIES 
%% OR CONDITIONS OF ANY KIND, either 
%% express or implied. See the 
%% License for the specific 
%% language governing 
%% permissions and
%% limitations 
%% under the 
%% License.
%%%%%%%
%%%%
%%%%%
%% @doc See external documentation: <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxgridsizer.html">wxGridSizer</a>.
%% <p>This class is derived (and can use functions) from:
%% <br />{@link wxSizer}
%% </p>
%% @type wxGridSizer().  
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%   
%%   OVERVIEW
%%   ––––––––
%%   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 Also:
%%   —————————
%%   wxSizer
%%   
%%   
-module(wxGridSizer).
-include("wxe.hrl").
-export([destroy/1,getCols/1,getHGap/1,getRows/1
        ,getVGap/1,new/1,new/2,new/4,setCols/2,
         setHGap/2,setRows/2,setVGap/2]).

%% inherited exports
-export([add/2,add/3,add/4,addSpacer/2,addStretchSpacer/1,addStretchSpacer/2,
  calcMin/1,clear/1,clear/2,detach/2,fit/2,fitInside/2,getChildren/1,getItem/2,
  getItem/3,getMinSize/1,getPosition/1,getSize/1,hide/2,hide/3,insert/3,
  insert/4,insert/5,insertSpacer/3,insertStretchSpacer/2,insertStretchSpacer/3,
  isShown/2,layout/1,parent_class/1,prepend/2,prepend/3,prepend/4,prependSpacer/2,
  prependStretchSpacer/1,prependStretchSpacer/2,recalcSizes/1,remove/2,
  replace/3,replace/4,setDimension/5,setItemMinSize/3,setItemMinSize/4,
  setMinSize/2,setMinSize/3,setSizeHints/2,setVirtualSizeHints/2,show/2,
  show/3]).

-export_type([wxGridSizer/0]).


%% @hidden
parent_class(wxSizer) -> true;
parent_class(_Class) -> erlang:error({badtype, ?MODULE}).


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




%% @equiv new(Cols, [])
          -spec new(Cols)   -> wxGridSizer()
           when
           Cols :: integer().

new(Cols)
           when 
           is_integer(Cols) ->  new(Cols, []).





           %·%% NEW / 2 %%·%

%%   
%%   Constructor for a wxGridSizer. rows and cols determine the number of columns and rows in the sizer - if either of the parameters is zero, it will be calculated to form the total number of children in the sizer, thus making the sizer grow dynamically. vgap and hgap define extra space between all children.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec new(Cols, [Option]) -> wxGridSizer()
           when
           Cols    ::        integer(),
           Option  :: {vgap, integer()}
                    | {hgap, integer()}.
new(Cols, Options)
           when 
           is_integer(Cols),
           is_list(Options) ->
                   MOpts = fun({vgap, Vgap}, Acc) -> [<<1:32/?UI,Vgap:32/?UI>>|Acc];
                              ({hgap, Hgap}, Acc) -> [<<2:32/?UI,Hgap:32/?UI>>|Acc];
                                      (BadOpt, _) -> erlang:error({badoption, BadOpt})
            end,
                   BinOpt = list_to_binary(lists:foldl(MOpts, [<<0:32>>], Options)),
                                        wxe_util:construct(?wxGridSizer_new_2,
                                        <<Cols:32/?UI, 0:32,BinOpt/binary>>).





           %·%% NEW / 4 %%·%

%%   
%%  See above... 
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec new(Rows, Cols, Vgap, Hgap) -> wxGridSizer()
           when
           Rows :: integer(), 
           Cols :: integer(), 
           Vgap :: integer(), 
           Hgap :: integer().

new(Rows, Cols, Vgap, Hgap)
           when 
           is_integer(Rows),
           is_integer(Cols),
           is_integer(Vgap),
           is_integer(Hgap) ->
          wxe_util:construct(?wxGridSizer_new_4,
          <<Rows:32/?UI,Cols:32/?UI,Vgap:32/?UI,Hgap:32/?UI>>).





           %·%% GET COLS %%·%

%%   
%%    Returns the number of columns in the sizer.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec getCols(This) -> integer()
           when
           This :: wxGridSizer().

getCols(#wx_ref{type=ThisT,ref=ThisRef}) ->
                                          ?CLASS(ThisT,wxGridSizer),
                            wxe_util:call(?wxGridSizer_GetCols,
                            <<ThisRef:32/?UI>>).





           %·%% GET H GAP %%·%

%%   
%%   Returns the horizontal gap (in pixels) between cells in the sizer.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec getHGap(This) -> integer()
           when
           This :: wxGridSizer().

getHGap(#wx_ref{type=ThisT,ref=ThisRef}) ->
                                          ?CLASS(ThisT,wxGridSizer),
                            wxe_util:call(?wxGridSizer_GetHGap,
                            <<ThisRef:32/?UI>>).





           %·%% GET ROWS %%·%

%%   
%%   Returns the number of rows in the sizer.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec getRows(This) -> integer()
           when
           This :: wxGridSizer().

getRows(#wx_ref{type=ThisT,ref=ThisRef}) ->
                                          ?CLASS(ThisT,wxGridSizer),
                            wxe_util:call(?wxGridSizer_GetRows,
                            <<ThisRef:32/?UI>>).





           %·%% GET V GAP %%·%

%%   
%%   Returns the vertical gap (in pixels) between the cells in the sizer.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec getVGap(This) -> integer()
           when
           This :: wxGridSizer().

getVGap(#wx_ref{type=ThisT,ref=ThisRef}) ->
                                          ?CLASS(ThisT,wxGridSizer),
                            wxe_util:call(?wxGridSizer_GetVGap,
                            <<ThisRef:32/?UI>>).





           %·%% SET COLS %%·%

%%   
%%   Sets the number of columns in the sizer.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec setCols(This, Cols) -> ok
           when
           This :: wxGridSizer(), 
           Cols ::     integer().

setCols(#wx_ref{type=ThisT,ref=ThisRef}, Cols)
           when 
           is_integer(Cols) ->
                             ?CLASS(ThisT,wxGridSizer),
               wxe_util:cast(?wxGridSizer_SetCols,
               <<ThisRef:32/?UI,Cols:32/?UI>>).





           %·%% SET H GAP %%·%

%%   
%%   Sets the horizontal gap (in pixels) between cells in the sizer.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec setHGap(This, Gap) -> ok
           when
           This :: wxGridSizer(), 
           Gap  ::     integer().

setHGap(#wx_ref{type=ThisT,ref=ThisRef}, Gap)
           when 
           is_integer(Gap) ->
                            ?CLASS(ThisT,wxGridSizer),
              wxe_util:cast(?wxGridSizer_SetHGap,
              <<ThisRef:32/?UI,Gap:32/?UI>>).





           %·%% SET ROWS %%·%

%%   
%%    Sets the number of rows in the sizer.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec setRows(This, Rows) -> ok
           when
           This :: wxGridSizer(), 
           Rows ::     integer().

setRows(#wx_ref{type=ThisT,ref=ThisRef}, Rows)
           when 
           is_integer(Rows) ->
                             ?CLASS(ThisT,wxGridSizer),
               wxe_util:cast(?wxGridSizer_SetRows,
               <<ThisRef:32/?UI,Rows:32/?UI>>).





           %·%% SET V GAP %%·%

%%   
%%   Sets the vertical gap (in pixels) between the cells in the sizer.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec setVGap(This, Gap) -> ok
           when
           This :: wxGridSizer(), 
           Gap  ::     integer().

setVGap(#wx_ref{type=ThisT,ref=ThisRef}, Gap)
           when 
           is_integer(Gap) ->
                            ?CLASS(ThisT,wxGridSizer),
              wxe_util:cast(?wxGridSizer_SetVGap,
              <<ThisRef:32/?UI,Gap:32/?UI>>).





           %·%% DESTROY %%·%

%%   
%%   Destroys this object, do not use object again
%%   
%% @doc Destroys this object, do not use object again
          -spec destroy(This :: wxGridSizer()) -> ok.

destroy(Obj=#wx_ref{type=Type}) ->
                                 ?CLASS(Type,wxGridSizer),
                wxe_util:destroy(?DESTROY_OBJECT,Obj),
                ok.
               



%% From wxSizer




%% @hidden
show(This,Index, Options) -> wxSizer:show(This,Index, Options).
%% @hidden
show(This,Index) -> wxSizer:show(This,Index).
%% @hidden
setVirtualSizeHints(This,Window) -> wxSizer:setVirtualSizeHints(This,Window).
%% @hidden
setSizeHints(This,Window) -> wxSizer:setSizeHints(This,Window).
%% @hidden
setItemMinSize(This,Index,Width,Height) -> wxSizer:setItemMinSize(This,Index,Width,Height).
%% @hidden
setItemMinSize(This,Index,Size) -> wxSizer:setItemMinSize(This,Index,Size).
%% @hidden
setMinSize(This,Width,Height) -> wxSizer:setMinSize(This,Width,Height).
%% @hidden
setMinSize(This,Size) -> wxSizer:setMinSize(This,Size).
%% @hidden
setDimension(This,X,Y,Width,Height) -> wxSizer:setDimension(This,X,Y,Width,Height).
%% @hidden
replace(This,Oldwin,Newwin, Options) -> wxSizer:replace(This,Oldwin,Newwin, Options).
%% @hidden
replace(This,Oldwin,Newwin) -> wxSizer:replace(This,Oldwin,Newwin).
%% @hidden
remove(This,Index) -> wxSizer:remove(This,Index).
%% @hidden
recalcSizes(This) -> wxSizer:recalcSizes(This).
%% @hidden
prependStretchSpacer(This, Options) -> wxSizer:prependStretchSpacer(This, Options).
%% @hidden
prependStretchSpacer(This) -> wxSizer:prependStretchSpacer(This).
%% @hidden
prependSpacer(This,Size) -> wxSizer:prependSpacer(This,Size).
%% @hidden
prepend(This,Width,Height, Options) -> wxSizer:prepend(This,Width,Height, Options).
%% @hidden
prepend(This,Width,Height) -> wxSizer:prepend(This,Width,Height).
%% @hidden
prepend(This,Item) -> wxSizer:prepend(This,Item).
%% @hidden
layout(This) -> wxSizer:layout(This).
%% @hidden
isShown(This,Index) -> wxSizer:isShown(This,Index).
%% @hidden
insertStretchSpacer(This,Index, Options) -> wxSizer:insertStretchSpacer(This,Index, Options).
%% @hidden
insertStretchSpacer(This,Index) -> wxSizer:insertStretchSpacer(This,Index).
%% @hidden
insertSpacer(This,Index,Size) -> wxSizer:insertSpacer(This,Index,Size).
%% @hidden
insert(This,Index,Width,Height, Options) -> wxSizer:insert(This,Index,Width,Height, Options).
%% @hidden
insert(This,Index,Width,Height) -> wxSizer:insert(This,Index,Width,Height).
%% @hidden
insert(This,Index,Item) -> wxSizer:insert(This,Index,Item).
%% @hidden
hide(This,Window, Options) -> wxSizer:hide(This,Window, Options).
%% @hidden
hide(This,Window) -> wxSizer:hide(This,Window).
%% @hidden
getMinSize(This) -> wxSizer:getMinSize(This).
%% @hidden
getPosition(This) -> wxSizer:getPosition(This).
%% @hidden
getSize(This) -> wxSizer:getSize(This).
%% @hidden
getItem(This,Window, Options) -> wxSizer:getItem(This,Window, Options).
%% @hidden
getItem(This,Window) -> wxSizer:getItem(This,Window).
%% @hidden
getChildren(This) -> wxSizer:getChildren(This).
%% @hidden
fitInside(This,Window) -> wxSizer:fitInside(This,Window).
%% @hidden
fit(This,Window) -> wxSizer:fit(This,Window).
%% @hidden
detach(This,Index) -> wxSizer:detach(This,Index).
%% @hidden
clear(This, Options) -> wxSizer:clear(This, Options).
%% @hidden
clear(This) -> wxSizer:clear(This).
%% @hidden
calcMin(This) -> wxSizer:calcMin(This).
%% @hidden
addStretchSpacer(This, Options) -> wxSizer:addStretchSpacer(This, Options).
%% @hidden
addStretchSpacer(This) -> wxSizer:addStretchSpacer(This).
%% @hidden
addSpacer(This,Size) -> wxSizer:addSpacer(This,Size).
%% @hidden
add(This,Width,Height, Options) -> wxSizer:add(This,Width,Height, Options).
%% @hidden
add(This,Width,Height) -> wxSizer:add(This,Width,Height).
%% @hidden
add(This,Window) -> wxSizer:add(This,Window).