fixing file paths after renaming

[wxWidgets.git] / interface / wrapsizer.h

diff --git a/interface/wrapsizer.h b/interface/wrapsizer.h
index e79832704c814a0b45ef1abf9f6ca1a877deae6a..9a186de2fce58e6c6eada4564c46f12648d02108 100644 (file)
--- a/interface/wrapsizer.h
+++ b/interface/wrapsizer.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wrapsizer.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wrapsizer.h

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

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


@@ -9,40 +9,55 @@
 /**
     @class wxWrapSizer
     @wxheader{wrapsizer.h}
 /**
     @class wxWrapSizer
     @wxheader{wrapsizer.h}

-    
-    A wrap sizer lays out its items in a single line, like a box sizer -- as long 
-    as there is space available in that direction. Once all available space in 
+
+    A wrap sizer lays out its items in a single line, like a box sizer -- as long
+    as there is space available in that direction. Once all available space in

     the primary direction has been used, a new line is added and items are added
     there.
     the primary direction has been used, a new line is added and items are added
     there.

-    
+

     So a wrap sizer has a primary orientation for adding items, and adds lines
     So a wrap sizer has a primary orientation for adding items, and adds lines

-    as needed in the secondary direction. 
-    
+    as needed in the secondary direction.
+

     @library{wxcore}
     @category{winlayout}
     @library{wxcore}
     @category{winlayout}

-    
-    @seealso
-    wxBoxSizer, wxSizer, @ref overview_sizeroverview "Sizer overview"
+
+    @see wxBoxSizer, wxSizer, @ref overview_sizeroverview "Sizer overview"

 */
 class wxWrapSizer : public wxBoxSizer
 {
 public:
     /**
 */
 class wxWrapSizer : public wxBoxSizer
 {
 public:
     /**

-        Constructor for a wxWrapSizer. @e orient determines the primary direction of
+        Constructor for a wxWrapSizer. @a orient determines the primary direction of

         the sizer (the most common case being @c wxHORIZONTAL). The flags
         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 
+        Not used by an application. This is the mechanism by which sizers can inform

         sub-items of the first determined size component. The sub-item can then better
         sub-items of the first determined size component. The sub-item can then better

-        determine its size requirements. 
-        
+        determine its size requirements.

         Returns @true if the information was used (and the sub-item min size was
         updated).
     */
     bool InformFirstDirection(int direction, int size,
                               int availableOtherDir);
         Returns @true if the information was used (and the sub-item min size was
         updated).
     */
     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;

 };
 };

+