]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/statbox.tex
added wxDEPRECATED_INLINE, use it for wxPixelData<wxBitmap>::UseAlpha() to fix Sun...
[wxWidgets.git] / docs / latex / wx / statbox.tex
... / ...
CommitLineData
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
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
8using a static box as a parent might work in some versions of wxWidgets, it
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.
15
16\wxheading{Derived from}
17
18\helpref{wxControl}{wxcontrol}\\
19\helpref{wxWindow}{wxwindow}\\
20\helpref{wxEvtHandler}{wxevthandler}\\
21\helpref{wxObject}{wxobject}
22
23\wxheading{Include files}
24
25<wx/statbox.h>
26
27\wxheading{Library}
28
29\helpref{wxCore}{librarieslist}
30
31\wxheading{Window styles}
32
33There are no special styles for this control.
34
35See also \helpref{window styles overview}{windowstyles}.
36
37\wxheading{See also}
38
39\helpref{wxStaticText}{wxstatictext}
40
41\latexignore{\rtfignore{\wxheading{Members}}}
42
43\membersection{wxStaticBox::wxStaticBox}\label{wxstaticboxctor}
44
45\func{}{wxStaticBox}{\void}
46
47Default constructor.
48
49\func{}{wxStaticBox}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
50\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
51\param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBox"}}
52
53Constructor, 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
75\membersection{wxStaticBox::\destruct{wxStaticBox}}\label{wxstaticboxdtor}
76
77\func{void}{\destruct{wxStaticBox}}{\void}
78
79Destructor, destroying the group box.
80
81\membersection{wxStaticBox::Create}\label{wxstaticboxcreate}
82
83\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
84\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
85\param{long}{ style = 0}, \param{const wxString\& }{name = ``staticBox"}}
86
87Creates the static box for two-step construction. See \helpref{wxStaticBox::wxStaticBox}{wxstaticboxctor}\rtfsp
88for further details.
89
90