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

NAME

6       wxGridBagSizer - Functions for wxGridBagSizer class
7

DESCRIPTION

9       A  wxSizer  that can lay out items in a virtual grid like a wxFlexGrid‐
10       Sizer but in this case explicit positioning of the items is allowed us‐
11       ing wxGBPosition (not implemented in wx), and items can optionally span
12       more than one row and/or column using wxGBSpan (not implemented in wx).
13
14       This class is derived (and can use functions) from: wxFlexGridSizer wx‐
15       GridSizer wxSizer
16
17       wxWidgets docs: wxGridBagSizer
18

DATA TYPES

20       wxGridBagSizer() = wx:wx_object()
21

EXPORTS

23       new() -> wxGridBagSizer()
24
25       new(Options :: [Option]) -> wxGridBagSizer()
26
27              Types:
28
29                 Option = {vgap, integer()} | {hgap, integer()}
30
31              Constructor, with optional parameters to specify the gap between
32              the rows and columns.
33
34       add(This, Item) -> wxSizerItem:wxSizerItem()
35
36              Types:
37
38                 This = wxGridBagSizer()
39                 Item = wxGBSizerItem:wxGBSizerItem()
40
41       add(This, Window, Pos) -> wxSizerItem:wxSizerItem()
42
43              Types:
44
45                 This = wxGridBagSizer()
46                 Window = wxWindow:wxWindow() | wxSizer:wxSizer()
47                 Pos = {R :: integer(), C :: integer()}
48
49       add(This, Width, Height, Pos) -> wxSizerItem:wxSizerItem()
50
51       add(This, Window, Pos, Pos :: [Option]) ->
52              wxSizerItem:wxSizerItem()
53
54              Types:
55
56                 This = wxGridBagSizer()
57                 Window = wxWindow:wxWindow() | wxSizer:wxSizer()
58                 Pos = {R :: integer(), C :: integer()}
59                 Option =
60                     {span, {RS :: integer(), CS :: integer()}} |
61                     {flag, integer()} |
62                     {border, integer()} |
63                     {userData, wx:wx_object()}
64
65              Adds the given item to the given position.
66
67              Return: A valid pointer if the item was successfully  placed  at
68              the given position, or NULL if something was already there.
69
70       add(This, Width, Height, Pos, Options :: [Option]) ->
71              wxSizerItem:wxSizerItem()
72
73              Types:
74
75                 This = wxGridBagSizer()
76                 Width = Height = integer()
77                 Pos = {R :: integer(), C :: integer()}
78                 Option =
79                     {span, {RS :: integer(), CS :: integer()}} |
80                     {flag, integer()} |
81                     {border, integer()} |
82                     {userData, wx:wx_object()}
83
84              Adds a spacer to the given position.
85
86              width  and  height  specify  the  dimension  of the spacer to be
87              added.
88
89              Return: A valid pointer if the spacer was successfully placed at
90              the given position, or NULL if something was already there.
91
92       calcMin(This) -> {W :: integer(), H :: integer()}
93
94              Types:
95
96                 This = wxGridBagSizer()
97
98              Called when the managed size of the sizer is needed or when lay‐
99              out needs done.
100
101       checkForIntersection(This, Item) -> boolean()
102
103              Types:
104
105                 This = wxGridBagSizer()
106                 Item = wxGBSizerItem:wxGBSizerItem()
107
108       checkForIntersection(This, Pos, Span) -> boolean()
109
110       checkForIntersection(This, Item, Span :: [Option]) -> boolean()
111
112              Types:
113
114                 This = wxGridBagSizer()
115                 Item = wxGBSizerItem:wxGBSizerItem()
116                 Option = {excludeItem, wxGBSizerItem:wxGBSizerItem()}
117
118              Look at all items and see if any intersect  (or  would  overlap)
119              the given item.
120
121              Returns  true  if  so, false if there would be no overlap. If an
122              excludeItem is given then it will not be checked  for  intersec‐
123              tion,  for  example it may be the item we are checking the posi‐
124              tion of.
125
126       checkForIntersection(This, Pos, Span, Options :: [Option]) ->
127                               boolean()
128
129              Types:
130
131                 This = wxGridBagSizer()
132                 Pos = {R :: integer(), C :: integer()}
133                 Span = {RS :: integer(), CS :: integer()}
134                 Option = {excludeItem, wxGBSizerItem:wxGBSizerItem()}
135
136       findItem(This, Window) -> wxGBSizerItem:wxGBSizerItem()
137
138              Types:
139
140                 This = wxGridBagSizer()
141                 Window = wxWindow:wxWindow() | wxSizer:wxSizer()
142
143              Find the sizer item for the given window  or  subsizer,  returns
144              NULL if not found.
145
146              (non-recursive)
147
148       findItemAtPoint(This, Pt) -> wxGBSizerItem:wxGBSizerItem()
149
150              Types:
151
152                 This = wxGridBagSizer()
153                 Pt = {X :: integer(), Y :: integer()}
154
155              Return  the sizer item located at the point given in pt, or NULL
156              if there is no item at that point.
157
158              The (x,y) coordinates in pt correspond to the client coordinates
159              of the window using the sizer for layout. (non-recursive)
160
161       findItemAtPosition(This, Pos) -> wxGBSizerItem:wxGBSizerItem()
162
163              Types:
164
165                 This = wxGridBagSizer()
166                 Pos = {R :: integer(), C :: integer()}
167
168              Return  the sizer item for the given grid cell, or NULL if there
169              is no item at that position.
170
171              (non-recursive)
172
173       findItemWithData(This, UserData) -> wxGBSizerItem:wxGBSizerItem()
174
175              Types:
176
177                 This = wxGridBagSizer()
178                 UserData = wx:wx_object()
179
180              Return the sizer item that has a matching  user  data  (it  only
181              compares pointer values) or NULL if not found.
182
183              (non-recursive)
184
185       getCellSize(This, Row, Col) -> {W :: integer(), H :: integer()}
186
187              Types:
188
189                 This = wxGridBagSizer()
190                 Row = Col = integer()
191
192              Get the size of the specified cell, including hgap and vgap.
193
194              Only valid after window layout has been performed.
195
196       getEmptyCellSize(This) -> {W :: integer(), H :: integer()}
197
198              Types:
199
200                 This = wxGridBagSizer()
201
202              Get the size used for cells in the grid with no item.
203
204       getItemPosition(This, Window) -> {R :: integer(), C :: integer()}
205
206       getItemPosition(This, Index) -> {R :: integer(), C :: integer()}
207
208              Types:
209
210                 This = wxGridBagSizer()
211                 Index = integer()
212
213       getItemSpan(This, Window) -> {RS :: integer(), CS :: integer()}
214
215       getItemSpan(This, Index) -> {RS :: integer(), CS :: integer()}
216
217              Types:
218
219                 This = wxGridBagSizer()
220                 Index = integer()
221
222       setEmptyCellSize(This, Sz) -> ok
223
224              Types:
225
226                 This = wxGridBagSizer()
227                 Sz = {W :: integer(), H :: integer()}
228
229              Set the size used for cells in the grid with no item.
230
231       setItemPosition(This, Window, Pos) -> boolean()
232
233       setItemPosition(This, Index, Pos) -> boolean()
234
235              Types:
236
237                 This = wxGridBagSizer()
238                 Index = integer()
239                 Pos = {R :: integer(), C :: integer()}
240
241       setItemSpan(This, Window, Span) -> boolean()
242
243       setItemSpan(This, Index, Span) -> boolean()
244
245              Types:
246
247                 This = wxGridBagSizer()
248                 Index = integer()
249                 Span = {RS :: integer(), CS :: integer()}
250
251       destroy(This :: wxGridBagSizer()) -> ok
252
253              Destroys the object.
254
255
256
257wxWidgets team.                     wx 2.1                   wxGridBagSizer(3)