docs/latex/wx/flexsizr.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        flexsizr.tex
   3 %% Purpose:     wxFlexGridSizer
   4 %% Author:      wxWidgets Team
   5 %% Modified by:
   6 %% Created:
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) wxWidgets Team
   9 %% License:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxFlexGridSizer}}\label{wxflexgridsizer}
  13
  14 A flex grid sizer is a sizer which lays out its children in a two-dimensional
  15 table with all table fields in one row having the same
  16 height and all fields in one column having the same width, but all
  17 rows or all columns are not necessarily the same height or width as in
  18 the \helpref{wxGridSizer}{wxgridsizer}.
  19
  20 Since wxWidgets 2.5.0, wxFlexGridSizer can also size items equally in one
  21 direction but unequally ("flexibly") in the other. If the sizer is only
  22 flexible in one direction (this can be changed using
  23 \helpref{SetFlexibleDirection}{wxflexgridsizersetflexibledirection}),
  24 it needs to be decided how the sizer should grow in the other ("non-flexible")
  25 direction in order to fill the available space. The
  26 \helpref{SetNonFlexibleGrowMode}{wxflexgridsizersetnonflexiblegrowmode} method
  27 serves this purpose.
  28
  29 \wxheading{Derived from}
  30
  31 \helpref{wxGridSizer}{wxgridsizer}\\
  32 \helpref{wxSizer}{wxsizer}\\
  33 \helpref{wxObject}{wxobject}
  34
  35 \wxheading{Include files}
  36
  37 <wx/sizer.h>
  38
  39 \wxheading{See also}
  40
  41 \helpref{wxSizer}{wxsizer}, \helpref{Sizer overview}{sizeroverview}
  42
  43 \latexignore{\rtfignore{\wxheading{Members}}}
  44
  45 \membersection{wxFlexGridSizer::wxFlexGridSizer}\label{wxflexgridsizerwxflexgridsizer}
  46
  47 \func{}{wxFlexGridSizer}{\param{int }{rows}, \param{int }{cols}, \param{int }{vgap}, \param{int }{hgap}}
  48
  49 \func{}{wxFlexGridSizer}{\param{int }{cols}, \param{int }{vgap = 0}, \param{int }{hgap = 0}}
  50
  51 Constructor for a wxGridSizer. {\it rows} and {\it cols} determine the number of
  52 columns and rows in the sizer - if either of the parameters is zero, it will be
  53 calculated to form the total number of children in the sizer, thus making the
  54 sizer grow dynamically. {\it vgap} and {\it hgap} define extra space between
  55 all children.
  56
  57
  58 \membersection{wxFlexGridSizer::AddGrowableCol}\label{wxflexgridsizeraddgrowablecol}
  59
  60 \func{void}{AddGrowableCol}{\param{size\_t }{idx}, \param{int }{proportion = $0$}}
  61
  62 Specifies that column {\it idx} (starting from zero) should be grown if
  63 there is extra space available to the sizer.
  64
  65 The {\it proportion} parameter has the same meaning as the stretch factor for
  66 the \helpref{sizers}{sizeroverview} except that if all proportions are $0$,
  67 then all columns are resized equally (instead of not being resized at all).
  68
  69 \membersection{wxFlexGridSizer::AddGrowableRow}\label{wxflexgridsizeraddgrowablerow}
  70
  71 \func{void}{AddGrowableRow}{\param{size\_t }{idx}, \param{int }{proportion = $0$}}
  72
  73 Specifies that row idx (starting from zero) should be grown if there
  74 is extra space available to the sizer.
  75
  76 See \helpref{AddGrowableCol}{wxflexgridsizeraddgrowablecol} for the description
  77 of {\it proportion} parameter.
  78
  79 \membersection{wxFlexGridSizer::GetFlexibleDirection}\label{wxflexgridsizergetflexibledrection}
  80
  81 \constfunc{int}{GetFlexibleDirection}{\void}
  82
  83 Returns a wxOrientation value that specifies whether the sizer flexibly
  84 resizes its columns, rows, or both (default).
  85
  86 \wxheading{Return value}
  87
  88 One of the following values:
  89
  90 \begin{twocollist}
  91 \twocolitem{wxVERTICAL}{Rows are flexibly sized.}
  92 \twocolitem{wxHORIZONTAL}{Columns are flexibly sized.}
  93 \twocolitem{wxBOTH}{Both rows and columns are flexibly sized (this is the default value).}
  94 \end{twocollist}
  95
  96 \wxheading{See also}
  97
  98 \helpref{SetFlexibleDirection}{wxflexgridsizersetflexibledirection}
  99
 100
 101 \membersection{wxFlexGridSizer::GetNonFlexibleGrowMode}\label{wxflexgridsizergetnonflexiblegrowmode}
 102
 103 \constfunc{int}{GetNonFlexibleGrowMode}{\void}
 104
 105 Returns the value that specifies how the sizer grows in the "non-flexible"
 106 direction if there is one.
 107
 108 \wxheading{Return value}
 109
 110 One of the following values:
 111
 112 \begin{twocollist}
 113 \twocolitem{wxFLEX\_GROWMODE\_NONE}{Sizer doesn't grow in the non-flexible direction.}
 114 \twocolitem{wxFLEX\_GROWMODE\_SPECIFIED}{Sizer honors growable columns/rows set with
 115 \helpref{AddGrowableCol}{wxflexgridsizeraddgrowablecol} and
 116 \helpref{AddGrowableRow}{wxflexgridsizeraddgrowablerow}.
 117 In this case equal sizing applies to minimum sizes of columns or
 118 rows (this is the default value).}
 119 \twocolitem{wxFLEX\_GROWMODE\_ALL}{Sizer equally stretches all columns or rows
 120 in the non-flexible direction, whether they are growable or not in the flexible
 121 direction.}
 122 \end{twocollist}
 123
 124 \wxheading{See also}
 125
 126 \helpref{SetFlexibleDirection}{wxflexgridsizersetflexibledirection},
 127 \helpref{SetNonFlexibleGrowMode}{wxflexgridsizersetnonflexiblegrowmode}
 128
 129
 130 \membersection{wxFlexGridSizer::RemoveGrowableCol}\label{wxflexgridsizerremovegrowablecol}
 131
 132 \func{void}{RemoveGrowableCol}{\param{size\_t }{idx}}
 133
 134 Specifies that column idx is no longer growable.
 135
 136
 137 \membersection{wxFlexGridSizer::RemoveGrowableRow}\label{wxflexgridsizerremovegrowablerow}
 138
 139 \func{void}{RemoveGrowableRow}{\param{size\_t }{idx}}
 140
 141 Specifies that row idx is no longer growable.
 142
 143
 144 \membersection{wxFlexGridSizer::SetFlexibleDirection}\label{wxflexgridsizersetflexibledirection}
 145
 146 \func{void}{SetFlexibleDirection}{\param{int }{direction}}
 147
 148 Specifies whether the sizer should flexibly resize its columns, rows, or
 149 both. Argument {\tt direction} can be {\tt wxVERTICAL}, {\tt wxHORIZONTAL}
 150 or {\tt wxBOTH} (which is the default value). Any other value is ignored. See
 151 \helpref{GetFlexibleDirection()}{wxflexgridsizergetflexibledrection} for the
 152 explanation of these values.
 153
 154 Note that this method does not trigger relayout.
 155
 156
 157 \membersection{wxFlexGridSizer::SetNonFlexibleGrowMode}\label{wxflexgridsizersetnonflexiblegrowmode}
 158
 159 \func{void}{SetNonFlexibleGrowMode}{\param{wxFlexSizerGrowMode }{mode}}
 160
 161 Specifies how the sizer should grow in the non-flexible direction if
 162 there is one (so
 163 \helpref{SetFlexibleDirection()}{wxflexgridsizersetflexibledirection} must have
 164 been called previously). Argument {\it mode} can be one of those documented in
 165 \helpref{GetNonFlexibleGrowMode}{wxflexgridsizergetnonflexiblegrowmode}, please
 166 see there for their explanation.
 167
 168 Note that this method does not trigger relayout.