wxWidgets/interface/wx/statbox.h
Vadim Zeitlin 338c3ec73a Correct examples in wxStaticBox(Sizer) documentation.
Added missing wxID_ANY in the control creation calls.

Also rephrase/extend the discussion about creating windows shown inside the
static box as its children or siblings.

Closes #11086.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61628 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2009-08-07 12:39:41 +00:00

103 lines
3.2 KiB
Objective-C

/////////////////////////////////////////////////////////////////////////////
// Name: statbox.h
// Purpose: interface of wxStaticBox
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@class wxStaticBox
A static box is a rectangle drawn around other windows to denote
a logical grouping of items.
Note that while the previous versions required that windows appearing
inside a static box be created as its siblings (i.e. use the same parent as
the static box itself), since wxWidgets 2.9.1 it is also possible to create
them as children of wxStaticBox itself and you are actually encouraged to
do it like this if compatibility with the previous versions is not
important.
So the new recommended way to create static box is:
@code
void MyFrame::CreateControls()
{
wxPanel *panel = new wxPanel(this);
wxStaticBox *box = new wxStaticBox(panel, wxID_ANY, "StaticBox");
new wxStaticText(box, wxID_ANY "This window is a child of the staticbox");
...
}
@endcode
While the compatible -- and now deprecated -- way is
@code
wxStaticBox *box = new wxStaticBox(panel, wxID_ANY, "StaticBox");
new wxStaticText(panel, wxID_ANY "This window is a child of the panel");
...
@endcode
Also note that there is a specialized wxSizer class (wxStaticBoxSizer) which can
be used as an easier way to pack items into a static box.
@library{wxcore}
@category{ctrl}
@appearance{staticbox.png}
@see wxStaticText, wxStaticBoxSizer
*/
class wxStaticBox : public wxControl
{
public:
/**
Default constructor
*/
wxStaticBox();
/**
Constructor, creating and showing a static box.
@param parent
Parent window. Must not be @NULL.
@param id
Window identifier. The value wxID_ANY indicates a default value.
@param label
Text to be displayed in the static box, the empty string for no label.
@param pos
Window position.
If ::wxDefaultPosition is specified then a default position is chosen.
@param size
Checkbox size.
If ::wxDefaultSize is specified then a default size is chosen.
@param style
Window style. See wxStaticBox.
@param name
Window name.
@see Create()
*/
wxStaticBox(wxWindow* parent, wxWindowID id,
const wxString& label,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxStaticBoxNameStr);
/**
Destructor, destroying the group box.
*/
virtual ~wxStaticBox();
/**
Creates the static box for two-step construction.
See wxStaticBox() for further details.
*/
bool Create(wxWindow* parent, wxWindowID id, const wxString& label,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, long style = 0,
const wxString& name = wxStaticBoxNameStr);
};