Applied minor documentation corrections to wxRegKey from charles (fixes #10407).

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

diff --git a/interface/wx/sizer.h b/interface/wx/sizer.h
index 847cfd7a06a34feea152b9daa1fdaab1a24d8bee..86269f643f85c8cfdb52b3d55a8a779d5ff549bb 100644 (file)
--- a/interface/wx/sizer.h
+++ b/interface/wx/sizer.h
@@ -526,43 +526,6 @@ public:
 
 
 
-/**
-    @class wxNotebookSizer
-
-    @deprecated
-    This class is deprecated and should not be used in new code! It is no
-    longer needed, wxNotebook control can be inserted
-    into any sizer class and its minimal size will be determined correctly.
-
-    wxNotebookSizer is a specialized sizer to make sizers work in connection
-    with using notebooks. This sizer is different from any other sizer as you
-    must not add any children to it - instead, it queries the notebook class
-    itself.  The only thing this sizer does is to determine the size of the
-    biggest page of the notebook and report an adjusted minimal size to a more
-    toplevel sizer.
-
-    @library{wxbase}
-    @category{winlayout}
-
-    @see wxSizer, wxNotebook,
-         @ref overview_sizer "Sizers overview"
-*/
-class wxNotebookSizer : public wxSizer
-{
-public:
-    /**
-        Constructor. It takes an associated notebook as its only parameter.
-    */
-    wxNotebookSizer(wxNotebook* notebook);
-
-    /**
-        Returns the notebook associated with the sizer.
-    */
-    wxNotebook* GetNotebook();
-};
-
-
-
 /**
     @class wxFlexGridSizer
 
@@ -643,15 +606,24 @@ public:
         Returns the value that specifies how the sizer grows in the "non-flexible"
         direction if there is one.
 
+        The behaviour of the elements in the flexible direction (i.e. both rows
+        and columns by default, or rows only if GetFlexibleDirection() is @c
+        wxVERTICAL or columns only if it is @c wxHORIZONTAL) is always governed
+        by their proportion as specified in the call to AddGrowableRow() or
+        AddGrowableCol(). What happens in the other direction depends on the
+        value of returned by this function as described below.
+
         @return
             One of the following values:
-            - wxFLEX_GROWMODE_NONE: Sizer doesn't grow in the non-flexible direction.
-            - wxFLEX_GROWMODE_SPECIFIED: Sizer honors growable columns/rows set with
-              AddGrowableCol() and AddGrowableRow(). In this case equal sizing applies
-              to minimum sizes of columns or rows (this is the default value).
+            - wxFLEX_GROWMODE_NONE: Sizer doesn't grow its elements at all in
+              the non-flexible direction.
+            - wxFLEX_GROWMODE_SPECIFIED: Sizer honors growable columns/rows set
+              with AddGrowableCol() and AddGrowableRow() in the non-flexible
+              direction as well. In this case equal sizing applies to minimum
+              sizes of columns or rows (this is the default value).
             - wxFLEX_GROWMODE_ALL: Sizer equally stretches all columns or rows in
-              the non-flexible direction, whether they are growable or not in the
-              flexible direction.
+              the non-flexible direction, independently of the proportions
+              applied in the flexible direction.
 
         @see SetFlexibleDirection(), SetNonFlexibleGrowMode()
     */
@@ -1119,6 +1091,14 @@ public:
     */
     wxWindow* GetContainingWindow() const;
 
+    /**
+       Returns the number of items in the sizer.
+
+       If you just need to test whether the sizer is empty or not you can also
+       use IsEmpty() function.
+    */
+    size_t GetItemCount() const;
+
     /**
         Finds wxSizerItem which holds the given @a window.
         Use parameter @a recursive to search in subsizers too.
@@ -1269,6 +1249,13 @@ public:
     */
     wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1);
 
+    /**
+        Return @true if the sizer has no elements.
+
+        @see GetItemCount()
+     */
+    bool IsEmpty() const;
+
     /**
         Returns @true if the @a window is shown.