document GetValue() behaviour when called from an event handler processing change...

[wxWidgets.git] / interface / statbox.h

diff --git a/interface/statbox.h b/interface/statbox.h
index 08734706ee5c12afc2902096a66f6bb025240047..b6719749cbae2ba6403db47202cfd22a59970cdf 100644 (file)
--- a/interface/statbox.h
+++ b/interface/statbox.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        statbox.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        statbox.h

-// Purpose:     documentation for wxStaticBox class
+// Purpose:     interface of wxStaticBox

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -9,66 +9,62 @@
 /**
     @class wxStaticBox
     @wxheader{statbox.h}
 /**
     @class wxStaticBox
     @wxheader{statbox.h}

-    
+

     A static box is a rectangle drawn around other panel items to denote
     a logical grouping of items.
     A static box is a rectangle drawn around other panel items to denote
     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
     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. 
-    
-    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 
+    results in a crash under, for example, wxGTK.
+
+    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.
     correct Z-Order of controls.

-    
+

     @library{wxcore}
     @category{ctrl}
     @library{wxcore}
     @category{ctrl}

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

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

-    //@{

     /**
     /**

-        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 the size (-1, -1) is specified then a default size is chosen.
-        
-        @param style 
-        Window style. See wxStaticBox.
-        
-        @param name 
-        Window name.
-        
-        @sa Create()
+      Default constructor

     */
     wxStaticBox();
     */
     wxStaticBox();

-        wxStaticBox(wxWindow* parent, wxWindowID id,
-                    const wxString& label,
-                    const wxPoint& pos = wxDefaultPosition,
-                    const wxSize& size = wxDefaultSize,
-                    long style = 0,
-                    const wxString& name = "staticBox");
-    //@}
+    
+    /**
+        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 the size (-1, -1) 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 = "staticBox");

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


@@ -86,3 +82,4 @@ public:
                 long style = 0,
                 const wxString& name = "staticBox");
 };
                 long style = 0,
                 const wxString& name = "staticBox");
 };

+