]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/boxsizer.tex
Doc tweaks
[wxWidgets.git] / docs / latex / wx / boxsizer.tex
index c58931c47c7972850ea43e1bc037ae8ec622efb6..08de2b2152cfdc7d79d81dca0190e0e11946fa6b 100644 (file)
@@ -1,43 +1,50 @@
-%
-% automatically generated by HelpGen from
-% include\wx\sizer.h at 13/Aug/99 22:27:59
-%
-
-
 \section{\class{wxBoxSizer}}\label{wxboxsizer}
 
+The basic idea behind a box sizer is that windows will most often be laid out in rather
+simple basic geometry, typically in a row or a column or several hierarchies of either.
 
-
-wxBoxSizer
-
+For more information, please see \helpref{Programming with wxBoxSizer}{boxsizerprogramming}.
 
 \wxheading{Derived from}
 
-\helpref{wxSizer}{wxsizer}
+\helpref{wxSizer}{wxsizer}\\
+\helpref{wxObject}{wxobject}
 
-\wxheading{Data structures}
+\wxheading{Include files}
 
-}
+<wx/sizer.h>
 
-\latexignore{\rtfignore{\wxheading{Members}}}
+\wxheading{See also}
 
+\helpref{wxSizer}{wxsizer}, \helpref{Sizer overview}{sizeroverview}
 
 \membersection{wxBoxSizer::wxBoxSizer}\label{wxboxsizerwxboxsizer}
 
 \func{}{wxBoxSizer}{\param{int }{orient}}
 
+Constructor for a wxBoxSizer. {\it orient} may be either of wxVERTICAL
+or wxHORIZONTAL for creating either a column sizer or a row sizer.
 
 \membersection{wxBoxSizer::RecalcSizes}\label{wxboxsizerrecalcsizes}
 
 \func{void}{RecalcSizes}{\void}
 
+Implements the calculation of a box sizer's dimensions and then sets
+the size of its its children (calling \helpref{wxWindow::SetSize}{wxwindowsetsize} 
+if the child is a window). It is used internally only and must not be called
+by the user. Documented for information.
 
 \membersection{wxBoxSizer::CalcMin}\label{wxboxsizercalcmin}
 
 \func{wxSize}{CalcMin}{\void}
 
+Implements the calculation of a box sizer's minimal. It is used internally
+only and must not be called by the user. Documented for information.
 
 \membersection{wxBoxSizer::GetOrientation}\label{wxboxsizergetorientation}
 
 \func{int}{GetOrientation}{\void}
 
+Returns the orientation of the box sizer, either wxVERTICAL
+or wxHORIZONTAL.
+