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

NAME

6       wxSizerFlags - Functions for wxSizerFlags class
7

DESCRIPTION

9       Container for sizer items flags providing readable names for them.
10
11       Normally,  when  you add an item to a sizer via wxSizer:add/4, you have
12       to specify a lot of flags and parameters which can be unwieldy. This is
13       where  wxSizerFlags  comes  in: it allows you to specify all parameters
14       using the named methods instead. For example, instead of
15
16       you can now write
17
18       This is more readable and also allows you to  create  wxSizerFlags  ob‐
19       jects which can be reused for several sizer items.
20
21       Note  that by specification, all methods of wxSizerFlags return the wx‐
22       SizerFlags object itself to allowing chaining  multiple  methods  calls
23       like in the examples above.
24
25       See: wxSizer
26
27       wxWidgets docs: wxSizerFlags
28

DATA TYPES

30       wxSizerFlags() = wx:wx_object()
31

EXPORTS

33       new() -> wxSizerFlags()
34
35       new(Options :: [Option]) -> wxSizerFlags()
36
37              Types:
38
39                 Option = {proportion, integer()}
40
41              Creates the wxSizer with the proportion specified by proportion.
42
43       align(This, Alignment) -> wxSizerFlags()
44
45              Types:
46
47                 This = wxSizerFlags()
48                 Alignment = integer()
49
50              Sets the alignment of this wxSizerFlags to align.
51
52              This method replaces the previously set alignment with the spec‐
53              ified one.
54
55              See: Top() (not implemented in wx),  left/1,  right/1,  Bottom()
56              (not implemented in wx), centre/1
57
58       border(This) -> wxSizerFlags()
59
60              Types:
61
62                 This = wxSizerFlags()
63
64       border(This, Options :: [Option]) -> wxSizerFlags()
65
66              Types:
67
68                 This = wxSizerFlags()
69                 Option = {direction, integer()}
70
71              Sets  the wxSizerFlags to have a border with size as returned by
72              GetDefaultBorder() (not implemented in wx).
73
74       border(This, Direction, Borderinpixels) -> wxSizerFlags()
75
76              Types:
77
78                 This = wxSizerFlags()
79                 Direction = Borderinpixels = integer()
80
81              Sets the wxSizerFlags to have a border of  a  number  of  pixels
82              specified by borderinpixels with the directions specified by di‐
83              rection.
84
85              Prefer to use the overload below or DoubleBorder()  (not  imple‐
86              mented in wx) or TripleBorder() (not implemented in wx) versions
87              instead of hard-coding the border value in pixels to  avoid  too
88              small borders on devices with high DPI displays.
89
90       centre(This) -> wxSizerFlags()
91
92              Types:
93
94                 This = wxSizerFlags()
95
96              See: center/1.
97
98       center(This) -> wxSizerFlags()
99
100              Types:
101
102                 This = wxSizerFlags()
103
104              Sets the object of the wxSizerFlags to center itself in the area
105              it is given.
106
107       expand(This) -> wxSizerFlags()
108
109              Types:
110
111                 This = wxSizerFlags()
112
113              Sets the object of the wxSizerFlags to expand to  fill  as  much
114              area as it can.
115
116       left(This) -> wxSizerFlags()
117
118              Types:
119
120                 This = wxSizerFlags()
121
122              Aligns the object to the left, similar for Align(wxALIGN_LEFT).
123
124              Unlike  align/2,  this method doesn't change the vertical align‐
125              ment of the item.
126
127       proportion(This, Proportion) -> wxSizerFlags()
128
129              Types:
130
131                 This = wxSizerFlags()
132                 Proportion = integer()
133
134              Sets the proportion of this wxSizerFlags to proportion.
135
136       right(This) -> wxSizerFlags()
137
138              Types:
139
140                 This = wxSizerFlags()
141
142              Aligns  the  object  to  the  right,   similar   for   Align(wx‐
143              ALIGN_RIGHT).
144
145              Unlike  align/2,  this method doesn't change the vertical align‐
146              ment of the item.
147
148       destroy(This :: wxSizerFlags()) -> ok
149
150              Destroys the object.
151
152
153
154wxWidgets team.                     wx 2.1                     wxSizerFlags(3)