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