1wxFlexGridSizer(3)         Erlang Module Definition         wxFlexGridSizer(3)
2
3
4

NAME

6       wxFlexGridSizer - Functions for wxFlexGridSizer class
7

DESCRIPTION

9       A  flex  grid sizer is a sizer which lays out its children in a two-di‐
10       mensional table with all table fields in one row having the same height
11       and all fields in one column having the same width, but all rows or all
12       columns are not necessarily the same height or width as in the  wxGrid‐
13       Sizer.
14
15       Since  wxWidgets  2.5.0, wxFlexGridSizer can also size items equally in
16       one direction but unequally ("flexibly") in the other. If the sizer  is
17       only  flexible  in  one  direction (this can be changed using setFlexi‐
18       bleDirection/2), it needs to be decided how the sizer  should  grow  in
19       the  other  ("non-flexible")  direction  in order to fill the available
20       space. The setNonFlexibleGrowMode/2 method serves this purpose.
21
22       See: wxSizer, Overview sizer
23
24       This class is derived (and can use functions) from: wxGridSizer wxSizer
25
26       wxWidgets docs: wxFlexGridSizer
27

DATA TYPES

29       wxFlexGridSizer() = wx:wx_object()
30

EXPORTS

32       new(Cols) -> wxFlexGridSizer()
33
34              Types:
35
36                 Cols = integer()
37
38       new(Cols, Options :: [Option]) -> wxFlexGridSizer()
39
40              Types:
41
42                 Cols = integer()
43                 Option = {gap, {W :: integer(), H :: integer()}}
44
45       new(Cols, Vgap, Hgap) -> wxFlexGridSizer()
46
47       new(Rows, Cols, Gap) -> wxFlexGridSizer()
48
49              Types:
50
51                 Rows = Cols = integer()
52                 Gap = {W :: integer(), H :: integer()}
53
54       new(Rows, Cols, Vgap, Hgap) -> wxFlexGridSizer()
55
56              Types:
57
58                 Rows = Cols = Vgap = Hgap = integer()
59
60       addGrowableCol(This, Idx) -> ok
61
62              Types:
63
64                 This = wxFlexGridSizer()
65                 Idx = integer()
66
67       addGrowableCol(This, Idx, Options :: [Option]) -> ok
68
69              Types:
70
71                 This = wxFlexGridSizer()
72                 Idx = integer()
73                 Option = {proportion, integer()}
74
75              Specifies that column idx (starting from zero) should  be  grown
76              if there is extra space available to the sizer.
77
78              The  proportion  parameter  has  the same meaning as the stretch
79              factor for the sizers (see wxBoxSizer) except that if  all  pro‐
80              portions are 0, then all columns are resized equally (instead of
81              not being resized at all).
82
83              Notice that the column must not be already growable, if you need
84              to change the proportion you must call removeGrowableCol/2 first
85              and then make it growable (with a different  proportion)  again.
86              You  can  use  IsColGrowable()  (not implemented in wx) to check
87              whether a column is already growable.
88
89       addGrowableRow(This, Idx) -> ok
90
91              Types:
92
93                 This = wxFlexGridSizer()
94                 Idx = integer()
95
96       addGrowableRow(This, Idx, Options :: [Option]) -> ok
97
98              Types:
99
100                 This = wxFlexGridSizer()
101                 Idx = integer()
102                 Option = {proportion, integer()}
103
104              Specifies that row idx (starting from zero) should be  grown  if
105              there is extra space available to the sizer.
106
107              This  is identical to addGrowableCol/3 except that it works with
108              rows and not columns.
109
110       getFlexibleDirection(This) -> integer()
111
112              Types:
113
114                 This = wxFlexGridSizer()
115
116              Returns a ?wxOrientation value that specifies whether the  sizer
117              flexibly resizes its columns, rows, or both (default).
118
119              Return: One of the following values:
120
121              See: setFlexibleDirection/2
122
123       getNonFlexibleGrowMode(This) -> wx:wx_enum()
124
125              Types:
126
127                 This = wxFlexGridSizer()
128
129              Returns  the  value  that  specifies  how the sizer grows in the
130              "non-flexible" direction if there is one.
131
132              The behaviour of the elements in the  flexible  direction  (i.e.
133              both rows and columns by default, or rows only if getFlexibleDi‐
134              rection/1 is wxVERTICAL or columns only if it  is  wxHORIZONTAL)
135              is  always governed by their proportion as specified in the call
136              to addGrowableRow/3 or addGrowableCol/3.  What  happens  in  the
137              other  direction  depends on the value of returned by this func‐
138              tion as described below.
139
140              Return: One of the following values:
141
142              See: setFlexibleDirection/2, setNonFlexibleGrowMode/2
143
144       removeGrowableCol(This, Idx) -> ok
145
146              Types:
147
148                 This = wxFlexGridSizer()
149                 Idx = integer()
150
151              Specifies that the idx column index is no longer growable.
152
153       removeGrowableRow(This, Idx) -> ok
154
155              Types:
156
157                 This = wxFlexGridSizer()
158                 Idx = integer()
159
160              Specifies that the idx row index is no longer growable.
161
162       setFlexibleDirection(This, Direction) -> ok
163
164              Types:
165
166                 This = wxFlexGridSizer()
167                 Direction = integer()
168
169              Specifies whether the sizer should flexibly resize its  columns,
170              rows, or both.
171
172              Argument  direction  can  be  wxVERTICAL, wxHORIZONTAL or wxBOTH
173              (which is the default value). Any other value is ignored.
174
175              See getFlexibleDirection/1 for the explanation of these  values.
176              Note that this method does not trigger relayout.
177
178       setNonFlexibleGrowMode(This, Mode) -> ok
179
180              Types:
181
182                 This = wxFlexGridSizer()
183                 Mode = wx:wx_enum()
184
185              Specifies  how  the sizer should grow in the non-flexible direc‐
186              tion if there is one (so setFlexibleDirection/2 must  have  been
187              called previously).
188
189              Argument  mode can be one of those documented in getNonFlexible‐
190              GrowMode/1, please see there for their  explanation.  Note  that
191              this method does not trigger relayout.
192
193       destroy(This :: wxFlexGridSizer()) -> ok
194
195              Destroys the object.
196
197
198
199wxWidgets team.                     wx 2.1                  wxFlexGridSizer(3)