X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2a818b7a73b609778bfb413af0be627ef891587c..66c2bf7b1d9326fb650acfaae22ec50528cfbf7c:/include/wx/sizer.h?ds=inline diff --git a/include/wx/sizer.h b/include/wx/sizer.h index 125dd55c7f..7d20b548c8 100644 --- a/include/wx/sizer.h +++ b/include/wx/sizer.h @@ -4,7 +4,6 @@ // Author: Robert Roebling and Robin Dunn // Modified by: Ron Lee, Vadim Zeitlin (wxSizerFlags) // Created: -// RCS-ID: $Id$ // Copyright: (c) Robin Dunn, Robert Roebling // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -38,7 +37,7 @@ class WXDLLIMPEXP_FWD_CORE wxSizer; // wxSizerFlags: flags used for an item in the sizer // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxSizerFlags +class WXDLLIMPEXP_CORE wxSizerFlags { public: // construct the flags object initialized with the given proportion (0 by @@ -58,6 +57,15 @@ public: return *this; } + wxSizerFlags& Expand() + { + m_flags |= wxEXPAND; + return *this; + } + + // notice that Align() replaces the current alignment flags, use specific + // methods below such as Top(), Left() &c if you want to set just the + // vertical or horizontal alignment wxSizerFlags& Align(int alignment) // combination of wxAlignment values { m_flags &= ~wxALIGN_MASK; @@ -66,27 +74,48 @@ public: return *this; } - wxSizerFlags& Expand() + // some shortcuts for Align() + wxSizerFlags& Centre() { return Align(wxALIGN_CENTRE); } + wxSizerFlags& Center() { return Centre(); } + + wxSizerFlags& Top() { - m_flags |= wxEXPAND; + m_flags &= ~(wxALIGN_BOTTOM | wxALIGN_CENTRE_VERTICAL); + return *this; + } + + wxSizerFlags& Left() + { + m_flags &= ~(wxALIGN_RIGHT | wxALIGN_CENTRE_HORIZONTAL); + return *this; + } + + wxSizerFlags& Right() + { + m_flags = (m_flags & ~wxALIGN_CENTRE_HORIZONTAL) | wxALIGN_RIGHT; + return *this; + } + + wxSizerFlags& Bottom() + { + m_flags = (m_flags & ~wxALIGN_CENTRE_VERTICAL) | wxALIGN_BOTTOM; 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 + #ifdef __WXGTK20__ + // GNOME HIG says to use 6px as the base unit: + // http://library.gnome.org/devel/hig-book/stable/design-window.html.en + return 6; + #else // FIXME: default border size shouldn't be hardcoded and at the very // least they should depend on the current font size return 5; + #endif #else return 0; #endif @@ -95,6 +124,10 @@ public: wxSizerFlags& Border(int direction, int borderInPixels) { + wxCHECK_MSG( !(direction & ~wxALL), *this, + wxS("direction must be a combination of wxDirection ") + wxS("enum values.") ); + m_flags &= ~wxALL; m_flags |= direction; @@ -170,6 +203,13 @@ public: return *this; } + // makes the item ignore window's visibility status + wxSizerFlags& ReserveSpaceEvenIfHidden() + { + m_flags |= wxRESERVE_SPACE_EVEN_IF_HIDDEN; + return *this; + } + // accessors for wxSizer only int GetProportion() const { return m_proportion; } int GetFlags() const { return m_flags; } @@ -186,7 +226,7 @@ private: // wxSizerSpacer: used by wxSizerItem to represent a spacer // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxSizerSpacer +class WXDLLIMPEXP_CORE wxSizerSpacer { public: wxSizerSpacer(const wxSize& size) : m_size(size), m_isShown(true) { } @@ -209,15 +249,15 @@ private: // wxSizerItem // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxSizerItem : public wxObject +class WXDLLIMPEXP_CORE wxSizerItem : public wxObject { public: // window wxSizerItem( wxWindow *window, - int proportion, - int flag, - int border, - wxObject* userData ); + int proportion=0, + int flag=0, + int border=0, + wxObject* userData=NULL ); // window with flags wxSizerItem(wxWindow *window, const wxSizerFlags& flags) @@ -229,10 +269,10 @@ public: // subsizer wxSizerItem( wxSizer *sizer, - int proportion, - int flag, - int border, - wxObject* userData ); + int proportion=0, + int flag=0, + int border=0, + wxObject* userData=NULL ); // sizer with flags wxSizerItem(wxSizer *sizer, const wxSizerFlags& flags) @@ -245,10 +285,10 @@ public: // spacer wxSizerItem( int width, int height, - int proportion, - int flag, - int border, - wxObject* userData); + int proportion=0, + int flag=0, + int border=0, + wxObject* userData=NULL); // spacer with flags wxSizerItem(int width, int height, const wxSizerFlags& flags) @@ -274,6 +314,10 @@ public: { return m_minSize; } wxSize GetMinSizeWithBorder() const; + wxSize GetMaxSize() const + { return IsWindow() ? m_window->GetMaxSize() : wxDefaultSize; } + wxSize GetMaxSizeWithBorder() const; + void SetMinSize(const wxSize& size) { if ( IsWindow() ) @@ -332,10 +376,12 @@ public: { return m_kind == Item_Sizer ? m_sizer : NULL; } wxSize GetSpacer() const; - // this function behaves obviously for the windows and spacers but for the + // 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 + // false if all of them are hidden. Also, it always returns true if + // wxRESERVE_SPACE_EVEN_IF_HIDDEN flag was used. bool IsShown() const; + void Show(bool show); void SetUserData(wxObject* userData) @@ -345,9 +391,9 @@ public: wxPoint GetPosition() const { return m_pos; } - // Called once the first component of an item has been decided. This is - // used in algorithms that depend on knowing the size in one direction - // before the min size in the other direction can be known. + // Called once the first component of an item has been decided. This is + // used in algorithms that depend on knowing the size in one direction + // before the min size in the other direction can be known. // Returns true if it made use of the information (and min size was changed). bool InformFirstDirection( int direction, int size, int availableOtherDir=-1 ); @@ -397,6 +443,10 @@ protected: void DoSetSizer(wxSizer *sizer); void DoSetSpacer(const wxSize& size); + // Add the border specified for this item to the given size + // if it's != wxDefaultSize, just return wxDefaultSize otherwise. + wxSize AddBorderToSize(const wxSize& size) const; + // discriminated union: depending on m_kind one of the fields is valid enum { @@ -432,7 +482,7 @@ protected: private: DECLARE_CLASS(wxSizerItem) - DECLARE_NO_COPY_CLASS(wxSizerItem) + wxDECLARE_NO_COPY_CLASS(wxSizerItem); }; WX_DECLARE_EXPORTED_LIST( wxSizerItem, wxSizerItemList ); @@ -442,7 +492,7 @@ WX_DECLARE_EXPORTED_LIST( wxSizerItem, wxSizerItemList ); // wxSizer //--------------------------------------------------------------------------- -class WXDLLEXPORT wxSizer: public wxObject, public wxClientDataContainer +class WXDLLIMPEXP_CORE wxSizer: public wxObject, public wxClientDataContainer { public: wxSizer() { m_containingWindow = NULL; } @@ -471,7 +521,7 @@ public: wxSizerItem* Add( int width, int height, const wxSizerFlags& flags); wxSizerItem* Add( wxSizerItem *item); - wxSizerItem* AddSpacer(int size); + virtual wxSizerItem *AddSpacer(int size); wxSizerItem* AddStretchSpacer(int prop = 1); wxSizerItem* Insert(size_t index, @@ -502,8 +552,12 @@ public: wxSizerItem* Insert(size_t index, int width, int height, - const wxSizerFlags& flags); - virtual wxSizerItem* Insert( size_t index, wxSizerItem *item); + const wxSizerFlags& flags); + + // NB: do _not_ override this function in the derived classes, this one is + // virtual for compatibility reasons only to allow old code overriding + // it to continue to work, override DoInsert() instead in the new code + virtual wxSizerItem* Insert(size_t index, wxSizerItem *item); wxSizerItem* InsertSpacer(size_t index, int size); wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1); @@ -558,10 +612,10 @@ public: virtual void DeleteWindows(); // Inform sizer about the first direction that has been decided (by parent item) - // Returns true if it made use of the informtion (and recalculated min size) + // Returns true if it made use of the information (and recalculated min size) virtual bool InformFirstDirection( int WXUNUSED(direction), int WXUNUSED(size), int WXUNUSED(availableOtherDir) ) { return false; } - + void SetMinSize( int width, int height ) { DoSetMinSize( width, height ); } void SetMinSize( const wxSize& size ) @@ -601,6 +655,9 @@ public: virtual void Layout(); + wxSize ComputeFittingClientSize(wxWindow *window); + wxSize ComputeFittingWindowSize(wxWindow *window); + wxSize Fit( wxWindow *window ); void FitInside( wxWindow *window ); void SetSizeHints( wxWindow *window ); @@ -614,7 +671,21 @@ public: const wxSizerItemList& GetChildren() const { return m_children; } - void SetDimension( int x, int y, int width, int height ); + void SetDimension(const wxPoint& pos, const wxSize& size) + { + m_position = pos; + m_size = size; + Layout(); + + // This call is required for wxWrapSizer to be able to calculate its + // minimal size correctly. + InformFirstDirection(wxHORIZONTAL, size.x, size.y); + } + void SetDimension(int x, int y, int width, int height) + { SetDimension(wxPoint(x, y), wxSize(width, height)); } + + size_t GetItemCount() const { return m_children.GetCount(); } + bool IsEmpty() const { return m_children.IsEmpty(); } wxSizerItem* GetItem( wxWindow *window, bool recursive = false ); wxSizerItem* GetItem( wxSizer *sizer, bool recursive = false ); @@ -643,6 +714,10 @@ public: void Show(bool show) { ShowItems(show); } + // This is the ShowItems() counterpart and returns true if any of the sizer + // items are shown. + virtual bool AreAnyItemsShown() const; + protected: wxSize m_size; wxSize m_minSize; @@ -652,8 +727,6 @@ protected: // 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 VirtualFitSize( wxWindow *window ); @@ -663,6 +736,10 @@ protected: virtual bool DoSetItemMinSize( wxSizer *sizer, int width, int height ); virtual bool DoSetItemMinSize( size_t index, int width, int height ); + // insert a new item into m_children at given index and return the item + // itself + virtual wxSizerItem* DoInsert(size_t index, wxSizerItem *item); + private: DECLARE_CLASS(wxSizer) }; @@ -671,17 +748,33 @@ private: // wxGridSizer //--------------------------------------------------------------------------- -class WXDLLEXPORT wxGridSizer: public wxSizer +class WXDLLIMPEXP_CORE wxGridSizer: public wxSizer { public: + // ctors specifying the number of columns only: number of rows will be + // deduced automatically depending on the number of sizer elements + wxGridSizer( int cols, int vgap, int hgap ); + wxGridSizer( int cols, const wxSize& gap = wxSize(0, 0) ); + + // ctors specifying the number of rows and columns wxGridSizer( int rows, int cols, int vgap, int hgap ); - wxGridSizer( int cols, int vgap = 0, int hgap = 0 ); + wxGridSizer( int rows, int cols, const wxSize& gap ); virtual void RecalcSizes(); virtual wxSize CalcMin(); - void SetCols( int cols ) { m_cols = cols; } - void SetRows( int rows ) { m_rows = rows; } + void SetCols( int cols ) + { + wxASSERT_MSG( cols >= 0, "Number of columns must be non-negative"); + m_cols = cols; + } + + void SetRows( int rows ) + { + wxASSERT_MSG( rows >= 0, "Number of rows must be non-negative"); + m_rows = rows; + } + void SetVGap( int gap ) { m_vgap = gap; } void SetHGap( int gap ) { m_hgap = gap; } int GetCols() const { return m_cols; } @@ -689,17 +782,51 @@ public: int GetVGap() const { return m_vgap; } int GetHGap() const { return m_hgap; } + int GetEffectiveColsCount() const { return m_cols ? m_cols : CalcCols(); } + int GetEffectiveRowsCount() const { return m_rows ? m_rows : CalcRows(); } + + // return the number of total items and the number of columns and rows + // (for internal use only) + int CalcRowsCols(int& rows, int& cols) const; + protected: + // the number of rows/columns in the sizer, if 0 then it is determined + // dynamically depending on the total number of items int m_rows; int m_cols; + + // gaps between rows and columns 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; + virtual wxSizerItem *DoInsert(size_t index, wxSizerItem *item); void SetItemBounds( wxSizerItem *item, int x, int y, int w, int h ); + // returns the number of columns/rows needed for the current total number + // of children (and the fixed number of rows/columns) + int CalcCols() const + { + wxCHECK_MSG + ( + m_rows, 0, + "Can't calculate number of cols if number of rows is not specified" + ); + + return int(m_children.GetCount() + m_rows - 1) / m_rows; + } + + int CalcRows() const + { + wxCHECK_MSG + ( + m_cols, 0, + "Can't calculate number of cols if number of rows is not specified" + ); + + return int(m_children.GetCount() + m_cols - 1) / m_cols; + } + private: DECLARE_CLASS(wxGridSizer) }; @@ -708,8 +835,8 @@ private: // wxFlexGridSizer //--------------------------------------------------------------------------- -// the bevaiour for resizing wxFlexGridSizer cells in the "non-flexible" -// direction +// values which define the behaviour for resizing wxFlexGridSizer cells in the +// "non-flexible" direction enum wxFlexSizerGrowMode { // don't resize the cells in non-flexible direction at all @@ -722,14 +849,20 @@ enum wxFlexSizerGrowMode wxFLEX_GROWMODE_ALL }; -class WXDLLEXPORT wxFlexGridSizer: public wxGridSizer +class WXDLLIMPEXP_CORE wxFlexGridSizer: public wxGridSizer { public: - // ctors/dtor + // ctors specifying the number of columns only: number of rows will be + // deduced automatically depending on the number of sizer elements + wxFlexGridSizer( int cols, int vgap, int hgap ); + wxFlexGridSizer( int cols, const wxSize& gap = wxSize(0, 0) ); + + // ctors specifying the number of rows and columns wxFlexGridSizer( int rows, int cols, int vgap, int hgap ); - wxFlexGridSizer( int cols, int vgap = 0, int hgap = 0 ); - virtual ~wxFlexGridSizer(); + wxFlexGridSizer( int rows, int cols, const wxSize& gap ); + // dtor + virtual ~wxFlexGridSizer(); // set the rows/columns which will grow (the others will remain of the // constant initial size) @@ -738,6 +871,8 @@ public: void AddGrowableCol( size_t idx, int proportion = 0 ); void RemoveGrowableCol( size_t idx ); + bool IsRowGrowable( size_t idx ); + bool IsColGrowable( 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 @@ -786,14 +921,14 @@ protected: private: DECLARE_CLASS(wxFlexGridSizer) - DECLARE_NO_COPY_CLASS(wxFlexGridSizer) + wxDECLARE_NO_COPY_CLASS(wxFlexGridSizer); }; //--------------------------------------------------------------------------- // wxBoxSizer //--------------------------------------------------------------------------- -class WXDLLEXPORT wxBoxSizer: public wxSizer +class WXDLLIMPEXP_CORE wxBoxSizer: public wxSizer { public: wxBoxSizer(int orient) @@ -802,9 +937,11 @@ public: m_totalProportion = 0; wxASSERT_MSG( m_orient == wxHORIZONTAL || m_orient == wxVERTICAL, - _T("invalid value for wxBoxSizer orientation") ); + wxT("invalid value for wxBoxSizer orientation") ); } + virtual wxSizerItem *AddSpacer(int size); + int GetOrientation() const { return m_orient; } bool IsVertical() const { return m_orient == wxVERTICAL; } @@ -876,36 +1013,6 @@ private: DECLARE_CLASS(wxBoxSizer) }; -//--------------------------------------------------------------------------- -// wxWrapSizer - A box sizer that can wrap items on several lines when -// widths exceed available width. -//--------------------------------------------------------------------------- - -// Borrow unused flag value -#define wxEXTEND_LAST_ON_EACH_LINE wxFULL_REPAINT_ON_RESIZE - -class WXDLLEXPORT wxWrapSizer: public wxBoxSizer -{ -public: - wxWrapSizer( int orient=wxHORIZONTAL, int flags=wxEXTEND_LAST_ON_EACH_LINE ); - virtual ~wxWrapSizer(); - - virtual void RecalcSizes(); - virtual wxSize CalcMin(); - - virtual bool InformFirstDirection( int direction, int size, int availableOtherDir ); - -protected: - int m_prim_size_last; // Size in primary direction last time - int m_n_line; // Number of lines - wxBoxSizer m_rows; // Rows of items - int m_flags; - - void AdjustPropLastItem(wxSizer *psz, wxSizerItem *itemLast); - - DECLARE_DYNAMIC_CLASS(wxWrapSizer) -}; - //--------------------------------------------------------------------------- // wxStaticBoxSizer //--------------------------------------------------------------------------- @@ -914,7 +1021,7 @@ protected: class WXDLLIMPEXP_FWD_CORE wxStaticBox; -class WXDLLEXPORT wxStaticBoxSizer: public wxBoxSizer +class WXDLLIMPEXP_CORE wxStaticBoxSizer: public wxBoxSizer { public: wxStaticBoxSizer(wxStaticBox *box, int orient); @@ -929,6 +1036,7 @@ public: // override to hide/show the static box as well virtual void ShowItems (bool show); + virtual bool AreAnyItemsShown() const; virtual bool Detach( wxWindow *window ); virtual bool Detach( wxSizer *sizer ) { return wxBoxSizer::Detach(sizer); } @@ -939,14 +1047,18 @@ protected: private: DECLARE_CLASS(wxStaticBoxSizer) - DECLARE_NO_COPY_CLASS(wxStaticBoxSizer) + wxDECLARE_NO_COPY_CLASS(wxStaticBoxSizer); }; #endif // wxUSE_STATBOX +//--------------------------------------------------------------------------- +// wxStdDialogButtonSizer +//--------------------------------------------------------------------------- + #if wxUSE_BUTTON -class WXDLLEXPORT wxStdDialogButtonSizer: public wxBoxSizer +class WXDLLIMPEXP_CORE wxStdDialogButtonSizer: public wxBoxSizer { public: // Constructor just creates a new wxBoxSizer, not much else. @@ -987,7 +1099,7 @@ protected: private: DECLARE_CLASS(wxStdDialogButtonSizer) - DECLARE_NO_COPY_CLASS(wxStdDialogButtonSizer) + wxDECLARE_NO_COPY_CLASS(wxStdDialogButtonSizer); }; #endif // wxUSE_BUTTON @@ -1015,12 +1127,18 @@ inline void wxSizerItem::SetSpacer(const wxSize& size) } inline void wxSizerItem::SetSpacer(int width, int height) -{ - DoSetSpacer(wxSize(width, height)); -} +{ + DoSetSpacer(wxSize(width, height)); +} #endif // WXWIN_COMPATIBILITY_2_8 +inline wxSizerItem* +wxSizer::Insert(size_t index, wxSizerItem *item) +{ + return DoInsert(index, item); +} + inline wxSizerItem* wxSizer::Add( wxSizerItem *item )