]>
Commit | Line | Data |
---|---|---|
a660d684 KB |
1 | \section{\class{wxStaticBox}}\label{wxstaticbox} |
2 | ||
3 | A static box is a rectangle drawn around other panel items to denote | |
4 | a logical grouping of items. | |
5 | ||
8d753488 VZ |
6 | Please note that a static box should {\bf not} be used as the parent for the |
7 | controls it contains, instead they should be siblings of each other. Although | |
fc2171bd | 8 | using a static box as a parent might work in some versions of wxWidgets, it |
34c29c43 RD |
9 | results in a crash under, for example, wxGTK. |
10 | ||
11 | Also, please note that because of this, the order in which you create new | |
12 | controls is important. Create your wxStaticBox control {\bf before} any | |
13 | siblings that are to appear inside the wxStaticBox in order to preserve the | |
14 | correct Z-Order of controls. | |
8d753488 | 15 | |
a660d684 KB |
16 | \wxheading{Derived from} |
17 | ||
18 | \helpref{wxControl}{wxcontrol}\\ | |
19 | \helpref{wxWindow}{wxwindow}\\ | |
20 | \helpref{wxEvtHandler}{wxevthandler}\\ | |
21 | \helpref{wxObject}{wxobject} | |
22 | ||
954b8ae6 JS |
23 | \wxheading{Include files} |
24 | ||
25 | <wx/statbox.h> | |
26 | ||
a7af285d VZ |
27 | \wxheading{Library} |
28 | ||
29 | \helpref{wxCore}{librarieslist} | |
30 | ||
a660d684 KB |
31 | \wxheading{Window styles} |
32 | ||
33 | There are no special styles for this control. | |
34 | ||
35 | See also \helpref{window styles overview}{windowstyles}. | |
36 | ||
37 | \wxheading{See also} | |
38 | ||
39 | \helpref{wxStaticText}{wxstatictext} | |
40 | ||
41 | \latexignore{\rtfignore{\wxheading{Members}}} | |
42 | ||
15d83f72 | 43 | \membersection{wxStaticBox::wxStaticBox}\label{wxstaticboxctor} |
a660d684 KB |
44 | |
45 | \func{}{wxStaticBox}{\void} | |
46 | ||
47 | Default constructor. | |
48 | ||
eaaa6a06 | 49 | \func{}{wxStaticBox}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp |
a660d684 | 50 | \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp |
eaaa6a06 | 51 | \param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBox"}} |
a660d684 KB |
52 | |
53 | Constructor, creating and showing a static box. | |
54 | ||
55 | \wxheading{Parameters} | |
56 | ||
57 | \docparam{parent}{Parent window. Must not be NULL.} | |
58 | ||
59 | \docparam{id}{Window identifier. A value of -1 indicates a default value.} | |
60 | ||
61 | \docparam{label}{Text to be displayed in the static box, the empty string for no label.} | |
62 | ||
63 | \docparam{pos}{Window position. If the position (-1, -1) is specified then a default position is chosen.} | |
64 | ||
65 | \docparam{size}{Checkbox size. If the size (-1, -1) is specified then a default size is chosen.} | |
66 | ||
67 | \docparam{style}{Window style. See \helpref{wxStaticBox}{wxstaticbox}.} | |
68 | ||
69 | \docparam{name}{Window name.} | |
70 | ||
71 | \wxheading{See also} | |
72 | ||
73 | \helpref{wxStaticBox::Create}{wxstaticboxcreate} | |
74 | ||
15d83f72 | 75 | \membersection{wxStaticBox::\destruct{wxStaticBox}}\label{wxstaticboxdtor} |
a660d684 KB |
76 | |
77 | \func{void}{\destruct{wxStaticBox}}{\void} | |
78 | ||
79 | Destructor, destroying the group box. | |
80 | ||
81 | \membersection{wxStaticBox::Create}\label{wxstaticboxcreate} | |
82 | ||
eaaa6a06 | 83 | \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp |
a660d684 | 84 | \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp |
eaaa6a06 | 85 | \param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBox"}} |
a660d684 | 86 | |
15d83f72 | 87 | Creates the static box for two-step construction. See \helpref{wxStaticBox::wxStaticBox}{wxstaticboxctor}\rtfsp |
a660d684 KB |
88 | for further details. |
89 | ||
90 |