X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4393b50ccd24114090d61665ba737e64b755cbde..dcb139ff26b3fc3b03852c95ae72c3fd7dc5153f:/include/wx/sizer.h diff --git a/include/wx/sizer.h b/include/wx/sizer.h index a9b4295653..4023dfa87f 100644 --- a/include/wx/sizer.h +++ b/include/wx/sizer.h @@ -2,7 +2,7 @@ // Name: sizer.h // Purpose: provide wxSizer class for layout // Author: Robert Roebling and Robin Dunn -// Modified by: Ron Lee +// Modified by: Ron Lee, Vadim Zeitlin (wxSizerFlags) // Created: // RCS-ID: $Id$ // Copyright: (c) Robin Dunn, Robert Roebling @@ -12,7 +12,7 @@ #ifndef __WXSIZER_H__ #define __WXSIZER_H__ -#if defined(__GNUG__) && !defined(__APPLE__) +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "sizer.h" #endif @@ -21,14 +21,83 @@ #include "wx/window.h" #include "wx/frame.h" #include "wx/dialog.h" +#include "wx/bookctrl.h" //--------------------------------------------------------------------------- // classes //--------------------------------------------------------------------------- -class wxSizerItem; -class wxSizer; -class wxBoxSizer; +class WXDLLEXPORT wxSizerItem; +class WXDLLEXPORT wxSizer; +class WXDLLEXPORT wxBoxSizer; + + +// ---------------------------------------------------------------------------- +// wxSizerFlags: flags used for an item in the sizer +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxSizerFlags +{ +public: + // construct the flags object initialized with the given proportion (0 by + // default) + wxSizerFlags(int proportion = 0) : m_proportion(proportion) + { + m_flags = 0; + m_borderInPixels = 0; + } + + // setters for all sizer flags, they all return the object itself so that + // calls to them can be chained + + wxSizerFlags& Proportion(int proportion) + { + m_proportion = proportion; + return *this; + } + + wxSizerFlags& Align(int alignment) // combination of wxAlignment values + { + m_flags &= wxALL; + m_flags |= alignment; + + return *this; + } + + // some shortcuts for Align() + wxSizerFlags& Expand() { return Align(wxEXPAND); } + wxSizerFlags& Centre() { return Align(wxCENTRE); } + wxSizerFlags& Center() { return Centre(); } + + + wxSizerFlags& Border(int direction, int borderInPixels) + { + m_flags &= ~wxALL; + m_flags |= direction; + + m_borderInPixels = borderInPixels; + + return *this; + } + + wxSizerFlags& Border(int direction = wxALL) + { + // FIXME: default border size shouldn't be hardcoded + return Border(direction, 5); + } + + + // accessors for wxSizer only + int GetProportion() const { return m_proportion; } + int GetFlags() const { return m_flags; } + int GetBorderInPixels() const { return m_borderInPixels; } + +private: + int m_proportion; + int m_flags; + int m_borderInPixels; +}; + //--------------------------------------------------------------------------- // wxSizerItem @@ -37,13 +106,21 @@ class wxBoxSizer; class WXDLLEXPORT wxSizerItem: public wxObject { public: - // spacer - wxSizerItem( int width, - int height, - int proportion, - int flag, - int border, - wxObject* userData); + // window with flags + wxSizerItem(wxWindow *window, const wxSizerFlags& flags) + { + Init(flags); + + m_window = window; + } + + // sizer with flags + wxSizerItem(wxSizer *sizer, const wxSizerFlags& flags) + { + Init(flags); + + m_sizer = sizer; + } // window wxSizerItem( wxWindow *window, @@ -59,7 +136,16 @@ public: int border, wxObject* userData ); - ~wxSizerItem(); + // spacer + wxSizerItem( int width, + int height, + int proportion, + int flag, + int border, + wxObject* userData); + + wxSizerItem(); + virtual ~wxSizerItem(); virtual void DeleteWindows(); @@ -73,8 +159,17 @@ public: 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 ) - { 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 @@ -111,7 +206,7 @@ public: 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 ) @@ -131,6 +226,13 @@ public: { return m_pos; } protected: + // common part of several ctors + void Init(); + + // common part of ctors taking wxSizerFlags + void Init(const wxSizerFlags& flags); + + wxWindow *m_window; wxSizer *m_sizer; wxSize m_size; @@ -169,64 +271,84 @@ public: wxSizer(); ~wxSizer(); - /* These should be called Append() really. */ - 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, + // methods for adding elements to the sizer: there are Add/Insert/Prepend + // overloads for each of window/sizer/spacer/wxSizerItem + inline void Add( wxWindow *window, + int proportion = 0, + int flag = 0, + int border = 0, + wxObject* userData = NULL ); + inline void Add( wxSizer *sizer, + int proportion = 0, + int flag = 0, + int border = 0, + wxObject* userData = NULL ); + inline void Add( int width, + int height, + int proportion = 0, + int flag = 0, + int border = 0, + wxObject* userData = NULL ); + inline void Add( wxWindow *window, const wxSizerFlags& flags ); + inline void Add( wxSizer *sizer, const wxSizerFlags& flags ); + inline void Add( wxSizerItem *item ); + + inline void AddSpacer(int size); + inline void AddStretchSpacer(int prop = 1); + + inline void Insert( size_t index, + wxWindow *window, + int proportion = 0, + int flag = 0, + int border = 0, + wxObject* userData = NULL ); + inline void Insert( size_t index, + wxSizer *sizer, + int proportion = 0, + int flag = 0, + int border = 0, + wxObject* userData = NULL ); + inline void Insert( size_t index, + int width, + int height, + int proportion = 0, + int flag = 0, + int border = 0, + wxObject* userData = NULL ); + inline void Insert( size_t index, + wxWindow *window, + const wxSizerFlags& flags ); + inline void Insert( size_t index, + wxSizer *sizer, + const wxSizerFlags& flags ); + virtual void Insert( size_t index, wxSizerItem *item ); + + inline void InsertSpacer(size_t index, int size); + inline void InsertStretchSpacer(size_t index, int prop = 1); + + inline void Prepend( wxWindow *window, int proportion = 0, int flag = 0, int border = 0, wxObject* userData = NULL ); - virtual void Insert( size_t index, - wxSizer *sizer, + inline void Prepend( wxSizer *sizer, int proportion = 0, int flag = 0, int border = 0, wxObject* userData = NULL ); - virtual void Insert( size_t index, - int width, + inline void Prepend( 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 ); + inline void Prepend( wxWindow *window, const wxSizerFlags& flags ); + inline void Prepend( wxSizer *sizer, const wxSizerFlags& flags ); + inline void Prepend( wxSizerItem *item ); + + inline void PrependSpacer(int size); + inline void PrependStretchSpacer(int prop = 1); + // Deprecated in 2.6 since historically it does not delete the window, // use Detach instead. @@ -288,23 +410,23 @@ public: // 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 ); + bool Show( wxWindow *window, bool show = true, bool recursive = false ); + bool Show( wxSizer *sizer, bool show = true, bool recursive = false ); + bool 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 Hide( wxSizer *sizer, bool recursive = false ) + { return Show( sizer, false, recursive ); } + bool Hide( wxWindow *window, bool recursive = false ) + { return Show( window, false, recursive ); } + bool Hide( size_t index ) + { return 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); + virtual void ShowItems (bool show); protected: wxSize m_size; @@ -412,12 +534,19 @@ public: 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; @@ -435,6 +564,9 @@ protected: int m_flexDirection; wxFlexSizerGrowMode m_growMode; + // saves CalcMin result to optimize RecalcSizes + wxSize m_calculatedMinSize; + private: DECLARE_CLASS(wxFlexGridSizer) DECLARE_NO_COPY_CLASS(wxFlexGridSizer) @@ -489,6 +621,9 @@ public: wxStaticBox *GetStaticBox() const { return m_staticBox; } + // override to hide/show the static box as well + virtual void ShowItems (bool show); + protected: wxStaticBox *m_staticBox; @@ -499,27 +634,56 @@ private: #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 -class WXDLLEXPORT wxNotebookSizer: public wxSizer +// this sizer works with wxNotebook/wxListbook/... and sizes the control to +// fit its pages +class WXDLLEXPORT wxBookCtrl; + +class WXDLLEXPORT wxBookCtrlSizer : public wxSizer { public: - wxNotebookSizer( wxNotebook *nb ); + wxDEPRECATED( wxBookCtrlSizer(wxBookCtrl *bookctrl) ); - void RecalcSizes(); - wxSize CalcMin(); + wxBookCtrl *GetControl() const { return m_bookctrl; } - wxNotebook *GetNotebook() const - { return m_notebook; } + virtual void RecalcSizes(); + virtual wxSize CalcMin(); 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: + 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) @@ -528,6 +692,168 @@ private: #endif // wxUSE_NOTEBOOK +#endif // wxUSE_BOOKCTRL + +#endif // WXWIN_COMPATIBILITY_2_4 + +// ---------------------------------------------------------------------------- +// inline functions implementation +// ---------------------------------------------------------------------------- + +inline void +wxSizer::Add( wxWindow *window, int proportion, int flag, int border, wxObject* userData ) +{ + Add( new wxSizerItem( window, proportion, flag, border, userData ) ); +} + +inline void +wxSizer::Add( wxSizer *sizer, int proportion, int flag, int border, wxObject* userData ) +{ + Add( new wxSizerItem( sizer, proportion, flag, border, userData ) ); +} + +inline void +wxSizer::Add( int width, int height, int proportion, int flag, int border, wxObject* userData ) +{ + Add( new wxSizerItem( width, height, proportion, flag, border, userData ) ); +} + +inline void +wxSizer::Add( wxWindow *window, const wxSizerFlags& flags ) +{ + Add( new wxSizerItem(window, flags) ); +} + +inline void +wxSizer::Add( wxSizer *sizer, const wxSizerFlags& flags ) +{ + Add( new wxSizerItem(sizer, flags) ); +} + +inline void +wxSizer::Add( wxSizerItem *item ) +{ + Insert( m_children.GetCount(), item ); +} + +inline void +wxSizer::AddSpacer(int size) +{ + Add(size, size); +} + +inline void +wxSizer::AddStretchSpacer(int prop) +{ + Add(0, 0, prop); +} + +inline void +wxSizer::Prepend( wxWindow *window, int proportion, int flag, int border, wxObject* userData ) +{ + Prepend( new wxSizerItem( window, proportion, flag, border, userData ) ); +} + +inline void +wxSizer::Prepend( wxSizer *sizer, int proportion, int flag, int border, wxObject* userData ) +{ + Prepend( new wxSizerItem( sizer, proportion, flag, border, userData ) ); +} + +inline void +wxSizer::Prepend( int width, int height, int proportion, int flag, int border, wxObject* userData ) +{ + Prepend( new wxSizerItem( width, height, proportion, flag, border, userData ) ); +} + +inline void +wxSizer::Prepend( wxSizerItem *item ) +{ + Insert( 0, item ); +} + +inline void +wxSizer::PrependSpacer(int size) +{ + Prepend(size, size); +} + +inline void +wxSizer::PrependStretchSpacer(int prop) +{ + Prepend(0, 0, prop); +} + +inline void +wxSizer::Prepend( wxWindow *window, const wxSizerFlags& flags ) +{ + Prepend( new wxSizerItem(window, flags) ); +} + +inline void +wxSizer::Prepend( wxSizer *sizer, const wxSizerFlags& flags ) +{ + Prepend( new wxSizerItem(sizer, flags) ); +} + +inline void +wxSizer::Insert( size_t index, + wxWindow *window, + int proportion, + int flag, + int border, + wxObject* userData ) +{ + Insert( index, new wxSizerItem( window, proportion, flag, border, userData ) ); +} + +inline void +wxSizer::Insert( size_t index, + wxSizer *sizer, + int proportion, + int flag, + int border, + wxObject* userData ) +{ + Insert( index, new wxSizerItem( sizer, proportion, flag, border, userData ) ); +} + +inline void +wxSizer::Insert( size_t index, + int width, + int height, + int proportion, + int flag, + int border, + wxObject* userData ) +{ + Insert( index, new wxSizerItem( width, height, proportion, flag, border, userData ) ); +} + +inline void +wxSizer::Insert( size_t index, wxWindow *window, const wxSizerFlags& flags ) +{ + Insert( index, new wxSizerItem(window, flags) ); +} + +inline void +wxSizer::Insert( size_t index, wxSizer *sizer, const wxSizerFlags& flags ) +{ + Insert( index, new wxSizerItem(sizer, flags) ); +} + +inline void +wxSizer::InsertSpacer(size_t index, int size) +{ + Insert(index, size, size); +} + +inline void +wxSizer::InsertStretchSpacer(size_t index, int prop) +{ + Insert(index, 0, 0, prop); +} + + +#endif // __WXSIZER_H__ -#endif - // __WXSIZER_H__