moved xti info to common file

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

diff --git a/include/wx/sizer.h b/include/wx/sizer.h
index 0bcc34cb34c5d931bbc1d34ae3eedaec895afaae..6d414fd09d20308b3cc8a22ee7d0a3e1d33fb5b0 100644 (file)
--- a/include/wx/sizer.h
+++ b/include/wx/sizer.h
@@ -510,7 +510,7 @@ public:
     wxSizerItem* Add( int width, int height, const wxSizerFlags& flags);
     wxSizerItem* Add( wxSizerItem *item);
 
     wxSizerItem* Add( int width, int height, const wxSizerFlags& flags);
     wxSizerItem* Add( wxSizerItem *item);
 

-    wxSizerItem* AddSpacer(int size);
+    virtual wxSizerItem *AddSpacer(int size);

     wxSizerItem* AddStretchSpacer(int prop = 1);
 
     wxSizerItem* Insert(size_t index,
     wxSizerItem* AddStretchSpacer(int prop = 1);
 
     wxSizerItem* Insert(size_t index,


@@ -542,7 +542,11 @@ public:
                         int width,
                         int height,
                         const wxSizerFlags& flags);
                         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);
 
     wxSizerItem* InsertSpacer(size_t index, int size);
     wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1);


@@ -713,6 +717,10 @@ protected:
     virtual bool DoSetItemMinSize( wxSizer *sizer, int width, int height );
     virtual bool DoSetItemMinSize( size_t index, int width, int height );
 
     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)
 };
 private:
     DECLARE_CLASS(wxSizer)
 };


@@ -724,16 +732,30 @@ private:
 class WXDLLIMPEXP_CORE wxGridSizer: public wxSizer
 {
 public:
 class WXDLLIMPEXP_CORE wxGridSizer: public wxSizer
 {
 public:

-    wxGridSizer( int rows, int cols, int vgap, int hgap );
-    wxGridSizer( int cols, int vgap = 0, int hgap = 0 );
+    // ctors specifying the number of columns only: number of rows will be
+    // deduced automatically depending on the number of sizer elements
+    wxGridSizer( int cols, int vgap, int hgap );
+    wxGridSizer( int cols, const wxSize& gap = wxSize(0, 0) );

 
 

-    virtual wxSizerItem *Insert(size_t index, wxSizerItem *item);
+    // ctors specifying the number of rows and columns
+    wxGridSizer( int rows, int cols, int vgap, int hgap );
+    wxGridSizer( int rows, int cols, const wxSize& gap );

 
     virtual void RecalcSizes();
     virtual wxSize CalcMin();
 
 
     virtual void RecalcSizes();
     virtual wxSize CalcMin();
 

-    void SetCols( int cols )    { m_cols = cols; }
-    void SetRows( int rows )    { m_rows = rows; }
+    void SetCols( int cols )
+    {
+        wxASSERT_MSG( cols >= 0, "Number of columns must be non-negative");
+        m_cols = cols;
+    }
+
+    void SetRows( int rows )
+    {
+        wxASSERT_MSG( rows >= 0, "Number of rows must be non-negative");
+        m_rows = rows;
+    }
+

     void SetVGap( int gap )     { m_vgap = gap; }
     void SetHGap( int gap )     { m_hgap = gap; }
     int GetCols() const         { return m_cols; }
     void SetVGap( int gap )     { m_vgap = gap; }
     void SetHGap( int gap )     { m_hgap = gap; }
     int GetCols() const         { return m_cols; }


@@ -741,18 +763,51 @@ public:
     int GetVGap() const         { return m_vgap; }
     int GetHGap() const         { return m_hgap; }
 
     int GetVGap() const         { return m_vgap; }
     int GetHGap() const         { return m_hgap; }
 

+    int GetEffectiveColsCount() const   { return m_cols ? m_cols : CalcCols(); }
+    int GetEffectiveRowsCount() const   { return m_rows ? m_rows : CalcRows(); }
+

     // return the number of total items and the number of columns and rows
     // (for internal use only)
     int CalcRowsCols(int& rows, int& cols) const;
 
 protected:
     // return the number of total items and the number of columns and rows
     // (for internal use only)
     int CalcRowsCols(int& rows, int& cols) const;
 
 protected:

+    // the number of rows/columns in the sizer, if 0 then it is determined
+    // dynamically depending on the total number of items

     int    m_rows;
     int    m_cols;
     int    m_rows;
     int    m_cols;

+
+    // gaps between rows and columns

     int    m_vgap;
     int    m_hgap;
 
     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 );
 
     void SetItemBounds( wxSizerItem *item, int x, int y, int w, int h );
 

+    // returns the number of columns/rows needed for the current total number
+    // of children (and the fixed number of rows/columns)
+    int CalcCols() const
+    {
+        wxCHECK_MSG
+        (
+            m_rows, 0,
+            "Can't calculate number of cols if number of rows is not specified"
+        );
+
+        return (m_children.GetCount() + m_rows - 1) / m_rows;
+    }
+
+    int CalcRows() const
+    {
+        wxCHECK_MSG
+        (
+            m_cols, 0,
+            "Can't calculate number of cols if number of rows is not specified"
+        );
+
+        return (m_children.GetCount() + m_cols - 1) / m_cols;
+    }
+

 private:
     DECLARE_CLASS(wxGridSizer)
 };
 private:
     DECLARE_CLASS(wxGridSizer)
 };


@@ -778,11 +833,17 @@ enum wxFlexSizerGrowMode
 class WXDLLIMPEXP_CORE wxFlexGridSizer: public wxGridSizer
 {
 public:
 class WXDLLIMPEXP_CORE wxFlexGridSizer: public wxGridSizer
 {
 public:

-    // ctors/dtor
+    // ctors specifying the number of columns only: number of rows will be
+    // deduced automatically depending on the number of sizer elements
+    wxFlexGridSizer( int cols, int vgap, int hgap );
+    wxFlexGridSizer( int cols, const wxSize& gap = wxSize(0, 0) );
+
+    // ctors specifying the number of rows and columns

     wxFlexGridSizer( int rows, int cols, int vgap, int hgap );
     wxFlexGridSizer( int rows, int cols, int vgap, int hgap );

-    wxFlexGridSizer( int cols, int vgap = 0, int hgap = 0 );
-    virtual ~wxFlexGridSizer();
+    wxFlexGridSizer( int rows, int cols, const wxSize& gap );

 
 

+    // dtor
+    virtual ~wxFlexGridSizer();

 
     // set the rows/columns which will grow (the others will remain of the
     // constant initial size)
 
     // set the rows/columns which will grow (the others will remain of the
     // constant initial size)


@@ -860,6 +921,8 @@ public:
                       wxT("invalid value for wxBoxSizer orientation") );
     }
 
                       wxT("invalid value for wxBoxSizer orientation") );
     }
 

+    virtual wxSizerItem *AddSpacer(int size);
+

     int GetOrientation() const { return m_orient; }
 
     bool IsVertical() const { return m_orient == wxVERTICAL; }
     int GetOrientation() const { return m_orient; }
 
     bool IsVertical() const { return m_orient == wxVERTICAL; }


@@ -1050,6 +1113,12 @@ inline void wxSizerItem::SetSpacer(int width, int height)
 
 #endif // WXWIN_COMPATIBILITY_2_8
 
 
 #endif // WXWIN_COMPATIBILITY_2_8
 

+inline wxSizerItem*
+wxSizer::Insert(size_t index, wxSizerItem *item)
+{
+    return DoInsert(index, item);
+}
+

 
 inline wxSizerItem*
 wxSizer::Add( wxSizerItem *item )
 
 inline wxSizerItem*
 wxSizer::Add( wxSizerItem *item )