]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/sizer.h
Fixed typo.
[wxWidgets.git] / include / wx / sizer.h
index 5407125af41e0fd8f2d47fd79ccc20775414ac5a..c3837e3deb741eabd4d32f678b8654d2cff1ead9 100644 (file)
 
 #include "wx/defs.h"
 
-#include "wx/button.h"
 #include "wx/window.h"
-#include "wx/frame.h"
-#include "wx/dialog.h"
-#include "wx/bookctrl.h"
 
 //---------------------------------------------------------------------------
 // classes
 //---------------------------------------------------------------------------
 
+class WXDLLEXPORT wxButton;
+class WXDLLEXPORT wxBoxSizer;
 class WXDLLEXPORT wxSizerItem;
 class WXDLLEXPORT wxSizer;
-class WXDLLEXPORT wxBoxSizer;
 
+#ifndef wxUSE_BORDER_BY_DEFAULT
+    #ifdef __SMARTPHONE__
+        // no borders by default on limited size screen
+        #define wxUSE_BORDER_BY_DEFAULT 0
+    #else
+        #define wxUSE_BORDER_BY_DEFAULT 1
+    #endif
+#endif
 
 // ----------------------------------------------------------------------------
 // wxSizerFlags: flags used for an item in the sizer
@@ -55,19 +60,36 @@ public:
 
     wxSizerFlags& Align(int alignment) // combination of wxAlignment values
     {
-        m_flags &= wxALL;
+        m_flags &= ~wxALIGN_MASK;
         m_flags |= alignment;
 
         return *this;
     }
 
+    wxSizerFlags& Expand()
+    {
+        m_flags |= wxEXPAND;
+        return *this;
+    }
+
     // some shortcuts for Align()
-    wxSizerFlags& Expand() { return Align(wxEXPAND); }
     wxSizerFlags& Centre() { return Align(wxCENTRE); }
     wxSizerFlags& Center() { return Centre(); }
     wxSizerFlags& Left() { return Align(wxALIGN_LEFT); }
     wxSizerFlags& Right() { return Align(wxALIGN_RIGHT); }
 
+    // default border size used by Border() below
+    static int GetDefaultBorder()
+    {
+#if wxUSE_BORDER_BY_DEFAULT
+        // FIXME: default border size shouldn't be hardcoded and at the very
+        //        least they should depend on the current font size
+        return 5;
+#else
+        return 0;
+#endif
+    }
+
 
     wxSizerFlags& Border(int direction, int borderInPixels)
     {
@@ -81,10 +103,55 @@ public:
 
     wxSizerFlags& Border(int direction = wxALL)
     {
-        // FIXME: default border size shouldn't be hardcoded
-        return Border(direction, 5);
+#if wxUSE_BORDER_BY_DEFAULT
+        return Border(direction, GetDefaultBorder());
+#else
+        // no borders by default on limited size screen
+        wxUnusedVar(direction);
+
+        return *this;
+#endif
+    }
+
+    wxSizerFlags& DoubleBorder(int direction = wxALL)
+    {
+#if wxUSE_BORDER_BY_DEFAULT
+        return Border(direction, 2*GetDefaultBorder());
+#else
+        wxUnusedVar(direction);
+
+        return *this;
+#endif
+    }
+
+    wxSizerFlags& TripleBorder(int direction = wxALL)
+    {
+#if wxUSE_BORDER_BY_DEFAULT
+        return Border(direction, 3*GetDefaultBorder());
+#else
+        wxUnusedVar(direction);
+
+        return *this;
+#endif
+    }
+
+    wxSizerFlags& HorzBorder()
+    {
+#if wxUSE_BORDER_BY_DEFAULT
+        return Border(wxLEFT | wxRIGHT, GetDefaultBorder());
+#else
+        return *this;
+#endif
     }
 
+    wxSizerFlags& DoubleHorzBorder()
+    {
+#if wxUSE_BORDER_BY_DEFAULT
+        return Border(wxLEFT | wxRIGHT, 2*GetDefaultBorder());
+#else
+        return *this;
+#endif
+    }
 
     // accessors for wxSizer only
     int GetProportion() const { return m_proportion; }
@@ -184,7 +251,7 @@ public:
 
     virtual wxSize GetSize() const;
     virtual wxSize CalcMin();
-    virtual void SetDimension( wxPoint pos, wxSize size );
+    virtual void SetDimension( const wxPoint& pos, const wxSize& size );
 
     wxSize GetMinSize() const
         { return m_minSize; }
@@ -218,9 +285,11 @@ public:
     bool IsSizer() const { return m_kind == Item_Sizer; }
     bool IsSpacer() const { return m_kind == Item_Spacer; }
 
+#if WXWIN_COMPATIBILITY_2_6
     // Deprecated in 2.6, use {G,S}etProportion instead.
     wxDEPRECATED( void SetOption( int option ) );
     wxDEPRECATED( int GetOption() const );
+#endif // WXWIN_COMPATIBILITY_2_6
 
     void SetProportion( int proportion )
         { m_proportion = proportion; }
@@ -241,9 +310,14 @@ public:
         { return m_kind == Item_Sizer ? m_sizer : NULL; }
     wxSize GetSpacer() const;
 
-    void Show(bool show);
+    // this function behaves obviously for the windows and spacers but for the
+    // sizers it returns true if any sizer element is shown and only returns
+    // false if all of them are hidden
     bool IsShown() const;
+    void Show(bool show);
 
+    void SetUserData(wxObject* userData)
+        { delete m_userData; m_userData = userData; }
     wxObject* GetUserData() const
         { return m_userData; }
     wxPoint GetPosition() const
@@ -263,6 +337,8 @@ protected:
     // common part of ctors taking wxSizerFlags
     void Init(const wxSizerFlags& flags);
 
+
+    // discriminated union: depending on m_kind one of the fields is valid
     enum
     {
         Item_None,
@@ -309,91 +385,98 @@ WX_DECLARE_EXPORTED_LIST( wxSizerItem, wxSizerItemList );
 class WXDLLEXPORT wxSizer: public wxObject, public wxClientDataContainer
 {
 public:
-    wxSizer();
-    ~wxSizer();
+    wxSizer() { m_containingWindow = NULL; }
+    virtual ~wxSizer();
 
     // methods for adding elements to the sizer: there are Add/Insert/Prepend
     // overloads for each of window/sizer/spacer/wxSizerItem
-    inline wxSizerItem* Add( wxWindow *window,
-                             int proportion = 0,
-                             int flag = 0,
-                             int border = 0,
-                             wxObject* userData = NULL );
-    inline wxSizerItem* Add( wxSizer *sizer,
-                             int proportion = 0,
-                             int flag = 0,
-                             int border = 0,
-                             wxObject* userData = NULL );
-    inline wxSizerItem* Add( int width,
-                             int height,
-                             int proportion = 0,
-                             int flag = 0,
-                             int border = 0,
-                             wxObject* userData = NULL );
-    inline wxSizerItem* Add( wxWindow *window, const wxSizerFlags& flags );
-    inline wxSizerItem* Add( wxSizer *sizer, const wxSizerFlags& flags );
-    inline wxSizerItem* Add( wxSizerItem *item );
-
-    inline wxSizerItem* AddSpacer(int size);
-    inline wxSizerItem* AddStretchSpacer(int prop = 1);
-
-    inline wxSizerItem* Insert( size_t index,
-                                wxWindow *window,
-                                int proportion = 0,
-                                int flag = 0,
-                                int border = 0,
-                                wxObject* userData = NULL );
-    inline wxSizerItem* Insert( size_t index,
-                                wxSizer *sizer,
-                                int proportion = 0,
-                                int flag = 0,
-                                int border = 0,
-                                wxObject* userData = NULL );
-    inline wxSizerItem* Insert( size_t index,
-                                int width,
-                                int height,
-                                int proportion = 0,
-                                int flag = 0,
-                                int border = 0,
-                                wxObject* userData = NULL );
-    inline wxSizerItem* Insert( size_t index,
-                                wxWindow *window,
-                                const wxSizerFlags& flags );
-    inline wxSizerItem* Insert( size_t index,
-                                wxSizer *sizer,
-                                const wxSizerFlags& flags );
-    virtual wxSizerItem* Insert( size_t index, wxSizerItem *item );
-
-    inline wxSizerItem* InsertSpacer(size_t index, int size);
-    inline wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1);
-
-    inline wxSizerItem* Prepend( wxWindow *window,
-                                 int proportion = 0,
-                                 int flag = 0,
-                                 int border = 0,
-                                 wxObject* userData = NULL );
-    inline wxSizerItem* Prepend( wxSizer *sizer,
-                                 int proportion = 0,
-                                 int flag = 0,
-                                 int border = 0,
-                                 wxObject* userData = NULL );
-    inline wxSizerItem* Prepend( int width,
-                                 int height,
-                                 int proportion = 0,
-                                 int flag = 0,
-                                 int border = 0,
-                                 wxObject* userData = NULL );
-    inline wxSizerItem* Prepend( wxWindow *window, const wxSizerFlags& flags );
-    inline wxSizerItem* Prepend( wxSizer *sizer, const wxSizerFlags& flags );
-    inline wxSizerItem* Prepend( wxSizerItem *item );
-
-    inline wxSizerItem* PrependSpacer(int size);
-    inline wxSizerItem* PrependStretchSpacer(int prop = 1);
-
-
+    wxSizerItem* Add(wxWindow *window,
+                     int proportion = 0,
+                     int flag = 0,
+                     int border = 0,
+                     wxObject* userData = NULL);
+    wxSizerItem* Add(wxSizer *sizer,
+                     int proportion = 0,
+                     int flag = 0,
+                     int border = 0,
+                     wxObject* userData = NULL);
+    wxSizerItem* Add(int width,
+                     int height,
+                     int proportion = 0,
+                     int flag = 0,
+                     int border = 0,
+                     wxObject* userData = NULL);
+    wxSizerItem* Add( wxWindow *window, const wxSizerFlags& flags);
+    wxSizerItem* Add( wxSizer *sizer, const wxSizerFlags& flags);
+    wxSizerItem* Add( wxSizerItem *item);
+
+    wxSizerItem* AddSpacer(int size);
+    wxSizerItem* AddStretchSpacer(int prop = 1);
+
+    wxSizerItem* Insert(size_t index,
+                        wxWindow *window,
+                        int proportion = 0,
+                        int flag = 0,
+                        int border = 0,
+                        wxObject* userData = NULL);
+    wxSizerItem* Insert(size_t index,
+                        wxSizer *sizer,
+                        int proportion = 0,
+                        int flag = 0,
+                        int border = 0,
+                        wxObject* userData = NULL);
+    wxSizerItem* Insert(size_t index,
+                        int width,
+                        int height,
+                        int proportion = 0,
+                        int flag = 0,
+                        int border = 0,
+                        wxObject* userData = NULL);
+    wxSizerItem* Insert(size_t index,
+                        wxWindow *window,
+                        const wxSizerFlags& flags);
+    wxSizerItem* Insert(size_t index,
+                        wxSizer *sizer,
+                        const wxSizerFlags& flags);
+    virtual wxSizerItem* Insert( size_t index, wxSizerItem *item);
+
+    wxSizerItem* InsertSpacer(size_t index, int size);
+    wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1);
+
+    wxSizerItem* Prepend(wxWindow *window,
+                         int proportion = 0,
+                         int flag = 0,
+                         int border = 0,
+                         wxObject* userData = NULL);
+    wxSizerItem* Prepend(wxSizer *sizer,
+                         int proportion = 0,
+                         int flag = 0,
+                         int border = 0,
+                         wxObject* userData = NULL);
+    wxSizerItem* Prepend(int width,
+                         int height,
+                         int proportion = 0,
+                         int flag = 0,
+                         int border = 0,
+                         wxObject* userData = NULL);
+    wxSizerItem* Prepend(wxWindow *window, const wxSizerFlags& flags);
+    wxSizerItem* Prepend(wxSizer *sizer, const wxSizerFlags& flags);
+    wxSizerItem* Prepend(wxSizerItem *item);
+
+    wxSizerItem* PrependSpacer(int size);
+    wxSizerItem* PrependStretchSpacer(int prop = 1);
+
+    // set (or possibly unset if window is NULL) or get the window this sizer
+    // is used in 
+    void SetContainingWindow(wxWindow *window);
+    wxWindow *GetContainingWindow() const { return m_containingWindow; }
+
+#if WXWIN_COMPATIBILITY_2_6
     // Deprecated in 2.6 since historically it does not delete the window,
     // use Detach instead.
     wxDEPRECATED( virtual bool Remove( wxWindow *window ) );
+#endif // WXWIN_COMPATIBILITY_2_6
+
     virtual bool Remove( wxSizer *sizer );
     virtual bool Remove( int index );
 
@@ -401,29 +484,33 @@ public:
     virtual bool Detach( wxSizer *sizer );
     virtual bool Detach( int index );
 
+    virtual bool Replace( wxWindow *oldwin, wxWindow *newwin, bool recursive = false );  
+    virtual bool Replace( wxSizer *oldsz, wxSizer *newsz, bool recursive = false );  
+    virtual bool Replace( size_t index, wxSizerItem *newitem );  
+
     virtual void Clear( bool delete_windows = false );
     virtual void DeleteWindows();
 
     void SetMinSize( int width, int height )
         { DoSetMinSize( width, height ); }
-    void SetMinSize( wxSize size )
+    void SetMinSize( const wxSize& size )
         { DoSetMinSize( size.x, size.y ); }
 
     // Searches recursively
     bool SetItemMinSize( wxWindow *window, int width, int height )
         { return DoSetItemMinSize( window, width, height ); }
-    bool SetItemMinSize( wxWindow *window, wxSize size )
+    bool SetItemMinSize( wxWindow *window, const wxSize& size )
         { return DoSetItemMinSize( window, size.x, size.y ); }
 
     // Searches recursively
     bool SetItemMinSize( wxSizer *sizer, int width, int height )
         { return DoSetItemMinSize( sizer, width, height ); }
-    bool SetItemMinSize( wxSizer *sizer, wxSize size )
+    bool SetItemMinSize( wxSizer *sizer, const wxSize& size )
         { return DoSetItemMinSize( sizer, 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 )
+    bool SetItemMinSize( size_t index, const wxSize& size )
         { return DoSetItemMinSize( index, size.x, size.y ); }
 
     wxSize GetSize() const
@@ -473,18 +560,16 @@ public:
     // Recursively call wxWindow::Show () on all sizer items.
     virtual void ShowItems (bool show);
 
-    void Show(bool show)
-    {   m_isShown = show;
-        ShowItems(show);
-    }
-    bool IsShown() const { return m_isShown; }
+    void Show(bool show) { ShowItems(show); }
 
 protected:
     wxSize              m_size;
     wxSize              m_minSize;
     wxPoint             m_position;
     wxSizerItemList     m_children;
-    bool                m_isShown;
+
+    // the window this sizer is used in, can be NULL
+    wxWindow *m_containingWindow;
 
     wxSize GetMaxWindowSize( wxWindow *window ) const;
     wxSize GetMinWindowSize( wxWindow *window );
@@ -667,6 +752,7 @@ class WXDLLEXPORT wxStaticBoxSizer: public wxBoxSizer
 public:
     wxStaticBoxSizer(wxStaticBox *box, int orient);
     wxStaticBoxSizer(int orient, wxWindow *win, const wxString& label = wxEmptyString);
+    virtual ~wxStaticBoxSizer();
 
     void RecalcSizes();
     wxSize CalcMin();
@@ -677,6 +763,10 @@ public:
     // override to hide/show the static box as well
     virtual void ShowItems (bool show);
 
+    virtual bool Detach( wxWindow *window );
+    virtual bool Detach( wxSizer *sizer ) { return wxBoxSizer::Detach(sizer); }
+    virtual bool Detach( int index ) { return wxBoxSizer::Detach(index); }
+
 protected:
     wxStaticBox   *m_staticBox;
 
@@ -752,7 +842,9 @@ class WXDLLEXPORT wxBookCtrlBase;
 class WXDLLEXPORT wxBookCtrlSizer : public wxSizer
 {
 public:
+#if WXWIN_COMPATIBILITY_2_6
     wxDEPRECATED( wxBookCtrlSizer(wxBookCtrlBase *bookctrl) );
+#endif // WXWIN_COMPATIBILITY_2_6
 
     wxBookCtrlBase *GetControl() const { return m_bookctrl; }
 
@@ -781,7 +873,9 @@ class WXDLLEXPORT wxNotebook;
 class WXDLLEXPORT wxNotebookSizer : public wxBookCtrlSizer
 {
 public:
+#if WXWIN_COMPATIBILITY_2_6
     wxDEPRECATED( wxNotebookSizer(wxNotebook *nb) );
+#endif // WXWIN_COMPATIBILITY_2_6
 
     wxNotebook *GetNotebook() const { return (wxNotebook *)m_bookctrl; }
 
@@ -800,6 +894,12 @@ private:
 // inline functions implementation
 // ----------------------------------------------------------------------------
 
+inline wxSizerItem*
+wxSizer::Add( wxSizerItem *item )
+{
+    return Insert( m_children.GetCount(), item );
+}
+
 inline wxSizerItem*
 wxSizer::Add( wxWindow *window, int proportion, int flag, int border, wxObject* userData )
 {
@@ -830,12 +930,6 @@ wxSizer::Add( wxSizer *sizer, const wxSizerFlags& flags )
     return Add( new wxSizerItem(sizer, flags) );
 }
 
-inline wxSizerItem*
-wxSizer::Add( wxSizerItem *item )
-{
-    return Insert( m_children.GetCount(), item );
-}
-
 inline wxSizerItem*
 wxSizer::AddSpacer(int size)
 {
@@ -848,6 +942,12 @@ wxSizer::AddStretchSpacer(int prop)
     return Add(0, 0, prop);
 }
 
+inline wxSizerItem*
+wxSizer::Prepend( wxSizerItem *item )
+{
+    return Insert( 0, item );
+}
+
 inline wxSizerItem*
 wxSizer::Prepend( wxWindow *window, int proportion, int flag, int border, wxObject* userData )
 {
@@ -866,12 +966,6 @@ wxSizer::Prepend( int width, int height, int proportion, int flag, int border, w
     return Prepend( new wxSizerItem( width, height, proportion, flag, border, userData ) );
 }
 
-inline wxSizerItem*
-wxSizer::Prepend( wxSizerItem *item )
-{
-    return Insert( 0, item );
-}
-
 inline wxSizerItem*
 wxSizer::PrependSpacer(int size)
 {