Resolve ambiguity between GetClientXXX() methods in wxOSX wxComboBox.

[wxWidgets.git] / interface / wx / statbox.h

diff --git a/interface/wx/statbox.h b/interface/wx/statbox.h
index 7fa19dc21a4f5b811091455a39f05af76241dd7e..d10a693c128e1abe42fbf7d9573edc46804ab8a3 100644 (file)
--- a/interface/wx/statbox.h
+++ b/interface/wx/statbox.h
@@ -3,30 +3,50 @@
 // Purpose:     interface of wxStaticBox
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxStaticBox
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxStaticBox
 
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxStaticBox
 

-    A static box is a rectangle drawn around other panel items to denote
+    A static box is a rectangle drawn around other windows to denote

     a logical grouping of items.
 
     a logical grouping of items.
 

-    Please note that a static box should @b not be used as the parent for the
-    controls it contains, instead they should be siblings of each other. Although
-    using a static box as a parent might work in some versions of wxWidgets, it
-    results in a crash under, for example, wxGTK.
+    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.

 
 

-    Also, please note that because of this, the order in which you create new
-    controls is important. Create your wxStaticBox control @b before any
-    siblings that are to appear inside the wxStaticBox in order to preserve the
-    correct Z-Order of controls.
+    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}
 
     @library{wxcore}
     @category{ctrl}

-    <!-- @appearance{staticbox.png} -->
+    @appearance{staticbox.png}

 
 

-    @see wxStaticText
+    @see wxStaticText, wxStaticBoxSizer

 */
 class wxStaticBox : public wxControl
 {
 */
 class wxStaticBox : public wxControl
 {


@@ -47,10 +67,10 @@ public:
             Text to be displayed in the static box, the empty string for no label.
         @param pos
             Window position.
             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.
+            If ::wxDefaultPosition is specified then a default position is chosen.

         @param size
             Checkbox size.
         @param size
             Checkbox size.

-            If wxDefaultSize is specified then a default size is chosen.
+            If ::wxDefaultSize is specified then a default size is chosen.

         @param style
             Window style. See wxStaticBox.
         @param name
         @param style
             Window style. See wxStaticBox.
         @param name


@@ -63,7 +83,7 @@ public:
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,

-                const wxString& name = "staticBox");
+                const wxString& name = wxStaticBoxNameStr);

 
     /**
         Destructor, destroying the group box.
 
     /**
         Destructor, destroying the group box.


@@ -74,11 +94,9 @@ public:
         Creates the static box for two-step construction.
         See wxStaticBox() for further details.
     */
         Creates the static box for two-step construction.
         See wxStaticBox() for further details.
     */

-    bool Create(wxWindow* parent, wxWindowID id,
-                const wxString& label,
+    bool Create(wxWindow* parent, wxWindowID id, const wxString& label,

                 const wxPoint& pos = wxDefaultPosition,
                 const wxPoint& pos = wxDefaultPosition,

-                const wxSize& size = wxDefaultSize,
-                long style = 0,
-                const wxString& name = "staticBox");
+                const wxSize& size = wxDefaultSize, long style = 0,
+                const wxString& name = wxStaticBoxNameStr);

 };
 
 };