include/wx/sizer.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/sizer.h
   3 // Purpose:     provide wxSizer class for layout
   4 // Author:      Robert Roebling and Robin Dunn
   5 // Modified by: Ron Lee, Vadim Zeitlin (wxSizerFlags)
   6 // Created:
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Robin Dunn, Robert Roebling
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef __WXSIZER_H__
  13 #define __WXSIZER_H__
  14
  15 #include "wx/defs.h"
  16
  17 #include "wx/window.h"
  18
  19 //---------------------------------------------------------------------------
  20 // classes
  21 //---------------------------------------------------------------------------
  22
  23 class WXDLLEXPORT wxButton;
  24 class WXDLLEXPORT wxBoxSizer;
  25 class WXDLLEXPORT wxSizerItem;
  26 class WXDLLEXPORT wxSizer;
  27
  28 #ifndef wxUSE_BORDER_BY_DEFAULT
  29     #ifdef __SMARTPHONE__
  30         // no borders by default on limited size screen
  31         #define wxUSE_BORDER_BY_DEFAULT 0
  32     #else
  33         #define wxUSE_BORDER_BY_DEFAULT 1
  34     #endif
  35 #endif
  36
  37 // ----------------------------------------------------------------------------
  38 // wxSizerFlags: flags used for an item in the sizer
  39 // ----------------------------------------------------------------------------
  40
  41 class WXDLLEXPORT wxSizerFlags
  42 {
  43 public:
  44     // construct the flags object initialized with the given proportion (0 by
  45     // default)
  46     wxSizerFlags(int proportion = 0) : m_proportion(proportion)
  47     {
  48         m_flags = 0;
  49         m_borderInPixels = 0;
  50     }
  51
  52     // setters for all sizer flags, they all return the object itself so that
  53     // calls to them can be chained
  54
  55     wxSizerFlags& Proportion(int proportion)
  56     {
  57         m_proportion = proportion;
  58         return *this;
  59     }
  60
  61     wxSizerFlags& Align(int alignment) // combination of wxAlignment values
  62     {
  63         m_flags &= ~wxALIGN_MASK;
  64         m_flags |= alignment;
  65
  66         return *this;
  67     }
  68
  69     wxSizerFlags& Expand()
  70     {
  71         m_flags |= wxEXPAND;
  72         return *this;
  73     }
  74
  75     // some shortcuts for Align()
  76     wxSizerFlags& Centre() { return Align(wxCENTRE); }
  77     wxSizerFlags& Center() { return Centre(); }
  78     wxSizerFlags& Left() { return Align(wxALIGN_LEFT); }
  79     wxSizerFlags& Right() { return Align(wxALIGN_RIGHT); }
  80
  81     // default border size used by Border() below
  82     static int GetDefaultBorder()
  83     {
  84 #if wxUSE_BORDER_BY_DEFAULT
  85         // FIXME: default border size shouldn't be hardcoded and at the very
  86         //        least they should depend on the current font size
  87         return 5;
  88 #else
  89         return 0;
  90 #endif
  91     }
  92
  93
  94     wxSizerFlags& Border(int direction, int borderInPixels)
  95     {
  96         m_flags &= ~wxALL;
  97         m_flags |= direction;
  98
  99         m_borderInPixels = borderInPixels;
 100
 101         return *this;
 102     }
 103
 104     wxSizerFlags& Border(int direction = wxALL)
 105     {
 106 #if wxUSE_BORDER_BY_DEFAULT
 107         return Border(direction, GetDefaultBorder());
 108 #else
 109         // no borders by default on limited size screen
 110         wxUnusedVar(direction);
 111
 112         return *this;
 113 #endif
 114     }
 115
 116     wxSizerFlags& DoubleBorder(int direction = wxALL)
 117     {
 118 #if wxUSE_BORDER_BY_DEFAULT
 119         return Border(direction, 2*GetDefaultBorder());
 120 #else
 121         wxUnusedVar(direction);
 122
 123         return *this;
 124 #endif
 125     }
 126
 127     wxSizerFlags& TripleBorder(int direction = wxALL)
 128     {
 129 #if wxUSE_BORDER_BY_DEFAULT
 130         return Border(direction, 3*GetDefaultBorder());
 131 #else
 132         wxUnusedVar(direction);
 133
 134         return *this;
 135 #endif
 136     }
 137
 138     wxSizerFlags& HorzBorder()
 139     {
 140 #if wxUSE_BORDER_BY_DEFAULT
 141         return Border(wxLEFT | wxRIGHT, GetDefaultBorder());
 142 #else
 143         return *this;
 144 #endif
 145     }
 146
 147     wxSizerFlags& DoubleHorzBorder()
 148     {
 149 #if wxUSE_BORDER_BY_DEFAULT
 150         return Border(wxLEFT | wxRIGHT, 2*GetDefaultBorder());
 151 #else
 152         return *this;
 153 #endif
 154     }
 155
 156 #if wxABI_VERSION >= 20802
 157     // setters for the others flags
 158     wxSizerFlags& Shaped()
 159     {
 160         m_flags |= wxSHAPED;
 161
 162         return *this;
 163     }
 164
 165     wxSizerFlags& FixedMinSize()
 166     {
 167         m_flags |= wxFIXED_MINSIZE;
 168
 169         return *this;
 170     }
 171 #endif // wx 2.8.2+
 172
 173     // accessors for wxSizer only
 174     int GetProportion() const { return m_proportion; }
 175     int GetFlags() const { return m_flags; }
 176     int GetBorderInPixels() const { return m_borderInPixels; }
 177
 178 private:
 179     int m_proportion;
 180     int m_flags;
 181     int m_borderInPixels;
 182 };
 183
 184
 185 // ----------------------------------------------------------------------------
 186 // wxSizerSpacer: used by wxSizerItem to represent a spacer
 187 // ----------------------------------------------------------------------------
 188
 189 class WXDLLEXPORT wxSizerSpacer
 190 {
 191 public:
 192     wxSizerSpacer(const wxSize& size) : m_size(size), m_isShown(true) { }
 193
 194     void SetSize(const wxSize& size) { m_size = size; }
 195     const wxSize& GetSize() const { return m_size; }
 196
 197     void Show(bool show) { m_isShown = show; }
 198     bool IsShown() const { return m_isShown; }
 199
 200 private:
 201     // the size, in pixel
 202     wxSize m_size;
 203
 204     // is the spacer currently shown?
 205     bool m_isShown;
 206 };
 207
 208 // ----------------------------------------------------------------------------
 209 // wxSizerItem
 210 // ----------------------------------------------------------------------------
 211
 212 class WXDLLEXPORT wxSizerItem : public wxObject
 213 {
 214 public:
 215     // window
 216     wxSizerItem( wxWindow *window,
 217                  int proportion,
 218                  int flag,
 219                  int border,
 220                  wxObject* userData );
 221
 222     // window with flags
 223     wxSizerItem(wxWindow *window, const wxSizerFlags& flags)
 224     {
 225         Init(flags);
 226
 227         SetWindow(window);
 228     }
 229
 230     // subsizer
 231     wxSizerItem( wxSizer *sizer,
 232                  int proportion,
 233                  int flag,
 234                  int border,
 235                  wxObject* userData );
 236
 237     // sizer with flags
 238     wxSizerItem(wxSizer *sizer, const wxSizerFlags& flags)
 239     {
 240         Init(flags);
 241
 242         SetSizer(sizer);
 243     }
 244
 245     // spacer
 246     wxSizerItem( int width,
 247                  int height,
 248                  int proportion,
 249                  int flag,
 250                  int border,
 251                  wxObject* userData);
 252
 253     // spacer with flags
 254     wxSizerItem(int width, int height, const wxSizerFlags& flags)
 255     {
 256         Init(flags);
 257
 258         SetSpacer(width, height);
 259     }
 260
 261     wxSizerItem();
 262     virtual ~wxSizerItem();
 263
 264     virtual void DeleteWindows();
 265
 266     // Enable deleting the SizerItem without destroying the contained sizer.
 267     void DetachSizer() { m_sizer = NULL; }
 268
 269     virtual wxSize GetSize() const;
 270     virtual wxSize CalcMin();
 271     virtual void SetDimension( const wxPoint& pos, const wxSize& size );
 272
 273     wxSize GetMinSize() const
 274         { return m_minSize; }
 275     wxSize GetMinSizeWithBorder() const;
 276
 277     void SetMinSize(const wxSize& size)
 278     {
 279         if ( IsWindow() )
 280             m_window->SetMinSize(size);
 281         m_minSize = size;
 282     }
 283     void SetMinSize( int x, int y )
 284         { SetMinSize(wxSize(x, y)); }
 285     void SetInitSize( int x, int y )
 286         { SetMinSize(wxSize(x, y)); }
 287
 288     // if either of dimensions is zero, ratio is assumed to be 1
 289     // to avoid "divide by zero" errors
 290     void SetRatio(int width, int height)
 291         { m_ratio = (width && height) ? ((float) width / (float) height) : 1; }
 292     void SetRatio(const wxSize& size)
 293         { SetRatio(size.x, size.y); }
 294     void SetRatio(float ratio)
 295         { m_ratio = ratio; }
 296     float GetRatio() const
 297         { return m_ratio; }
 298
 299     virtual wxRect GetRect() { return m_rect; }
 300
 301     bool IsWindow() const { return m_kind == Item_Window; }
 302     bool IsSizer() const { return m_kind == Item_Sizer; }
 303     bool IsSpacer() const { return m_kind == Item_Spacer; }
 304
 305 #if WXWIN_COMPATIBILITY_2_6
 306     // Deprecated in 2.6, use {G,S}etProportion instead.
 307     wxDEPRECATED( void SetOption( int option ) );
 308     wxDEPRECATED( int GetOption() const );
 309 #endif // WXWIN_COMPATIBILITY_2_6
 310
 311     void SetProportion( int proportion )
 312         { m_proportion = proportion; }
 313     int GetProportion() const
 314         { return m_proportion; }
 315     void SetFlag( int flag )
 316         { m_flag = flag; }
 317     int GetFlag() const
 318         { return m_flag; }
 319     void SetBorder( int border )
 320         { m_border = border; }
 321     int GetBorder() const
 322         { return m_border; }
 323
 324     wxWindow *GetWindow() const
 325         { return m_kind == Item_Window ? m_window : NULL; }
 326     wxSizer *GetSizer() const
 327         { return m_kind == Item_Sizer ? m_sizer : NULL; }
 328     wxSize GetSpacer() const;
 329
 330     // this function behaves obviously for the windows and spacers but for the
 331     // sizers it returns true if any sizer element is shown and only returns
 332     // false if all of them are hidden
 333     bool IsShown() const;
 334     void Show(bool show);
 335
 336     void SetUserData(wxObject* userData)
 337         { delete m_userData; m_userData = userData; }
 338     wxObject* GetUserData() const
 339         { return m_userData; }
 340     wxPoint GetPosition() const
 341         { return m_pos; }
 342
 343
 344     // these functions do not free old sizer/spacer
 345     void SetWindow(wxWindow *window);
 346     void SetSizer(wxSizer *sizer);
 347     void SetSpacer(const wxSize& size);
 348     void SetSpacer(int width, int height) { SetSpacer(wxSize(width, height)); }
 349
 350 protected:
 351     // common part of several ctors
 352     void Init() { m_userData = NULL; }
 353
 354     // common part of ctors taking wxSizerFlags
 355     void Init(const wxSizerFlags& flags);
 356
 357
 358     // discriminated union: depending on m_kind one of the fields is valid
 359     enum
 360     {
 361         Item_None,
 362         Item_Window,
 363         Item_Sizer,
 364         Item_Spacer,
 365         Item_Max
 366     } m_kind;
 367     union
 368     {
 369         wxWindow      *m_window;
 370         wxSizer       *m_sizer;
 371         wxSizerSpacer *m_spacer;
 372     };
 373
 374     wxPoint      m_pos;
 375     wxSize       m_minSize;
 376     int          m_proportion;
 377     int          m_border;
 378     int          m_flag;
 379
 380     // on screen rectangle of this item (not including borders)
 381     wxRect       m_rect;
 382
 383     // Aspect ratio can always be calculated from m_size,
 384     // but this would cause precision loss when the window
 385     // is shrunk.  It is safer to preserve the initial value.
 386     float        m_ratio;
 387
 388     wxObject    *m_userData;
 389
 390 private:
 391     DECLARE_CLASS(wxSizerItem)
 392     DECLARE_NO_COPY_CLASS(wxSizerItem)
 393 };
 394
 395 WX_DECLARE_EXPORTED_LIST( wxSizerItem, wxSizerItemList );
 396
 397
 398 //---------------------------------------------------------------------------
 399 // wxSizer
 400 //---------------------------------------------------------------------------
 401
 402 class WXDLLEXPORT wxSizer: public wxObject, public wxClientDataContainer
 403 {
 404 public:
 405     wxSizer() { m_containingWindow = NULL; }
 406     virtual ~wxSizer();
 407
 408     // methods for adding elements to the sizer: there are Add/Insert/Prepend
 409     // overloads for each of window/sizer/spacer/wxSizerItem
 410     wxSizerItem* Add(wxWindow *window,
 411                      int proportion = 0,
 412                      int flag = 0,
 413                      int border = 0,
 414                      wxObject* userData = NULL);
 415     wxSizerItem* Add(wxSizer *sizer,
 416                      int proportion = 0,
 417                      int flag = 0,
 418                      int border = 0,
 419                      wxObject* userData = NULL);
 420     wxSizerItem* Add(int width,
 421                      int height,
 422                      int proportion = 0,
 423                      int flag = 0,
 424                      int border = 0,
 425                      wxObject* userData = NULL);
 426     wxSizerItem* Add( wxWindow *window, const wxSizerFlags& flags);
 427     wxSizerItem* Add( wxSizer *sizer, const wxSizerFlags& flags);
 428     wxSizerItem* Add( wxSizerItem *item);
 429
 430     wxSizerItem* AddSpacer(int size);
 431     wxSizerItem* AddStretchSpacer(int prop = 1);
 432
 433     wxSizerItem* Insert(size_t index,
 434                         wxWindow *window,
 435                         int proportion = 0,
 436                         int flag = 0,
 437                         int border = 0,
 438                         wxObject* userData = NULL);
 439     wxSizerItem* Insert(size_t index,
 440                         wxSizer *sizer,
 441                         int proportion = 0,
 442                         int flag = 0,
 443                         int border = 0,
 444                         wxObject* userData = NULL);
 445     wxSizerItem* Insert(size_t index,
 446                         int width,
 447                         int height,
 448                         int proportion = 0,
 449                         int flag = 0,
 450                         int border = 0,
 451                         wxObject* userData = NULL);
 452     wxSizerItem* Insert(size_t index,
 453                         wxWindow *window,
 454                         const wxSizerFlags& flags);
 455     wxSizerItem* Insert(size_t index,
 456                         wxSizer *sizer,
 457                         const wxSizerFlags& flags);
 458     virtual wxSizerItem* Insert( size_t index, wxSizerItem *item);
 459
 460     wxSizerItem* InsertSpacer(size_t index, int size);
 461     wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1);
 462
 463     wxSizerItem* Prepend(wxWindow *window,
 464                          int proportion = 0,
 465                          int flag = 0,
 466                          int border = 0,
 467                          wxObject* userData = NULL);
 468     wxSizerItem* Prepend(wxSizer *sizer,
 469                          int proportion = 0,
 470                          int flag = 0,
 471                          int border = 0,
 472                          wxObject* userData = NULL);
 473     wxSizerItem* Prepend(int width,
 474                          int height,
 475                          int proportion = 0,
 476                          int flag = 0,
 477                          int border = 0,
 478                          wxObject* userData = NULL);
 479     wxSizerItem* Prepend(wxWindow *window, const wxSizerFlags& flags);
 480     wxSizerItem* Prepend(wxSizer *sizer, const wxSizerFlags& flags);
 481     wxSizerItem* Prepend(wxSizerItem *item);
 482
 483     wxSizerItem* PrependSpacer(int size);
 484     wxSizerItem* PrependStretchSpacer(int prop = 1);
 485
 486     // set (or possibly unset if window is NULL) or get the window this sizer
 487     // is used in
 488     void SetContainingWindow(wxWindow *window);
 489     wxWindow *GetContainingWindow() const { return m_containingWindow; }
 490
 491 #if WXWIN_COMPATIBILITY_2_6
 492     // Deprecated in 2.6 since historically it does not delete the window,
 493     // use Detach instead.
 494     wxDEPRECATED( virtual bool Remove( wxWindow *window ) );
 495 #endif // WXWIN_COMPATIBILITY_2_6
 496
 497     virtual bool Remove( wxSizer *sizer );
 498     virtual bool Remove( int index );
 499
 500     virtual bool Detach( wxWindow *window );
 501     virtual bool Detach( wxSizer *sizer );
 502     virtual bool Detach( int index );
 503
 504     virtual bool Replace( wxWindow *oldwin, wxWindow *newwin, bool recursive = false );
 505     virtual bool Replace( wxSizer *oldsz, wxSizer *newsz, bool recursive = false );
 506     virtual bool Replace( size_t index, wxSizerItem *newitem );
 507
 508     virtual void Clear( bool delete_windows = false );
 509     virtual void DeleteWindows();
 510
 511     void SetMinSize( int width, int height )
 512         { DoSetMinSize( width, height ); }
 513     void SetMinSize( const wxSize& size )
 514         { DoSetMinSize( size.x, size.y ); }
 515
 516     // Searches recursively
 517     bool SetItemMinSize( wxWindow *window, int width, int height )
 518         { return DoSetItemMinSize( window, width, height ); }
 519     bool SetItemMinSize( wxWindow *window, const wxSize& size )
 520         { return DoSetItemMinSize( window, size.x, size.y ); }
 521
 522     // Searches recursively
 523     bool SetItemMinSize( wxSizer *sizer, int width, int height )
 524         { return DoSetItemMinSize( sizer, width, height ); }
 525     bool SetItemMinSize( wxSizer *sizer, const wxSize& size )
 526         { return DoSetItemMinSize( sizer, size.x, size.y ); }
 527
 528     bool SetItemMinSize( size_t index, int width, int height )
 529         { return DoSetItemMinSize( index, width, height ); }
 530     bool SetItemMinSize( size_t index, const wxSize& size )
 531         { return DoSetItemMinSize( index, size.x, size.y ); }
 532
 533     wxSize GetSize() const
 534         { return m_size; }
 535     wxPoint GetPosition() const
 536         { return m_position; }
 537
 538     // Calculate the minimal size or return m_minSize if bigger.
 539     wxSize GetMinSize();
 540
 541     virtual void RecalcSizes() = 0;
 542     virtual wxSize CalcMin() = 0;
 543
 544     virtual void Layout();
 545
 546     wxSize Fit( wxWindow *window );
 547     void FitInside( wxWindow *window );
 548     void SetSizeHints( wxWindow *window );
 549     void SetVirtualSizeHints( wxWindow *window );
 550
 551     wxSizerItemList& GetChildren()
 552         { return m_children; }
 553
 554     void SetDimension( int x, int y, int width, int height );
 555
 556     wxSizerItem* GetItem( wxWindow *window, bool recursive = false );
 557     wxSizerItem* GetItem( wxSizer *sizer, bool recursive = false );
 558     wxSizerItem* GetItem( size_t index );
 559
 560     // Manage whether individual scene items are considered
 561     // in the layout calculations or not.
 562     bool Show( wxWindow *window, bool show = true, bool recursive = false );
 563     bool Show( wxSizer *sizer, bool show = true, bool recursive = false );
 564     bool Show( size_t index, bool show = true );
 565
 566     bool Hide( wxSizer *sizer, bool recursive = false )
 567         { return Show( sizer, false, recursive ); }
 568     bool Hide( wxWindow *window, bool recursive = false )
 569         { return Show( window, false, recursive ); }
 570     bool Hide( size_t index )
 571         { return Show( index, false ); }
 572
 573     bool IsShown( wxWindow *window ) const;
 574     bool IsShown( wxSizer *sizer ) const;
 575     bool IsShown( size_t index ) const;
 576
 577     // Recursively call wxWindow::Show () on all sizer items.
 578     virtual void ShowItems (bool show);
 579
 580     void Show(bool show) { ShowItems(show); }
 581
 582 protected:
 583     wxSize              m_size;
 584     wxSize              m_minSize;
 585     wxPoint             m_position;
 586     wxSizerItemList     m_children;
 587
 588     // the window this sizer is used in, can be NULL
 589     wxWindow *m_containingWindow;
 590
 591     wxSize GetMaxWindowSize( wxWindow *window ) const;
 592     wxSize GetMinWindowSize( wxWindow *window );
 593     wxSize GetMaxClientSize( wxWindow *window ) const;
 594     wxSize GetMinClientSize( wxWindow *window );
 595     wxSize VirtualFitSize( wxWindow *window );
 596
 597     virtual void DoSetMinSize( int width, int height );
 598     virtual bool DoSetItemMinSize( wxWindow *window, int width, int height );
 599     virtual bool DoSetItemMinSize( wxSizer *sizer, int width, int height );
 600     virtual bool DoSetItemMinSize( size_t index, int width, int height );
 601
 602 private:
 603     DECLARE_CLASS(wxSizer)
 604 };
 605
 606 //---------------------------------------------------------------------------
 607 // wxGridSizer
 608 //---------------------------------------------------------------------------
 609
 610 class WXDLLEXPORT wxGridSizer: public wxSizer
 611 {
 612 public:
 613     wxGridSizer( int rows, int cols, int vgap, int hgap );
 614     wxGridSizer( int cols, int vgap = 0, int hgap = 0 );
 615
 616     virtual void RecalcSizes();
 617     virtual wxSize CalcMin();
 618
 619     void SetCols( int cols )    { m_cols = cols; }
 620     void SetRows( int rows )    { m_rows = rows; }
 621     void SetVGap( int gap )     { m_vgap = gap; }
 622     void SetHGap( int gap )     { m_hgap = gap; }
 623     int GetCols() const         { return m_cols; }
 624     int GetRows() const         { return m_rows; }
 625     int GetVGap() const         { return m_vgap; }
 626     int GetHGap() const         { return m_hgap; }
 627
 628 protected:
 629     int    m_rows;
 630     int    m_cols;
 631     int    m_vgap;
 632     int    m_hgap;
 633
 634     // return the number of total items and the number of columns and rows
 635     int CalcRowsCols(int& rows, int& cols) const;
 636
 637     void SetItemBounds( wxSizerItem *item, int x, int y, int w, int h );
 638
 639 private:
 640     DECLARE_CLASS(wxGridSizer)
 641 };
 642
 643 //---------------------------------------------------------------------------
 644 // wxFlexGridSizer
 645 //---------------------------------------------------------------------------
 646
 647 // the bevaiour for resizing wxFlexGridSizer cells in the "non-flexible"
 648 // direction
 649 enum wxFlexSizerGrowMode
 650 {
 651     // don't resize the cells in non-flexible direction at all
 652     wxFLEX_GROWMODE_NONE,
 653
 654     // uniformly resize only the specified ones (default)
 655     wxFLEX_GROWMODE_SPECIFIED,
 656
 657     // uniformly resize all cells
 658     wxFLEX_GROWMODE_ALL
 659 };
 660
 661 class WXDLLEXPORT wxFlexGridSizer: public wxGridSizer
 662 {
 663 public:
 664     // ctors/dtor
 665     wxFlexGridSizer( int rows, int cols, int vgap, int hgap );
 666     wxFlexGridSizer( int cols, int vgap = 0, int hgap = 0 );
 667     virtual ~wxFlexGridSizer();
 668
 669
 670     // set the rows/columns which will grow (the others will remain of the
 671     // constant initial size)
 672     void AddGrowableRow( size_t idx, int proportion = 0 );
 673     void RemoveGrowableRow( size_t idx );
 674     void AddGrowableCol( size_t idx, int proportion = 0 );
 675     void RemoveGrowableCol( size_t idx );
 676
 677
 678     // the sizer cells may grow in both directions, not grow at all or only
 679     // grow in one direction but not the other
 680
 681     // the direction may be wxVERTICAL, wxHORIZONTAL or wxBOTH (default)
 682     void SetFlexibleDirection(int direction) { m_flexDirection = direction; }
 683     int GetFlexibleDirection() const { return m_flexDirection; }
 684
 685     // note that the grow mode only applies to the direction which is not
 686     // flexible
 687     void SetNonFlexibleGrowMode(wxFlexSizerGrowMode mode) { m_growMode = mode; }
 688     wxFlexSizerGrowMode GetNonFlexibleGrowMode() const { return m_growMode; }
 689
 690     // Read-only access to the row heights and col widths arrays
 691     const wxArrayInt& GetRowHeights() const { return m_rowHeights; }
 692     const wxArrayInt& GetColWidths() const  { return m_colWidths; }
 693
 694     // implementation
 695     virtual void RecalcSizes();
 696     virtual wxSize CalcMin();
 697
 698 protected:
 699     void AdjustForFlexDirection();
 700     void AdjustForGrowables(const wxSize& sz, const wxSize& minsz,
 701                             int nrows, int ncols);
 702
 703     // the heights/widths of all rows/columns
 704     wxArrayInt  m_rowHeights,
 705                 m_colWidths;
 706
 707     // indices of the growable columns and rows
 708     wxArrayInt  m_growableRows,
 709                 m_growableCols;
 710
 711     // proportion values of the corresponding growable rows and columns
 712     wxArrayInt  m_growableRowsProportions,
 713                 m_growableColsProportions;
 714
 715     // parameters describing whether the growable cells should be resized in
 716     // both directions or only one
 717     int m_flexDirection;
 718     wxFlexSizerGrowMode m_growMode;
 719
 720     // saves CalcMin result to optimize RecalcSizes
 721     wxSize m_calculatedMinSize;
 722
 723 private:
 724     DECLARE_CLASS(wxFlexGridSizer)
 725     DECLARE_NO_COPY_CLASS(wxFlexGridSizer)
 726 };
 727
 728 //---------------------------------------------------------------------------
 729 // wxBoxSizer
 730 //---------------------------------------------------------------------------
 731
 732 class WXDLLEXPORT wxBoxSizer: public wxSizer
 733 {
 734 public:
 735     wxBoxSizer( int orient );
 736
 737     void RecalcSizes();
 738     wxSize CalcMin();
 739
 740     int GetOrientation() const
 741         { return m_orient; }
 742
 743     void SetOrientation(int orient)
 744         { m_orient = orient; }
 745
 746 protected:
 747     int m_orient;
 748     int m_stretchable;
 749     int m_minWidth;
 750     int m_minHeight;
 751     int m_fixedWidth;
 752     int m_fixedHeight;
 753
 754 private:
 755     DECLARE_CLASS(wxBoxSizer)
 756 };
 757
 758 //---------------------------------------------------------------------------
 759 // wxStaticBoxSizer
 760 //---------------------------------------------------------------------------
 761
 762 #if wxUSE_STATBOX
 763
 764 class WXDLLEXPORT wxStaticBox;
 765
 766 class WXDLLEXPORT wxStaticBoxSizer: public wxBoxSizer
 767 {
 768 public:
 769     wxStaticBoxSizer(wxStaticBox *box, int orient);
 770     wxStaticBoxSizer(int orient, wxWindow *win, const wxString& label = wxEmptyString);
 771     virtual ~wxStaticBoxSizer();
 772
 773     void RecalcSizes();
 774     wxSize CalcMin();
 775
 776     wxStaticBox *GetStaticBox() const
 777         { return m_staticBox; }
 778
 779     // override to hide/show the static box as well
 780     virtual void ShowItems (bool show);
 781
 782     virtual bool Detach( wxWindow *window );
 783     virtual bool Detach( wxSizer *sizer ) { return wxBoxSizer::Detach(sizer); }
 784     virtual bool Detach( int index ) { return wxBoxSizer::Detach(index); }
 785
 786 protected:
 787     wxStaticBox   *m_staticBox;
 788
 789 private:
 790     DECLARE_CLASS(wxStaticBoxSizer)
 791     DECLARE_NO_COPY_CLASS(wxStaticBoxSizer)
 792 };
 793
 794 #endif // wxUSE_STATBOX
 795
 796 #if wxUSE_BUTTON
 797
 798 class WXDLLEXPORT wxStdDialogButtonSizer: public wxBoxSizer
 799 {
 800 public:
 801     // Constructor just creates a new wxBoxSizer, not much else.
 802     // Box sizer orientation is automatically determined here:
 803     // vertical for PDAs, horizontal for everything else?
 804     wxStdDialogButtonSizer();
 805
 806     // Checks button ID against system IDs and sets one of the pointers below
 807     // to this button. Does not do any sizer-related things here.
 808     void AddButton(wxButton *button);
 809
 810     // Use these if no standard ID can/should be used
 811     void SetAffirmativeButton( wxButton *button );
 812     void SetNegativeButton( wxButton *button );
 813     void SetCancelButton( wxButton *button );
 814
 815     // All platform-specific code here, checks which buttons exist and add
 816     // them to the sizer accordingly.
 817     // Note - one potential hack on Mac we could use here,
 818     // if m_buttonAffirmative is wxID_SAVE then ensure wxID_SAVE
 819     // is set to _("Save") and m_buttonNegative is set to _("Don't Save")
 820     // I wouldn't add any other hacks like that into here,
 821     // but this one I can see being useful.
 822     void Realize();
 823
 824     wxButton *GetAffirmativeButton() const { return m_buttonAffirmative; }
 825     wxButton *GetApplyButton() const { return m_buttonApply; }
 826     wxButton *GetNegativeButton() const { return m_buttonNegative; }
 827     wxButton *GetCancelButton() const { return m_buttonCancel; }
 828     wxButton *GetHelpButton() const { return m_buttonHelp; }
 829
 830 protected:
 831     wxButton *m_buttonAffirmative;  // wxID_OK, wxID_YES, wxID_SAVE go here
 832     wxButton *m_buttonApply;
 833     wxButton *m_buttonNegative;     // wxID_NO
 834     wxButton *m_buttonCancel;
 835     wxButton *m_buttonHelp;
 836
 837 private:
 838     DECLARE_CLASS(wxStdDialogButtonSizer)
 839     DECLARE_NO_COPY_CLASS(wxStdDialogButtonSizer)
 840 };
 841
 842 #endif // wxUSE_BUTTON
 843
 844 #if WXWIN_COMPATIBILITY_2_4
 845 // NB: wxBookCtrlSizer and wxNotebookSizer are deprecated, they
 846 //     don't do anything. wxBookCtrlBase::DoGetBestSize does the job now.
 847
 848 // ----------------------------------------------------------------------------
 849 // wxBookCtrlSizer
 850 // ----------------------------------------------------------------------------
 851
 852 #if wxUSE_BOOKCTRL
 853
 854 // this sizer works with wxNotebook/wxListbook/... and sizes the control to
 855 // fit its pages
 856 class WXDLLEXPORT wxBookCtrlBase;
 857
 858 class WXDLLEXPORT wxBookCtrlSizer : public wxSizer
 859 {
 860 public:
 861 #if WXWIN_COMPATIBILITY_2_6
 862     wxDEPRECATED( wxBookCtrlSizer(wxBookCtrlBase *bookctrl) );
 863 #endif // WXWIN_COMPATIBILITY_2_6
 864
 865     wxBookCtrlBase *GetControl() const { return m_bookctrl; }
 866
 867     virtual void RecalcSizes();
 868     virtual wxSize CalcMin();
 869
 870 protected:
 871     // this protected ctor lets us mark the real one above as deprecated
 872     // and still have warning-free build of the library itself:
 873     wxBookCtrlSizer() {}
 874
 875     wxBookCtrlBase *m_bookctrl;
 876
 877 private:
 878     DECLARE_CLASS(wxBookCtrlSizer)
 879     DECLARE_NO_COPY_CLASS(wxBookCtrlSizer)
 880 };
 881
 882
 883 #if wxUSE_NOTEBOOK
 884
 885 // before wxBookCtrlBase we only had wxNotebookSizer, keep it for backwards
 886 // compatibility
 887 class WXDLLEXPORT wxNotebook;
 888
 889 class WXDLLEXPORT wxNotebookSizer : public wxBookCtrlSizer
 890 {
 891 public:
 892 #if WXWIN_COMPATIBILITY_2_6
 893     wxDEPRECATED( wxNotebookSizer(wxNotebook *nb) );
 894 #endif // WXWIN_COMPATIBILITY_2_6
 895
 896     wxNotebook *GetNotebook() const { return (wxNotebook *)m_bookctrl; }
 897
 898 private:
 899     DECLARE_CLASS(wxNotebookSizer)
 900     DECLARE_NO_COPY_CLASS(wxNotebookSizer)
 901 };
 902
 903 #endif // wxUSE_NOTEBOOK
 904
 905 #endif // wxUSE_BOOKCTRL
 906
 907 #endif // WXWIN_COMPATIBILITY_2_4
 908
 909 // ----------------------------------------------------------------------------
 910 // inline functions implementation
 911 // ----------------------------------------------------------------------------
 912
 913 inline wxSizerItem*
 914 wxSizer::Add( wxSizerItem *item )
 915 {
 916     return Insert( m_children.GetCount(), item );
 917 }
 918
 919 inline wxSizerItem*
 920 wxSizer::Add( wxWindow *window, int proportion, int flag, int border, wxObject* userData )
 921 {
 922     return Add( new wxSizerItem( window, proportion, flag, border, userData ) );
 923 }
 924
 925 inline wxSizerItem*
 926 wxSizer::Add( wxSizer *sizer, int proportion, int flag, int border, wxObject* userData )
 927 {
 928     return Add( new wxSizerItem( sizer, proportion, flag, border, userData ) );
 929 }
 930
 931 inline wxSizerItem*
 932 wxSizer::Add( int width, int height, int proportion, int flag, int border, wxObject* userData )
 933 {
 934     return Add( new wxSizerItem( width, height, proportion, flag, border, userData ) );
 935 }
 936
 937 inline wxSizerItem*
 938 wxSizer::Add( wxWindow *window, const wxSizerFlags& flags )
 939 {
 940     return Add( new wxSizerItem(window, flags) );
 941 }
 942
 943 inline wxSizerItem*
 944 wxSizer::Add( wxSizer *sizer, const wxSizerFlags& flags )
 945 {
 946     return Add( new wxSizerItem(sizer, flags) );
 947 }
 948
 949 inline wxSizerItem*
 950 wxSizer::AddSpacer(int size)
 951 {
 952     return Add(size, size);
 953 }
 954
 955 inline wxSizerItem*
 956 wxSizer::AddStretchSpacer(int prop)
 957 {
 958     return Add(0, 0, prop);
 959 }
 960
 961 inline wxSizerItem*
 962 wxSizer::Prepend( wxSizerItem *item )
 963 {
 964     return Insert( 0, item );
 965 }
 966
 967 inline wxSizerItem*
 968 wxSizer::Prepend( wxWindow *window, int proportion, int flag, int border, wxObject* userData )
 969 {
 970     return Prepend( new wxSizerItem( window, proportion, flag, border, userData ) );
 971 }
 972
 973 inline wxSizerItem*
 974 wxSizer::Prepend( wxSizer *sizer, int proportion, int flag, int border, wxObject* userData )
 975 {
 976     return Prepend( new wxSizerItem( sizer, proportion, flag, border, userData ) );
 977 }
 978
 979 inline wxSizerItem*
 980 wxSizer::Prepend( int width, int height, int proportion, int flag, int border, wxObject* userData )
 981 {
 982     return Prepend( new wxSizerItem( width, height, proportion, flag, border, userData ) );
 983 }
 984
 985 inline wxSizerItem*
 986 wxSizer::PrependSpacer(int size)
 987 {
 988     return Prepend(size, size);
 989 }
 990
 991 inline wxSizerItem*
 992 wxSizer::PrependStretchSpacer(int prop)
 993 {
 994     return Prepend(0, 0, prop);
 995 }
 996
 997 inline wxSizerItem*
 998 wxSizer::Prepend( wxWindow *window, const wxSizerFlags& flags )
 999 {
1000     return Prepend( new wxSizerItem(window, flags) );
1001 }
1002
1003 inline wxSizerItem*
1004 wxSizer::Prepend( wxSizer *sizer, const wxSizerFlags& flags )
1005 {
1006     return Prepend( new wxSizerItem(sizer, flags) );
1007 }
1008
1009 inline wxSizerItem*
1010 wxSizer::Insert( size_t index,
1011                  wxWindow *window,
1012                  int proportion,
1013                  int flag,
1014                  int border,
1015                  wxObject* userData )
1016 {
1017     return Insert( index, new wxSizerItem( window, proportion, flag, border, userData ) );
1018 }
1019
1020 inline wxSizerItem*
1021 wxSizer::Insert( size_t index,
1022                  wxSizer *sizer,
1023                  int proportion,
1024                  int flag,
1025                  int border,
1026                  wxObject* userData )
1027 {
1028     return Insert( index, new wxSizerItem( sizer, proportion, flag, border, userData ) );
1029 }
1030
1031 inline wxSizerItem*
1032 wxSizer::Insert( size_t index,
1033                  int width,
1034                  int height,
1035                  int proportion,
1036                  int flag,
1037                  int border,
1038                  wxObject* userData )
1039 {
1040     return Insert( index, new wxSizerItem( width, height, proportion, flag, border, userData ) );
1041 }
1042
1043 inline wxSizerItem*
1044 wxSizer::Insert( size_t index, wxWindow *window, const wxSizerFlags& flags )
1045 {
1046     return Insert( index, new wxSizerItem(window, flags) );
1047 }
1048
1049 inline wxSizerItem*
1050 wxSizer::Insert( size_t index, wxSizer *sizer, const wxSizerFlags& flags )
1051 {
1052     return Insert( index, new wxSizerItem(sizer, flags) );
1053 }
1054
1055 inline wxSizerItem*
1056 wxSizer::InsertSpacer(size_t index, int size)
1057 {
1058     return Insert(index, size, size);
1059 }
1060
1061 inline wxSizerItem*
1062 wxSizer::InsertStretchSpacer(size_t index, int prop)
1063 {
1064     return Insert(index, 0, 0, prop);
1065 }
1066
1067
1068 #endif // __WXSIZER_H__