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