From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Thu, 8 May 2008 22:50:40 +0000 (+0000)
Subject: update the documentation after the patch 1876663
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/4fc3ee301bab3cc9e2f8493528be5e027d1f1d72

update the documentation after the patch 1876663

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53501 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/interface/wrapsizer.h b/interface/wrapsizer.h
index 3109e8cd6e..9a186de2fc 100644
--- a/interface/wrapsizer.h
+++ b/interface/wrapsizer.h
@@ -29,10 +29,15 @@ public:
     /**
         Constructor for a wxWrapSizer. @a orient determines the primary direction of
         the sizer (the most common case being @c wxHORIZONTAL). The flags
-        parameter may have the value @c wxEXTEND_LAST_ON_EACH_LINE which will
-        cause the last item on each line to use any remaining space on that line.
+        parameter can be a combination of the values @c
+        wxEXTEND_LAST_ON_EACH_LINE which will cause the last item on each line
+        to use any remaining space on that line and @c wxREMOVE_LEADING_SPACES
+        which removes any spacer elements from the beginning of a row. Both of
+        these flags are on by default.
     */
-    wxWrapSizer(int orient, int flags);
+    wxWrapSizer(int orient = wxHORIZONTAL,
+                int flags = wxEXTEND_LAST_ON_EACH_LINE |
+                            wxREMOVE_LEADING_SPACES);
 
     /**
         Not used by an application. This is the mechanism by which sizers can inform
@@ -43,5 +48,16 @@ public:
     */
     bool InformFirstDirection(int direction, int size,
                               int availableOtherDir);
+
+protected:
+    /**
+        Can be overridden in the derived classes to treat some normal items as
+        spacers.
+
+        This method is used to determine whether the given @a item should be
+        considered to be a spacer for the purposes of @c wxREMOVE_LEADING_SPACES
+        implementation. By default only returns @true for the real spacers.
+     */
+    virtual bool IsSpaceItem(wxSizerItem *item) const;
 };