Add RunScript and implement on all backends. Document and add a very simple unit...

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

diff --git a/include/wx/sizer.h b/include/wx/sizer.h
index 85c5292c4ff3f763f45e7c51a0e5801a65d3e737..39044e31e880958f4f78e19749928fd7629393b9 100644 (file)
--- a/include/wx/sizer.h
+++ b/include/wx/sizer.h
@@ -79,28 +79,28 @@ public:
     wxSizerFlags& Centre() { return Align(wxALIGN_CENTRE); }
     wxSizerFlags& Center() { return Centre(); }
 
     wxSizerFlags& Centre() { return Align(wxALIGN_CENTRE); }
     wxSizerFlags& Center() { return Centre(); }
 

-    wxSizerFlags& Top() 
-    { 
-        m_flags &= ~(wxALIGN_BOTTOM | wxALIGN_CENTRE_VERTICAL); 
-        return *this; 
+    wxSizerFlags& Top()
+    {
+        m_flags &= ~(wxALIGN_BOTTOM | wxALIGN_CENTRE_VERTICAL);
+        return *this;

     }
 
     }
 

-    wxSizerFlags& Left() 
-    { 
-        m_flags &= ~(wxALIGN_RIGHT | wxALIGN_CENTRE_HORIZONTAL); 
-        return *this; 
+    wxSizerFlags& Left()
+    {
+        m_flags &= ~(wxALIGN_RIGHT | wxALIGN_CENTRE_HORIZONTAL);
+        return *this;

     }
 
     }
 

-    wxSizerFlags& Right() 
-    { 
-        m_flags = (m_flags & ~wxALIGN_CENTRE_HORIZONTAL) | wxALIGN_RIGHT; 
-        return *this; 
+    wxSizerFlags& Right()
+    {
+        m_flags = (m_flags & ~wxALIGN_CENTRE_HORIZONTAL) | wxALIGN_RIGHT;
+        return *this;

     }
 
     }
 

-    wxSizerFlags& Bottom() 
-    { 
-        m_flags = (m_flags & ~wxALIGN_CENTRE_VERTICAL) | wxALIGN_BOTTOM; 
-        return *this; 
+    wxSizerFlags& Bottom()
+    {
+        m_flags = (m_flags & ~wxALIGN_CENTRE_VERTICAL) | wxALIGN_BOTTOM;
+        return *this;

     }
 
 
     }
 
 


@@ -384,9 +384,9 @@ public:
     wxPoint GetPosition() const
         { return m_pos; }
 
     wxPoint GetPosition() const
         { return m_pos; }
 

-    // Called once the first component of an item has been decided. This is 
-    // used in algorithms that depend on knowing the size in one direction 
-    // before the min size in the other direction can be known. 
+    // Called once the first component of an item has been decided. This is
+    // used in algorithms that depend on knowing the size in one direction
+    // before the min size in the other direction can be known.

     // Returns true if it made use of the information (and min size was changed).
     bool InformFirstDirection( int direction, int size, int availableOtherDir=-1 );
 
     // Returns true if it made use of the information (and min size was changed).
     bool InformFirstDirection( int direction, int size, int availableOtherDir=-1 );
 


@@ -471,7 +471,7 @@ protected:
 
 private:
     DECLARE_CLASS(wxSizerItem)
 
 private:
     DECLARE_CLASS(wxSizerItem)

-    DECLARE_NO_COPY_CLASS(wxSizerItem)
+    wxDECLARE_NO_COPY_CLASS(wxSizerItem);

 };
 
 WX_DECLARE_EXPORTED_LIST( wxSizerItem, wxSizerItemList );
 };
 
 WX_DECLARE_EXPORTED_LIST( wxSizerItem, wxSizerItemList );


@@ -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,


@@ -541,8 +541,12 @@ public:
     wxSizerItem* Insert(size_t index,
                         int width,
                         int height,
     wxSizerItem* Insert(size_t index,
                         int width,
                         int height,

-                        const wxSizerFlags& flags);                        
-    virtual wxSizerItem* Insert( size_t index, wxSizerItem *item);
+                        const wxSizerFlags& flags);
+
+    // 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);


@@ -600,7 +604,7 @@ public:
     // Returns true if it made use of the informtion (and recalculated min size)
     virtual bool InformFirstDirection( int WXUNUSED(direction), int WXUNUSED(size), int WXUNUSED(availableOtherDir) )
         { return false; }
     // Returns true if it made use of the informtion (and recalculated min size)
     virtual bool InformFirstDirection( int WXUNUSED(direction), int WXUNUSED(size), int WXUNUSED(availableOtherDir) )
         { return false; }

-    
+

     void SetMinSize( int width, int height )
         { DoSetMinSize( width, height ); }
     void SetMinSize( const wxSize& size )
     void SetMinSize( int width, int height )
         { DoSetMinSize( width, height ); }
     void SetMinSize( const wxSize& size )


@@ -661,10 +665,17 @@ public:
         m_position = pos;
         m_size = size;
         Layout();
         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)); }
 
     }
     void SetDimension(int x, int y, int width, int height)
         { SetDimension(wxPoint(x, y), wxSize(width, height)); }
 

+    size_t GetItemCount() const { return m_children.GetCount(); }
+    bool IsEmpty() const { return m_children.IsEmpty(); }
+

     wxSizerItem* GetItem( wxWindow *window, bool recursive = false );
     wxSizerItem* GetItem( wxSizer *sizer, bool recursive = false );
     wxSizerItem* GetItem( size_t index );
     wxSizerItem* GetItem( wxWindow *window, bool recursive = false );
     wxSizerItem* GetItem( wxSizer *sizer, bool recursive = false );
     wxSizerItem* GetItem( size_t index );


@@ -710,6 +721,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)
 };


@@ -721,14 +736,30 @@ private:
 class WXDLLIMPEXP_CORE wxGridSizer: public wxSizer
 {
 public:
 class WXDLLIMPEXP_CORE wxGridSizer: public wxSizer
 {
 public:

+    // 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) );
+
+    // ctors specifying the number of rows and columns

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

-    wxGridSizer( int cols, int vgap = 0, int hgap = 0 );
+    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; }


@@ -736,17 +767,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:
 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;
 

-    // return the number of total items and the number of columns and rows
-    int CalcRowsCols(int& rows, int& cols) const;
+    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)
 };


@@ -755,8 +820,8 @@ private:
 // wxFlexGridSizer
 //---------------------------------------------------------------------------
 
 // wxFlexGridSizer
 //---------------------------------------------------------------------------
 

-// the bevaiour for resizing wxFlexGridSizer cells in the "non-flexible"
-// direction
+// values which define the behaviour for resizing wxFlexGridSizer cells in the
+// "non-flexible" direction

 enum wxFlexSizerGrowMode
 {
     // don't resize the cells in non-flexible direction at all
 enum wxFlexSizerGrowMode
 {
     // don't resize the cells in non-flexible direction at all


@@ -772,11 +837,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)


@@ -785,6 +856,8 @@ public:
     void AddGrowableCol( size_t idx, int proportion = 0 );
     void RemoveGrowableCol( size_t idx );
 
     void AddGrowableCol( size_t idx, int proportion = 0 );
     void RemoveGrowableCol( size_t idx );
 

+    bool IsRowGrowable( size_t idx );
+    bool IsColGrowable( size_t idx );

 
     // the sizer cells may grow in both directions, not grow at all or only
     // grow in one direction but not the other
 
     // the sizer cells may grow in both directions, not grow at all or only
     // grow in one direction but not the other


@@ -833,7 +906,7 @@ protected:
 
 private:
     DECLARE_CLASS(wxFlexGridSizer)
 
 private:
     DECLARE_CLASS(wxFlexGridSizer)

-    DECLARE_NO_COPY_CLASS(wxFlexGridSizer)
+    wxDECLARE_NO_COPY_CLASS(wxFlexGridSizer);

 };
 
 //---------------------------------------------------------------------------
 };
 
 //---------------------------------------------------------------------------


@@ -849,9 +922,11 @@ public:
         m_totalProportion = 0;
 
         wxASSERT_MSG( m_orient == wxHORIZONTAL || m_orient == wxVERTICAL,
         m_totalProportion = 0;
 
         wxASSERT_MSG( m_orient == wxHORIZONTAL || m_orient == wxVERTICAL,

-                      _T("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; }


@@ -956,11 +1031,15 @@ protected:
 
 private:
     DECLARE_CLASS(wxStaticBoxSizer)
 
 private:
     DECLARE_CLASS(wxStaticBoxSizer)

-    DECLARE_NO_COPY_CLASS(wxStaticBoxSizer)
+    wxDECLARE_NO_COPY_CLASS(wxStaticBoxSizer);

 };
 
 #endif // wxUSE_STATBOX
 
 };
 
 #endif // wxUSE_STATBOX
 

+//---------------------------------------------------------------------------
+// wxStdDialogButtonSizer
+//---------------------------------------------------------------------------
+

 #if wxUSE_BUTTON
 
 class WXDLLIMPEXP_CORE wxStdDialogButtonSizer: public wxBoxSizer
 #if wxUSE_BUTTON
 
 class WXDLLIMPEXP_CORE wxStdDialogButtonSizer: public wxBoxSizer


@@ -1004,7 +1083,7 @@ protected:
 
 private:
     DECLARE_CLASS(wxStdDialogButtonSizer)
 
 private:
     DECLARE_CLASS(wxStdDialogButtonSizer)

-    DECLARE_NO_COPY_CLASS(wxStdDialogButtonSizer)
+    wxDECLARE_NO_COPY_CLASS(wxStdDialogButtonSizer);

 };
 
 #endif // wxUSE_BUTTON
 };
 
 #endif // wxUSE_BUTTON


@@ -1032,12 +1111,18 @@ inline void wxSizerItem::SetSpacer(const wxSize& size)
 }
 
 inline void wxSizerItem::SetSpacer(int width, int height)
 }
 
 inline void wxSizerItem::SetSpacer(int width, int height)

-{ 
-    DoSetSpacer(wxSize(width, height)); 
-} 
+{
+    DoSetSpacer(wxSize(width, 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 )