]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/sbsizer.tex
Use const
[wxWidgets.git] / docs / latex / wx / sbsizer.tex
index ef37faf75c8c7d4b6928691250791b33cd13b6f2..f6d8fb5975103a619bea55b66f9230978f75b58f 100644 (file)
@@ -1,10 +1,10 @@
 \section{\class{wxStaticBoxSizer}}\label{wxstaticboxsizer}
 
-wxStaticBoxSizer is a sizer derived from wxBoxSizer. It is useful for
-layouts which make use of static boxes in connection with sizers.
-
-See also \helpref{wxSizer}{wxsizer}, \helpref{wxStaticBox}{wxstaticbox} and
-  \helpref{wxBoxSizer}{wxboxsizer}.
+wxStaticBoxSizer is a sizer derived from wxBoxSizer but adds a static
+box around the sizer. This static box may be either created independently or
+the sizer may create it itself as a convenience. In any case, the sizer owns
+the \helpref{wxStaticBox}{wxstaticbox} control and will delete it if it is
+deleted.
 
 \wxheading{Derived from}
 
@@ -12,17 +12,37 @@ See also \helpref{wxSizer}{wxsizer}, \helpref{wxStaticBox}{wxstaticbox} and
 \helpref{wxSizer}{wxsizer}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/sizer.h>
+
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
+\wxheading{See also}
+
+\helpref{wxSizer}{wxsizer}, \helpref{wxStaticBox}{wxstaticbox}, \helpref{wxBoxSizer}{wxboxsizer}, \helpref{Sizer overview}{sizeroverview}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxStaticBoxSizer::wxStaticBoxSizer}\label{wxstaticboxsizerwxstaticboxsizer}
 
 \func{}{wxStaticBoxSizer}{\param{wxStaticBox* }{box}, \param{int }{orient}}
 
-Constructor. It takes an associated static box and the orientation {\it orient}
-as parameters - orient can be either of wxVERTICAL or wxHORIZONTAL.
+\func{}{wxStaticBoxSizer}{\param{int }{orient}, \param{wxWindow }{*parent}, \param{const wxString\& }{label = wxEmptyString}}
+
+The first constructor uses an already existing static box. It takes the
+associated static box and the orientation \arg{orient}, which can be either
+\texttt{wxVERTICAL} or \texttt{wxHORIZONTAL} as parameters.
+
+The second one creates a new static box with the given label and parent window.
+
 
 \membersection{wxStaticBoxSizer::GetStaticBox}\label{wxstaticboxsizergetstaticbox}
 
 \func{wxStaticBox*}{GetStaticBox}{\void}
 
-Returns the static box associated with the sizer.
\ No newline at end of file
+Returns the static box associated with the sizer.
+