Added scripts to demonstrate how to package a PocketPC app

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

diff --git a/docs/latex/wx/sizer.tex b/docs/latex/wx/sizer.tex
index c93d40cb4d8b1b20cbd736970a5f52e3bbf8c7d2..22d64fe7e7acd0a6115a5b30d8a2ee8c691793ed 100644 (file)
--- a/docs/latex/wx/sizer.tex
+++ b/docs/latex/wx/sizer.tex
@@ -62,8 +62,12 @@ The destructor.
 
 \membersection{wxSizer::Add}\label{wxsizeradd}
 
+\func{wxSizerItem*}{Add}{\param{wxWindow* }{window}, \param{const wxSizerFlags\& }{flags}}
+
 \func{wxSizerItem*}{Add}{\param{wxWindow* }{window}, \param{int }{proportion = 0},\param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
+\func{wxSizerItem*}{Add}{\param{wxSizer* }{sizer}, \param{const wxSizerFlags\& }{flags}}
+
 \func{wxSizerItem*}{Add}{\param{wxSizer* }{sizer}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
 \func{wxSizerItem*}{Add}{\param{int }{width}, \param{int }{height}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
@@ -142,6 +146,8 @@ the sizer, adjusted for the border if any.}
 item, for use in derived classes when sizing information is more
 complex than the {\it proportion} and {\it flag} will allow for.}
 
+\docparam{flags}{A \helpref{wxSizerFlags}{wxsizerflags} object that 
+enables you to specify most of the above parameters more conveniently.}
 
 \membersection{wxSizer::AddSpacer}\label{wxsizeraddspacer}
 
@@ -254,8 +260,12 @@ size of all the children and their borders or the minimal size set by
 
 \membersection{wxSizer::Insert}\label{wxsizerinsert}
 
+\func{wxSizerItem*}{Insert}{\param{size\_t }{index}, \param{wxWindow* }{window}, \param{const wxSizerFlags\& }{flags}}
+
 \func{wxSizerItem*}{Insert}{\param{size\_t }{index}, \param{wxWindow* }{window}, \param{int }{proportion = 0},\param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
+\func{wxSizerItem*}{Insert}{\param{size\_t }{index}, \param{wxSizer* }{sizer}, \param{const wxSizerFlags\& }{flags}}
+
 \func{wxSizerItem*}{Insert}{\param{size\_t }{index}, \param{wxSizer* }{sizer}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
 \func{wxSizerItem*}{Insert}{\param{size\_t }{index}, \param{int }{width}, \param{int }{height}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
@@ -294,8 +304,12 @@ the current dimension.
 
 \membersection{wxSizer::Prepend}\label{wxsizerprepend}
 
+\func{wxSizerItem*}{Prepend}{\param{wxWindow* }{window}, \param{const wxSizerFlags\& }{flags}}
+
 \func{wxSizerItem*}{Prepend}{\param{wxWindow* }{window}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
+\func{wxSizerItem*}{Prepend}{\param{wxSizer* }{sizer}, \param{const wxSizerFlags\& }{flags}}
+
 \func{wxSizerItem*}{Prepend}{\param{wxSizer* }{sizer}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
 \func{wxSizerItem*}{Prepend}{\param{int }{width}, \param{int }{height}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border= 0}, \param{wxObject* }{userData = NULL}}
@@ -430,20 +444,23 @@ are the only two sizer classes that can size rows/columns independently.
 
 \section{\class{wxSizerFlags}}\label{wxsizerflags}
 
+PRELIMINARY.
+
 Normally, when you add something to a sizer via \helpref{wxSizer::Add}{wxsizeradd}, you have to specify a lot of flags and parameters.  This can be unwieldy.
 
 This is where wxSizerFlags comes in.  Instead of a bunch of flags and other stuff, you can use wxSizerFlags, which is a convenient class for doing so.
 
-Note that by specification, all methods that are not accessors of wxSizerFlags return the wxSizerFlags object itself to ease the calling of multiple methods at a time.
+Note that by specification, all methods of wxSizerFlags return the wxSizerFlags object itself to ease the calling of multiple methods at a time.
+
 
-\membersection{wxSizer::wxSizer}\label{wxsizerflagsctor}
+\membersection{wxSizerFlags::wxSizerFlags}\label{wxsizerflagsctor}
 
 \func{}{wxSizerFlags}{\param{int }{proportion = 0}}
 
 Creates the wxSizer with the proportion specified by \tt{proportion}.
 
 
-\membersection{wxSizer::Align}\label{wxsizerflagsalign}
+\membersection{wxSizerFlags::Align}\label{wxsizerflagsalign}
 
 \func{wxSizerFlags\& }{Align}{\param{int }{align = 0}}
 
@@ -451,8 +468,14 @@ Sets the alignment of this wxSizerFlags to \tt{align}.
 
 Note that if this method is not called, the wxSizerFlags has no specified alignment.
 
+\wxheading{See also}
+
+\helpref{Left}{wxsizerflagsleft},\\
+\helpref{Right}{wxsizerflagsright},\\
+\helpref{Centre}{wxsizerflagscentre}
 
-\membersection{wxSizer::Border}\label{wxsizerflagsborder}
+
+\membersection{wxSizerFlags::Border}\label{wxsizerflagsborder}
 
 \func{wxSizerFlags\& }{Border}{\param{int }{direction}, \param{int }{borderinpixels}}
 
@@ -463,53 +486,52 @@ Sets the wxSizerFlags to have a border of a number of pixels specified by \tt{bo
 Sets the wxSizerFlags to have a border of a default size with the directions specified by \tt{direction}.
 
 
-\membersection{wxSizer::Center}\label{wxsizerflagscenter}
+\membersection{wxSizerFlags::Center}\label{wxsizerflagscenter}
 
 \func{wxSizerFlags\& }{Center}{\void}
 
 Sets the object of the wxSizerFlags to center itself in the area it is given.
 
 
-\membersection{wxSizer::Centre}\label{wxsizerflagscentre}
+\membersection{wxSizerFlags::Centre}\label{wxsizerflagscentre}
 
 \func{wxSizerFlags\& }{Centre}{\void}
 
 \helpref{wxSizerFlags::Center}{wxsizerflagscenter} for people with the other dialect of english.
 
 
-\membersection{wxSizer::Expand}\label{wxsizerflagsexpand}
+\membersection{wxSizerFlags::Expand}\label{wxsizerflagsexpand}
 
-\func{wxSizerFlags\& }{Align}{\void}
+\func{wxSizerFlags\& }{Expand}{\void}
 
 Sets the object of the wxSizerFlags to expand to fill as much area as it can.
 
 
-\membersection{wxSizer::GetBorderInPixels}\label{wxsizerflagsgetborderinpixels}
-
-\func{int }{GetProportion}{\void}
-
-Obtains the number of pixels assigned to this wxSizerFlags border.
+\membersection{wxSizerFlags::Left}\label{wxsizerflagsleft}
 
+\func{wxSizerFlags\& }{Left}{\void}
 
-\membersection{wxSizer::GetFlags}\label{wxsizerflagsgetflags}
+Aligns the object to the left, shortcut for \texttt{Align(wxALIGN\_LEFT)}
 
-\func{int }{GetFlags}{\void}
+\wxheading{See also}
 
-Gets the flag value you would pass to a wxSizer method.
+\helpref{Align}{wxsizerflagsalign}
 
 
-\membersection{wxSizer::GetProportion}\label{wxsizerflagsgetproportion}
+\membersection{wxSizerFlags::Proportion}\label{wxsizerflagsproportion}
 
-\func{int }{GetProportion}{\void}
+\func{wxSizerFlags\& }{Proportion}{\param{int }{proportion = 0}}
 
-Gets the amount of proportion given to this wxSizerFlags.
+Sets the proportion of this wxSizerFlags to \tt{proportion}
 
 
-\membersection{wxSizer::Proportion}\label{wxsizerflagsproportion}
+\membersection{wxSizerFlags::Right}\label{wxsizerflagsright}
 
-\func{wxSizerFlags\& }{Proportion}{\param{int }{proportion = 0}}
+\func{wxSizerFlags\& }{Right}{\void}
 
-Sets the proportion of this wxSizerFlags to \tt{proportion}
+Aligns the object to the right, shortcut for \texttt{Align(wxALIGN\_RIGHT)}
 
+\wxheading{See also}
 
+\helpref{Align}{wxsizerflagsalign}