- Include wxCocoa specific header

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

diff --git a/include/wx/sizer.h b/include/wx/sizer.h
index 76b3f14090a8267be280a0ddb1cccfa43e8f9891..754daac250308cb17cd92bf9827f083d51237565 100644 (file)
--- a/include/wx/sizer.h
+++ b/include/wx/sizer.h
@@ -1,18 +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
+// Copyright:   (c) Robin Dunn, Robert Roebling

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __WXSIZER_H__
 #define __WXSIZER_H__
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __WXSIZER_H__
 #define __WXSIZER_H__
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(__APPLE__)

 #pragma interface "sizer.h"
 #endif
 
 #pragma interface "sizer.h"
 #endif
 


@@ -38,24 +38,43 @@ class WXDLLEXPORT wxSizerItem: public wxObject
 {
 public:
     // spacer
 {
 public:
     // spacer

-    wxSizerItem( int width, int height, int option, int flag, int border, wxObject* userData);
+    wxSizerItem( int width,
+                 int height,
+                 int proportion,
+                 int flag,
+                 int border,
+                 wxObject* userData);

 
     // window
 
     // window

-    wxSizerItem( wxWindow *window, int option, int flag, int border, wxObject* userData );
+    wxSizerItem( wxWindow *window,
+                 int proportion,
+                 int flag,
+                 int border,
+                 wxObject* userData );

 
     // subsizer
 
     // subsizer

-    wxSizerItem( wxSizer *sizer, int option, int flag, int border, wxObject* userData );
+    wxSizerItem( wxSizer *sizer,
+                 int proportion,
+                 int flag,
+                 int border,
+                 wxObject* userData );

 
     ~wxSizerItem();
 
     ~wxSizerItem();

-    
+

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

-    virtual wxSize GetSize();
+    // Enable deleting the SizerItem without destroying the contained sizer.
+    void DetachSizer()
+        { m_sizer = 0; }
+
+    virtual wxSize GetSize() const;

     virtual wxSize CalcMin();
     virtual void SetDimension( wxPoint pos, wxSize size );
 
     virtual wxSize CalcMin();
     virtual void SetDimension( wxPoint pos, wxSize size );
 

-    wxSize GetMinSize()
+    wxSize GetMinSize() const

         { return m_minSize; }
         { return m_minSize; }

+    void SetInitSize( int x, int y )
+        { m_minSize.x = x; m_minSize.y = 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


@@ -68,18 +87,26 @@ public:
     float GetRatio() const
         { return m_ratio; }
 
     float GetRatio() const
         { return m_ratio; }
 

-    bool IsWindow();
-    bool IsSizer();
-    bool IsSpacer();
+    bool IsWindow() const;
+    bool IsSizer() const;
+    bool IsSpacer() const;

 
 

-    void SetInitSize( int x, int y )
-        { m_minSize.x = x; m_minSize.y = y; }
-    void SetOption( int option )
-        { m_option = option; }
+    // Deprecated in 2.6, use {G,S}etProportion instead.
+    wxDEPRECATED( void SetOption( int option ) );
+    wxDEPRECATED( int GetOption() const );
+
+    void SetProportion( int proportion )
+        { m_proportion = proportion; }
+    int GetProportion() const
+        { return m_proportion; }

     void SetFlag( int flag )
         { m_flag = flag; }
     void SetFlag( int flag )
         { m_flag = flag; }

+    int GetFlag() const
+        { return m_flag; }

     void SetBorder( int border )
         { m_border = border; }
     void SetBorder( int border )
         { m_border = border; }

+    int GetBorder() const
+        { return m_border; }

 
     wxWindow *GetWindow() const
         { return m_window; }
 
     wxWindow *GetWindow() const
         { return m_window; }


@@ -89,15 +116,18 @@ public:
         { return m_sizer; }
     void SetSizer( wxSizer *sizer )
         { m_sizer = sizer; }
         { return m_sizer; }
     void SetSizer( wxSizer *sizer )
         { m_sizer = sizer; }

-    int GetOption() const
-        { return m_option; }
-    int GetFlag() const
-        { return m_flag; }
-    int GetBorder() const
-        { return m_border; }
-    wxObject* GetUserData()
+    const wxSize &GetSpacer() const
+        { return m_size; }
+    void SetSpacer( const wxSize &size )
+        { m_size = size; m_minSize = size; }
+
+    void Show ( bool show );
+    bool IsShown() const
+        { return m_show; }
+
+    wxObject* GetUserData() const

         { return m_userData; }
         { return m_userData; }

-    wxPoint GetPosition()
+    wxPoint GetPosition() const

         { return m_pos; }
 
 protected:
         { return m_pos; }
 
 protected:


@@ -106,19 +136,29 @@ protected:
     wxSize       m_size;
     wxPoint      m_pos;
     wxSize       m_minSize;
     wxSize       m_size;
     wxPoint      m_pos;
     wxSize       m_minSize;

-    int          m_option;
+    int          m_proportion;

     int          m_border;
     int          m_flag;
     int          m_border;
     int          m_flag;

-    // als: aspect ratio can always be calculated from m_size,
-    //      but this would cause precision loss when the window
-    //      is shrinked.  it is safer to preserve initial value.
+
+    // If true, then this item is considered in the layout
+    // calculation.  Otherwise, it is skipped over.
+    bool         m_show;
+
+    // Aspect ratio can always be calculated from m_size,
+    // but this would cause precision loss when the window
+    // is shrunk.  It is safer to preserve the initial value.

     float        m_ratio;
     float        m_ratio;

+

     wxObject    *m_userData;
 
 private:
     DECLARE_CLASS(wxSizerItem);
     wxObject    *m_userData;
 
 private:
     DECLARE_CLASS(wxSizerItem);

+    DECLARE_NO_COPY_CLASS(wxSizerItem)

 };
 
 };
 

+WX_DECLARE_EXPORTED_LIST( wxSizerItem, wxSizerItemList );
+
+

 //---------------------------------------------------------------------------
 // wxSizer
 //---------------------------------------------------------------------------
 //---------------------------------------------------------------------------
 // wxSizer
 //---------------------------------------------------------------------------


@@ -130,23 +170,75 @@ public:
     ~wxSizer();
 
     /* These should be called Append() really. */
     ~wxSizer();
 
     /* These should be called Append() really. */

-    virtual void Add( wxWindow *window, int option = 0, int flag = 0, int border = 0, wxObject* userData = NULL );
-    virtual void Add( wxSizer *sizer, int option = 0, int flag = 0, int border = 0, wxObject* userData = NULL );
-    virtual void Add( int width, int height, int option = 0, int flag = 0, int border = 0, wxObject* userData = NULL );
-
-    virtual void Insert( int before, wxWindow *window, int option = 0, int flag = 0, int border = 0, wxObject* userData = NULL );
-    virtual void Insert( int before, wxSizer *sizer, int option = 0, int flag = 0, int border = 0, wxObject* userData = NULL );
-    virtual void Insert( int before, int width, int height, int option = 0, int flag = 0, int border = 0, wxObject* userData = NULL );
+    virtual void Add( wxWindow *window,
+                      int proportion = 0,
+                      int flag = 0,
+                      int border = 0,
+                      wxObject* userData = NULL );
+    virtual void Add( wxSizer *sizer,
+                      int proportion = 0,
+                      int flag = 0,
+                      int border = 0,
+                      wxObject* userData = NULL );
+    virtual void Add( int width,
+                      int height,
+                      int proportion = 0,
+                      int flag = 0,
+                      int border = 0,
+                      wxObject* userData = NULL );
+    virtual void Add( wxSizerItem *item );
+
+    virtual void Insert( size_t index,
+                         wxWindow *window,
+                         int proportion = 0,
+                         int flag = 0,
+                         int border = 0,
+                         wxObject* userData = NULL );
+    virtual void Insert( size_t index,
+                         wxSizer *sizer,
+                         int proportion = 0,
+                         int flag = 0,
+                         int border = 0,
+                         wxObject* userData = NULL );
+    virtual void Insert( size_t index,
+                         int width,
+                         int height,
+                         int proportion = 0,
+                         int flag = 0,
+                         int border = 0,
+                         wxObject* userData = NULL );
+    virtual void Insert( size_t index,
+                         wxSizerItem *item );
+
+    virtual void Prepend( wxWindow *window,
+                          int proportion = 0,
+                          int flag = 0,
+                          int border = 0,
+                          wxObject* userData = NULL );
+    virtual void Prepend( wxSizer *sizer,
+                          int proportion = 0,
+                          int flag = 0,
+                          int border = 0,
+                          wxObject* userData = NULL );
+    virtual void Prepend( int width,
+                          int height,
+                          int proportion = 0,
+                          int flag = 0,
+                          int border = 0,
+                          wxObject* userData = NULL );
+    virtual void Prepend( wxSizerItem *item );
+
+    // 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( int index );

 
 

-    virtual void Prepend( wxWindow *window, int option = 0, int flag = 0, int border = 0, wxObject* userData = NULL );
-    virtual void Prepend( wxSizer *sizer, int option = 0, int flag = 0, int border = 0, wxObject* userData = NULL );
-    virtual void Prepend( int width, int height, int option = 0, int flag = 0, int border = 0, wxObject* userData = NULL );
+    virtual bool Detach( wxWindow *window );
+    virtual bool Detach( wxSizer *sizer );
+    virtual bool Detach( int index );

 
 

-    virtual bool Remove( wxWindow *window );
-    virtual bool Remove( wxSizer *sizer );
-    virtual bool Remove( int pos );
-    
-    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 )


@@ -166,14 +258,14 @@ public:
     bool SetItemMinSize( wxSizer *sizer, wxSize size )
         { return DoSetItemMinSize( sizer, size.x, size.y ); }
 
     bool SetItemMinSize( wxSizer *sizer, wxSize size )
         { return DoSetItemMinSize( sizer, size.x, size.y ); }
 

-    bool SetItemMinSize( int pos, int width, int height )
-        { return DoSetItemMinSize( pos, width, height ); }
-    bool SetItemMinSize( int pos, wxSize size )
-        { return DoSetItemMinSize( pos, size.x, size.y ); }
+    bool SetItemMinSize( size_t index, int width, int height )
+        { return DoSetItemMinSize( index, width, height ); }
+    bool SetItemMinSize( size_t index, wxSize size )
+        { return DoSetItemMinSize( index, size.x, size.y ); }

 
 

-    wxSize GetSize()
+    wxSize GetSize() const

         { return m_size; }
         { return m_size; }

-    wxPoint GetPosition()
+    wxPoint GetPosition() const

         { return m_position; }
 
     /* Calculate the minimal size or return m_minSize if bigger. */
         { return m_position; }
 
     /* Calculate the minimal size or return m_minSize if bigger. */


@@ -189,20 +281,40 @@ public:
     void SetSizeHints( wxWindow *window );
     void SetVirtualSizeHints( wxWindow *window );
 
     void SetSizeHints( wxWindow *window );
     void SetVirtualSizeHints( wxWindow *window );
 

-    wxList& GetChildren()
+    wxSizerItemList& GetChildren()

         { return m_children; }
 
     void SetDimension( int x, int y, int width, int height );
 
         { return m_children; }
 
     void SetDimension( int x, int y, int width, int height );
 

+    // 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 Hide( wxSizer *sizer )
+        { Show( sizer, false ); }
+    void Hide( wxWindow *window )
+        { Show( window, false ); }
+    void Hide( size_t index )
+        { 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.
+    void ShowItems (bool show);
+

 protected:
 protected:

-    wxSize  m_size;
-    wxSize  m_minSize;
-    wxPoint m_position;
-    wxList  m_children;
+    wxSize              m_size;
+    wxSize              m_minSize;
+    wxPoint             m_position;
+    wxSizerItemList     m_children;

 
 

-    wxSize GetMaxWindowSize( wxWindow *window );
+    wxSize GetMaxWindowSize( wxWindow *window ) const;

     wxSize GetMinWindowSize( wxWindow *window );
     wxSize GetMinWindowSize( wxWindow *window );

-    wxSize GetMaxClientSize( wxWindow *window );
+    wxSize GetMaxClientSize( wxWindow *window ) const;

     wxSize GetMinClientSize( wxWindow *window );
     wxSize FitSize( wxWindow *window );
     wxSize VirtualFitSize( wxWindow *window );
     wxSize GetMinClientSize( wxWindow *window );
     wxSize FitSize( wxWindow *window );
     wxSize VirtualFitSize( wxWindow *window );


@@ -210,7 +322,7 @@ protected:
     virtual void DoSetMinSize( int width, int height );
     virtual bool DoSetItemMinSize( wxWindow *window, int width, int height );
     virtual bool DoSetItemMinSize( wxSizer *sizer, int width, int height );
     virtual void DoSetMinSize( int width, int height );
     virtual bool DoSetItemMinSize( wxWindow *window, int width, int height );
     virtual bool DoSetItemMinSize( wxSizer *sizer, int width, int height );

-    virtual bool DoSetItemMinSize( int pos, int width, int height );
+    virtual bool DoSetItemMinSize( size_t index, int width, int height );

 
 private:
     DECLARE_CLASS(wxSizer);
 
 private:
     DECLARE_CLASS(wxSizer);


@@ -226,17 +338,17 @@ 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 SetVGap( int gap )     { m_vgap = gap; }
     void SetHGap( int gap )     { m_hgap = gap; }
 
     void SetCols( int cols )    { m_cols = cols; }
     void SetRows( int rows )    { m_rows = rows; }
     void SetVGap( int gap )     { m_vgap = gap; }
     void SetHGap( int gap )     { m_hgap = gap; }

-    int GetCols()               { return m_cols; }
-    int GetRows()               { return m_rows; }
-    int GetVGap()               { return m_vgap; }
-    int GetHGap()               { return m_hgap; }
+    int GetCols() const         { return m_cols; }
+    int GetRows() const         { return m_rows; }
+    int GetVGap() const         { return m_vgap; }
+    int GetHGap() const         { return m_hgap; }

 
 protected:
     int    m_rows;
 
 protected:
     int    m_rows;


@@ -244,6 +356,9 @@ protected:
     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;
+

     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:


@@ -254,31 +369,75 @@ private:
 // 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 );
 

+
+    // 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; }
+
+
+    // implementation
+    virtual void RecalcSizes();
+    virtual wxSize CalcMin();
+

 protected:
 protected:

-    int         *m_rowHeights;
-    int         *m_colWidths;
-    wxArrayInt  m_growableRows;
-    wxArrayInt  m_growableCols;
+    // the heights/widths of all rows/columns
+    wxArrayInt  m_rowHeights,
+                m_colWidths;

 
 

-    void CreateArrays();
+    // 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;

 
 private:
     DECLARE_CLASS(wxFlexGridSizer);
 
 private:
     DECLARE_CLASS(wxFlexGridSizer);

+    DECLARE_NO_COPY_CLASS(wxFlexGridSizer)

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


@@ -293,9 +452,12 @@ public:
     void RecalcSizes();
     wxSize CalcMin();
 
     void RecalcSizes();
     wxSize CalcMin();
 

-    int GetOrientation()
+    int GetOrientation() const

         { return m_orient; }
 
         { return m_orient; }
 

+    void SetOrientation(int orient)
+        { m_orient = orient; }
+

 protected:
     int m_orient;
     int m_stretchable;
 protected:
     int m_orient;
     int m_stretchable;


@@ -324,7 +486,7 @@ public:
     void RecalcSizes();
     wxSize CalcMin();
 
     void RecalcSizes();
     wxSize CalcMin();
 

-    wxStaticBox *GetStaticBox()
+    wxStaticBox *GetStaticBox() const

         { return m_staticBox; }
 
 protected:
         { return m_staticBox; }
 
 protected:


@@ -332,6 +494,7 @@ protected:
 
 private:
     DECLARE_CLASS(wxStaticBoxSizer);
 
 private:
     DECLARE_CLASS(wxStaticBoxSizer);

+    DECLARE_NO_COPY_CLASS(wxStaticBoxSizer)

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


@@ -352,7 +515,7 @@ public:
     void RecalcSizes();
     wxSize CalcMin();
 
     void RecalcSizes();
     wxSize CalcMin();
 

-    wxNotebook *GetNotebook()
+    wxNotebook *GetNotebook() const

         { return m_notebook; }
 
 protected:
         { return m_notebook; }
 
 protected:


@@ -360,6 +523,7 @@ protected:
 
 private:
     DECLARE_CLASS(wxNotebookSizer);
 
 private:
     DECLARE_CLASS(wxNotebookSizer);

+    DECLARE_NO_COPY_CLASS(wxNotebookSizer)

 };
 
 #endif // wxUSE_NOTEBOOK
 };
 
 #endif // wxUSE_NOTEBOOK