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