Fix assorted typos in comments and other non-code.

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

diff --git a/include/wx/sizer.h b/include/wx/sizer.h
index ac8f5b6f34fe3bec689503be5ff11b7ea645cd06..7d20b548c8bffc6eb4cbdfd6f4f15e1e3cb7ec91 100644 (file)
--- a/include/wx/sizer.h
+++ b/include/wx/sizer.h
@@ -4,7 +4,6 @@
 // Author:      Robert Roebling and Robin Dunn
 // Modified by: Ron Lee, Vadim Zeitlin (wxSizerFlags)
 // Created:
-// RCS-ID:      $Id$
 // Copyright:   (c) Robin Dunn, Robert Roebling
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
@@ -125,6 +124,10 @@ public:
 
     wxSizerFlags& Border(int direction, int borderInPixels)
     {
+        wxCHECK_MSG( !(direction & ~wxALL), *this,
+                     wxS("direction must be a combination of wxDirection ")
+                     wxS("enum values.") );
+
         m_flags &= ~wxALL;
         m_flags |= direction;
 
@@ -251,10 +254,10 @@ class WXDLLIMPEXP_CORE wxSizerItem : public wxObject
 public:
     // window
     wxSizerItem( wxWindow *window,
-                 int proportion,
-                 int flag,
-                 int border,
-                 wxObject* userData );
+                 int proportion=0,
+                 int flag=0,
+                 int border=0,
+                 wxObject* userData=NULL );
 
     // window with flags
     wxSizerItem(wxWindow *window, const wxSizerFlags& flags)
@@ -266,10 +269,10 @@ public:
 
     // subsizer
     wxSizerItem( wxSizer *sizer,
-                 int proportion,
-                 int flag,
-                 int border,
-                 wxObject* userData );
+                 int proportion=0,
+                 int flag=0,
+                 int border=0,
+                 wxObject* userData=NULL );
 
     // sizer with flags
     wxSizerItem(wxSizer *sizer, const wxSizerFlags& flags)
@@ -282,10 +285,10 @@ public:
     // spacer
     wxSizerItem( int width,
                  int height,
-                 int proportion,
-                 int flag,
-                 int border,
-                 wxObject* userData);
+                 int proportion=0,
+                 int flag=0,
+                 int border=0,
+                 wxObject* userData=NULL);
 
     // spacer with flags
     wxSizerItem(int width, int height, const wxSizerFlags& flags)
@@ -311,6 +314,10 @@ public:
         { return m_minSize; }
     wxSize GetMinSizeWithBorder() const;
 
+    wxSize GetMaxSize() const
+        { return IsWindow() ? m_window->GetMaxSize() : wxDefaultSize; }
+    wxSize GetMaxSizeWithBorder() const;
+
     void SetMinSize(const wxSize& size)
     {
         if ( IsWindow() )
@@ -436,6 +443,10 @@ protected:
     void DoSetSizer(wxSizer *sizer);
     void DoSetSpacer(const wxSize& size);
 
+    // Add the border specified for this item to the given size
+    // if it's != wxDefaultSize, just return wxDefaultSize otherwise.
+    wxSize AddBorderToSize(const wxSize& size) const;
+
     // discriminated union: depending on m_kind one of the fields is valid
     enum
     {
@@ -542,7 +553,11 @@ public:
                         int width,
                         int height,
                         const wxSizerFlags& flags);
-    virtual wxSizerItem* Insert( size_t index, wxSizerItem *item);
+
+    // NB: do _not_ override this function in the derived classes, this one is
+    //     virtual for compatibility reasons only to allow old code overriding
+    //     it to continue to work, override DoInsert() instead in the new code
+    virtual wxSizerItem* Insert(size_t index, wxSizerItem *item);
 
     wxSizerItem* InsertSpacer(size_t index, int size);
     wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1);
@@ -597,7 +612,7 @@ public:
     virtual void DeleteWindows();
 
     // Inform sizer about the first direction that has been decided (by parent item)
-    // Returns true if it made use of the informtion (and recalculated min size)
+    // Returns true if it made use of the information (and recalculated min size)
     virtual bool InformFirstDirection( int WXUNUSED(direction), int WXUNUSED(size), int WXUNUSED(availableOtherDir) )
         { return false; }
 
@@ -661,6 +676,10 @@ public:
         m_position = pos;
         m_size = size;
         Layout();
+
+        // This call is required for wxWrapSizer to be able to calculate its
+        // minimal size correctly.
+        InformFirstDirection(wxHORIZONTAL, size.x, size.y);
     }
     void SetDimension(int x, int y, int width, int height)
         { SetDimension(wxPoint(x, y), wxSize(width, height)); }
@@ -695,6 +714,10 @@ public:
 
     void Show(bool show) { ShowItems(show); }
 
+    // This is the ShowItems() counterpart and returns true if any of the sizer
+    // items are shown.
+    virtual bool AreAnyItemsShown() const;
+
 protected:
     wxSize              m_size;
     wxSize              m_minSize;
@@ -713,6 +736,10 @@ protected:
     virtual bool DoSetItemMinSize( wxSizer *sizer, int width, int height );
     virtual bool DoSetItemMinSize( size_t index, int width, int height );
 
+    // insert a new item into m_children at given index and return the item
+    // itself
+    virtual wxSizerItem* DoInsert(size_t index, wxSizerItem *item);
+
 private:
     DECLARE_CLASS(wxSizer)
 };
@@ -733,13 +760,6 @@ public:
     wxGridSizer( int rows, int cols, int vgap, int hgap );
     wxGridSizer( int rows, int cols, const wxSize& gap );
 
-    virtual wxSizerItem *Insert(size_t index, wxSizerItem *item);
-
-#ifdef __WXOSX__
-    // TODO change to better condition
-    using wxSizer::Insert;
-#endif
-
     virtual void RecalcSizes();
     virtual wxSize CalcMin();
 
@@ -779,6 +799,8 @@ protected:
     int    m_vgap;
     int    m_hgap;
 
+    virtual wxSizerItem *DoInsert(size_t index, wxSizerItem *item);
+
     void SetItemBounds( wxSizerItem *item, int x, int y, int w, int h );
 
     // returns the number of columns/rows needed for the current total number
@@ -791,7 +813,7 @@ protected:
             "Can't calculate number of cols if number of rows is not specified"
         );
 
-        return (m_children.GetCount() + m_rows - 1) / m_rows;
+        return int(m_children.GetCount() + m_rows - 1) / m_rows;
     }
 
     int CalcRows() const
@@ -802,7 +824,7 @@ protected:
             "Can't calculate number of cols if number of rows is not specified"
         );
 
-        return (m_children.GetCount() + m_cols - 1) / m_cols;
+        return int(m_children.GetCount() + m_cols - 1) / m_cols;
     }
 
 private:
@@ -1014,6 +1036,7 @@ public:
 
     // override to hide/show the static box as well
     virtual void ShowItems (bool show);
+    virtual bool AreAnyItemsShown() const;
 
     virtual bool Detach( wxWindow *window );
     virtual bool Detach( wxSizer *sizer ) { return wxBoxSizer::Detach(sizer); }
@@ -1110,6 +1133,12 @@ inline void wxSizerItem::SetSpacer(int width, int height)
 
 #endif // WXWIN_COMPATIBILITY_2_8
 
+inline wxSizerItem*
+wxSizer::Insert(size_t index, wxSizerItem *item)
+{
+    return DoInsert(index, item);
+}
+
 
 inline wxSizerItem*
 wxSizer::Add( wxSizerItem *item )