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