]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/statbox.tex
several fixes
[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
6\wxheading{Derived from}
7
8\helpref{wxControl}{wxcontrol}\\
9\helpref{wxWindow}{wxwindow}\\
10\helpref{wxEvtHandler}{wxevthandler}\\
11\helpref{wxObject}{wxobject}
12
13\wxheading{Window styles}
14
15There are no special styles for this control.
16
17See also \helpref{window styles overview}{windowstyles}.
18
19\wxheading{See also}
20
21\helpref{wxStaticText}{wxstatictext}
22
23\latexignore{\rtfignore{\wxheading{Members}}}
24
25\membersection{wxStaticBox::wxStaticBox}\label{wxstaticboxconstr}
26
27\func{}{wxStaticBox}{\void}
28
29Default constructor.
30
eaaa6a06 31\func{}{wxStaticBox}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
a660d684 32\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
eaaa6a06 33\param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBox"}}
a660d684
KB
34
35Constructor, creating and showing a static box.
36
37\wxheading{Parameters}
38
39\docparam{parent}{Parent window. Must not be NULL.}
40
41\docparam{id}{Window identifier. A value of -1 indicates a default value.}
42
43\docparam{label}{Text to be displayed in the static box, the empty string for no label.}
44
45\docparam{pos}{Window position. If the position (-1, -1) is specified then a default position is chosen.}
46
47\docparam{size}{Checkbox size. If the size (-1, -1) is specified then a default size is chosen.}
48
49\docparam{style}{Window style. See \helpref{wxStaticBox}{wxstaticbox}.}
50
51\docparam{name}{Window name.}
52
53\wxheading{See also}
54
55\helpref{wxStaticBox::Create}{wxstaticboxcreate}
56
57\membersection{wxStaticBox::\destruct{wxStaticBox}}
58
59\func{void}{\destruct{wxStaticBox}}{\void}
60
61Destructor, destroying the group box.
62
63\membersection{wxStaticBox::Create}\label{wxstaticboxcreate}
64
eaaa6a06 65\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
a660d684 66\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
eaaa6a06 67\param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBox"}}
a660d684
KB
68
69Creates the static box for two-step construction. See \helpref{wxStaticBox::wxStaticBox}{wxstaticboxconstr}\rtfsp
70for further details.
71
72