added and documented wxWindow::MoveBefore/AfterInTabOrder()

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

diff --git a/include/wx/sizer.h b/include/wx/sizer.h
index b5f06659551fd8c880b0037d09f3644f3e747895..665a26b5dd3fea27907bf8c6c625e6517d9dab23 100644 (file)
--- a/include/wx/sizer.h
+++ b/include/wx/sizer.h
@@ -1,19 +1,18 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        sizer.h
-// Purpose:     provide wxSizer class for layouting
+// Purpose:     provide wxSizer class for layout
 // Author:      Robert Roebling and Robin Dunn
 // Modified by: Ron Lee
 // Created:
 // RCS-ID:      $Id$
-// Copyright:   (c) Robin Dunn, Dirk Holtwick and Robert Roebling
-//              (c) 2003, Ron Lee
+// Copyright:   (c) Robin Dunn, Robert Roebling
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __WXSIZER_H__
 #define __WXSIZER_H__
 
-#if defined(__GNUG__) && !defined(__APPLE__)
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma interface "sizer.h"
 #endif
 
@@ -60,7 +59,8 @@ public:
                  int border,
                  wxObject* userData );
 
-    ~wxSizerItem();
+    wxSizerItem();
+    virtual ~wxSizerItem();
 
     virtual void DeleteWindows();
 
@@ -74,8 +74,17 @@ public:
 
     wxSize GetMinSize() const
         { return m_minSize; }
+    wxSize GetMinSizeWithBorder() const;
+
+    void SetMinSize(const wxSize& size)
+        {
+            if (IsWindow()) m_window->SetMinSize(size);
+            m_minSize = size;            
+        }
+    void SetMinSize( int x, int y )
+        { SetMinSize(wxSize(x, y)); }    
     void SetInitSize( int x, int y )
-        { m_minSize.x = x; m_minSize.y = y; }
+        { SetMinSize(wxSize(x, y)); }
 
     void SetRatio( int width, int height )
         // if either of dimensions is zero, ratio is assumed to be 1
@@ -112,7 +121,7 @@ public:
     wxWindow *GetWindow() const
         { return m_window; }
     void SetWindow( wxWindow *window )
-        { m_window = window; }
+        { m_window = window; m_minSize = window->GetSize(); }
     wxSizer *GetSizer() const
         { return m_sizer; }
     void SetSizer( wxSizer *sizer )
@@ -153,7 +162,7 @@ protected:
     wxObject    *m_userData;
 
 private:
-    DECLARE_CLASS(wxSizerItem);
+    DECLARE_CLASS(wxSizerItem)
     DECLARE_NO_COPY_CLASS(wxSizerItem)
 };
 
@@ -305,7 +314,7 @@ public:
     bool IsShown( size_t index ) const;
 
     // Recursively call wxWindow::Show () on all sizer items.
-    void ShowItems (bool show);
+    virtual void ShowItems (bool show);
 
 protected:
     wxSize              m_size;
@@ -326,7 +335,7 @@ protected:
     virtual bool DoSetItemMinSize( size_t index, int width, int height );
 
 private:
-    DECLARE_CLASS(wxSizer);
+    DECLARE_CLASS(wxSizer)
 };
 
 //---------------------------------------------------------------------------
@@ -363,7 +372,7 @@ protected:
     void SetItemBounds( wxSizerItem *item, int x, int y, int w, int h );
 
 private:
-    DECLARE_CLASS(wxGridSizer);
+    DECLARE_CLASS(wxGridSizer)
 };
 
 //---------------------------------------------------------------------------
@@ -395,9 +404,9 @@ public:
 
     // set the rows/columns which will grow (the others will remain of the
     // constant initial size)
-    void AddGrowableRow( size_t idx );
+    void AddGrowableRow( size_t idx, int proportion = 0 );
     void RemoveGrowableRow( size_t idx );
-    void AddGrowableCol( size_t idx );
+    void AddGrowableCol( size_t idx, int proportion = 0 );
     void RemoveGrowableCol( size_t idx );
 
 
@@ -413,12 +422,19 @@ public:
     void SetNonFlexibleGrowMode(wxFlexSizerGrowMode mode) { m_growMode = mode; }
     wxFlexSizerGrowMode GetNonFlexibleGrowMode() const { return m_growMode; }
 
-
+    // Read-only access to the row heights and col widths arrays
+    const wxArrayInt& GetRowHeights() const { return m_rowHeights; }
+    const wxArrayInt& GetColWidths() const  { return m_colWidths; }
+    
     // implementation
     virtual void RecalcSizes();
     virtual wxSize CalcMin();
 
 protected:
+    void AdjustForFlexDirection();
+    void AdjustForGrowables(const wxSize& sz, const wxSize& minsz,
+                            int nrows, int ncols);
+    
     // the heights/widths of all rows/columns
     wxArrayInt  m_rowHeights,
                 m_colWidths;
@@ -427,13 +443,20 @@ protected:
     wxArrayInt  m_growableRows,
                 m_growableCols;
 
+    // proportion values of the corresponding growable rows and columns
+    wxArrayInt  m_growableRowsProportions,
+                m_growableColsProportions;
+
     // parameters describing whether the growable cells should be resized in
     // both directions or only one
     int m_flexDirection;
     wxFlexSizerGrowMode m_growMode;
 
+    // saves CalcMin result to optimize RecalcSizes
+    wxSize m_calculatedMinSize;
+
 private:
-    DECLARE_CLASS(wxFlexGridSizer);
+    DECLARE_CLASS(wxFlexGridSizer)
     DECLARE_NO_COPY_CLASS(wxFlexGridSizer)
 };
 
@@ -464,7 +487,7 @@ protected:
     int m_fixedHeight;
 
 private:
-    DECLARE_CLASS(wxBoxSizer);
+    DECLARE_CLASS(wxBoxSizer)
 };
 
 //---------------------------------------------------------------------------
@@ -486,45 +509,81 @@ public:
     wxStaticBox *GetStaticBox() const
         { return m_staticBox; }
 
+    // override to hide/show the static box as well
+    virtual void ShowItems (bool show);
+
 protected:
     wxStaticBox   *m_staticBox;
 
 private:
-    DECLARE_CLASS(wxStaticBoxSizer);
+    DECLARE_CLASS(wxStaticBoxSizer)
     DECLARE_NO_COPY_CLASS(wxStaticBoxSizer)
 };
 
 #endif // wxUSE_STATBOX
 
-//---------------------------------------------------------------------------
-// wxNotebookSizer
-//---------------------------------------------------------------------------
 
-#if wxUSE_NOTEBOOK
+#if WXWIN_COMPATIBILITY_2_4
+// NB: wxBookCtrlSizer and wxNotebookSizer are deprecated, they
+//     don't do anything. wxBookCtrl::DoGetBestSize does the job now.
 
-class WXDLLEXPORT wxNotebook;
+// ----------------------------------------------------------------------------
+// wxBookCtrlSizer
+// ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxNotebookSizer: public wxSizer
+#if wxUSE_BOOKCTRL
+
+// this sizer works with wxNotebook/wxListbook/... and sizes the control to
+// fit its pages
+class WXDLLEXPORT wxBookCtrl;
+
+class WXDLLEXPORT wxBookCtrlSizer : public wxSizer
 {
 public:
-    wxNotebookSizer( wxNotebook *nb );
-
-    void RecalcSizes();
-    wxSize CalcMin();
+    wxDEPRECATED( wxBookCtrlSizer(wxBookCtrl *bookctrl) );
 
-    wxNotebook *GetNotebook() const
-        { return m_notebook; }
+    wxBookCtrl *GetControl() const { return m_bookctrl; }
+    
+    virtual void RecalcSizes();
+    virtual wxSize CalcMin();
 
 protected:
-    wxNotebook   *m_notebook;
+    // this protected ctor lets us mark the real one above as deprecated
+    // and still has warning-free build of the library itself:
+    wxBookCtrlSizer() {}
+    
+    wxBookCtrl *m_bookctrl;
 
 private:
-    DECLARE_CLASS(wxNotebookSizer);
+    DECLARE_CLASS(wxBookCtrlSizer)
+    DECLARE_NO_COPY_CLASS(wxBookCtrlSizer)
+};
+
+
+#if wxUSE_NOTEBOOK
+
+// before wxBookCtrl we only had wxNotebookSizer, keep it for backwards
+// compatibility
+class WXDLLEXPORT wxNotebook;
+
+class WXDLLEXPORT wxNotebookSizer : public wxBookCtrlSizer
+{
+public:
+    wxDEPRECATED( wxNotebookSizer(wxNotebook *nb) );
+
+    wxNotebook *GetNotebook() const { return (wxNotebook *)m_bookctrl; }
+
+private:
+    DECLARE_CLASS(wxNotebookSizer)
     DECLARE_NO_COPY_CLASS(wxNotebookSizer)
 };
 
 #endif // wxUSE_NOTEBOOK
 
+#endif // wxUSE_BOOKCTRL
+
+#endif // WXWIN_COMPATIBILITY_2_4
+
+
+#endif // __WXSIZER_H__
 
-#endif
-  // __WXSIZER_H__