Described in the comments and documented the semantics of the parameters and

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

diff --git a/docs/latex/wx/flexsizr.tex b/docs/latex/wx/flexsizr.tex
index 92c1f8d5c29f32c2bd95145317fc7ba7064a2305..28b3c3c95ff72a218d5e8fe659f180b7b08cba34 100644 (file)
--- a/docs/latex/wx/flexsizr.tex
+++ b/docs/latex/wx/flexsizr.tex
@@ -1,3 +1,14 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        flexsizr.tex
+%% Purpose:     wxFlexGridSizer
+%% Author:      wxWidgets Team
+%% Modified by:
+%% Created:
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets Team
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \section{\class{wxFlexGridSizer}}\label{wxflexgridsizer}
 
 A flex grid sizer is a sizer which lays out its children in a two-dimensional
@@ -6,12 +17,12 @@ 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}{wxflexgridsizersetflexibledirection}),
+flexible in one direction (this can be changed using
+\helpref{SetFlexibleDirection}{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 
+direction in order to fill the available space. The
 \helpref{SetNonFlexibleGrowMode}{wxflexgridsizersetnonflexiblegrowmode} method
 serves this purpose.
 
@@ -21,10 +32,15 @@ serves this purpose.
 \helpref{wxSizer}{wxsizer}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/sizer.h>
+
 \wxheading{See also}
 
 \helpref{wxSizer}{wxsizer}, \helpref{Sizer overview}{sizeroverview}
 
+\latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxFlexGridSizer::wxFlexGridSizer}\label{wxflexgridsizerwxflexgridsizer}
 
@@ -62,7 +78,7 @@ of {\it proportion} parameter.
 
 \membersection{wxFlexGridSizer::GetFlexibleDirection}\label{wxflexgridsizergetflexibledrection}
 
-\constfunc{int}{GetFlexibleDirections}{\void}
+\constfunc{int}{GetFlexibleDirection}{\void}
 
 Returns a wxOrientation value that specifies whether the sizer flexibly
 resizes its columns, rows, or both (default).
@@ -79,7 +95,7 @@ One of the following values:
 
 \wxheading{See also}
 
-\helpref{SetFlexibleDrection}{wxflexgridsizersetflexibledirection}
+\helpref{SetFlexibleDirection}{wxflexgridsizersetflexibledirection}
 
 
 \membersection{wxFlexGridSizer::GetNonFlexibleGrowMode}\label{wxflexgridsizergetnonflexiblegrowmode}
@@ -96,18 +112,18 @@ One of the following values:
 \begin{twocollist}
 \twocolitem{wxFLEX\_GROWMODE\_NONE}{Sizer doesn't grow in the non flexible direction.}
 \twocolitem{wxFLEX\_GROWMODE\_SPECIFIED}{Sizer honors growable columns/rows set with
-\helpref{AddGrowableCol}{wxflexgridsizeraddgrowablecol} and 
+\helpref{AddGrowableCol}{wxflexgridsizeraddgrowablecol} and
 \helpref{AddGrowableRow}{wxflexgridsizeraddgrowablerow}.
 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}{wxflexgridsizersetflexibledirection}, 
+\helpref{SetFlexibleDirection}{wxflexgridsizersetflexibledirection},
 \helpref{SetNonFlexibleGrowMode}{wxflexgridsizersetnonflexiblegrowmode}
 
 
@@ -127,10 +143,10 @@ Specifies that row idx is no longer growable.
 
 \membersection{wxFlexGridSizer::SetFlexibleDirection}\label{wxflexgridsizersetflexibledirection}
 
-\func{void}{SetFlexibleDirections}{\param{int }{direction}}
+\func{void}{SetFlexibleDirection}{\param{int }{direction}}
 
 Specifies whether the sizer should flexibly resize its columns, rows, or
-both. Argument {\tt 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.
@@ -140,14 +156,13 @@ Note that this method does not trigger relayout.
 
 \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()}{wxflexgridsizersetflexibledirection} must have
+\helpref{SetFlexibleDirection()}{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.
 
 Note that this method does not trigger relayout.
-