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 WXDLLIMPEXP_FWD_CORE wxButton;
  24 class WXDLLIMPEXP_FWD_CORE wxBoxSizer;
  25 class WXDLLIMPEXP_FWD_CORE wxSizerItem;
  26 class WXDLLIMPEXP_FWD_CORE 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 WXDLLIMPEXP_CORE 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& Expand()
  62     {
  63         m_flags |= wxEXPAND;
  64         return *this;
  65     }
  66
  67     // notice that Align() replaces the current alignment flags, use specific
  68     // methods below such as Top(), Left() &c if you want to set just the
  69     // vertical or horizontal alignment
  70     wxSizerFlags& Align(int alignment) // combination of wxAlignment values
  71     {
  72         m_flags &= ~wxALIGN_MASK;
  73         m_flags |= alignment;
  74
  75         return *this;
  76     }
  77
  78     // some shortcuts for Align()
  79     wxSizerFlags& Centre() { return Align(wxALIGN_CENTRE); }
  80     wxSizerFlags& Center() { return Centre(); }
  81
  82     wxSizerFlags& Top()
  83     {
  84         m_flags &= ~(wxALIGN_BOTTOM | wxALIGN_CENTRE_VERTICAL);
  85         return *this;
  86     }
  87
  88     wxSizerFlags& Left()
  89     {
  90         m_flags &= ~(wxALIGN_RIGHT | wxALIGN_CENTRE_HORIZONTAL);
  91         return *this;
  92     }
  93
  94     wxSizerFlags& Right()
  95     {
  96         m_flags = (m_flags & ~wxALIGN_CENTRE_HORIZONTAL) | wxALIGN_RIGHT;
  97         return *this;
  98     }
  99
 100     wxSizerFlags& Bottom()
 101     {
 102         m_flags = (m_flags & ~wxALIGN_CENTRE_VERTICAL) | wxALIGN_BOTTOM;
 103         return *this;
 104     }
 105
 106
 107     // default border size used by Border() below
 108     static int GetDefaultBorder()
 109     {
 110 #if wxUSE_BORDER_BY_DEFAULT
 111     #ifdef __WXGTK20__
 112         // GNOME HIG says to use 6px as the base unit:
 113         // http://library.gnome.org/devel/hig-book/stable/design-window.html.en
 114         return 6;
 115     #else
 116         // FIXME: default border size shouldn't be hardcoded and at the very
 117         //        least they should depend on the current font size
 118         return 5;
 119     #endif
 120 #else
 121         return 0;
 122 #endif
 123     }
 124
 125
 126     wxSizerFlags& Border(int direction, int borderInPixels)
 127     {
 128         m_flags &= ~wxALL;
 129         m_flags |= direction;
 130
 131         m_borderInPixels = borderInPixels;
 132
 133         return *this;
 134     }
 135
 136     wxSizerFlags& Border(int direction = wxALL)
 137     {
 138 #if wxUSE_BORDER_BY_DEFAULT
 139         return Border(direction, GetDefaultBorder());
 140 #else
 141         // no borders by default on limited size screen
 142         wxUnusedVar(direction);
 143
 144         return *this;
 145 #endif
 146     }
 147
 148     wxSizerFlags& DoubleBorder(int direction = wxALL)
 149     {
 150 #if wxUSE_BORDER_BY_DEFAULT
 151         return Border(direction, 2*GetDefaultBorder());
 152 #else
 153         wxUnusedVar(direction);
 154
 155         return *this;
 156 #endif
 157     }
 158
 159     wxSizerFlags& TripleBorder(int direction = wxALL)
 160     {
 161 #if wxUSE_BORDER_BY_DEFAULT
 162         return Border(direction, 3*GetDefaultBorder());
 163 #else
 164         wxUnusedVar(direction);
 165
 166         return *this;
 167 #endif
 168     }
 169
 170     wxSizerFlags& HorzBorder()
 171     {
 172 #if wxUSE_BORDER_BY_DEFAULT
 173         return Border(wxLEFT | wxRIGHT, GetDefaultBorder());
 174 #else
 175         return *this;
 176 #endif
 177     }
 178
 179     wxSizerFlags& DoubleHorzBorder()
 180     {
 181 #if wxUSE_BORDER_BY_DEFAULT
 182         return Border(wxLEFT | wxRIGHT, 2*GetDefaultBorder());
 183 #else
 184         return *this;
 185 #endif
 186     }
 187
 188     // setters for the others flags
 189     wxSizerFlags& Shaped()
 190     {
 191         m_flags |= wxSHAPED;
 192
 193         return *this;
 194     }
 195
 196     wxSizerFlags& FixedMinSize()
 197     {
 198         m_flags |= wxFIXED_MINSIZE;
 199
 200         return *this;
 201     }
 202
 203     // makes the item ignore window's visibility status
 204     wxSizerFlags& ReserveSpaceEvenIfHidden()
 205     {
 206         m_flags |= wxRESERVE_SPACE_EVEN_IF_HIDDEN;
 207         return *this;
 208     }
 209
 210     // accessors for wxSizer only
 211     int GetProportion() const { return m_proportion; }
 212     int GetFlags() const { return m_flags; }
 213     int GetBorderInPixels() const { return m_borderInPixels; }
 214
 215 private:
 216     int m_proportion;
 217     int m_flags;
 218     int m_borderInPixels;
 219 };
 220
 221
 222 // ----------------------------------------------------------------------------
 223 // wxSizerSpacer: used by wxSizerItem to represent a spacer
 224 // ----------------------------------------------------------------------------
 225
 226 class WXDLLIMPEXP_CORE wxSizerSpacer
 227 {
 228 public:
 229     wxSizerSpacer(const wxSize& size) : m_size(size), m_isShown(true) { }
 230
 231     void SetSize(const wxSize& size) { m_size = size; }
 232     const wxSize& GetSize() const { return m_size; }
 233
 234     void Show(bool show) { m_isShown = show; }
 235     bool IsShown() const { return m_isShown; }
 236
 237 private:
 238     // the size, in pixel
 239     wxSize m_size;
 240
 241     // is the spacer currently shown?
 242     bool m_isShown;
 243 };
 244
 245 // ----------------------------------------------------------------------------
 246 // wxSizerItem
 247 // ----------------------------------------------------------------------------
 248
 249 class WXDLLIMPEXP_CORE wxSizerItem : public wxObject
 250 {
 251 public:
 252     // window
 253     wxSizerItem( wxWindow *window,
 254                  int proportion,
 255                  int flag,
 256                  int border,
 257                  wxObject* userData );
 258
 259     // window with flags
 260     wxSizerItem(wxWindow *window, const wxSizerFlags& flags)
 261     {
 262         Init(flags);
 263
 264         DoSetWindow(window);
 265     }
 266
 267     // subsizer
 268     wxSizerItem( wxSizer *sizer,
 269                  int proportion,
 270                  int flag,
 271                  int border,
 272                  wxObject* userData );
 273
 274     // sizer with flags
 275     wxSizerItem(wxSizer *sizer, const wxSizerFlags& flags)
 276     {
 277         Init(flags);
 278
 279         DoSetSizer(sizer);
 280     }
 281
 282     // spacer
 283     wxSizerItem( int width,
 284                  int height,
 285                  int proportion,
 286                  int flag,
 287                  int border,
 288                  wxObject* userData);
 289
 290     // spacer with flags
 291     wxSizerItem(int width, int height, const wxSizerFlags& flags)
 292     {
 293         Init(flags);
 294
 295         DoSetSpacer(wxSize(width, height));
 296     }
 297
 298     wxSizerItem();
 299     virtual ~wxSizerItem();
 300
 301     virtual void DeleteWindows();
 302
 303     // Enable deleting the SizerItem without destroying the contained sizer.
 304     void DetachSizer() { m_sizer = NULL; }
 305
 306     virtual wxSize GetSize() const;
 307     virtual wxSize CalcMin();
 308     virtual void SetDimension( const wxPoint& pos, const wxSize& size );
 309
 310     wxSize GetMinSize() const
 311         { return m_minSize; }
 312     wxSize GetMinSizeWithBorder() const;
 313
 314     void SetMinSize(const wxSize& size)
 315     {
 316         if ( IsWindow() )
 317             m_window->SetMinSize(size);
 318         m_minSize = size;
 319     }
 320     void SetMinSize( int x, int y )
 321         { SetMinSize(wxSize(x, y)); }
 322     void SetInitSize( int x, int y )
 323         { SetMinSize(wxSize(x, y)); }
 324
 325     // if either of dimensions is zero, ratio is assumed to be 1
 326     // to avoid "divide by zero" errors
 327     void SetRatio(int width, int height)
 328         { m_ratio = (width && height) ? ((float) width / (float) height) : 1; }
 329     void SetRatio(const wxSize& size)
 330         { SetRatio(size.x, size.y); }
 331     void SetRatio(float ratio)
 332         { m_ratio = ratio; }
 333     float GetRatio() const
 334         { return m_ratio; }
 335
 336     virtual wxRect GetRect() { return m_rect; }
 337
 338     // set a sizer item id (different from a window id, all sizer items,
 339     // including spacers, can have an associated id)
 340     void SetId(int id) { m_id = id; }
 341     int GetId() const { return m_id; }
 342
 343     bool IsWindow() const { return m_kind == Item_Window; }
 344     bool IsSizer() const { return m_kind == Item_Sizer; }
 345     bool IsSpacer() const { return m_kind == Item_Spacer; }
 346
 347 #if WXWIN_COMPATIBILITY_2_6
 348     // Deprecated in 2.6, use {G,S}etProportion instead.
 349     wxDEPRECATED( void SetOption( int option ) );
 350     wxDEPRECATED( int GetOption() const );
 351 #endif // WXWIN_COMPATIBILITY_2_6
 352
 353     void SetProportion( int proportion )
 354         { m_proportion = proportion; }
 355     int GetProportion() const
 356         { return m_proportion; }
 357     void SetFlag( int flag )
 358         { m_flag = flag; }
 359     int GetFlag() const
 360         { return m_flag; }
 361     void SetBorder( int border )
 362         { m_border = border; }
 363     int GetBorder() const
 364         { return m_border; }
 365
 366     wxWindow *GetWindow() const
 367         { return m_kind == Item_Window ? m_window : NULL; }
 368     wxSizer *GetSizer() const
 369         { return m_kind == Item_Sizer ? m_sizer : NULL; }
 370     wxSize GetSpacer() const;
 371
 372     // This function behaves obviously for the windows and spacers but for the
 373     // sizers it returns true if any sizer element is shown and only returns
 374     // false if all of them are hidden. Also, it always returns true if
 375     // wxRESERVE_SPACE_EVEN_IF_HIDDEN flag was used.
 376     bool IsShown() const;
 377
 378     void Show(bool show);
 379
 380     void SetUserData(wxObject* userData)
 381         { delete m_userData; m_userData = userData; }
 382     wxObject* GetUserData() const
 383         { return m_userData; }
 384     wxPoint GetPosition() const
 385         { return m_pos; }
 386
 387     // Called once the first component of an item has been decided. This is
 388     // used in algorithms that depend on knowing the size in one direction
 389     // before the min size in the other direction can be known.
 390     // Returns true if it made use of the information (and min size was changed).
 391     bool InformFirstDirection( int direction, int size, int availableOtherDir=-1 );
 392
 393     // these functions delete the current contents of the item if it's a sizer
 394     // or a spacer but not if it is a window
 395     void AssignWindow(wxWindow *window)
 396     {
 397         Free();
 398         DoSetWindow(window);
 399     }
 400
 401     void AssignSizer(wxSizer *sizer)
 402     {
 403         Free();
 404         DoSetSizer(sizer);
 405     }
 406
 407     void AssignSpacer(const wxSize& size)
 408     {
 409         Free();
 410         DoSetSpacer(size);
 411     }
 412
 413     void AssignSpacer(int w, int h) { AssignSpacer(wxSize(w, h)); }
 414
 415 #if WXWIN_COMPATIBILITY_2_8
 416     // these functions do not free the old sizer/spacer and so can easily
 417     // provoke the memory leaks and so shouldn't be used, use Assign() instead
 418     wxDEPRECATED( void SetWindow(wxWindow *window) );
 419     wxDEPRECATED( void SetSizer(wxSizer *sizer) );
 420     wxDEPRECATED( void SetSpacer(const wxSize& size) );
 421     wxDEPRECATED( void SetSpacer(int width, int height) );
 422 #endif // WXWIN_COMPATIBILITY_2_8
 423
 424 protected:
 425     // common part of several ctors
 426     void Init() { m_userData = NULL; m_kind = Item_None; }
 427
 428     // common part of ctors taking wxSizerFlags
 429     void Init(const wxSizerFlags& flags);
 430
 431     // free current contents
 432     void Free();
 433
 434     // common parts of Set/AssignXXX()
 435     void DoSetWindow(wxWindow *window);
 436     void DoSetSizer(wxSizer *sizer);
 437     void DoSetSpacer(const wxSize& size);
 438
 439     // discriminated union: depending on m_kind one of the fields is valid
 440     enum
 441     {
 442         Item_None,
 443         Item_Window,
 444         Item_Sizer,
 445         Item_Spacer,
 446         Item_Max
 447     } m_kind;
 448     union
 449     {
 450         wxWindow      *m_window;
 451         wxSizer       *m_sizer;
 452         wxSizerSpacer *m_spacer;
 453     };
 454
 455     wxPoint      m_pos;
 456     wxSize       m_minSize;
 457     int          m_proportion;
 458     int          m_border;
 459     int          m_flag;
 460     int          m_id;
 461
 462     // on screen rectangle of this item (not including borders)
 463     wxRect       m_rect;
 464
 465     // Aspect ratio can always be calculated from m_size,
 466     // but this would cause precision loss when the window
 467     // is shrunk.  It is safer to preserve the initial value.
 468     float        m_ratio;
 469
 470     wxObject    *m_userData;
 471
 472 private:
 473     DECLARE_CLASS(wxSizerItem)
 474     wxDECLARE_NO_COPY_CLASS(wxSizerItem);
 475 };
 476
 477 WX_DECLARE_EXPORTED_LIST( wxSizerItem, wxSizerItemList );
 478
 479
 480 //---------------------------------------------------------------------------
 481 // wxSizer
 482 //---------------------------------------------------------------------------
 483
 484 class WXDLLIMPEXP_CORE wxSizer: public wxObject, public wxClientDataContainer
 485 {
 486 public:
 487     wxSizer() { m_containingWindow = NULL; }
 488     virtual ~wxSizer();
 489
 490     // methods for adding elements to the sizer: there are Add/Insert/Prepend
 491     // overloads for each of window/sizer/spacer/wxSizerItem
 492     wxSizerItem* Add(wxWindow *window,
 493                      int proportion = 0,
 494                      int flag = 0,
 495                      int border = 0,
 496                      wxObject* userData = NULL);
 497     wxSizerItem* Add(wxSizer *sizer,
 498                      int proportion = 0,
 499                      int flag = 0,
 500                      int border = 0,
 501                      wxObject* userData = NULL);
 502     wxSizerItem* Add(int width,
 503                      int height,
 504                      int proportion = 0,
 505                      int flag = 0,
 506                      int border = 0,
 507                      wxObject* userData = NULL);
 508     wxSizerItem* Add( wxWindow *window, const wxSizerFlags& flags);
 509     wxSizerItem* Add( wxSizer *sizer, const wxSizerFlags& flags);
 510     wxSizerItem* Add( int width, int height, const wxSizerFlags& flags);
 511     wxSizerItem* Add( wxSizerItem *item);
 512
 513     virtual wxSizerItem *AddSpacer(int size);
 514     wxSizerItem* AddStretchSpacer(int prop = 1);
 515
 516     wxSizerItem* Insert(size_t index,
 517                         wxWindow *window,
 518                         int proportion = 0,
 519                         int flag = 0,
 520                         int border = 0,
 521                         wxObject* userData = NULL);
 522     wxSizerItem* Insert(size_t index,
 523                         wxSizer *sizer,
 524                         int proportion = 0,
 525                         int flag = 0,
 526                         int border = 0,
 527                         wxObject* userData = NULL);
 528     wxSizerItem* Insert(size_t index,
 529                         int width,
 530                         int height,
 531                         int proportion = 0,
 532                         int flag = 0,
 533                         int border = 0,
 534                         wxObject* userData = NULL);
 535     wxSizerItem* Insert(size_t index,
 536                         wxWindow *window,
 537                         const wxSizerFlags& flags);
 538     wxSizerItem* Insert(size_t index,
 539                         wxSizer *sizer,
 540                         const wxSizerFlags& flags);
 541     wxSizerItem* Insert(size_t index,
 542                         int width,
 543                         int height,
 544                         const wxSizerFlags& flags);
 545
 546     // NB: do _not_ override this function in the derived classes, this one is
 547     //     virtual for compatibility reasons only to allow old code overriding
 548     //     it to continue to work, override DoInsert() instead in the new code
 549     virtual wxSizerItem* Insert(size_t index, wxSizerItem *item);
 550
 551     wxSizerItem* InsertSpacer(size_t index, int size);
 552     wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1);
 553
 554     wxSizerItem* Prepend(wxWindow *window,
 555                          int proportion = 0,
 556                          int flag = 0,
 557                          int border = 0,
 558                          wxObject* userData = NULL);
 559     wxSizerItem* Prepend(wxSizer *sizer,
 560                          int proportion = 0,
 561                          int flag = 0,
 562                          int border = 0,
 563                          wxObject* userData = NULL);
 564     wxSizerItem* Prepend(int width,
 565                          int height,
 566                          int proportion = 0,
 567                          int flag = 0,
 568                          int border = 0,
 569                          wxObject* userData = NULL);
 570     wxSizerItem* Prepend(wxWindow *window, const wxSizerFlags& flags);
 571     wxSizerItem* Prepend(wxSizer *sizer, const wxSizerFlags& flags);
 572     wxSizerItem* Prepend(int width, int height, const wxSizerFlags& flags);
 573     wxSizerItem* Prepend(wxSizerItem *item);
 574
 575     wxSizerItem* PrependSpacer(int size);
 576     wxSizerItem* PrependStretchSpacer(int prop = 1);
 577
 578     // set (or possibly unset if window is NULL) or get the window this sizer
 579     // is used in
 580     void SetContainingWindow(wxWindow *window);
 581     wxWindow *GetContainingWindow() const { return m_containingWindow; }
 582
 583 #if WXWIN_COMPATIBILITY_2_6
 584     // Deprecated in 2.6 since historically it does not delete the window,
 585     // use Detach instead.
 586     wxDEPRECATED( virtual bool Remove( wxWindow *window ) );
 587 #endif // WXWIN_COMPATIBILITY_2_6
 588
 589     virtual bool Remove( wxSizer *sizer );
 590     virtual bool Remove( int index );
 591
 592     virtual bool Detach( wxWindow *window );
 593     virtual bool Detach( wxSizer *sizer );
 594     virtual bool Detach( int index );
 595
 596     virtual bool Replace( wxWindow *oldwin, wxWindow *newwin, bool recursive = false );
 597     virtual bool Replace( wxSizer *oldsz, wxSizer *newsz, bool recursive = false );
 598     virtual bool Replace( size_t index, wxSizerItem *newitem );
 599
 600     virtual void Clear( bool delete_windows = false );
 601     virtual void DeleteWindows();
 602
 603     // Inform sizer about the first direction that has been decided (by parent item)
 604     // Returns true if it made use of the informtion (and recalculated min size)
 605     virtual bool InformFirstDirection( int WXUNUSED(direction), int WXUNUSED(size), int WXUNUSED(availableOtherDir) )
 606         { return false; }
 607
 608     void SetMinSize( int width, int height )
 609         { DoSetMinSize( width, height ); }
 610     void SetMinSize( const wxSize& size )
 611         { DoSetMinSize( size.x, size.y ); }
 612
 613     // Searches recursively
 614     bool SetItemMinSize( wxWindow *window, int width, int height )
 615         { return DoSetItemMinSize( window, width, height ); }
 616     bool SetItemMinSize( wxWindow *window, const wxSize& size )
 617         { return DoSetItemMinSize( window, size.x, size.y ); }
 618
 619     // Searches recursively
 620     bool SetItemMinSize( wxSizer *sizer, int width, int height )
 621         { return DoSetItemMinSize( sizer, width, height ); }
 622     bool SetItemMinSize( wxSizer *sizer, const wxSize& size )
 623         { return DoSetItemMinSize( sizer, size.x, size.y ); }
 624
 625     bool SetItemMinSize( size_t index, int width, int height )
 626         { return DoSetItemMinSize( index, width, height ); }
 627     bool SetItemMinSize( size_t index, const wxSize& size )
 628         { return DoSetItemMinSize( index, size.x, size.y ); }
 629
 630     wxSize GetSize() const
 631         { return m_size; }
 632     wxPoint GetPosition() const
 633         { return m_position; }
 634
 635     // Calculate the minimal size or return m_minSize if bigger.
 636     wxSize GetMinSize();
 637
 638     // These virtual functions are used by the layout algorithm: first
 639     // CalcMin() is called to calculate the minimal size of the sizer and
 640     // prepare for laying it out and then RecalcSizes() is called to really
 641     // update all the sizer items
 642     virtual wxSize CalcMin() = 0;
 643     virtual void RecalcSizes() = 0;
 644
 645     virtual void Layout();
 646
 647     wxSize ComputeFittingClientSize(wxWindow *window);
 648     wxSize ComputeFittingWindowSize(wxWindow *window);
 649
 650     wxSize Fit( wxWindow *window );
 651     void FitInside( wxWindow *window );
 652     void SetSizeHints( wxWindow *window );
 653 #if WXWIN_COMPATIBILITY_2_8
 654     // This only calls FitInside() since 2.9
 655     wxDEPRECATED( void SetVirtualSizeHints( wxWindow *window ) );
 656 #endif
 657
 658     wxSizerItemList& GetChildren()
 659         { return m_children; }
 660     const wxSizerItemList& GetChildren() const
 661         { return m_children; }
 662
 663     void SetDimension(const wxPoint& pos, const wxSize& size)
 664     {
 665         m_position = pos;
 666         m_size = size;
 667         Layout();
 668
 669         // This call is required for wxWrapSizer to be able to calculate its
 670         // minimal size correctly.
 671         InformFirstDirection(wxHORIZONTAL, size.x, size.y);
 672     }
 673     void SetDimension(int x, int y, int width, int height)
 674         { SetDimension(wxPoint(x, y), wxSize(width, height)); }
 675
 676     size_t GetItemCount() const { return m_children.GetCount(); }
 677     bool IsEmpty() const { return m_children.IsEmpty(); }
 678
 679     wxSizerItem* GetItem( wxWindow *window, bool recursive = false );
 680     wxSizerItem* GetItem( wxSizer *sizer, bool recursive = false );
 681     wxSizerItem* GetItem( size_t index );
 682     wxSizerItem* GetItemById( int id, bool recursive = false );
 683
 684     // Manage whether individual scene items are considered
 685     // in the layout calculations or not.
 686     bool Show( wxWindow *window, bool show = true, bool recursive = false );
 687     bool Show( wxSizer *sizer, bool show = true, bool recursive = false );
 688     bool Show( size_t index, bool show = true );
 689
 690     bool Hide( wxSizer *sizer, bool recursive = false )
 691         { return Show( sizer, false, recursive ); }
 692     bool Hide( wxWindow *window, bool recursive = false )
 693         { return Show( window, false, recursive ); }
 694     bool Hide( size_t index )
 695         { return Show( index, false ); }
 696
 697     bool IsShown( wxWindow *window ) const;
 698     bool IsShown( wxSizer *sizer ) const;
 699     bool IsShown( size_t index ) const;
 700
 701     // Recursively call wxWindow::Show () on all sizer items.
 702     virtual void ShowItems (bool show);
 703
 704     void Show(bool show) { ShowItems(show); }
 705
 706 protected:
 707     wxSize              m_size;
 708     wxSize              m_minSize;
 709     wxPoint             m_position;
 710     wxSizerItemList     m_children;
 711
 712     // the window this sizer is used in, can be NULL
 713     wxWindow *m_containingWindow;
 714
 715     wxSize GetMaxClientSize( wxWindow *window ) const;
 716     wxSize GetMinClientSize( wxWindow *window );
 717     wxSize VirtualFitSize( wxWindow *window );
 718
 719     virtual void DoSetMinSize( int width, int height );
 720     virtual bool DoSetItemMinSize( wxWindow *window, int width, int height );
 721     virtual bool DoSetItemMinSize( wxSizer *sizer, int width, int height );
 722     virtual bool DoSetItemMinSize( size_t index, int width, int height );
 723
 724     // insert a new item into m_children at given index and return the item
 725     // itself
 726     virtual wxSizerItem* DoInsert(size_t index, wxSizerItem *item);
 727
 728 private:
 729     DECLARE_CLASS(wxSizer)
 730 };
 731
 732 //---------------------------------------------------------------------------
 733 // wxGridSizer
 734 //---------------------------------------------------------------------------
 735
 736 class WXDLLIMPEXP_CORE wxGridSizer: public wxSizer
 737 {
 738 public:
 739     // ctors specifying the number of columns only: number of rows will be
 740     // deduced automatically depending on the number of sizer elements
 741     wxGridSizer( int cols, int vgap, int hgap );
 742     wxGridSizer( int cols, const wxSize& gap = wxSize(0, 0) );
 743
 744     // ctors specifying the number of rows and columns
 745     wxGridSizer( int rows, int cols, int vgap, int hgap );
 746     wxGridSizer( int rows, int cols, const wxSize& gap );
 747
 748     virtual void RecalcSizes();
 749     virtual wxSize CalcMin();
 750
 751     void SetCols( int cols )
 752     {
 753         wxASSERT_MSG( cols >= 0, "Number of columns must be non-negative");
 754         m_cols = cols;
 755     }
 756
 757     void SetRows( int rows )
 758     {
 759         wxASSERT_MSG( rows >= 0, "Number of rows must be non-negative");
 760         m_rows = rows;
 761     }
 762
 763     void SetVGap( int gap )     { m_vgap = gap; }
 764     void SetHGap( int gap )     { m_hgap = gap; }
 765     int GetCols() const         { return m_cols; }
 766     int GetRows() const         { return m_rows; }
 767     int GetVGap() const         { return m_vgap; }
 768     int GetHGap() const         { return m_hgap; }
 769
 770     int GetEffectiveColsCount() const   { return m_cols ? m_cols : CalcCols(); }
 771     int GetEffectiveRowsCount() const   { return m_rows ? m_rows : CalcRows(); }
 772
 773     // return the number of total items and the number of columns and rows
 774     // (for internal use only)
 775     int CalcRowsCols(int& rows, int& cols) const;
 776
 777 protected:
 778     // the number of rows/columns in the sizer, if 0 then it is determined
 779     // dynamically depending on the total number of items
 780     int    m_rows;
 781     int    m_cols;
 782
 783     // gaps between rows and columns
 784     int    m_vgap;
 785     int    m_hgap;
 786
 787     virtual wxSizerItem *DoInsert(size_t index, wxSizerItem *item);
 788
 789     void SetItemBounds( wxSizerItem *item, int x, int y, int w, int h );
 790
 791     // returns the number of columns/rows needed for the current total number
 792     // of children (and the fixed number of rows/columns)
 793     int CalcCols() const
 794     {
 795         wxCHECK_MSG
 796         (
 797             m_rows, 0,
 798             "Can't calculate number of cols if number of rows is not specified"
 799         );
 800
 801         return (m_children.GetCount() + m_rows - 1) / m_rows;
 802     }
 803
 804     int CalcRows() const
 805     {
 806         wxCHECK_MSG
 807         (
 808             m_cols, 0,
 809             "Can't calculate number of cols if number of rows is not specified"
 810         );
 811
 812         return (m_children.GetCount() + m_cols - 1) / m_cols;
 813     }
 814
 815 private:
 816     DECLARE_CLASS(wxGridSizer)
 817 };
 818
 819 //---------------------------------------------------------------------------
 820 // wxFlexGridSizer
 821 //---------------------------------------------------------------------------
 822
 823 // values which define the behaviour for resizing wxFlexGridSizer cells in the
 824 // "non-flexible" direction
 825 enum wxFlexSizerGrowMode
 826 {
 827     // don't resize the cells in non-flexible direction at all
 828     wxFLEX_GROWMODE_NONE,
 829
 830     // uniformly resize only the specified ones (default)
 831     wxFLEX_GROWMODE_SPECIFIED,
 832
 833     // uniformly resize all cells
 834     wxFLEX_GROWMODE_ALL
 835 };
 836
 837 class WXDLLIMPEXP_CORE wxFlexGridSizer: public wxGridSizer
 838 {
 839 public:
 840     // ctors specifying the number of columns only: number of rows will be
 841     // deduced automatically depending on the number of sizer elements
 842     wxFlexGridSizer( int cols, int vgap, int hgap );
 843     wxFlexGridSizer( int cols, const wxSize& gap = wxSize(0, 0) );
 844
 845     // ctors specifying the number of rows and columns
 846     wxFlexGridSizer( int rows, int cols, int vgap, int hgap );
 847     wxFlexGridSizer( int rows, int cols, const wxSize& gap );
 848
 849     // dtor
 850     virtual ~wxFlexGridSizer();
 851
 852     // set the rows/columns which will grow (the others will remain of the
 853     // constant initial size)
 854     void AddGrowableRow( size_t idx, int proportion = 0 );
 855     void RemoveGrowableRow( size_t idx );
 856     void AddGrowableCol( size_t idx, int proportion = 0 );
 857     void RemoveGrowableCol( size_t idx );
 858
 859     bool IsRowGrowable( size_t idx );
 860     bool IsColGrowable( size_t idx );
 861
 862     // the sizer cells may grow in both directions, not grow at all or only
 863     // grow in one direction but not the other
 864
 865     // the direction may be wxVERTICAL, wxHORIZONTAL or wxBOTH (default)
 866     void SetFlexibleDirection(int direction) { m_flexDirection = direction; }
 867     int GetFlexibleDirection() const { return m_flexDirection; }
 868
 869     // note that the grow mode only applies to the direction which is not
 870     // flexible
 871     void SetNonFlexibleGrowMode(wxFlexSizerGrowMode mode) { m_growMode = mode; }
 872     wxFlexSizerGrowMode GetNonFlexibleGrowMode() const { return m_growMode; }
 873
 874     // Read-only access to the row heights and col widths arrays
 875     const wxArrayInt& GetRowHeights() const { return m_rowHeights; }
 876     const wxArrayInt& GetColWidths() const  { return m_colWidths; }
 877
 878     // implementation
 879     virtual void RecalcSizes();
 880     virtual wxSize CalcMin();
 881
 882 protected:
 883     void AdjustForFlexDirection();
 884     void AdjustForGrowables(const wxSize& sz);
 885     void FindWidthsAndHeights(int nrows, int ncols);
 886
 887     // the heights/widths of all rows/columns
 888     wxArrayInt  m_rowHeights,
 889                 m_colWidths;
 890
 891     // indices of the growable columns and rows
 892     wxArrayInt  m_growableRows,
 893                 m_growableCols;
 894
 895     // proportion values of the corresponding growable rows and columns
 896     wxArrayInt  m_growableRowsProportions,
 897                 m_growableColsProportions;
 898
 899     // parameters describing whether the growable cells should be resized in
 900     // both directions or only one
 901     int m_flexDirection;
 902     wxFlexSizerGrowMode m_growMode;
 903
 904     // saves CalcMin result to optimize RecalcSizes
 905     wxSize m_calculatedMinSize;
 906
 907 private:
 908     DECLARE_CLASS(wxFlexGridSizer)
 909     wxDECLARE_NO_COPY_CLASS(wxFlexGridSizer);
 910 };
 911
 912 //---------------------------------------------------------------------------
 913 // wxBoxSizer
 914 //---------------------------------------------------------------------------
 915
 916 class WXDLLIMPEXP_CORE wxBoxSizer: public wxSizer
 917 {
 918 public:
 919     wxBoxSizer(int orient)
 920     {
 921         m_orient = orient;
 922         m_totalProportion = 0;
 923
 924         wxASSERT_MSG( m_orient == wxHORIZONTAL || m_orient == wxVERTICAL,
 925                       wxT("invalid value for wxBoxSizer orientation") );
 926     }
 927
 928     virtual wxSizerItem *AddSpacer(int size);
 929
 930     int GetOrientation() const { return m_orient; }
 931
 932     bool IsVertical() const { return m_orient == wxVERTICAL; }
 933
 934     void SetOrientation(int orient) { m_orient = orient; }
 935
 936     // implementation of our resizing logic
 937     virtual wxSize CalcMin();
 938     virtual void RecalcSizes();
 939
 940 protected:
 941     // helpers for our code: this returns the component of the given wxSize in
 942     // the direction of the sizer and in the other direction, respectively
 943     int GetSizeInMajorDir(const wxSize& sz) const
 944     {
 945         return m_orient == wxHORIZONTAL ? sz.x : sz.y;
 946     }
 947
 948     int& SizeInMajorDir(wxSize& sz)
 949     {
 950         return m_orient == wxHORIZONTAL ? sz.x : sz.y;
 951     }
 952
 953     int& PosInMajorDir(wxPoint& pt)
 954     {
 955         return m_orient == wxHORIZONTAL ? pt.x : pt.y;
 956     }
 957
 958     int GetSizeInMinorDir(const wxSize& sz) const
 959     {
 960         return m_orient == wxHORIZONTAL ? sz.y : sz.x;
 961     }
 962
 963     int& SizeInMinorDir(wxSize& sz)
 964     {
 965         return m_orient == wxHORIZONTAL ? sz.y : sz.x;
 966     }
 967
 968     int& PosInMinorDir(wxPoint& pt)
 969     {
 970         return m_orient == wxHORIZONTAL ? pt.y : pt.x;
 971     }
 972
 973     // another helper: creates wxSize from major and minor components
 974     wxSize SizeFromMajorMinor(int major, int minor) const
 975     {
 976         if ( m_orient == wxHORIZONTAL )
 977         {
 978             return wxSize(major, minor);
 979         }
 980         else // wxVERTICAL
 981         {
 982             return wxSize(minor, major);
 983         }
 984     }
 985
 986
 987     // either wxHORIZONTAL or wxVERTICAL
 988     int m_orient;
 989
 990     // the sum of proportion of all of our elements
 991     int m_totalProportion;
 992
 993     // the minimal size needed for this sizer as calculated by the last call to
 994     // our CalcMin()
 995     wxSize m_minSize;
 996
 997 private:
 998     DECLARE_CLASS(wxBoxSizer)
 999 };
1000
1001 //---------------------------------------------------------------------------
1002 // wxStaticBoxSizer
1003 //---------------------------------------------------------------------------
1004
1005 #if wxUSE_STATBOX
1006
1007 class WXDLLIMPEXP_FWD_CORE wxStaticBox;
1008
1009 class WXDLLIMPEXP_CORE wxStaticBoxSizer: public wxBoxSizer
1010 {
1011 public:
1012     wxStaticBoxSizer(wxStaticBox *box, int orient);
1013     wxStaticBoxSizer(int orient, wxWindow *win, const wxString& label = wxEmptyString);
1014     virtual ~wxStaticBoxSizer();
1015
1016     void RecalcSizes();
1017     wxSize CalcMin();
1018
1019     wxStaticBox *GetStaticBox() const
1020         { return m_staticBox; }
1021
1022     // override to hide/show the static box as well
1023     virtual void ShowItems (bool show);
1024
1025     virtual bool Detach( wxWindow *window );
1026     virtual bool Detach( wxSizer *sizer ) { return wxBoxSizer::Detach(sizer); }
1027     virtual bool Detach( int index ) { return wxBoxSizer::Detach(index); }
1028
1029 protected:
1030     wxStaticBox   *m_staticBox;
1031
1032 private:
1033     DECLARE_CLASS(wxStaticBoxSizer)
1034     wxDECLARE_NO_COPY_CLASS(wxStaticBoxSizer);
1035 };
1036
1037 #endif // wxUSE_STATBOX
1038
1039 //---------------------------------------------------------------------------
1040 // wxStdDialogButtonSizer
1041 //---------------------------------------------------------------------------
1042
1043 #if wxUSE_BUTTON
1044
1045 class WXDLLIMPEXP_CORE wxStdDialogButtonSizer: public wxBoxSizer
1046 {
1047 public:
1048     // Constructor just creates a new wxBoxSizer, not much else.
1049     // Box sizer orientation is automatically determined here:
1050     // vertical for PDAs, horizontal for everything else?
1051     wxStdDialogButtonSizer();
1052
1053     // Checks button ID against system IDs and sets one of the pointers below
1054     // to this button. Does not do any sizer-related things here.
1055     void AddButton(wxButton *button);
1056
1057     // Use these if no standard ID can/should be used
1058     void SetAffirmativeButton( wxButton *button );
1059     void SetNegativeButton( wxButton *button );
1060     void SetCancelButton( wxButton *button );
1061
1062     // All platform-specific code here, checks which buttons exist and add
1063     // them to the sizer accordingly.
1064     // Note - one potential hack on Mac we could use here,
1065     // if m_buttonAffirmative is wxID_SAVE then ensure wxID_SAVE
1066     // is set to _("Save") and m_buttonNegative is set to _("Don't Save")
1067     // I wouldn't add any other hacks like that into here,
1068     // but this one I can see being useful.
1069     void Realize();
1070
1071     wxButton *GetAffirmativeButton() const { return m_buttonAffirmative; }
1072     wxButton *GetApplyButton() const { return m_buttonApply; }
1073     wxButton *GetNegativeButton() const { return m_buttonNegative; }
1074     wxButton *GetCancelButton() const { return m_buttonCancel; }
1075     wxButton *GetHelpButton() const { return m_buttonHelp; }
1076
1077 protected:
1078     wxButton *m_buttonAffirmative;  // wxID_OK, wxID_YES, wxID_SAVE go here
1079     wxButton *m_buttonApply;        // wxID_APPLY
1080     wxButton *m_buttonNegative;     // wxID_NO
1081     wxButton *m_buttonCancel;       // wxID_CANCEL, wxID_CLOSE
1082     wxButton *m_buttonHelp;         // wxID_HELP, wxID_CONTEXT_HELP
1083
1084 private:
1085     DECLARE_CLASS(wxStdDialogButtonSizer)
1086     wxDECLARE_NO_COPY_CLASS(wxStdDialogButtonSizer);
1087 };
1088
1089 #endif // wxUSE_BUTTON
1090
1091
1092 // ----------------------------------------------------------------------------
1093 // inline functions implementation
1094 // ----------------------------------------------------------------------------
1095
1096 #if WXWIN_COMPATIBILITY_2_8
1097
1098 inline void wxSizerItem::SetWindow(wxWindow *window)
1099 {
1100     DoSetWindow(window);
1101 }
1102
1103 inline void wxSizerItem::SetSizer(wxSizer *sizer)
1104 {
1105     DoSetSizer(sizer);
1106 }
1107
1108 inline void wxSizerItem::SetSpacer(const wxSize& size)
1109 {
1110     DoSetSpacer(size);
1111 }
1112
1113 inline void wxSizerItem::SetSpacer(int width, int height)
1114 {
1115     DoSetSpacer(wxSize(width, height));
1116 }
1117
1118 #endif // WXWIN_COMPATIBILITY_2_8
1119
1120 inline wxSizerItem*
1121 wxSizer::Insert(size_t index, wxSizerItem *item)
1122 {
1123     return DoInsert(index, item);
1124 }
1125
1126
1127 inline wxSizerItem*
1128 wxSizer::Add( wxSizerItem *item )
1129 {
1130     return Insert( m_children.GetCount(), item );
1131 }
1132
1133 inline wxSizerItem*
1134 wxSizer::Add( wxWindow *window, int proportion, int flag, int border, wxObject* userData )
1135 {
1136     return Add( new wxSizerItem( window, proportion, flag, border, userData ) );
1137 }
1138
1139 inline wxSizerItem*
1140 wxSizer::Add( wxSizer *sizer, int proportion, int flag, int border, wxObject* userData )
1141 {
1142     return Add( new wxSizerItem( sizer, proportion, flag, border, userData ) );
1143 }
1144
1145 inline wxSizerItem*
1146 wxSizer::Add( int width, int height, int proportion, int flag, int border, wxObject* userData )
1147 {
1148     return Add( new wxSizerItem( width, height, proportion, flag, border, userData ) );
1149 }
1150
1151 inline wxSizerItem*
1152 wxSizer::Add( wxWindow *window, const wxSizerFlags& flags )
1153 {
1154     return Add( new wxSizerItem(window, flags) );
1155 }
1156
1157 inline wxSizerItem*
1158 wxSizer::Add( wxSizer *sizer, const wxSizerFlags& flags )
1159 {
1160     return Add( new wxSizerItem(sizer, flags) );
1161 }
1162
1163 inline wxSizerItem*
1164 wxSizer::Add( int width, int height, const wxSizerFlags& flags )
1165 {
1166     return Add( new wxSizerItem(width, height, flags) );
1167 }
1168
1169 inline wxSizerItem*
1170 wxSizer::AddSpacer(int size)
1171 {
1172     return Add(size, size);
1173 }
1174
1175 inline wxSizerItem*
1176 wxSizer::AddStretchSpacer(int prop)
1177 {
1178     return Add(0, 0, prop);
1179 }
1180
1181 inline wxSizerItem*
1182 wxSizer::Prepend( wxSizerItem *item )
1183 {
1184     return Insert( 0, item );
1185 }
1186
1187 inline wxSizerItem*
1188 wxSizer::Prepend( wxWindow *window, int proportion, int flag, int border, wxObject* userData )
1189 {
1190     return Prepend( new wxSizerItem( window, proportion, flag, border, userData ) );
1191 }
1192
1193 inline wxSizerItem*
1194 wxSizer::Prepend( wxSizer *sizer, int proportion, int flag, int border, wxObject* userData )
1195 {
1196     return Prepend( new wxSizerItem( sizer, proportion, flag, border, userData ) );
1197 }
1198
1199 inline wxSizerItem*
1200 wxSizer::Prepend( int width, int height, int proportion, int flag, int border, wxObject* userData )
1201 {
1202     return Prepend( new wxSizerItem( width, height, proportion, flag, border, userData ) );
1203 }
1204
1205 inline wxSizerItem*
1206 wxSizer::PrependSpacer(int size)
1207 {
1208     return Prepend(size, size);
1209 }
1210
1211 inline wxSizerItem*
1212 wxSizer::PrependStretchSpacer(int prop)
1213 {
1214     return Prepend(0, 0, prop);
1215 }
1216
1217 inline wxSizerItem*
1218 wxSizer::Prepend( wxWindow *window, const wxSizerFlags& flags )
1219 {
1220     return Prepend( new wxSizerItem(window, flags) );
1221 }
1222
1223 inline wxSizerItem*
1224 wxSizer::Prepend( wxSizer *sizer, const wxSizerFlags& flags )
1225 {
1226     return Prepend( new wxSizerItem(sizer, flags) );
1227 }
1228
1229 inline wxSizerItem*
1230 wxSizer::Prepend( int width, int height, const wxSizerFlags& flags )
1231 {
1232     return Prepend( new wxSizerItem(width, height, flags) );
1233 }
1234
1235 inline wxSizerItem*
1236 wxSizer::Insert( size_t index,
1237                  wxWindow *window,
1238                  int proportion,
1239                  int flag,
1240                  int border,
1241                  wxObject* userData )
1242 {
1243     return Insert( index, new wxSizerItem( window, proportion, flag, border, userData ) );
1244 }
1245
1246 inline wxSizerItem*
1247 wxSizer::Insert( size_t index,
1248                  wxSizer *sizer,
1249                  int proportion,
1250                  int flag,
1251                  int border,
1252                  wxObject* userData )
1253 {
1254     return Insert( index, new wxSizerItem( sizer, proportion, flag, border, userData ) );
1255 }
1256
1257 inline wxSizerItem*
1258 wxSizer::Insert( size_t index,
1259                  int width,
1260                  int height,
1261                  int proportion,
1262                  int flag,
1263                  int border,
1264                  wxObject* userData )
1265 {
1266     return Insert( index, new wxSizerItem( width, height, proportion, flag, border, userData ) );
1267 }
1268
1269 inline wxSizerItem*
1270 wxSizer::Insert( size_t index, wxWindow *window, const wxSizerFlags& flags )
1271 {
1272     return Insert( index, new wxSizerItem(window, flags) );
1273 }
1274
1275 inline wxSizerItem*
1276 wxSizer::Insert( size_t index, wxSizer *sizer, const wxSizerFlags& flags )
1277 {
1278     return Insert( index, new wxSizerItem(sizer, flags) );
1279 }
1280
1281 inline wxSizerItem*
1282 wxSizer::Insert( size_t index, int width, int height, const wxSizerFlags& flags )
1283 {
1284     return Insert( index, new wxSizerItem(width, height, flags) );
1285 }
1286
1287 inline wxSizerItem*
1288 wxSizer::InsertSpacer(size_t index, int size)
1289 {
1290     return Insert(index, size, size);
1291 }
1292
1293 inline wxSizerItem*
1294 wxSizer::InsertStretchSpacer(size_t index, int prop)
1295 {
1296     return Insert(index, 0, 0, prop);
1297 }
1298
1299 #endif // __WXSIZER_H__