include/wx/sizer.h

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