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