X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/eaf498dffe669663ea40394798d6a35ffc7fb62e..8b2858410444b111cb192d1539ef6c76209091fd:/docs/latex/wx/flexsizr.tex diff --git a/docs/latex/wx/flexsizr.tex b/docs/latex/wx/flexsizr.tex index c27734f92c..c161b8fafa 100644 --- a/docs/latex/wx/flexsizr.tex +++ b/docs/latex/wx/flexsizr.tex @@ -6,10 +6,10 @@ height and all fields in one column having the same width, but all rows or all columns are not necessarily the same height or width as in the \helpref{wxGridSizer}{wxgridsizer}. -Since wxWindows 2.5.0, wxFlexGridSizer can also size items equally in one +Since wxWidgets 2.5.0, wxFlexGridSizer can also size items equally in one direction but unequally ("flexibly") in the other. If the sizer is only flexible in one direction (this can be changed using -\helpref{SetFlexibleDrection}{wxflexgridsizersetflexibledrection}), +\helpref{SetFlexibleDrection}{wxflexgridsizersetflexibledirection}), it needs to be decided how the sizer should grow in the other ("non flexible") direction in order to fill the available space. The \helpref{SetNonFlexibleGrowMode}{wxflexgridsizersetnonflexiblegrowmode} method @@ -21,10 +21,15 @@ serves this purpose. \helpref{wxSizer}{wxsizer}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{See also} \helpref{wxSizer}{wxsizer}, \helpref{Sizer overview}{sizeroverview} +\latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxFlexGridSizer::wxFlexGridSizer}\label{wxflexgridsizerwxflexgridsizer} @@ -41,18 +46,25 @@ all children. \membersection{wxFlexGridSizer::AddGrowableCol}\label{wxflexgridsizeraddgrowablecol} -\func{void}{AddGrowableCol}{\param{size\_t }{idx}} +\func{void}{AddGrowableCol}{\param{size\_t }{idx}, \param{int }{proportion = $0$}} -Specifies that column idx (starting from zero) should be grown if +Specifies that column {\it idx} (starting from zero) should be grown if there is extra space available to the sizer. +The {\it proportion} parameter has the same meaning as the stretch factor for +the \helpref{sizers}{sizeroverview} except that if all proportions are $0$, +then all columns are resized equally (instead of not being resized at all). + \membersection{wxFlexGridSizer::AddGrowableRow}\label{wxflexgridsizeraddgrowablerow} -\func{void}{AddGrowableRow}{\param{size\_t }{idx}} +\func{void}{AddGrowableRow}{\param{size\_t }{idx}, \param{int }{proportion = $0$}} Specifies that row idx (starting from zero) should be grown if there is extra space available to the sizer. +See \helpref{AddGrowableCol}{wxflexgridsizeraddgrowablecol} for the description +of {\it proportion} parameter. + \membersection{wxFlexGridSizer::GetFlexibleDirection}\label{wxflexgridsizergetflexibledrection} \constfunc{int}{GetFlexibleDirections}{\void} @@ -72,7 +84,7 @@ One of the following values: \wxheading{See also} -\helpref{SetFlexibleDrection}{wxflexgridsizersetflexibledrection} +\helpref{SetFlexibleDrection}{wxflexgridsizersetflexibledirection} \membersection{wxFlexGridSizer::GetNonFlexibleGrowMode}\label{wxflexgridsizergetnonflexiblegrowmode} @@ -94,13 +106,13 @@ One of the following values: In this case equal sizing applies to minimum sizes of columns or rows (this is the default value).} \twocolitem{wxFLEX\_GROWMODE\_ALL}{Sizer equally stretches all columns or rows -in the non flexible direction, whether they are growable or not in the flexbile +in the non flexible direction, whether they are growable or not in the flexible direction.} \end{twocollist} \wxheading{See also} -\helpref{SetFlexibleDrection}{wxflexgridsizersetflexibledrection}, +\helpref{SetFlexibleDrection}{wxflexgridsizersetflexibledirection}, \helpref{SetNonFlexibleGrowMode}{wxflexgridsizersetnonflexiblegrowmode} @@ -118,7 +130,7 @@ Specifies that column idx is no longer growable. Specifies that row idx is no longer growable. -\membersection{wxFlexGridSizer::SetFlexibleDirection}{wxflexgridsizersetflexibledrection} +\membersection{wxFlexGridSizer::SetFlexibleDirection}\label{wxflexgridsizersetflexibledirection} \func{void}{SetFlexibleDirections}{\param{int }{direction}} @@ -131,13 +143,13 @@ explanation of these values. Note that this method does not trigger relayout. -\membersection{wxFlexGridSizer::SetNonFlexibleGrowMode}{wxflexgridsizersetnonflexiblegrowmode} +\membersection{wxFlexGridSizer::SetNonFlexibleGrowMode}\label{wxflexgridsizersetnonflexiblegrowmode} -\func{void}{SetNonFlexibleGrowMode}{\param{int }{mode}} +\func{void}{SetNonFlexibleGrowMode}{\param{wxFlexSizerGrowMode }{mode}} Specifies how the sizer should grow in the non flexible direction if there is one (so -\helpref{SetFlexibleDirections()}{wxflexgridsizersetflexibledrection} must have +\helpref{SetFlexibleDirections()}{wxflexgridsizersetflexibledirection} must have been called previously). Argument {\it mode} can be one of those documented in \helpref{GetNonFlexibleGrowMode}{wxflexgridsizergetnonflexiblegrowmode}, please see there for their explanation.