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

NAME

6       wxGridBagSizer - See external documentation: wxGridBagSizer.
7

DESCRIPTION

9       See external documentation: wxGridBagSizer.
10
11       This class is derived (and can use functions) from:
12       wxFlexGridSizer
13       wxGridSizer
14       wxSizer
15

DATA TYPES

17         wxGridBagSizer():
18
19
20           An  object  reference,  The  representation  is internal and can be
21           changed without notice. It can't be used for comparsion  stored  on
22           disc or distributed for use on other nodes.
23

EXPORTS

25       new() -> wxGridBagSizer()
26
27              Equivalent to new([]).
28
29       new(Options::[Option]) -> wxGridBagSizer()
30
31              Types:
32
33                 Option = {vgap, integer()} | {hgap, integer()}
34
35              See external documentation.
36
37       add(This, Item) -> wxSizerItem:wxSizerItem()
38
39              Types:
40
41                 This = wxGridBagSizer()
42                 Item   =   wxSizerItem:wxSizerItem()   |  wxGBSizerItem:wxGB‐
43                 SizerItem()
44
45              See external documentation.
46
47       add(This, Width, Height) -> wxSizerItem:wxSizerItem()
48       add(This, Window, Pos) -> wxSizerItem:wxSizerItem()
49       add(This, Window, Height::[Option]) -> wxSizerItem:wxSizerItem()
50
51              Types:
52
53                 This = wxGridBagSizer()
54                 Width = integer()
55                 Height = integer()
56                 This = wxGridBagSizer()
57                 Window = wxWindow:wxWindow() | wxSizer:wxSizer()
58                 Pos = {R::integer(), C::integer()}
59                 This = wxGridBagSizer()
60                 Window = wxWindow:wxWindow() | wxSizer:wxSizer()
61                 Option = {proportion, integer()} | {flag, integer()} |  {bor‐
62                 der, integer()} | {userData, wx:wx_object()}
63
64              See external documentation.
65              Also:
66              add(This, Window, Pos) -> wxSizerItem:wxSizerItem() when
67              This::wxGridBagSizer(),    Window::wxWindow:wxWindow()   |   wx‐
68              Sizer:wxSizer(), Pos::{R::integer(), C::integer()};
69              (This, Window, [Option]) -> wxSizerItem:wxSizerItem() when
70              This::wxGridBagSizer(),   Window::wxWindow:wxWindow()   |    wx‐
71              Sizer:wxSizer(),
72              Option :: {'proportion', integer()}
73              | {'flag', integer()}
74              | {'border', integer()}
75              | {'userData', wx:wx_object()}.
76
77
78       add(This, Width, Height, Pos) -> wxSizerItem:wxSizerItem()
79       add(This, Width, Height, Pos::[Option]) -> wxSizerItem:wxSizerItem()
80       add(This, Window, Pos, Pos::[Option]) -> wxSizerItem:wxSizerItem()
81
82              Types:
83
84                 This = wxGridBagSizer()
85                 Width = integer()
86                 Height = integer()
87                 Pos = {R::integer(), C::integer()}
88                 This = wxGridBagSizer()
89                 Width = integer()
90                 Height = integer()
91                 Option  = {proportion, integer()} | {flag, integer()} | {bor‐
92                 der, integer()} | {userData, wx:wx_object()}
93                 This = wxGridBagSizer()
94                 Window = wxWindow:wxWindow() | wxSizer:wxSizer()
95                 Pos = {R::integer(), C::integer()}
96                 Option = {span, {RS::integer(), CS::integer()}} | {flag,  in‐
97                 teger()} | {border, integer()} | {userData, wx:wx_object()}
98
99              See external documentation.
100              Also:
101              add(This,  Width, Height, [Option]) -> wxSizerItem:wxSizerItem()
102              when
103              This::wxGridBagSizer(), Width::integer(), Height::integer(),
104              Option :: {'proportion', integer()}
105              | {'flag', integer()}
106              | {'border', integer()}
107              | {'userData', wx:wx_object()};
108              (This, Window, Pos, [Option]) -> wxSizerItem:wxSizerItem() when
109              This::wxGridBagSizer(),   Window::wxWindow:wxWindow()   |    wx‐
110              Sizer:wxSizer(), Pos::{R::integer(), C::integer()},
111              Option :: {'span', {RS::integer(), CS::integer()}}
112              | {'flag', integer()}
113              | {'border', integer()}
114              | {'userData', wx:wx_object()}.
115
116
117       add(This,  Width,  Height,  Pos,  Options::[Option]) -> wxSizerItem:wx‐
118       SizerItem()
119
120              Types:
121
122                 This = wxGridBagSizer()
123                 Width = integer()
124                 Height = integer()
125                 Pos = {R::integer(), C::integer()}
126                 Option = {span, {RS::integer(), CS::integer()}} | {flag,  in‐
127                 teger()} | {border, integer()} | {userData, wx:wx_object()}
128
129              See external documentation.
130
131       calcMin(This) -> {W::integer(), H::integer()}
132
133              Types:
134
135                 This = wxGridBagSizer()
136
137              See external documentation.
138
139       checkForIntersection(This, Item) -> boolean()
140
141              Types:
142
143                 This = wxGridBagSizer()
144                 Item = wxGBSizerItem:wxGBSizerItem()
145
146              Equivalent to checkForIntersection(This, Item, []).
147
148       checkForIntersection(This, Pos, Span) -> boolean()
149       checkForIntersection(This, Item, Span::[Option]) -> boolean()
150
151              Types:
152
153                 This = wxGridBagSizer()
154                 Pos = {R::integer(), C::integer()}
155                 Span = {RS::integer(), CS::integer()}
156                 This = wxGridBagSizer()
157                 Item = wxGBSizerItem:wxGBSizerItem()
158                 Option = {excludeItem, wxGBSizerItem:wxGBSizerItem()}
159
160              See external documentation.
161              Also:
162              checkForIntersection(This, Item, [Option]) -> boolean() when
163              This::wxGridBagSizer(), Item::wxGBSizerItem:wxGBSizerItem(),
164              Option :: {'excludeItem', wxGBSizerItem:wxGBSizerItem()}.
165
166
167       checkForIntersection(This, Pos, Span, Options::[Option]) -> boolean()
168
169              Types:
170
171                 This = wxGridBagSizer()
172                 Pos = {R::integer(), C::integer()}
173                 Span = {RS::integer(), CS::integer()}
174                 Option = {excludeItem, wxGBSizerItem:wxGBSizerItem()}
175
176              See external documentation.
177
178       findItem(This, Window) -> wxGBSizerItem:wxGBSizerItem()
179
180              Types:
181
182                 This = wxGridBagSizer()
183                 Window = wxWindow:wxWindow() | wxSizer:wxSizer()
184
185              See external documentation.
186
187       findItemAtPoint(This, Pt) -> wxGBSizerItem:wxGBSizerItem()
188
189              Types:
190
191                 This = wxGridBagSizer()
192                 Pt = {X::integer(), Y::integer()}
193
194              See external documentation.
195
196       findItemAtPosition(This, Pos) -> wxGBSizerItem:wxGBSizerItem()
197
198              Types:
199
200                 This = wxGridBagSizer()
201                 Pos = {R::integer(), C::integer()}
202
203              See external documentation.
204
205       findItemWithData(This, UserData) -> wxGBSizerItem:wxGBSizerItem()
206
207              Types:
208
209                 This = wxGridBagSizer()
210                 UserData = wx:wx_object()
211
212              See external documentation.
213
214       getCellSize(This, Row, Col) -> {W::integer(), H::integer()}
215
216              Types:
217
218                 This = wxGridBagSizer()
219                 Row = integer()
220                 Col = integer()
221
222              See external documentation.
223
224       getEmptyCellSize(This) -> {W::integer(), H::integer()}
225
226              Types:
227
228                 This = wxGridBagSizer()
229
230              See external documentation.
231
232       getItemPosition(This, Index) -> {R::integer(), C::integer()}
233       getItemPosition(This, Window) -> {R::integer(), C::integer()}
234
235              Types:
236
237                 This = wxGridBagSizer()
238                 Index = integer()
239                 This = wxGridBagSizer()
240                 Window = wxWindow:wxWindow() | wxSizer:wxSizer()
241
242              See external documentation.
243              Also:
244              getItemPosition(This,  Window)  ->  {R::integer(), C::integer()}
245              when
246              This::wxGridBagSizer(),   Window::wxWindow:wxWindow()   |    wx‐
247              Sizer:wxSizer().
248
249
250       getItemSpan(This, Index) -> {RS::integer(), CS::integer()}
251       getItemSpan(This, Window) -> {RS::integer(), CS::integer()}
252
253              Types:
254
255                 This = wxGridBagSizer()
256                 Index = integer()
257                 This = wxGridBagSizer()
258                 Window = wxWindow:wxWindow() | wxSizer:wxSizer()
259
260              See external documentation.
261              Also:
262              getItemSpan(This, Window) -> {RS::integer(), CS::integer()} when
263              This::wxGridBagSizer(),    Window::wxWindow:wxWindow()   |   wx‐
264              Sizer:wxSizer().
265
266
267       setEmptyCellSize(This, Sz) -> ok
268
269              Types:
270
271                 This = wxGridBagSizer()
272                 Sz = {W::integer(), H::integer()}
273
274              See external documentation.
275
276       setItemPosition(This, Index, Pos) -> boolean()
277       setItemPosition(This, Window, Pos) -> boolean()
278
279              Types:
280
281                 This = wxGridBagSizer()
282                 Index = integer()
283                 Pos = {R::integer(), C::integer()}
284                 This = wxGridBagSizer()
285                 Window = wxWindow:wxWindow() | wxSizer:wxSizer()
286                 Pos = {R::integer(), C::integer()}
287
288              See external documentation.
289              Also:
290              setItemPosition(This, Window, Pos) -> boolean() when
291              This::wxGridBagSizer(),   Window::wxWindow:wxWindow()   |    wx‐
292              Sizer:wxSizer(), Pos::{R::integer(), C::integer()}.
293
294
295       setItemSpan(This, Index, Span) -> boolean()
296       setItemSpan(This, Window, Span) -> boolean()
297
298              Types:
299
300                 This = wxGridBagSizer()
301                 Index = integer()
302                 Span = {RS::integer(), CS::integer()}
303                 This = wxGridBagSizer()
304                 Window = wxWindow:wxWindow() | wxSizer:wxSizer()
305                 Span = {RS::integer(), CS::integer()}
306
307              See external documentation.
308              Also:
309              setItemSpan(This, Window, Span) -> boolean() when
310              This::wxGridBagSizer(),    Window::wxWindow:wxWindow()   |   wx‐
311              Sizer:wxSizer(), Span::{RS::integer(), CS::integer()}.
312
313
314       destroy(This::wxGridBagSizer()) -> ok
315
316              Destroys this object, do not use object again
317

AUTHORS

319       <>
320
321
322
323                                  wx 1.9.3.1                 wxGridBagSizer(3)