X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/adbf2d732fe5f254f45ab27530e4f9c044cb385f..56eeb97339e6760855b4e7866b7f4dd92368a189:/include/wx/sizer.h diff --git a/include/wx/sizer.h b/include/wx/sizer.h index 804c618dbd..ea5803beba 100644 --- a/include/wx/sizer.h +++ b/include/wx/sizer.h @@ -1,8 +1,8 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: sizer.h +// Name: wx/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,39 +12,206 @@ #ifndef __WXSIZER_H__ #define __WXSIZER_H__ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) -#pragma interface "sizer.h" -#endif - #include "wx/defs.h" #include "wx/window.h" -#include "wx/frame.h" -#include "wx/dialog.h" //--------------------------------------------------------------------------- // classes //--------------------------------------------------------------------------- -class wxSizerItem; -class wxSizer; -class wxBoxSizer; +class WXDLLEXPORT wxButton; +class WXDLLEXPORT wxBoxSizer; +class WXDLLEXPORT wxSizerItem; +class WXDLLEXPORT 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 -//--------------------------------------------------------------------------- -// wxSizerItem -//--------------------------------------------------------------------------- +// ---------------------------------------------------------------------------- +// wxSizerFlags: flags used for an item in the sizer +// ---------------------------------------------------------------------------- -class WXDLLEXPORT wxSizerItem: public wxObject +class WXDLLEXPORT wxSizerFlags { public: - // spacer - wxSizerItem( int width, - int height, - int proportion, - int flag, - int border, - wxObject* userData); + // 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 &= ~wxALIGN_MASK; + m_flags |= alignment; + + return *this; + } + + wxSizerFlags& Expand() + { + m_flags |= wxEXPAND; + return *this; + } + + // some shortcuts for Align() + 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) + { + m_flags &= ~wxALL; + m_flags |= direction; + + m_borderInPixels = borderInPixels; + + return *this; + } + + wxSizerFlags& Border(int direction = wxALL) + { +#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; } + int GetFlags() const { return m_flags; } + int GetBorderInPixels() const { return m_borderInPixels; } + +private: + int m_proportion; + int m_flags; + int m_borderInPixels; +}; + + +// ---------------------------------------------------------------------------- +// wxSizerSpacer: used by wxSizerItem to represent a spacer +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxSizerSpacer +{ +public: + wxSizerSpacer(const wxSize& size) : m_size(size), m_isShown(true) { } + + void SetSize(const wxSize& size) { m_size = size; } + const wxSize& GetSize() const { return m_size; } + + void Show(bool show) { m_isShown = show; } + bool IsShown() const { return m_isShown; } + +private: + // the size, in pixel + wxSize m_size; + + // is the spacer currently shown? + bool m_isShown; +}; + +// ---------------------------------------------------------------------------- +// wxSizerItem +// ---------------------------------------------------------------------------- +class WXDLLEXPORT wxSizerItem : public wxObject +{ +public: // window wxSizerItem( wxWindow *window, int proportion, @@ -52,6 +219,14 @@ public: int border, wxObject* userData ); + // window with flags + wxSizerItem(wxWindow *window, const wxSizerFlags& flags) + { + Init(flags); + + DoSetWindow(window); + } + // subsizer wxSizerItem( wxSizer *sizer, int proportion, @@ -59,50 +234,79 @@ public: int border, wxObject* userData ); + // sizer with flags + wxSizerItem(wxSizer *sizer, const wxSizerFlags& flags) + { + Init(flags); + + DoSetSizer(sizer); + } + + // spacer + wxSizerItem( int width, + int height, + int proportion, + int flag, + int border, + wxObject* userData); + + // spacer with flags + wxSizerItem(int width, int height, const wxSizerFlags& flags) + { + Init(flags); + + DoSetSpacer(wxSize(width, height)); + } + wxSizerItem(); virtual ~wxSizerItem(); virtual void DeleteWindows(); // Enable deleting the SizerItem without destroying the contained sizer. - void DetachSizer() - { m_sizer = 0; } + void DetachSizer() { m_sizer = NULL; } 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; } + wxSize GetMinSizeWithBorder() const; + void SetMinSize(const wxSize& size) - { - if (IsWindow() && !(m_flag & wxFIXED_MINSIZE)) - m_window->SetSizeHints(size); - m_minSize = size; - } + { + if ( IsWindow() ) + m_window->SetMinSize(size); + m_minSize = size; + } void SetMinSize( int x, int y ) - { SetMinSize(wxSize(x, y)); } + { SetMinSize(wxSize(x, y)); } void SetInitSize( int x, int y ) { SetMinSize(wxSize(x, y)); } - void SetRatio( int width, int height ) - // if either of dimensions is zero, ratio is assumed to be 1 - // to avoid "divide by zero" errors + // if either of dimensions is zero, ratio is assumed to be 1 + // to avoid "divide by zero" errors + void SetRatio(int width, int height) { m_ratio = (width && height) ? ((float) width / (float) height) : 1; } - void SetRatio( wxSize size ) - { m_ratio = (size.x && size.y) ? ((float) size.x / (float) size.y) : 1; } - void SetRatio( float ratio ) + void SetRatio(const wxSize& size) + { SetRatio(size.x, size.y); } + void SetRatio(float ratio) { m_ratio = ratio; } float GetRatio() const { return m_ratio; } - bool IsWindow() const; - bool IsSizer() const; - bool IsSpacer() const; + virtual wxRect GetRect() { return m_rect; } + + bool IsWindow() const { return m_kind == Item_Window; } + 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; } @@ -118,40 +322,94 @@ public: { return m_border; } wxWindow *GetWindow() const - { return m_window; } - void SetWindow( wxWindow *window ) - { m_window = window; m_minSize = window->GetSize(); } + { return m_kind == Item_Window ? m_window : NULL; } wxSizer *GetSizer() const - { return m_sizer; } - void SetSizer( wxSizer *sizer ) - { m_sizer = sizer; } - const wxSize &GetSpacer() const - { return m_size; } - void SetSpacer( const wxSize &size ) - { m_size = size; m_minSize = size; } + { return m_kind == Item_Sizer ? m_sizer : NULL; } + wxSize GetSpacer() const; - void Show ( bool show ); - bool IsShown() const - { return m_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)); } + +#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: - wxWindow *m_window; - wxSizer *m_sizer; - wxSize m_size; + // common part of several ctors + 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, + Item_Window, + Item_Sizer, + Item_Spacer, + Item_Max + } m_kind; + union + { + wxWindow *m_window; + wxSizer *m_sizer; + wxSizerSpacer *m_spacer; + }; + wxPoint m_pos; wxSize m_minSize; int m_proportion; int m_border; int m_flag; - // If true, then this item is considered in the layout - // calculation. Otherwise, it is skipped over. - bool m_show; + // on screen rectangle of this item (not including borders) + wxRect m_rect; // Aspect ratio can always be calculated from m_size, // but this would cause precision loss when the window @@ -175,71 +433,98 @@ WX_DECLARE_EXPORTED_LIST( wxSizerItem, wxSizerItemList ); class WXDLLEXPORT wxSizer: public wxObject, public wxClientDataContainer { 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, + 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 + 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 ); - virtual void Insert( size_t index, - wxSizer *sizer, + wxObject* userData = NULL); + wxSizerItem* Prepend(wxSizer *sizer, int proportion = 0, int flag = 0, int border = 0, - wxObject* userData = NULL ); - virtual void Insert( size_t index, - int width, + wxObject* userData = NULL); + wxSizerItem* 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 ); + 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 ); @@ -247,29 +532,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 */ + // 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 */ + // 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 @@ -277,11 +566,15 @@ public: wxPoint GetPosition() const { return m_position; } - /* Calculate the minimal size or return m_minSize if bigger. */ + // 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(); @@ -292,21 +585,27 @@ public: wxSizerItemList& GetChildren() { return m_children; } + const wxSizerItemList& GetChildren() const + { return m_children; } void SetDimension( int x, int y, int width, int height ); + wxSizerItem* GetItem( wxWindow *window, bool recursive = false ); + wxSizerItem* GetItem( wxSizer *sizer, bool recursive = false ); + wxSizerItem* GetItem( size_t index ); + // 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; @@ -315,17 +614,21 @@ public: // Recursively call wxWindow::Show () on all sizer items. virtual void ShowItems (bool show); + void Show(bool show) { ShowItems(show); } + protected: wxSize m_size; wxSize m_minSize; wxPoint m_position; wxSizerItemList m_children; + // 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 ); @@ -424,16 +727,15 @@ public: // 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); - + void AdjustForGrowables(const wxSize& sz); + // the heights/widths of all rows/columns wxArrayInt m_rowHeights, m_colWidths; @@ -451,6 +753,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) @@ -463,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; } + + bool IsVertical() const { return m_orient == wxVERTICAL; } - int GetOrientation() const - { return m_orient; } + 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) @@ -497,7 +858,9 @@ class WXDLLEXPORT wxStaticBox; class WXDLLEXPORT wxStaticBoxSizer: public wxBoxSizer { public: - wxStaticBoxSizer( wxStaticBox *box, int orient ); + wxStaticBoxSizer(wxStaticBox *box, int orient); + wxStaticBoxSizer(int orient, wxWindow *win, const wxString& label = wxEmptyString); + virtual ~wxStaticBoxSizer(); void RecalcSizes(); wxSize CalcMin(); @@ -508,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; @@ -518,68 +885,236 @@ private: #endif // wxUSE_STATBOX +#if wxUSE_BUTTON + +class WXDLLEXPORT wxStdDialogButtonSizer: public wxBoxSizer +{ +public: + // Constructor just creates a new wxBoxSizer, not much else. + // Box sizer orientation is automatically determined here: + // vertical for PDAs, horizontal for everything else? + wxStdDialogButtonSizer(); + + // Checks button ID against system IDs and sets one of the pointers below + // to this button. Does not do any sizer-related things here. + void AddButton(wxButton *button); + + // Use these if no standard ID can/should be used + void SetAffirmativeButton( wxButton *button ); + void SetNegativeButton( wxButton *button ); + void SetCancelButton( wxButton *button ); + + // All platform-specific code here, checks which buttons exist and add + // them to the sizer accordingly. + // Note - one potential hack on Mac we could use here, + // if m_buttonAffirmative is wxID_SAVE then ensure wxID_SAVE + // is set to _("Save") and m_buttonNegative is set to _("Don't Save") + // I wouldn't add any other hacks like that into here, + // but this one I can see being useful. + void Realize(); + + wxButton *GetAffirmativeButton() const { return m_buttonAffirmative; } + wxButton *GetApplyButton() const { return m_buttonApply; } + wxButton *GetNegativeButton() const { return m_buttonNegative; } + wxButton *GetCancelButton() const { return m_buttonCancel; } + wxButton *GetHelpButton() const { return m_buttonHelp; } + +protected: + wxButton *m_buttonAffirmative; // wxID_OK, wxID_YES, wxID_SAVE go here + wxButton *m_buttonApply; // wxID_APPLY + wxButton *m_buttonNegative; // wxID_NO + wxButton *m_buttonCancel; // wxID_CANCEL, wxID_CLOSE + wxButton *m_buttonHelp; // wxID_HELP, wxID_CONTEXT_HELP + +private: + DECLARE_CLASS(wxStdDialogButtonSizer) + DECLARE_NO_COPY_CLASS(wxStdDialogButtonSizer) +}; + +#endif // wxUSE_BUTTON -#if WXWIN_COMPATIBILITY_2_4 -// NB: wxBookCtrlSizer and wxNotebookSizer are deprecated, they -// don't do anything. wxBookCtrl::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 wxBookCtrl; +inline void wxSizerItem::SetWindow(wxWindow *window) +{ + DoSetWindow(window); +} -class WXDLLEXPORT wxBookCtrlSizer : public wxSizer +inline void wxSizerItem::SetSizer(wxSizer *sizer) { -public: - wxDEPRECATED( wxBookCtrlSizer(wxBookCtrl *bookctrl) ); + DoSetSizer(sizer); +} - wxBookCtrl *GetControl() const { return m_bookctrl; } - - virtual void RecalcSizes(); - virtual wxSize CalcMin(); +inline void wxSizerItem::SetSpacer(const wxSize& size) +{ + DoSetSpacer(size); +} -protected: - // this protected ctor lets us mark the real one above as deprecated - // and still has warning-free build of the library itself: - wxBookCtrlSizer() {} - - wxBookCtrl *m_bookctrl; +inline void wxSizerItem::SetSpacer(int width, int height) +{ + DoSetSpacer(wxSize(width, height)); +} -private: - DECLARE_CLASS(wxBookCtrlSizer) - DECLARE_NO_COPY_CLASS(wxBookCtrlSizer) -}; +#endif // WXWIN_COMPATIBILITY_2_8 -#if wxUSE_NOTEBOOK +inline wxSizerItem* +wxSizer::Add( wxSizerItem *item ) +{ + return Insert( m_children.GetCount(), item ); +} -// before wxBookCtrl we only had wxNotebookSizer, keep it for backwards -// compatibility -class WXDLLEXPORT wxNotebook; +inline wxSizerItem* +wxSizer::Add( wxWindow *window, int proportion, int flag, int border, wxObject* userData ) +{ + return Add( new wxSizerItem( window, proportion, flag, border, userData ) ); +} -class WXDLLEXPORT wxNotebookSizer : public wxBookCtrlSizer +inline wxSizerItem* +wxSizer::Add( wxSizer *sizer, int proportion, int flag, int border, wxObject* userData ) { -public: - wxDEPRECATED( wxNotebookSizer(wxNotebook *nb) ); + return Add( new wxSizerItem( sizer, proportion, flag, border, userData ) ); +} - wxNotebook *GetNotebook() const { return (wxNotebook *)m_bookctrl; } +inline wxSizerItem* +wxSizer::Add( int width, int height, int proportion, int flag, int border, wxObject* userData ) +{ + return Add( new wxSizerItem( width, height, proportion, flag, border, userData ) ); +} -private: - DECLARE_CLASS(wxNotebookSizer) - DECLARE_NO_COPY_CLASS(wxNotebookSizer) -}; +inline wxSizerItem* +wxSizer::Add( wxWindow *window, const wxSizerFlags& flags ) +{ + return Add( new wxSizerItem(window, flags) ); +} -#endif // wxUSE_NOTEBOOK +inline wxSizerItem* +wxSizer::Add( wxSizer *sizer, const wxSizerFlags& flags ) +{ + return Add( new wxSizerItem(sizer, flags) ); +} -#endif // wxUSE_BOOKCTRL +inline wxSizerItem* +wxSizer::AddSpacer(int size) +{ + return Add(size, size); +} -#endif // WXWIN_COMPATIBILITY_2_4 +inline wxSizerItem* +wxSizer::AddStretchSpacer(int prop) +{ + return Add(0, 0, prop); +} +inline wxSizerItem* +wxSizer::Prepend( wxSizerItem *item ) +{ + return Insert( 0, item ); +} -#endif // __WXSIZER_H__ +inline wxSizerItem* +wxSizer::Prepend( wxWindow *window, int proportion, int flag, int border, wxObject* userData ) +{ + return Prepend( new wxSizerItem( window, proportion, flag, border, userData ) ); +} + +inline wxSizerItem* +wxSizer::Prepend( wxSizer *sizer, int proportion, int flag, int border, wxObject* userData ) +{ + return Prepend( new wxSizerItem( sizer, proportion, flag, border, userData ) ); +} + +inline wxSizerItem* +wxSizer::Prepend( int width, int height, int proportion, int flag, int border, wxObject* userData ) +{ + return Prepend( new wxSizerItem( width, height, proportion, flag, border, userData ) ); +} + +inline wxSizerItem* +wxSizer::PrependSpacer(int size) +{ + return Prepend(size, size); +} + +inline wxSizerItem* +wxSizer::PrependStretchSpacer(int prop) +{ + return Prepend(0, 0, prop); +} + +inline wxSizerItem* +wxSizer::Prepend( wxWindow *window, const wxSizerFlags& flags ) +{ + return Prepend( new wxSizerItem(window, flags) ); +} + +inline wxSizerItem* +wxSizer::Prepend( wxSizer *sizer, const wxSizerFlags& flags ) +{ + return Prepend( new wxSizerItem(sizer, flags) ); +} + +inline wxSizerItem* +wxSizer::Insert( size_t index, + wxWindow *window, + int proportion, + int flag, + int border, + wxObject* userData ) +{ + return Insert( index, new wxSizerItem( window, proportion, flag, border, userData ) ); +} + +inline wxSizerItem* +wxSizer::Insert( size_t index, + wxSizer *sizer, + int proportion, + int flag, + int border, + wxObject* userData ) +{ + return Insert( index, new wxSizerItem( sizer, proportion, flag, border, userData ) ); +} + +inline wxSizerItem* +wxSizer::Insert( size_t index, + int width, + int height, + int proportion, + int flag, + int border, + wxObject* userData ) +{ + return Insert( index, new wxSizerItem( width, height, proportion, flag, border, userData ) ); +} + +inline wxSizerItem* +wxSizer::Insert( size_t index, wxWindow *window, const wxSizerFlags& flags ) +{ + return Insert( index, new wxSizerItem(window, flags) ); +} + +inline wxSizerItem* +wxSizer::Insert( size_t index, wxSizer *sizer, const wxSizerFlags& flags ) +{ + return Insert( index, new wxSizerItem(sizer, flags) ); +} +inline wxSizerItem* +wxSizer::InsertSpacer(size_t index, int size) +{ + return Insert(index, size, size); +} + +inline wxSizerItem* +wxSizer::InsertStretchSpacer(size_t index, int prop) +{ + return Insert(index, 0, 0, prop); +} + +#endif // __WXSIZER_H__