X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fbfb8bcc3fa17e079d4219655b173f8ed2ccc65a..6619edf0ea94b6623f1c7e7875d5ca8abac23382:/include/wx/sizer.h diff --git a/include/wx/sizer.h b/include/wx/sizer.h index 28965fe97e..40f32e6e19 100644 --- a/include/wx/sizer.h +++ b/include/wx/sizer.h @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: sizer.h +// Name: wx/sizer.h // Purpose: provide wxSizer class for layout // Author: Robert Roebling and Robin Dunn // Modified by: Ron Lee, Vadim Zeitlin (wxSizerFlags) @@ -14,20 +14,25 @@ #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 wxSizerItem; -class WXDLLEXPORT wxSizer; -class WXDLLEXPORT wxBoxSizer; +class WXDLLIMPEXP_FWD_CORE wxButton; +class WXDLLIMPEXP_FWD_CORE wxBoxSizer; +class WXDLLIMPEXP_FWD_CORE wxSizerItem; +class WXDLLIMPEXP_FWD_CORE wxSizer; +#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,18 +60,37 @@ 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& Centre() { return Align(wxALIGN_CENTRE); } wxSizerFlags& Center() { return Centre(); } + wxSizerFlags& Top() { return Align(wxALIGN_TOP); } wxSizerFlags& Left() { return Align(wxALIGN_LEFT); } wxSizerFlags& Right() { return Align(wxALIGN_RIGHT); } + wxSizerFlags& Bottom() { return Align(wxALIGN_BOTTOM); } + + // 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 +105,70 @@ 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 + } + + // setters for the others flags + wxSizerFlags& Shaped() + { + m_flags |= wxSHAPED; + + return *this; + } + + wxSizerFlags& FixedMinSize() + { + m_flags |= wxFIXED_MINSIZE; + + return *this; + } // accessors for wxSizer only int GetProportion() const { return m_proportion; } @@ -140,7 +224,7 @@ public: { Init(flags); - SetWindow(window); + DoSetWindow(window); } // subsizer @@ -155,7 +239,7 @@ public: { Init(flags); - SetSizer(sizer); + DoSetSizer(sizer); } // spacer @@ -171,7 +255,7 @@ public: { Init(flags); - SetSpacer(width, height); + DoSetSpacer(wxSize(width, height)); } wxSizerItem(); @@ -218,9 +302,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,28 +327,66 @@ 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 { return m_pos; } + // these functions delete the current contents of the item if it's a sizer + // or a spacer but not if it is a window + void AssignWindow(wxWindow *window) + { + Free(); + DoSetWindow(window); + } + + void AssignSizer(wxSizer *sizer) + { + Free(); + DoSetSizer(sizer); + } + + void AssignSpacer(const wxSize& size) + { + Free(); + DoSetSpacer(size); + } + + void AssignSpacer(int w, int h) { AssignSpacer(wxSize(w, h)); } - // these functions do not free old sizer/spacer - void SetWindow(wxWindow *window); - void SetSizer(wxSizer *sizer); - void SetSpacer(const wxSize& size); - void SetSpacer(int width, int height) { SetSpacer(wxSize(width, height)); } +#if WXWIN_COMPATIBILITY_2_8 + // these functions do not free the old sizer/spacer and so can easily + // provoke the memory leaks and so shouldn't be used, use Assign() instead + wxDEPRECATED( void SetWindow(wxWindow *window) ); + wxDEPRECATED( void SetSizer(wxSizer *sizer) ); + wxDEPRECATED( void SetSpacer(const wxSize& size) ); + wxDEPRECATED( void SetSpacer(int width, int height) ); +#endif // WXWIN_COMPATIBILITY_2_8 protected: // common part of several ctors - void Init() { m_userData = NULL; } + void Init() { m_userData = NULL; m_kind = Item_None; } // common part of ctors taking wxSizerFlags void Init(const wxSizerFlags& flags); + // free current contents + void Free(); + + // common parts of Set/AssignXXX() + void DoSetWindow(wxWindow *window); + void DoSetSizer(wxSizer *sizer); + void DoSetSpacer(const wxSize& size); + + // discriminated union: depending on m_kind one of the fields is valid enum { Item_None, @@ -309,91 +433,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,6 +532,10 @@ 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(); @@ -434,8 +569,12 @@ public: // Calculate the minimal size or return m_minSize if bigger. wxSize GetMinSize(); - virtual void RecalcSizes() = 0; + // These virtual functions are used by the layout algorithm: first + // CalcMin() is called to calculate the minimal size of the sizer and + // prepare for laying it out and then RecalcSizes() is called to really + // update all the sizer items virtual wxSize CalcMin() = 0; + virtual void RecalcSizes() = 0; virtual void Layout(); @@ -446,6 +585,8 @@ public: wxSizerItemList& GetChildren() { return m_children; } + const wxSizerItemList& GetChildren() const + { return m_children; } void SetDimension( int x, int y, int width, int height ); @@ -473,24 +614,21 @@ 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 ); wxSize GetMaxClientSize( wxWindow *window ) const; wxSize GetMinClientSize( wxWindow *window ); - wxSize FitSize( wxWindow *window ); wxSize VirtualFitSize( wxWindow *window ); virtual void DoSetMinSize( int width, int height ); @@ -596,8 +734,7 @@ public: protected: void AdjustForFlexDirection(); - void AdjustForGrowables(const wxSize& sz, const wxSize& minsz, - int nrows, int ncols); + void AdjustForGrowables(const wxSize& sz); // the heights/widths of all rows/columns wxArrayInt m_rowHeights, @@ -631,24 +768,80 @@ private: class WXDLLEXPORT wxBoxSizer: public wxSizer { public: - wxBoxSizer( int orient ); + wxBoxSizer(int orient) + { + m_orient = orient; - void RecalcSizes(); - wxSize CalcMin(); + wxASSERT_MSG( m_orient == wxHORIZONTAL || m_orient == wxVERTICAL, + _T("invalid value for wxBoxSizer orientation") ); + } + + int GetOrientation() const { return m_orient; } - int GetOrientation() const - { return m_orient; } + bool IsVertical() const { return m_orient == wxVERTICAL; } - void SetOrientation(int orient) - { m_orient = orient; } + void SetOrientation(int orient) { m_orient = orient; } + + // implementation of our resizing logic + virtual wxSize CalcMin(); + virtual void RecalcSizes(); protected: + // helpers for our code: this returns the component of the given wxSize in + // the direction of the sizer and in the other direction, respectively + int SizeInMajorDir(const wxSize& sz) const + { + return m_orient == wxHORIZONTAL ? sz.x : sz.y; + } + + int& SizeInMajorDir(wxSize& sz) + { + return m_orient == wxHORIZONTAL ? sz.x : sz.y; + } + + int& PosInMajorDir(wxPoint& pt) + { + return m_orient == wxHORIZONTAL ? pt.x : pt.y; + } + + int SizeInMinorDir(const wxSize& sz) const + { + return m_orient == wxHORIZONTAL ? sz.y : sz.x; + } + + int& SizeInMinorDir(wxSize& sz) + { + return m_orient == wxHORIZONTAL ? sz.y : sz.x; + } + + int& PosInMinorDir(wxPoint& pt) + { + return m_orient == wxHORIZONTAL ? pt.y : pt.x; + } + + // another helper: creates wxSize from major and minor components + wxSize SizeFromMajorMinor(int major, int minor) const + { + if ( m_orient == wxHORIZONTAL ) + { + return wxSize(major, minor); + } + else // wxVERTICAL + { + return wxSize(minor, major); + } + } + + + // either wxHORIZONTAL or wxVERTICAL int m_orient; - int m_stretchable; - int m_minWidth; - int m_minHeight; - int m_fixedWidth; - int m_fixedHeight; + + // the sum of proportion of all of our elements + int m_totalProportion; + + // the minimal size needed for this sizer as calculated by the last call to + // our CalcMin() + wxSize m_minSize; private: DECLARE_CLASS(wxBoxSizer) @@ -660,13 +853,14 @@ private: #if wxUSE_STATBOX -class WXDLLEXPORT wxStaticBox; +class WXDLLIMPEXP_FWD_CORE wxStaticBox; 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 +871,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; @@ -723,10 +921,10 @@ public: protected: wxButton *m_buttonAffirmative; // wxID_OK, wxID_YES, wxID_SAVE go here - wxButton *m_buttonApply; + wxButton *m_buttonApply; // wxID_APPLY wxButton *m_buttonNegative; // wxID_NO - wxButton *m_buttonCancel; - wxButton *m_buttonHelp; + wxButton *m_buttonCancel; // wxID_CANCEL, wxID_CLOSE + wxButton *m_buttonHelp; // wxID_HELP, wxID_CONTEXT_HELP private: DECLARE_CLASS(wxStdDialogButtonSizer) @@ -735,70 +933,41 @@ private: #endif // wxUSE_BUTTON -#if WXWIN_COMPATIBILITY_2_4 -// NB: wxBookCtrlSizer and wxNotebookSizer are deprecated, they -// don't do anything. wxBookCtrlBase::DoGetBestSize does the job now. // ---------------------------------------------------------------------------- -// wxBookCtrlSizer +// inline functions implementation // ---------------------------------------------------------------------------- -#if wxUSE_BOOKCTRL +#if WXWIN_COMPATIBILITY_2_8 -// this sizer works with wxNotebook/wxListbook/... and sizes the control to -// fit its pages -class WXDLLEXPORT wxBookCtrlBase; - -class WXDLLEXPORT wxBookCtrlSizer : public wxSizer +inline void wxSizerItem::SetWindow(wxWindow *window) { -public: - wxDEPRECATED( wxBookCtrlSizer(wxBookCtrlBase *bookctrl) ); - - wxBookCtrlBase *GetControl() const { return m_bookctrl; } - - virtual void RecalcSizes(); - virtual wxSize CalcMin(); - -protected: - // this protected ctor lets us mark the real one above as deprecated - // and still have warning-free build of the library itself: - wxBookCtrlSizer() {} - - wxBookCtrlBase *m_bookctrl; - -private: - DECLARE_CLASS(wxBookCtrlSizer) - DECLARE_NO_COPY_CLASS(wxBookCtrlSizer) -}; - - -#if wxUSE_NOTEBOOK - -// before wxBookCtrlBase we only had wxNotebookSizer, keep it for backwards -// compatibility -class WXDLLEXPORT wxNotebook; + DoSetWindow(window); +} -class WXDLLEXPORT wxNotebookSizer : public wxBookCtrlSizer +inline void wxSizerItem::SetSizer(wxSizer *sizer) { -public: - wxDEPRECATED( wxNotebookSizer(wxNotebook *nb) ); - - wxNotebook *GetNotebook() const { return (wxNotebook *)m_bookctrl; } + DoSetSizer(sizer); +} -private: - DECLARE_CLASS(wxNotebookSizer) - DECLARE_NO_COPY_CLASS(wxNotebookSizer) -}; +inline void wxSizerItem::SetSpacer(const wxSize& size) +{ + DoSetSpacer(size); +} -#endif // wxUSE_NOTEBOOK +inline void wxSizerItem::SetSpacer(int width, int height) +{ + DoSetSpacer(wxSize(width, height)); +} -#endif // wxUSE_BOOKCTRL +#endif // WXWIN_COMPATIBILITY_2_8 -#endif // WXWIN_COMPATIBILITY_2_4 -// ---------------------------------------------------------------------------- -// 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 +999,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 +1011,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 +1035,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) { @@ -954,6 +1117,4 @@ wxSizer::InsertStretchSpacer(size_t index, int prop) return Insert(index, 0, 0, prop); } - #endif // __WXSIZER_H__ -