interface/statbox.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        statbox.h
   3 // Purpose:     documentation for wxStaticBox class
   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     @seealso
  31     wxStaticText
  32 */
  33 class wxStaticBox : public wxControl
  34 {
  35 public:
  36     //@{
  37     /**
  38         Constructor, creating and showing a static box.
  39
  40         @param parent
  41         Parent window. Must not be @NULL.
  42
  43         @param id
  44         Window identifier. The value wxID_ANY indicates a default value.
  45
  46         @param label
  47         Text to be displayed in the static box, the empty string for no label.
  48
  49         @param pos
  50         Window position. If wxDefaultPosition is specified then a default position
  51         is chosen.
  52
  53         @param size
  54         Checkbox size. If the size (-1, -1) is specified then a default size is chosen.
  55
  56         @param style
  57         Window style. See wxStaticBox.
  58
  59         @param name
  60         Window name.
  61
  62         @sa Create()
  63     */
  64     wxStaticBox();
  65     wxStaticBox(wxWindow* parent, wxWindowID id,
  66                 const wxString& label,
  67                 const wxPoint& pos = wxDefaultPosition,
  68                 const wxSize& size = wxDefaultSize,
  69                 long style = 0,
  70                 const wxString& name = "staticBox");
  71     //@}
  72
  73     /**
  74         Destructor, destroying the group box.
  75     */
  76     ~wxStaticBox();
  77
  78     /**
  79         Creates the static box for two-step construction. See wxStaticBox()
  80         for further details.
  81     */
  82     bool Create(wxWindow* parent, wxWindowID id,
  83                 const wxString& label,
  84                 const wxPoint& pos = wxDefaultPosition,
  85                 const wxSize& size = wxDefaultSize,
  86                 long style = 0,
  87                 const wxString& name = "staticBox");
  88 };