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

NAME

6       wxStaticBox - Functions for wxStaticBox class
7

DESCRIPTION

9       A static box is a rectangle drawn around other windows to denote a log‐
10       ical grouping of items.
11
12       Note that while the previous versions required that  windows  appearing
13       inside  a static box be created as its siblings (i.e. use the same par‐
14       ent as the static box itself), since wxWidgets 2.9.1 it is also  possi‐
15       ble  to create them as children of wxStaticBox itself and you are actu‐
16       ally encouraged to do it like this if compatibility with  the  previous
17       versions is not important.
18
19       So the new recommended way to create static box is:
20
21       While the compatible - and now deprecated - way is
22
23       Also  note that there is a specialized wxSizer class (wxStaticBoxSizer)
24       which can be used as an easier way to pack items into a static box.
25
26       See: wxStaticText, wxStaticBoxSizer
27
28       This class is derived (and can use functions) from: wxControl  wxWindow
29       wxEvtHandler
30
31       wxWidgets docs: wxStaticBox
32

DATA TYPES

34       wxStaticBox() = wx:wx_object()
35

EXPORTS

37       new() -> wxStaticBox()
38
39              Default constructor.
40
41       new(Parent, Id, Label) -> wxStaticBox()
42
43              Types:
44
45                 Parent = wxWindow:wxWindow()
46                 Id = integer()
47                 Label = unicode:chardata()
48
49       new(Parent, Id, Label, Options :: [Option]) -> wxStaticBox()
50
51              Types:
52
53                 Parent = wxWindow:wxWindow()
54                 Id = integer()
55                 Label = unicode:chardata()
56                 Option =
57                     {pos, {X :: integer(), Y :: integer()}} |
58                     {size, {W :: integer(), H :: integer()}} |
59                     {style, integer()}
60
61              Constructor, creating and showing a static box.
62
63              See: create/5
64
65       destroy(This :: wxStaticBox()) -> ok
66
67              Constructor for a static box using the given window as label.
68
69              This  constructor  takes  a  pointer to an arbitrary window (al‐
70              though usually a wxCheckBox or a wxRadioButton) instead of  just
71              the  usual text label and puts this window at the top of the box
72              at the place where the label would be shown.
73
74              The label window must be a non-null, fully  created  window  and
75              will  become  a child of this wxStaticBox, i.e. it will be owned
76              by this control and will be deleted when the wxStaticBox  itself
77              is deleted.
78
79              An example of creating a wxStaticBox with window as a label:
80
81              Currently this constructor is only available in wxGTK and wxMSW,
82              use wxHAS_WINDOW_LABEL_IN_STATIC_BOX to check whether it can  be
83              used at compile-time.
84
85              Since: 3.1.1 Destructor, destroying the group box.
86
87       create(This, Parent, Id, Label) -> boolean()
88
89              Types:
90
91                 This = wxStaticBox()
92                 Parent = wxWindow:wxWindow()
93                 Id = integer()
94                 Label = unicode:chardata()
95
96       create(This, Parent, Id, Label, Options :: [Option]) -> boolean()
97
98              Types:
99
100                 This = wxStaticBox()
101                 Parent = wxWindow:wxWindow()
102                 Id = integer()
103                 Label = unicode:chardata()
104                 Option =
105                     {pos, {X :: integer(), Y :: integer()}} |
106                     {size, {W :: integer(), H :: integer()}} |
107                     {style, integer()}
108
109              Creates the static box for two-step construction.
110
111              See new/4 for further details.
112
113
114
115wxWidgets team.                     wx 2.1                      wxStaticBox(3)