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 #if WXWIN_COMPATIBILITY_2_6
 233     // Deprecated in 2.6, use {G,S}etProportion instead.
 234     wxDEPRECATED( void SetOption( int option ) );
 235     wxDEPRECATED( int GetOption() const );
 236 #endif // WXWIN_COMPATIBILITY_2_6
 237
 238     void SetProportion( int proportion )
 239         { m_proportion = proportion; }
 240     int GetProportion() const
 241         { return m_proportion; }
 242     void SetFlag( int flag )
 243         { m_flag = flag; }
 244     int GetFlag() const
 245         { return m_flag; }
 246     void SetBorder( int border )
 247         { m_border = border; }
 248     int GetBorder() const
 249         { return m_border; }
 250
 251     wxWindow *GetWindow() const
 252         { return m_kind == Item_Window ? m_window : NULL; }
 253     wxSizer *GetSizer() const
 254         { return m_kind == Item_Sizer ? m_sizer : NULL; }
 255     wxSize GetSpacer() const;
 256
 257     // this function behaves obviously for the windows and spacers but for the
 258     // sizers it returns true if any sizer element is shown and only returns
 259     // false if all of them are hidden
 260     bool IsShown() const;
 261     void Show(bool show);
 262
 263     void SetUserData(wxObject* userData)
 264         { delete m_userData; m_userData = userData; }
 265     wxObject* GetUserData() const
 266         { return m_userData; }
 267     wxPoint GetPosition() const
 268         { return m_pos; }
 269
 270
 271     // these functions do not free old sizer/spacer
 272     void SetWindow(wxWindow *window);
 273     void SetSizer(wxSizer *sizer);
 274     void SetSpacer(const wxSize& size);
 275     void SetSpacer(int width, int height) { SetSpacer(wxSize(width, height)); }
 276
 277 protected:
 278     // common part of several ctors
 279     void Init() { m_userData = NULL; }
 280
 281     // common part of ctors taking wxSizerFlags
 282     void Init(const wxSizerFlags& flags);
 283
 284
 285     // discriminated union: depending on m_kind one of the fields is valid
 286     enum
 287     {
 288         Item_None,
 289         Item_Window,
 290         Item_Sizer,
 291         Item_Spacer,
 292         Item_Max
 293     } m_kind;
 294     union
 295     {
 296         wxWindow      *m_window;
 297         wxSizer       *m_sizer;
 298         wxSizerSpacer *m_spacer;
 299     };
 300
 301     wxPoint      m_pos;
 302     wxSize       m_minSize;
 303     int          m_proportion;
 304     int          m_border;
 305     int          m_flag;
 306
 307     // on screen rectangle of this item (not including borders)
 308     wxRect       m_rect;
 309
 310     // Aspect ratio can always be calculated from m_size,
 311     // but this would cause precision loss when the window
 312     // is shrunk.  It is safer to preserve the initial value.
 313     float        m_ratio;
 314
 315     wxObject    *m_userData;
 316
 317 private:
 318     DECLARE_CLASS(wxSizerItem)
 319     DECLARE_NO_COPY_CLASS(wxSizerItem)
 320 };
 321
 322 WX_DECLARE_EXPORTED_LIST( wxSizerItem, wxSizerItemList );
 323
 324
 325 //---------------------------------------------------------------------------
 326 // wxSizer
 327 //---------------------------------------------------------------------------
 328
 329 class WXDLLEXPORT wxSizer: public wxObject, public wxClientDataContainer
 330 {
 331 public:
 332     wxSizer() { }
 333     ~wxSizer();
 334
 335     // methods for adding elements to the sizer: there are Add/Insert/Prepend
 336     // overloads for each of window/sizer/spacer/wxSizerItem
 337     inline wxSizerItem* Add( wxWindow *window,
 338                              int proportion = 0,
 339                              int flag = 0,
 340                              int border = 0,
 341                              wxObject* userData = NULL );
 342     inline wxSizerItem* Add( wxSizer *sizer,
 343                              int proportion = 0,
 344                              int flag = 0,
 345                              int border = 0,
 346                              wxObject* userData = NULL );
 347     inline wxSizerItem* Add( int width,
 348                              int height,
 349                              int proportion = 0,
 350                              int flag = 0,
 351                              int border = 0,
 352                              wxObject* userData = NULL );
 353     inline wxSizerItem* Add( wxWindow *window, const wxSizerFlags& flags );
 354     inline wxSizerItem* Add( wxSizer *sizer, const wxSizerFlags& flags );
 355     inline wxSizerItem* Add( wxSizerItem *item );
 356
 357     inline wxSizerItem* AddSpacer(int size);
 358     inline wxSizerItem* AddStretchSpacer(int prop = 1);
 359
 360     inline wxSizerItem* Insert( size_t index,
 361                                 wxWindow *window,
 362                                 int proportion = 0,
 363                                 int flag = 0,
 364                                 int border = 0,
 365                                 wxObject* userData = NULL );
 366     inline wxSizerItem* Insert( size_t index,
 367                                 wxSizer *sizer,
 368                                 int proportion = 0,
 369                                 int flag = 0,
 370                                 int border = 0,
 371                                 wxObject* userData = NULL );
 372     inline wxSizerItem* Insert( size_t index,
 373                                 int width,
 374                                 int height,
 375                                 int proportion = 0,
 376                                 int flag = 0,
 377                                 int border = 0,
 378                                 wxObject* userData = NULL );
 379     inline wxSizerItem* Insert( size_t index,
 380                                 wxWindow *window,
 381                                 const wxSizerFlags& flags );
 382     inline wxSizerItem* Insert( size_t index,
 383                                 wxSizer *sizer,
 384                                 const wxSizerFlags& flags );
 385     virtual wxSizerItem* Insert( size_t index, wxSizerItem *item );
 386
 387     inline wxSizerItem* InsertSpacer(size_t index, int size);
 388     inline wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1);
 389
 390     inline wxSizerItem* Prepend( wxWindow *window,
 391                                  int proportion = 0,
 392                                  int flag = 0,
 393                                  int border = 0,
 394                                  wxObject* userData = NULL );
 395     inline wxSizerItem* Prepend( wxSizer *sizer,
 396                                  int proportion = 0,
 397                                  int flag = 0,
 398                                  int border = 0,
 399                                  wxObject* userData = NULL );
 400     inline wxSizerItem* Prepend( int width,
 401                                  int height,
 402                                  int proportion = 0,
 403                                  int flag = 0,
 404                                  int border = 0,
 405                                  wxObject* userData = NULL );
 406     inline wxSizerItem* Prepend( wxWindow *window, const wxSizerFlags& flags );
 407     inline wxSizerItem* Prepend( wxSizer *sizer, const wxSizerFlags& flags );
 408     inline wxSizerItem* Prepend( wxSizerItem *item );
 409
 410     inline wxSizerItem* PrependSpacer(int size);
 411     inline wxSizerItem* PrependStretchSpacer(int prop = 1);
 412
 413
 414 #if WXWIN_COMPATIBILITY_2_6
 415     // Deprecated in 2.6 since historically it does not delete the window,
 416     // use Detach instead.
 417     wxDEPRECATED( virtual bool Remove( wxWindow *window ) );
 418 #endif // WXWIN_COMPATIBILITY_2_6
 419
 420     virtual bool Remove( wxSizer *sizer );
 421     virtual bool Remove( int index );
 422
 423     virtual bool Detach( wxWindow *window );
 424     virtual bool Detach( wxSizer *sizer );
 425     virtual bool Detach( int index );
 426
 427     virtual bool Replace( wxWindow *oldwin, wxWindow *newwin, bool recursive = false );
 428     virtual bool Replace( wxSizer *oldsz, wxSizer *newsz, bool recursive = false );
 429     virtual bool Replace( size_t index, wxSizerItem *newitem );
 430
 431     virtual void Clear( bool delete_windows = false );
 432     virtual void DeleteWindows();
 433
 434     void SetMinSize( int width, int height )
 435         { DoSetMinSize( width, height ); }
 436     void SetMinSize( const wxSize& size )
 437         { DoSetMinSize( size.x, size.y ); }
 438
 439     // Searches recursively
 440     bool SetItemMinSize( wxWindow *window, int width, int height )
 441         { return DoSetItemMinSize( window, width, height ); }
 442     bool SetItemMinSize( wxWindow *window, const wxSize& size )
 443         { return DoSetItemMinSize( window, size.x, size.y ); }
 444
 445     // Searches recursively
 446     bool SetItemMinSize( wxSizer *sizer, int width, int height )
 447         { return DoSetItemMinSize( sizer, width, height ); }
 448     bool SetItemMinSize( wxSizer *sizer, const wxSize& size )
 449         { return DoSetItemMinSize( sizer, size.x, size.y ); }
 450
 451     bool SetItemMinSize( size_t index, int width, int height )
 452         { return DoSetItemMinSize( index, width, height ); }
 453     bool SetItemMinSize( size_t index, const wxSize& size )
 454         { return DoSetItemMinSize( index, size.x, size.y ); }
 455
 456     wxSize GetSize() const
 457         { return m_size; }
 458     wxPoint GetPosition() const
 459         { return m_position; }
 460
 461     // Calculate the minimal size or return m_minSize if bigger.
 462     wxSize GetMinSize();
 463
 464     virtual void RecalcSizes() = 0;
 465     virtual wxSize CalcMin() = 0;
 466
 467     virtual void Layout();
 468
 469     wxSize Fit( wxWindow *window );
 470     void FitInside( wxWindow *window );
 471     void SetSizeHints( wxWindow *window );
 472     void SetVirtualSizeHints( wxWindow *window );
 473
 474     wxSizerItemList& GetChildren()
 475         { return m_children; }
 476
 477     void SetDimension( int x, int y, int width, int height );
 478
 479     wxSizerItem* GetItem( wxWindow *window, bool recursive = false );
 480     wxSizerItem* GetItem( wxSizer *sizer, bool recursive = false );
 481     wxSizerItem* GetItem( size_t index );
 482
 483     // Manage whether individual scene items are considered
 484     // in the layout calculations or not.
 485     bool Show( wxWindow *window, bool show = true, bool recursive = false );
 486     bool Show( wxSizer *sizer, bool show = true, bool recursive = false );
 487     bool Show( size_t index, bool show = true );
 488
 489     bool Hide( wxSizer *sizer, bool recursive = false )
 490         { return Show( sizer, false, recursive ); }
 491     bool Hide( wxWindow *window, bool recursive = false )
 492         { return Show( window, false, recursive ); }
 493     bool Hide( size_t index )
 494         { return Show( index, false ); }
 495
 496     bool IsShown( wxWindow *window ) const;
 497     bool IsShown( wxSizer *sizer ) const;
 498     bool IsShown( size_t index ) const;
 499
 500     // Recursively call wxWindow::Show () on all sizer items.
 501     virtual void ShowItems (bool show);
 502
 503     void Show(bool show) { ShowItems(show); }
 504
 505 protected:
 506     wxSize              m_size;
 507     wxSize              m_minSize;
 508     wxPoint             m_position;
 509     wxSizerItemList     m_children;
 510
 511     wxSize GetMaxWindowSize( wxWindow *window ) const;
 512     wxSize GetMinWindowSize( wxWindow *window );
 513     wxSize GetMaxClientSize( wxWindow *window ) const;
 514     wxSize GetMinClientSize( wxWindow *window );
 515     wxSize FitSize( wxWindow *window );
 516     wxSize VirtualFitSize( wxWindow *window );
 517
 518     virtual void DoSetMinSize( int width, int height );
 519     virtual bool DoSetItemMinSize( wxWindow *window, int width, int height );
 520     virtual bool DoSetItemMinSize( wxSizer *sizer, int width, int height );
 521     virtual bool DoSetItemMinSize( size_t index, int width, int height );
 522
 523 private:
 524     DECLARE_CLASS(wxSizer)
 525 };
 526
 527 //---------------------------------------------------------------------------
 528 // wxGridSizer
 529 //---------------------------------------------------------------------------
 530
 531 class WXDLLEXPORT wxGridSizer: public wxSizer
 532 {
 533 public:
 534     wxGridSizer( int rows, int cols, int vgap, int hgap );
 535     wxGridSizer( int cols, int vgap = 0, int hgap = 0 );
 536
 537     virtual void RecalcSizes();
 538     virtual wxSize CalcMin();
 539
 540     void SetCols( int cols )    { m_cols = cols; }
 541     void SetRows( int rows )    { m_rows = rows; }
 542     void SetVGap( int gap )     { m_vgap = gap; }
 543     void SetHGap( int gap )     { m_hgap = gap; }
 544     int GetCols() const         { return m_cols; }
 545     int GetRows() const         { return m_rows; }
 546     int GetVGap() const         { return m_vgap; }
 547     int GetHGap() const         { return m_hgap; }
 548
 549 protected:
 550     int    m_rows;
 551     int    m_cols;
 552     int    m_vgap;
 553     int    m_hgap;
 554
 555     // return the number of total items and the number of columns and rows
 556     int CalcRowsCols(int& rows, int& cols) const;
 557
 558     void SetItemBounds( wxSizerItem *item, int x, int y, int w, int h );
 559
 560 private:
 561     DECLARE_CLASS(wxGridSizer)
 562 };
 563
 564 //---------------------------------------------------------------------------
 565 // wxFlexGridSizer
 566 //---------------------------------------------------------------------------
 567
 568 // the bevaiour for resizing wxFlexGridSizer cells in the "non-flexible"
 569 // direction
 570 enum wxFlexSizerGrowMode
 571 {
 572     // don't resize the cells in non-flexible direction at all
 573     wxFLEX_GROWMODE_NONE,
 574
 575     // uniformly resize only the specified ones (default)
 576     wxFLEX_GROWMODE_SPECIFIED,
 577
 578     // uniformly resize all cells
 579     wxFLEX_GROWMODE_ALL
 580 };
 581
 582 class WXDLLEXPORT wxFlexGridSizer: public wxGridSizer
 583 {
 584 public:
 585     // ctors/dtor
 586     wxFlexGridSizer( int rows, int cols, int vgap, int hgap );
 587     wxFlexGridSizer( int cols, int vgap = 0, int hgap = 0 );
 588     virtual ~wxFlexGridSizer();
 589
 590
 591     // set the rows/columns which will grow (the others will remain of the
 592     // constant initial size)
 593     void AddGrowableRow( size_t idx, int proportion = 0 );
 594     void RemoveGrowableRow( size_t idx );
 595     void AddGrowableCol( size_t idx, int proportion = 0 );
 596     void RemoveGrowableCol( size_t idx );
 597
 598
 599     // the sizer cells may grow in both directions, not grow at all or only
 600     // grow in one direction but not the other
 601
 602     // the direction may be wxVERTICAL, wxHORIZONTAL or wxBOTH (default)
 603     void SetFlexibleDirection(int direction) { m_flexDirection = direction; }
 604     int GetFlexibleDirection() const { return m_flexDirection; }
 605
 606     // note that the grow mode only applies to the direction which is not
 607     // flexible
 608     void SetNonFlexibleGrowMode(wxFlexSizerGrowMode mode) { m_growMode = mode; }
 609     wxFlexSizerGrowMode GetNonFlexibleGrowMode() const { return m_growMode; }
 610
 611     // Read-only access to the row heights and col widths arrays
 612     const wxArrayInt& GetRowHeights() const { return m_rowHeights; }
 613     const wxArrayInt& GetColWidths() const  { return m_colWidths; }
 614
 615     // implementation
 616     virtual void RecalcSizes();
 617     virtual wxSize CalcMin();
 618
 619 protected:
 620     void AdjustForFlexDirection();
 621     void AdjustForGrowables(const wxSize& sz, const wxSize& minsz,
 622                             int nrows, int ncols);
 623
 624     // the heights/widths of all rows/columns
 625     wxArrayInt  m_rowHeights,
 626                 m_colWidths;
 627
 628     // indices of the growable columns and rows
 629     wxArrayInt  m_growableRows,
 630                 m_growableCols;
 631
 632     // proportion values of the corresponding growable rows and columns
 633     wxArrayInt  m_growableRowsProportions,
 634                 m_growableColsProportions;
 635
 636     // parameters describing whether the growable cells should be resized in
 637     // both directions or only one
 638     int m_flexDirection;
 639     wxFlexSizerGrowMode m_growMode;
 640
 641     // saves CalcMin result to optimize RecalcSizes
 642     wxSize m_calculatedMinSize;
 643
 644 private:
 645     DECLARE_CLASS(wxFlexGridSizer)
 646     DECLARE_NO_COPY_CLASS(wxFlexGridSizer)
 647 };
 648
 649 //---------------------------------------------------------------------------
 650 // wxBoxSizer
 651 //---------------------------------------------------------------------------
 652
 653 class WXDLLEXPORT wxBoxSizer: public wxSizer
 654 {
 655 public:
 656     wxBoxSizer( int orient );
 657
 658     void RecalcSizes();
 659     wxSize CalcMin();
 660
 661     int GetOrientation() const
 662         { return m_orient; }
 663
 664     void SetOrientation(int orient)
 665         { m_orient = orient; }
 666
 667 protected:
 668     int m_orient;
 669     int m_stretchable;
 670     int m_minWidth;
 671     int m_minHeight;
 672     int m_fixedWidth;
 673     int m_fixedHeight;
 674
 675 private:
 676     DECLARE_CLASS(wxBoxSizer)
 677 };
 678
 679 //---------------------------------------------------------------------------
 680 // wxStaticBoxSizer
 681 //---------------------------------------------------------------------------
 682
 683 #if wxUSE_STATBOX
 684
 685 class WXDLLEXPORT wxStaticBox;
 686
 687 class WXDLLEXPORT wxStaticBoxSizer: public wxBoxSizer
 688 {
 689 public:
 690     wxStaticBoxSizer(wxStaticBox *box, int orient);
 691     wxStaticBoxSizer(int orient, wxWindow *win, const wxString& label = wxEmptyString);
 692     virtual ~wxStaticBoxSizer();
 693
 694     void RecalcSizes();
 695     wxSize CalcMin();
 696
 697     wxStaticBox *GetStaticBox() const
 698         { return m_staticBox; }
 699
 700     // override to hide/show the static box as well
 701     virtual void ShowItems (bool show);
 702
 703     virtual bool Detach( wxWindow *window );
 704     virtual bool Detach( wxSizer *sizer ) { return wxBoxSizer::Detach(sizer); }
 705     virtual bool Detach( int index ) { return wxBoxSizer::Detach(index); }
 706
 707 protected:
 708     wxStaticBox   *m_staticBox;
 709
 710 private:
 711     DECLARE_CLASS(wxStaticBoxSizer)
 712     DECLARE_NO_COPY_CLASS(wxStaticBoxSizer)
 713 };
 714
 715 #endif // wxUSE_STATBOX
 716
 717 #if wxUSE_BUTTON
 718
 719 class WXDLLEXPORT wxStdDialogButtonSizer: public wxBoxSizer
 720 {
 721 public:
 722     // Constructor just creates a new wxBoxSizer, not much else.
 723     // Box sizer orientation is automatically determined here:
 724     // vertical for PDAs, horizontal for everything else?
 725     wxStdDialogButtonSizer();
 726
 727     // Checks button ID against system IDs and sets one of the pointers below
 728     // to this button. Does not do any sizer-related things here.
 729     void AddButton(wxButton *button);
 730
 731     // Use these if no standard ID can/should be used
 732     void SetAffirmativeButton( wxButton *button );
 733     void SetNegativeButton( wxButton *button );
 734     void SetCancelButton( wxButton *button );
 735
 736     // All platform-specific code here, checks which buttons exist and add
 737     // them to the sizer accordingly.
 738     // Note - one potential hack on Mac we could use here,
 739     // if m_buttonAffirmative is wxID_SAVE then ensure wxID_SAVE
 740     // is set to _("Save") and m_buttonNegative is set to _("Don't Save")
 741     // I wouldn't add any other hacks like that into here,
 742     // but this one I can see being useful.
 743     void Realize();
 744
 745     wxButton *GetAffirmativeButton() const { return m_buttonAffirmative; }
 746     wxButton *GetApplyButton() const { return m_buttonApply; }
 747     wxButton *GetNegativeButton() const { return m_buttonNegative; }
 748     wxButton *GetCancelButton() const { return m_buttonCancel; }
 749     wxButton *GetHelpButton() const { return m_buttonHelp; }
 750
 751 protected:
 752     wxButton *m_buttonAffirmative;  // wxID_OK, wxID_YES, wxID_SAVE go here
 753     wxButton *m_buttonApply;
 754     wxButton *m_buttonNegative;     // wxID_NO
 755     wxButton *m_buttonCancel;
 756     wxButton *m_buttonHelp;
 757
 758 private:
 759     DECLARE_CLASS(wxStdDialogButtonSizer)
 760     DECLARE_NO_COPY_CLASS(wxStdDialogButtonSizer)
 761 };
 762
 763 #endif // wxUSE_BUTTON
 764
 765 #if WXWIN_COMPATIBILITY_2_4
 766 // NB: wxBookCtrlSizer and wxNotebookSizer are deprecated, they
 767 //     don't do anything. wxBookCtrlBase::DoGetBestSize does the job now.
 768
 769 // ----------------------------------------------------------------------------
 770 // wxBookCtrlSizer
 771 // ----------------------------------------------------------------------------
 772
 773 #if wxUSE_BOOKCTRL
 774
 775 // this sizer works with wxNotebook/wxListbook/... and sizes the control to
 776 // fit its pages
 777 class WXDLLEXPORT wxBookCtrlBase;
 778
 779 class WXDLLEXPORT wxBookCtrlSizer : public wxSizer
 780 {
 781 public:
 782 #if WXWIN_COMPATIBILITY_2_6
 783     wxDEPRECATED( wxBookCtrlSizer(wxBookCtrlBase *bookctrl) );
 784 #endif // WXWIN_COMPATIBILITY_2_6
 785
 786     wxBookCtrlBase *GetControl() const { return m_bookctrl; }
 787
 788     virtual void RecalcSizes();
 789     virtual wxSize CalcMin();
 790
 791 protected:
 792     // this protected ctor lets us mark the real one above as deprecated
 793     // and still have warning-free build of the library itself:
 794     wxBookCtrlSizer() {}
 795
 796     wxBookCtrlBase *m_bookctrl;
 797
 798 private:
 799     DECLARE_CLASS(wxBookCtrlSizer)
 800     DECLARE_NO_COPY_CLASS(wxBookCtrlSizer)
 801 };
 802
 803
 804 #if wxUSE_NOTEBOOK
 805
 806 // before wxBookCtrlBase we only had wxNotebookSizer, keep it for backwards
 807 // compatibility
 808 class WXDLLEXPORT wxNotebook;
 809
 810 class WXDLLEXPORT wxNotebookSizer : public wxBookCtrlSizer
 811 {
 812 public:
 813 #if WXWIN_COMPATIBILITY_2_6
 814     wxDEPRECATED( wxNotebookSizer(wxNotebook *nb) );
 815 #endif // WXWIN_COMPATIBILITY_2_6
 816
 817     wxNotebook *GetNotebook() const { return (wxNotebook *)m_bookctrl; }
 818
 819 private:
 820     DECLARE_CLASS(wxNotebookSizer)
 821     DECLARE_NO_COPY_CLASS(wxNotebookSizer)
 822 };
 823
 824 #endif // wxUSE_NOTEBOOK
 825
 826 #endif // wxUSE_BOOKCTRL
 827
 828 #endif // WXWIN_COMPATIBILITY_2_4
 829
 830 // ----------------------------------------------------------------------------
 831 // inline functions implementation
 832 // ----------------------------------------------------------------------------
 833
 834 inline wxSizerItem*
 835 wxSizer::Add( wxWindow *window, int proportion, int flag, int border, wxObject* userData )
 836 {
 837     return Add( new wxSizerItem( window, proportion, flag, border, userData ) );
 838 }
 839
 840 inline wxSizerItem*
 841 wxSizer::Add( wxSizer *sizer, int proportion, int flag, int border, wxObject* userData )
 842 {
 843     return Add( new wxSizerItem( sizer, proportion, flag, border, userData ) );
 844 }
 845
 846 inline wxSizerItem*
 847 wxSizer::Add( int width, int height, int proportion, int flag, int border, wxObject* userData )
 848 {
 849     return Add( new wxSizerItem( width, height, proportion, flag, border, userData ) );
 850 }
 851
 852 inline wxSizerItem*
 853 wxSizer::Add( wxWindow *window, const wxSizerFlags& flags )
 854 {
 855     return Add( new wxSizerItem(window, flags) );
 856 }
 857
 858 inline wxSizerItem*
 859 wxSizer::Add( wxSizer *sizer, const wxSizerFlags& flags )
 860 {
 861     return Add( new wxSizerItem(sizer, flags) );
 862 }
 863
 864 inline wxSizerItem*
 865 wxSizer::Add( wxSizerItem *item )
 866 {
 867     return Insert( m_children.GetCount(), item );
 868 }
 869
 870 inline wxSizerItem*
 871 wxSizer::AddSpacer(int size)
 872 {
 873     return Add(size, size);
 874 }
 875
 876 inline wxSizerItem*
 877 wxSizer::AddStretchSpacer(int prop)
 878 {
 879     return Add(0, 0, prop);
 880 }
 881
 882 inline wxSizerItem*
 883 wxSizer::Prepend( wxWindow *window, int proportion, int flag, int border, wxObject* userData )
 884 {
 885     return Prepend( new wxSizerItem( window, proportion, flag, border, userData ) );
 886 }
 887
 888 inline wxSizerItem*
 889 wxSizer::Prepend( wxSizer *sizer, int proportion, int flag, int border, wxObject* userData )
 890 {
 891     return Prepend( new wxSizerItem( sizer, proportion, flag, border, userData ) );
 892 }
 893
 894 inline wxSizerItem*
 895 wxSizer::Prepend( int width, int height, int proportion, int flag, int border, wxObject* userData )
 896 {
 897     return Prepend( new wxSizerItem( width, height, proportion, flag, border, userData ) );
 898 }
 899
 900 inline wxSizerItem*
 901 wxSizer::Prepend( wxSizerItem *item )
 902 {
 903     return Insert( 0, item );
 904 }
 905
 906 inline wxSizerItem*
 907 wxSizer::PrependSpacer(int size)
 908 {
 909     return Prepend(size, size);
 910 }
 911
 912 inline wxSizerItem*
 913 wxSizer::PrependStretchSpacer(int prop)
 914 {
 915     return Prepend(0, 0, prop);
 916 }
 917
 918 inline wxSizerItem*
 919 wxSizer::Prepend( wxWindow *window, const wxSizerFlags& flags )
 920 {
 921     return Prepend( new wxSizerItem(window, flags) );
 922 }
 923
 924 inline wxSizerItem*
 925 wxSizer::Prepend( wxSizer *sizer, const wxSizerFlags& flags )
 926 {
 927     return Prepend( new wxSizerItem(sizer, flags) );
 928 }
 929
 930 inline wxSizerItem*
 931 wxSizer::Insert( size_t index,
 932                  wxWindow *window,
 933                  int proportion,
 934                  int flag,
 935                  int border,
 936                  wxObject* userData )
 937 {
 938     return Insert( index, new wxSizerItem( window, proportion, flag, border, userData ) );
 939 }
 940
 941 inline wxSizerItem*
 942 wxSizer::Insert( size_t index,
 943                  wxSizer *sizer,
 944                  int proportion,
 945                  int flag,
 946                  int border,
 947                  wxObject* userData )
 948 {
 949     return Insert( index, new wxSizerItem( sizer, proportion, flag, border, userData ) );
 950 }
 951
 952 inline wxSizerItem*
 953 wxSizer::Insert( size_t index,
 954                  int width,
 955                  int height,
 956                  int proportion,
 957                  int flag,
 958                  int border,
 959                  wxObject* userData )
 960 {
 961     return Insert( index, new wxSizerItem( width, height, proportion, flag, border, userData ) );
 962 }
 963
 964 inline wxSizerItem*
 965 wxSizer::Insert( size_t index, wxWindow *window, const wxSizerFlags& flags )
 966 {
 967     return Insert( index, new wxSizerItem(window, flags) );
 968 }
 969
 970 inline wxSizerItem*
 971 wxSizer::Insert( size_t index, wxSizer *sizer, const wxSizerFlags& flags )
 972 {
 973     return Insert( index, new wxSizerItem(sizer, flags) );
 974 }
 975
 976 inline wxSizerItem*
 977 wxSizer::InsertSpacer(size_t index, int size)
 978 {
 979     return Insert(index, size, size);
 980 }
 981
 982 inline wxSizerItem*
 983 wxSizer::InsertStretchSpacer(size_t index, int prop)
 984 {
 985     return Insert(index, 0, 0, prop);
 986 }
 987
 988
 989 #endif // __WXSIZER_H__
 990