added stock buttons support

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

diff --git a/include/wx/sizer.h b/include/wx/sizer.h
index b46b5ec1b730352216629ced26b8ccb264b1f855..ade5aea7480eee617098acabd81141c769a18842 100644 (file)
--- a/include/wx/sizer.h
+++ b/include/wx/sizer.h
@@ -1,19 +1,18 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        sizer.h
 /////////////////////////////////////////////////////////////////////////////
 // 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$
 // 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__
 
 // 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
 
 #pragma interface "sizer.h"
 #endif
 


@@ -27,9 +26,9 @@
 // classes
 //---------------------------------------------------------------------------
 
 // classes
 //---------------------------------------------------------------------------
 

-class wxSizerItem;
-class wxSizer;
-class wxBoxSizer;
+class WXDLLEXPORT wxSizerItem;
+class WXDLLEXPORT wxSizer;
+class WXDLLEXPORT wxBoxSizer;

 
 //---------------------------------------------------------------------------
 // wxSizerItem
 
 //---------------------------------------------------------------------------
 // wxSizerItem


@@ -60,7 +59,8 @@ public:
                  int border,
                  wxObject* userData );
 
                  int border,
                  wxObject* userData );
 

-    ~wxSizerItem();
+    wxSizerItem();
+    virtual ~wxSizerItem();

 
     virtual void DeleteWindows();
 
 
     virtual void DeleteWindows();
 


@@ -74,8 +74,17 @@ public:
 
     wxSize GetMinSize() const
         { return m_minSize; }
 
     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 )
     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
 
     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 )
     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 )
     wxSizer *GetSizer() const
         { return m_sizer; }
     void SetSizer( wxSizer *sizer )


@@ -141,7 +150,7 @@ protected:
     int          m_border;
     int          m_flag;
 
     int          m_border;
     int          m_flag;
 

-    // If TRUE, then this item is considered in the layout
+    // If true, then this item is considered in the layout

     // calculation.  Otherwise, it is skipped over.
     bool         m_show;
 
     // calculation.  Otherwise, it is skipped over.
     bool         m_show;
 


@@ -153,7 +162,7 @@ protected:
     wxObject    *m_userData;
 
 private:
     wxObject    *m_userData;
 
 private:

-    DECLARE_CLASS(wxSizerItem);
+    DECLARE_CLASS(wxSizerItem)

     DECLARE_NO_COPY_CLASS(wxSizerItem)
 };
 
     DECLARE_NO_COPY_CLASS(wxSizerItem)
 };
 


@@ -189,6 +198,9 @@ public:
                       wxObject* userData = NULL );
     virtual void Add( wxSizerItem *item );
 
                       wxObject* userData = NULL );
     virtual void Add( wxSizerItem *item );
 

+    virtual void AddSpacer(int size);
+    virtual void AddStretchSpacer(int prop = 1);
+

     virtual void Insert( size_t index,
                          wxWindow *window,
                          int proportion = 0,
     virtual void Insert( size_t index,
                          wxWindow *window,
                          int proportion = 0,


@@ -211,6 +223,9 @@ public:
     virtual void Insert( size_t index,
                          wxSizerItem *item );
 
     virtual void Insert( size_t index,
                          wxSizerItem *item );
 

+    virtual void InsertSpacer(size_t index, int size);
+    virtual void InsertStretchSpacer(size_t index, int prop = 1);
+

     virtual void Prepend( wxWindow *window,
                           int proportion = 0,
                           int flag = 0,
     virtual void Prepend( wxWindow *window,
                           int proportion = 0,
                           int flag = 0,


@@ -229,17 +244,20 @@ public:
                           wxObject* userData = NULL );
     virtual void Prepend( wxSizerItem *item );
 
                           wxObject* userData = NULL );
     virtual void Prepend( wxSizerItem *item );
 

+    virtual void PrependSpacer(int size);
+    virtual void PrependStretchSpacer(int prop = 1);
+

     // Deprecated in 2.6 since historically it does not delete the window,
     // use Detach instead.
     wxDEPRECATED( virtual bool Remove( wxWindow *window ) );
     virtual bool Remove( wxSizer *sizer );
     // Deprecated in 2.6 since historically it does not delete the window,
     // use Detach instead.
     wxDEPRECATED( virtual bool Remove( wxWindow *window ) );
     virtual bool Remove( wxSizer *sizer );

-    virtual bool Remove( size_t index );
+    virtual bool Remove( int index );

 
     virtual bool Detach( wxWindow *window );
     virtual bool Detach( wxSizer *sizer );
 
     virtual bool Detach( wxWindow *window );
     virtual bool Detach( wxSizer *sizer );

-    virtual bool Detach( size_t index );
+    virtual bool Detach( int index );

 
 

-    virtual void Clear( bool delete_windows=FALSE );
+    virtual void Clear( bool delete_windows = false );

     virtual void DeleteWindows();
 
     void SetMinSize( int width, int height )
     virtual void DeleteWindows();
 
     void SetMinSize( int width, int height )


@@ -289,23 +307,23 @@ public:
 
     // Manage whether individual scene items are considered
     // in the layout calculations or not.
 
     // Manage whether individual scene items are considered
     // in the layout calculations or not.

-    void Show( wxWindow *window, bool show = TRUE );
-    void Show( wxSizer *sizer, bool show = TRUE );
-    void Show( size_t index, bool show = TRUE );
+    void Show( wxWindow *window, bool show = true );
+    void Show( wxSizer *sizer, bool show = true );
+    void Show( size_t index, bool show = true );

 
     void Hide( wxSizer *sizer )
 
     void Hide( wxSizer *sizer )

-        { Show( sizer, FALSE ); }
+        { Show( sizer, false ); }

     void Hide( wxWindow *window )
     void Hide( wxWindow *window )

-        { Show( window, FALSE ); }
+        { Show( window, false ); }

     void Hide( size_t index )
     void Hide( size_t index )

-        { Show( index, FALSE ); }
+        { Show( index, false ); }

 
     bool IsShown( wxWindow *window ) const;
     bool IsShown( wxSizer *sizer ) const;
     bool IsShown( size_t index ) const;
 
     // Recursively call wxWindow::Show () on all sizer items.
 
     bool IsShown( wxWindow *window ) const;
     bool IsShown( wxSizer *sizer ) const;
     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;
 
 protected:
     wxSize              m_size;


@@ -326,7 +344,7 @@ protected:
     virtual bool DoSetItemMinSize( size_t index, int width, int height );
 
 private:
     virtual bool DoSetItemMinSize( size_t index, int width, int height );
 
 private:

-    DECLARE_CLASS(wxSizer);
+    DECLARE_CLASS(wxSizer)

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


@@ -339,8 +357,8 @@ public:
     wxGridSizer( int rows, int cols, int vgap, int hgap );
     wxGridSizer( int cols, int vgap = 0, int hgap = 0 );
 
     wxGridSizer( int rows, int cols, int vgap, int hgap );
     wxGridSizer( int cols, int vgap = 0, int hgap = 0 );
 

-    void RecalcSizes();
-    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 )    { m_cols = cols; }
     void SetRows( int rows )    { m_rows = rows; }


@@ -363,38 +381,91 @@ protected:
     void SetItemBounds( wxSizerItem *item, int x, int y, int w, int h );
 
 private:
     void SetItemBounds( wxSizerItem *item, int x, int y, int w, int h );
 
 private:

-    DECLARE_CLASS(wxGridSizer);
+    DECLARE_CLASS(wxGridSizer)

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

+// the bevaiour for resizing wxFlexGridSizer cells in the "non-flexible"
+// direction
+enum wxFlexSizerGrowMode
+{
+    // don't resize the cells in non-flexible direction at all
+    wxFLEX_GROWMODE_NONE,
+
+    // uniformly resize only the specified ones (default)
+    wxFLEX_GROWMODE_SPECIFIED,
+
+    // uniformly resize all cells
+    wxFLEX_GROWMODE_ALL
+};
+

 class WXDLLEXPORT wxFlexGridSizer: public wxGridSizer
 {
 public:
 class WXDLLEXPORT wxFlexGridSizer: public wxGridSizer
 {
 public:

+    // ctors/dtor

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

-    ~wxFlexGridSizer();
+    virtual ~wxFlexGridSizer();

 
 

-    void RecalcSizes();
-    wxSize CalcMin();

 
 

-    void AddGrowableRow( size_t idx );
+    // set the rows/columns which will grow (the others will remain of the
+    // constant initial size)
+    void AddGrowableRow( size_t idx, int proportion = 0 );

     void RemoveGrowableRow( size_t idx );
     void RemoveGrowableRow( size_t idx );

-    void AddGrowableCol( size_t idx );
+    void AddGrowableCol( size_t idx, int proportion = 0 );

     void RemoveGrowableCol( size_t idx );
 
     void RemoveGrowableCol( size_t idx );
 

-protected:
-    int         *m_rowHeights;
-    int         *m_colWidths;
-    wxArrayInt  m_growableRows;
-    wxArrayInt  m_growableCols;

 
 

-    void CreateArrays();
+    // the sizer cells may grow in both directions, not grow at all or only
+    // grow in one direction but not the other
+
+    // the direction may be wxVERTICAL, wxHORIZONTAL or wxBOTH (default)
+    void SetFlexibleDirection(int direction) { m_flexDirection = direction; }
+    int GetFlexibleDirection() const { return m_flexDirection; }
+
+    // note that the grow mode only applies to the direction which is not
+    // flexible
+    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;
+
+    // indices of the growable columns and rows
+    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:
 
 private:

-    DECLARE_CLASS(wxFlexGridSizer);
+    DECLARE_CLASS(wxFlexGridSizer)

     DECLARE_NO_COPY_CLASS(wxFlexGridSizer)
 };
 
     DECLARE_NO_COPY_CLASS(wxFlexGridSizer)
 };
 


@@ -425,7 +496,7 @@ protected:
     int m_fixedHeight;
 
 private:
     int m_fixedHeight;
 
 private:

-    DECLARE_CLASS(wxBoxSizer);
+    DECLARE_CLASS(wxBoxSizer)

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


@@ -447,45 +518,81 @@ public:
     wxStaticBox *GetStaticBox() const
         { return m_staticBox; }
 
     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:
 protected:
     wxStaticBox   *m_staticBox;
 
 private:

-    DECLARE_CLASS(wxStaticBoxSizer);
+    DECLARE_CLASS(wxStaticBoxSizer)

     DECLARE_NO_COPY_CLASS(wxStaticBoxSizer)
 };
 
 #endif // wxUSE_STATBOX
 
     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
+// ----------------------------------------------------------------------------
+
+#if wxUSE_BOOKCTRL
+
+// this sizer works with wxNotebook/wxListbook/... and sizes the control to
+// fit its pages
+class WXDLLEXPORT wxBookCtrl;

 
 

-class WXDLLEXPORT wxNotebookSizer: public wxSizer
+class WXDLLEXPORT wxBookCtrlSizer : public wxSizer

 {
 public:
 {
 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:
 
 protected:

-    wxNotebook   *m_notebook;
+    // this protected ctor lets us mark the real one above as deprecated
+    // and still have warning-free build of the library itself:
+    wxBookCtrlSizer() {}
+    
+    wxBookCtrl *m_bookctrl;

 
 private:
 
 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
 
     DECLARE_NO_COPY_CLASS(wxNotebookSizer)
 };
 
 #endif // wxUSE_NOTEBOOK
 

+#endif // wxUSE_BOOKCTRL
+
+#endif // WXWIN_COMPATIBILITY_2_4
+
+
+#endif // __WXSIZER_H__

 
 

-#endif
-  // __WXSIZER_H__