interface/wx/statbox.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        statbox.h
   3 // Purpose:     interface of wxStaticBox
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxStaticBox
  11
  12     A static box is a rectangle drawn around other panel items to denote
  13     a logical grouping of items.
  14
  15     Please note that a static box should @b not be used as the parent for the
  16     controls it contains, instead they should be siblings of each other. Although
  17     using a static box as a parent might work in some versions of wxWidgets, it
  18     results in a crash under, for example, wxGTK.
  19
  20     Also, please note that because of this, the order in which you create new
  21     controls is important. Create your wxStaticBox control @b before any
  22     siblings that are to appear inside the wxStaticBox in order to preserve the
  23     correct Z-Order of controls.
  24
  25     @library{wxcore}
  26     @category{ctrl}
  27     <!-- @appearance{staticbox.png} -->
  28
  29     @see wxStaticText
  30 */
  31 class wxStaticBox : public wxControl
  32 {
  33 public:
  34     /**
  35       Default constructor
  36     */
  37     wxStaticBox();
  38
  39     /**
  40         Constructor, creating and showing a static box.
  41
  42         @param parent
  43             Parent window. Must not be @NULL.
  44         @param id
  45             Window identifier. The value wxID_ANY indicates a default value.
  46         @param label
  47             Text to be displayed in the static box, the empty string for no label.
  48         @param pos
  49             Window position. If wxDefaultPosition is specified then a default
  50         position is chosen.
  51         @param size
  52             Checkbox size. If the size (-1, -1) is specified then a default size is
  53         chosen.
  54         @param style
  55             Window style. See wxStaticBox.
  56         @param name
  57             Window name.
  58
  59         @see Create()
  60     */
  61     wxStaticBox(wxWindow* parent, wxWindowID id,
  62                 const wxString& label,
  63                 const wxPoint& pos = wxDefaultPosition,
  64                 const wxSize& size = wxDefaultSize,
  65                 long style = 0,
  66                 const wxString& name = "staticBox");
  67
  68     /**
  69         Destructor, destroying the group box.
  70     */
  71     virtual ~wxStaticBox();
  72
  73     /**
  74         Creates the static box for two-step construction. See wxStaticBox()
  75         for further details.
  76     */
  77     bool Create(wxWindow* parent, wxWindowID id,
  78                 const wxString& label,
  79                 const wxPoint& pos = wxDefaultPosition,
  80                 const wxSize& size = wxDefaultSize,
  81                 long style = 0,
  82                 const wxString& name = "staticBox");
  83 };
  84