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
   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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16 #pragma interface "sizer.h"
  17 #endif
  18
  19 #include "wx/defs.h"
  20
  21 #include "wx/window.h"
  22 #include "wx/frame.h"
  23 #include "wx/dialog.h"
  24
  25 //---------------------------------------------------------------------------
  26 // classes
  27 //---------------------------------------------------------------------------
  28
  29 class wxSizerItem;
  30 class wxSizer;
  31 class wxBoxSizer;
  32
  33 //---------------------------------------------------------------------------
  34 // wxSizerItem
  35 //---------------------------------------------------------------------------
  36
  37 class WXDLLEXPORT wxSizerItem: public wxObject
  38 {
  39 public:
  40     // spacer
  41     wxSizerItem( int width,
  42                  int height,
  43                  int proportion,
  44                  int flag,
  45                  int border,
  46                  wxObject* userData);
  47
  48     // window
  49     wxSizerItem( wxWindow *window,
  50                  int proportion,
  51                  int flag,
  52                  int border,
  53                  wxObject* userData );
  54
  55     // subsizer
  56     wxSizerItem( wxSizer *sizer,
  57                  int proportion,
  58                  int flag,
  59                  int border,
  60                  wxObject* userData );
  61
  62     wxSizerItem();
  63     virtual ~wxSizerItem();
  64
  65     virtual void DeleteWindows();
  66
  67     // Enable deleting the SizerItem without destroying the contained sizer.
  68     void DetachSizer()
  69         { m_sizer = 0; }
  70
  71     virtual wxSize GetSize() const;
  72     virtual wxSize CalcMin();
  73     virtual void SetDimension( wxPoint pos, wxSize size );
  74
  75     wxSize GetMinSize() const
  76         { return m_minSize; }
  77     void SetInitSize( int x, int y )
  78         { m_minSize.x = x; m_minSize.y = y; }
  79
  80     void SetRatio( int width, int height )
  81         // if either of dimensions is zero, ratio is assumed to be 1
  82         // to avoid "divide by zero" errors
  83         { m_ratio = (width && height) ? ((float) width / (float) height) : 1; }
  84     void SetRatio( wxSize size )
  85         { m_ratio = (size.x && size.y) ? ((float) size.x / (float) size.y) : 1; }
  86     void SetRatio( float ratio )
  87         { m_ratio = ratio; }
  88     float GetRatio() const
  89         { return m_ratio; }
  90
  91     bool IsWindow() const;
  92     bool IsSizer() const;
  93     bool IsSpacer() const;
  94
  95     // Deprecated in 2.6, use {G,S}etProportion instead.
  96     wxDEPRECATED( void SetOption( int option ) );
  97     wxDEPRECATED( int GetOption() const );
  98
  99     void SetProportion( int proportion )
 100         { m_proportion = proportion; }
 101     int GetProportion() const
 102         { return m_proportion; }
 103     void SetFlag( int flag )
 104         { m_flag = flag; }
 105     int GetFlag() const
 106         { return m_flag; }
 107     void SetBorder( int border )
 108         { m_border = border; }
 109     int GetBorder() const
 110         { return m_border; }
 111
 112     wxWindow *GetWindow() const
 113         { return m_window; }
 114     void SetWindow( wxWindow *window )
 115         { m_window = window; m_minSize = window->GetSize(); }
 116     wxSizer *GetSizer() const
 117         { return m_sizer; }
 118     void SetSizer( wxSizer *sizer )
 119         { m_sizer = sizer; }
 120     const wxSize &GetSpacer() const
 121         { return m_size; }
 122     void SetSpacer( const wxSize &size )
 123         { m_size = size; m_minSize = size; }
 124
 125     void Show ( bool show );
 126     bool IsShown() const
 127         { return m_show; }
 128
 129     wxObject* GetUserData() const
 130         { return m_userData; }
 131     wxPoint GetPosition() const
 132         { return m_pos; }
 133
 134 protected:
 135     wxWindow    *m_window;
 136     wxSizer     *m_sizer;
 137     wxSize       m_size;
 138     wxPoint      m_pos;
 139     wxSize       m_minSize;
 140     int          m_proportion;
 141     int          m_border;
 142     int          m_flag;
 143
 144     // If true, then this item is considered in the layout
 145     // calculation.  Otherwise, it is skipped over.
 146     bool         m_show;
 147
 148     // Aspect ratio can always be calculated from m_size,
 149     // but this would cause precision loss when the window
 150     // is shrunk.  It is safer to preserve the initial value.
 151     float        m_ratio;
 152
 153     wxObject    *m_userData;
 154
 155 private:
 156     DECLARE_CLASS(wxSizerItem)
 157     DECLARE_NO_COPY_CLASS(wxSizerItem)
 158 };
 159
 160 WX_DECLARE_EXPORTED_LIST( wxSizerItem, wxSizerItemList );
 161
 162
 163 //---------------------------------------------------------------------------
 164 // wxSizer
 165 //---------------------------------------------------------------------------
 166
 167 class WXDLLEXPORT wxSizer: public wxObject, public wxClientDataContainer
 168 {
 169 public:
 170     wxSizer();
 171     ~wxSizer();
 172
 173     /* These should be called Append() really. */
 174     virtual void Add( wxWindow *window,
 175                       int proportion = 0,
 176                       int flag = 0,
 177                       int border = 0,
 178                       wxObject* userData = NULL );
 179     virtual void Add( wxSizer *sizer,
 180                       int proportion = 0,
 181                       int flag = 0,
 182                       int border = 0,
 183                       wxObject* userData = NULL );
 184     virtual void Add( int width,
 185                       int height,
 186                       int proportion = 0,
 187                       int flag = 0,
 188                       int border = 0,
 189                       wxObject* userData = NULL );
 190     virtual void Add( wxSizerItem *item );
 191
 192     virtual void Insert( size_t index,
 193                          wxWindow *window,
 194                          int proportion = 0,
 195                          int flag = 0,
 196                          int border = 0,
 197                          wxObject* userData = NULL );
 198     virtual void Insert( size_t index,
 199                          wxSizer *sizer,
 200                          int proportion = 0,
 201                          int flag = 0,
 202                          int border = 0,
 203                          wxObject* userData = NULL );
 204     virtual void Insert( size_t index,
 205                          int width,
 206                          int height,
 207                          int proportion = 0,
 208                          int flag = 0,
 209                          int border = 0,
 210                          wxObject* userData = NULL );
 211     virtual void Insert( size_t index,
 212                          wxSizerItem *item );
 213
 214     virtual void Prepend( wxWindow *window,
 215                           int proportion = 0,
 216                           int flag = 0,
 217                           int border = 0,
 218                           wxObject* userData = NULL );
 219     virtual void Prepend( wxSizer *sizer,
 220                           int proportion = 0,
 221                           int flag = 0,
 222                           int border = 0,
 223                           wxObject* userData = NULL );
 224     virtual void Prepend( int width,
 225                           int height,
 226                           int proportion = 0,
 227                           int flag = 0,
 228                           int border = 0,
 229                           wxObject* userData = NULL );
 230     virtual void Prepend( wxSizerItem *item );
 231
 232     // Deprecated in 2.6 since historically it does not delete the window,
 233     // use Detach instead.
 234     wxDEPRECATED( virtual bool Remove( wxWindow *window ) );
 235     virtual bool Remove( wxSizer *sizer );
 236     virtual bool Remove( int index );
 237
 238     virtual bool Detach( wxWindow *window );
 239     virtual bool Detach( wxSizer *sizer );
 240     virtual bool Detach( int index );
 241
 242     virtual void Clear( bool delete_windows = false );
 243     virtual void DeleteWindows();
 244
 245     void SetMinSize( int width, int height )
 246         { DoSetMinSize( width, height ); }
 247     void SetMinSize( wxSize size )
 248         { DoSetMinSize( size.x, size.y ); }
 249
 250     /* Searches recursively */
 251     bool SetItemMinSize( wxWindow *window, int width, int height )
 252         { return DoSetItemMinSize( window, width, height ); }
 253     bool SetItemMinSize( wxWindow *window, wxSize size )
 254         { return DoSetItemMinSize( window, size.x, size.y ); }
 255
 256     /* Searches recursively */
 257     bool SetItemMinSize( wxSizer *sizer, int width, int height )
 258         { return DoSetItemMinSize( sizer, width, height ); }
 259     bool SetItemMinSize( wxSizer *sizer, wxSize size )
 260         { return DoSetItemMinSize( sizer, size.x, size.y ); }
 261
 262     bool SetItemMinSize( size_t index, int width, int height )
 263         { return DoSetItemMinSize( index, width, height ); }
 264     bool SetItemMinSize( size_t index, wxSize size )
 265         { return DoSetItemMinSize( index, size.x, size.y ); }
 266
 267     wxSize GetSize() const
 268         { return m_size; }
 269     wxPoint GetPosition() const
 270         { return m_position; }
 271
 272     /* Calculate the minimal size or return m_minSize if bigger. */
 273     wxSize GetMinSize();
 274
 275     virtual void RecalcSizes() = 0;
 276     virtual wxSize CalcMin() = 0;
 277
 278     virtual void Layout();
 279
 280     wxSize Fit( wxWindow *window );
 281     void FitInside( wxWindow *window );
 282     void SetSizeHints( wxWindow *window );
 283     void SetVirtualSizeHints( wxWindow *window );
 284
 285     wxSizerItemList& GetChildren()
 286         { return m_children; }
 287
 288     void SetDimension( int x, int y, int width, int height );
 289
 290     // Manage whether individual scene items are considered
 291     // in the layout calculations or not.
 292     void Show( wxWindow *window, bool show = true );
 293     void Show( wxSizer *sizer, bool show = true );
 294     void Show( size_t index, bool show = true );
 295
 296     void Hide( wxSizer *sizer )
 297         { Show( sizer, false ); }
 298     void Hide( wxWindow *window )
 299         { Show( window, false ); }
 300     void Hide( size_t index )
 301         { Show( index, false ); }
 302
 303     bool IsShown( wxWindow *window ) const;
 304     bool IsShown( wxSizer *sizer ) const;
 305     bool IsShown( size_t index ) const;
 306
 307     // Recursively call wxWindow::Show () on all sizer items.
 308     void ShowItems (bool show);
 309
 310 protected:
 311     wxSize              m_size;
 312     wxSize              m_minSize;
 313     wxPoint             m_position;
 314     wxSizerItemList     m_children;
 315
 316     wxSize GetMaxWindowSize( wxWindow *window ) const;
 317     wxSize GetMinWindowSize( wxWindow *window );
 318     wxSize GetMaxClientSize( wxWindow *window ) const;
 319     wxSize GetMinClientSize( wxWindow *window );
 320     wxSize FitSize( wxWindow *window );
 321     wxSize VirtualFitSize( wxWindow *window );
 322
 323     virtual void DoSetMinSize( int width, int height );
 324     virtual bool DoSetItemMinSize( wxWindow *window, int width, int height );
 325     virtual bool DoSetItemMinSize( wxSizer *sizer, int width, int height );
 326     virtual bool DoSetItemMinSize( size_t index, int width, int height );
 327
 328 private:
 329     DECLARE_CLASS(wxSizer)
 330 };
 331
 332 //---------------------------------------------------------------------------
 333 // wxGridSizer
 334 //---------------------------------------------------------------------------
 335
 336 class WXDLLEXPORT wxGridSizer: public wxSizer
 337 {
 338 public:
 339     wxGridSizer( int rows, int cols, int vgap, int hgap );
 340     wxGridSizer( int cols, int vgap = 0, int hgap = 0 );
 341
 342     virtual void RecalcSizes();
 343     virtual wxSize CalcMin();
 344
 345     void SetCols( int cols )    { m_cols = cols; }
 346     void SetRows( int rows )    { m_rows = rows; }
 347     void SetVGap( int gap )     { m_vgap = gap; }
 348     void SetHGap( int gap )     { m_hgap = gap; }
 349     int GetCols() const         { return m_cols; }
 350     int GetRows() const         { return m_rows; }
 351     int GetVGap() const         { return m_vgap; }
 352     int GetHGap() const         { return m_hgap; }
 353
 354 protected:
 355     int    m_rows;
 356     int    m_cols;
 357     int    m_vgap;
 358     int    m_hgap;
 359
 360     // return the number of total items and the number of columns and rows
 361     int CalcRowsCols(int& rows, int& cols) const;
 362
 363     void SetItemBounds( wxSizerItem *item, int x, int y, int w, int h );
 364
 365 private:
 366     DECLARE_CLASS(wxGridSizer)
 367 };
 368
 369 //---------------------------------------------------------------------------
 370 // wxFlexGridSizer
 371 //---------------------------------------------------------------------------
 372
 373 // the bevaiour for resizing wxFlexGridSizer cells in the "non-flexible"
 374 // direction
 375 enum wxFlexSizerGrowMode
 376 {
 377     // don't resize the cells in non-flexible direction at all
 378     wxFLEX_GROWMODE_NONE,
 379
 380     // uniformly resize only the specified ones (default)
 381     wxFLEX_GROWMODE_SPECIFIED,
 382
 383     // uniformly resize all cells
 384     wxFLEX_GROWMODE_ALL
 385 };
 386
 387 class WXDLLEXPORT wxFlexGridSizer: public wxGridSizer
 388 {
 389 public:
 390     // ctors/dtor
 391     wxFlexGridSizer( int rows, int cols, int vgap, int hgap );
 392     wxFlexGridSizer( int cols, int vgap = 0, int hgap = 0 );
 393     virtual ~wxFlexGridSizer();
 394
 395
 396     // set the rows/columns which will grow (the others will remain of the
 397     // constant initial size)
 398     void AddGrowableRow( size_t idx, int proportion = 0 );
 399     void RemoveGrowableRow( size_t idx );
 400     void AddGrowableCol( size_t idx, int proportion = 0 );
 401     void RemoveGrowableCol( size_t idx );
 402
 403
 404     // the sizer cells may grow in both directions, not grow at all or only
 405     // grow in one direction but not the other
 406
 407     // the direction may be wxVERTICAL, wxHORIZONTAL or wxBOTH (default)
 408     void SetFlexibleDirection(int direction) { m_flexDirection = direction; }
 409     int GetFlexibleDirection() const { return m_flexDirection; }
 410
 411     // note that the grow mode only applies to the direction which is not
 412     // flexible
 413     void SetNonFlexibleGrowMode(wxFlexSizerGrowMode mode) { m_growMode = mode; }
 414     wxFlexSizerGrowMode GetNonFlexibleGrowMode() const { return m_growMode; }
 415
 416     // Read-only access to the row heights and col widths arrays
 417     const wxArrayInt& GetRowHeights() const { return m_rowHeights; }
 418     const wxArrayInt& GetColWidths() const  { return m_colWidths; }
 419
 420     // implementation
 421     virtual void RecalcSizes();
 422     virtual wxSize CalcMin();
 423
 424 protected:
 425     void AdjustForFlexDirection();
 426     void AdjustForGrowables(const wxSize& sz, const wxSize& minsz,
 427                             int nrows, int ncols);
 428
 429     // the heights/widths of all rows/columns
 430     wxArrayInt  m_rowHeights,
 431                 m_colWidths;
 432
 433     // indices of the growable columns and rows
 434     wxArrayInt  m_growableRows,
 435                 m_growableCols;
 436
 437     // proportion values of the corresponding growable rows and columns
 438     wxArrayInt  m_growableRowsProportions,
 439                 m_growableColsProportions;
 440
 441     // parameters describing whether the growable cells should be resized in
 442     // both directions or only one
 443     int m_flexDirection;
 444     wxFlexSizerGrowMode m_growMode;
 445
 446 private:
 447     DECLARE_CLASS(wxFlexGridSizer)
 448     DECLARE_NO_COPY_CLASS(wxFlexGridSizer)
 449 };
 450
 451 //---------------------------------------------------------------------------
 452 // wxBoxSizer
 453 //---------------------------------------------------------------------------
 454
 455 class WXDLLEXPORT wxBoxSizer: public wxSizer
 456 {
 457 public:
 458     wxBoxSizer( int orient );
 459
 460     void RecalcSizes();
 461     wxSize CalcMin();
 462
 463     int GetOrientation() const
 464         { return m_orient; }
 465
 466     void SetOrientation(int orient)
 467         { m_orient = orient; }
 468
 469 protected:
 470     int m_orient;
 471     int m_stretchable;
 472     int m_minWidth;
 473     int m_minHeight;
 474     int m_fixedWidth;
 475     int m_fixedHeight;
 476
 477 private:
 478     DECLARE_CLASS(wxBoxSizer)
 479 };
 480
 481 //---------------------------------------------------------------------------
 482 // wxStaticBoxSizer
 483 //---------------------------------------------------------------------------
 484
 485 #if wxUSE_STATBOX
 486
 487 class WXDLLEXPORT wxStaticBox;
 488
 489 class WXDLLEXPORT wxStaticBoxSizer: public wxBoxSizer
 490 {
 491 public:
 492     wxStaticBoxSizer( wxStaticBox *box, int orient );
 493
 494     void RecalcSizes();
 495     wxSize CalcMin();
 496
 497     wxStaticBox *GetStaticBox() const
 498         { return m_staticBox; }
 499
 500 protected:
 501     wxStaticBox   *m_staticBox;
 502
 503 private:
 504     DECLARE_CLASS(wxStaticBoxSizer)
 505     DECLARE_NO_COPY_CLASS(wxStaticBoxSizer)
 506 };
 507
 508 #endif // wxUSE_STATBOX
 509
 510 // ----------------------------------------------------------------------------
 511 // wxBookCtrlSizer
 512 // ----------------------------------------------------------------------------
 513
 514 #if wxUSE_BOOKCTRL
 515
 516 // this sizer works with wxNotebook/wxListbook/... and sizes the control to
 517 // fit its pages
 518 class WXDLLEXPORT wxBookCtrl;
 519
 520 class WXDLLEXPORT wxBookCtrlSizer : public wxSizer
 521 {
 522 public:
 523     wxBookCtrlSizer(wxBookCtrl *bookctrl);
 524
 525     virtual void RecalcSizes();
 526     virtual wxSize CalcMin();
 527
 528     wxBookCtrl *GetControl() const { return m_bookctrl; }
 529
 530 protected:
 531     wxBookCtrl *m_bookctrl;
 532
 533 private:
 534     DECLARE_CLASS(wxBookCtrlSizer)
 535     DECLARE_NO_COPY_CLASS(wxBookCtrlSizer)
 536 };
 537
 538
 539 #if wxUSE_NOTEBOOK
 540
 541 // before wxBookCtrl we only had wxNotebookSizer, keep it for backwards
 542 // compatibility
 543 class WXDLLEXPORT wxNotebook;
 544
 545 class WXDLLEXPORT wxNotebookSizer : public wxBookCtrlSizer
 546 {
 547 public:
 548     wxNotebookSizer(wxNotebook *nb);
 549
 550     wxNotebook *GetNotebook() const { return (wxNotebook *)m_bookctrl; }
 551
 552 private:
 553     DECLARE_CLASS(wxNotebookSizer)
 554     DECLARE_NO_COPY_CLASS(wxNotebookSizer)
 555 };
 556
 557 #endif // wxUSE_NOTEBOOK
 558
 559 #endif // wxUSE_BOOKCTRL
 560
 561 #endif // __WXSIZER_H__
 562