documented that wxHSCROLL disables wrapping; added comment to the source

[wxWidgets.git] / docs / latex / wx / flexsizr.tex

diff --git a/docs/latex/wx/flexsizr.tex b/docs/latex/wx/flexsizr.tex
index 0ce1e99fe4bda4c935ddb8ae167e27b18c53a66c..92c1f8d5c29f32c2bd95145317fc7ba7064a2305 100644 (file)
--- a/docs/latex/wx/flexsizr.tex
+++ b/docs/latex/wx/flexsizr.tex
@@ -9,7 +9,7 @@ the \helpref{wxGridSizer}{wxgridsizer}.
 Since wxWindows 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
@@ -41,18 +41,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 +79,7 @@ One of the following values:
 
 \wxheading{See also}
 
-\helpref{SetFlexibleDrection}{wxflexgridsizersetflexibledrection}
+\helpref{SetFlexibleDrection}{wxflexgridsizersetflexibledirection}
 
 
 \membersection{wxFlexGridSizer::GetNonFlexibleGrowMode}\label{wxflexgridsizergetnonflexiblegrowmode}
@@ -100,7 +107,7 @@ direction.}
 
 \wxheading{See also}
 
-\helpref{SetFlexibleDrection}{wxflexgridsizersetflexibledrection}, 
+\helpref{SetFlexibleDrection}{wxflexgridsizersetflexibledirection}, 
 \helpref{SetNonFlexibleGrowMode}{wxflexgridsizersetnonflexiblegrowmode}
 
 
@@ -118,12 +125,12 @@ 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}}
 
 Specifies whether the sizer should flexibly resize its columns, rows, or
-both. Argument {\t direction} can be {\tt wxVERTICAL}, {\tt wxHORIZONTAL} 
+both. Argument {\tt direction} can be {\tt wxVERTICAL}, {\tt wxHORIZONTAL} 
 or {\tt wxBOTH} (which is the default value). Any other value is ignored. See
 \helpref{GetFlexibleDirection()}{wxflexgridsizergetflexibledrection} for the
 explanation of these values.
@@ -131,13 +138,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}}
 
 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.