+\wxheading{See also}
+
+\helpref{wxSizer::Hide}{wxsizerhide},\rtfsp
+\helpref{wxSizer::IsShown}{wxsizerisshown}
+
+
+
+
+\section{\class{wxSizerFlags}}\label{wxsizerflags}
+
+Normally, when you add an item to a sizer via
+\helpref{wxSizer::Add}{wxsizeradd}, you have to specify a lot of flags and
+parameters which can be unwieldy. This is where wxSizerFlags comes in: it
+allows you to specify all parameters using the named methods instead. For
+example, instead of
+
+\begin{verbatim}
+ sizer->Add(ctrl, 0, wxEXPAND | wxBORDER, 10);
+\end{verbatim}
+
+you can now write
+
+\begin{verbatim}
+ sizer->Add(ctrl, wxSizerFlags().Expand().Border(10));
+\end{verbatim}
+
+This is more readable and also allows you to create wxSizerFlags objects which
+can be reused for several sizer items.
+\begin{verbatim}
+ wxSizerFlags flagsExpand(1);
+ flagsExpand.Expand().Border(10);
+
+ sizer->Add(ctrl1, flagsExpand);
+ sizer->Add(ctrl2, flagsExpand);
+\end{verbatim}
+
+Note that by specification, all methods of wxSizerFlags return the wxSizerFlags
+object itself to allowing chaining multiple methods calls like in the examples
+above.
+
+
+\membersection{wxSizerFlags::wxSizerFlags}\label{wxsizerflagsctor}
+
+\func{}{wxSizerFlags}{\param{int }{proportion = 0}}
+
+Creates the wxSizer with the proportion specified by \arg{proportion}.
+
+
+\membersection{wxSizerFlags::Align}\label{wxsizerflagsalign}
+
+\func{wxSizerFlags\& }{Align}{\param{int }{align = 0}}
+
+Sets the alignment of this wxSizerFlags to \arg{align}.
+
+Note that if this method is not called, the wxSizerFlags has no specified alignment.
+
+\wxheading{See also}
+
+\helpref{Top}{wxsizerflagstop},\\
+\helpref{Left}{wxsizerflagsleft},\\
+\helpref{Right}{wxsizerflagsright},\\
+\helpref{Bottom}{wxsizerflagsbottom},\\
+\helpref{Centre}{wxsizerflagscentre}
+
+
+\membersection{wxSizerFlags::Border}\label{wxsizerflagsborder}
+
+\func{wxSizerFlags\& }{Border}{\param{int }{direction}, \param{int }{borderinpixels}}
+
+\func{wxSizerFlags\& }{Border}{\param{int }{direction = wxALL}}
+
+Sets the wxSizerFlags to have a border of a number of pixels specified by
+\arg{borderinpixels} with the directions specified by \arg{direction}.
+
+In the overloaded version without \arg{borderinpixels} parameter, the border of
+default size, as returned by \helpref{GetDefaultBorder}{wxsizerflagsgetdefaultborder},
+is used.
+
+
+\membersection{wxSizerFlags::Bottom}\label{wxsizerflagsbottom}
+
+\func{wxSizerFlags\& }{Bottom}{\void}
+
+Aligns the object to the bottom, shortcut for \texttt{Align(wxALIGN\_BOTTOM)}
+
+\wxheading{See also}
+
+\helpref{Align}{wxsizerflagsalign}
+
+
+\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{wxSizerFlags::Centre}\label{wxsizerflagscentre}
+
+\func{wxSizerFlags\& }{Centre}{\void}
+
+\helpref{wxSizerFlags::Center}{wxsizerflagscenter} for people with the other dialect of english.
+
+
+\membersection{wxSizerFlags::DoubleBorder}\label{wxsizerflagsdoubleborder}
+
+\func{wxSizerFlags\& }{DoubleBorder}{\param{int }{direction = wxALL}}
+
+Sets the border in the given \arg{direction} having twice the default border
+size.
+
+
+\membersection{wxSizerFlags::DoubleHorzBorder}\label{wxsizerflagsdoublehorzborder}
+
+\func{wxSizerFlags\& }{DoubleHorzBorder}{\void}
+
+Sets the border in left and right directions having twice the default border
+size.
+
+
+\membersection{wxSizerFlags::Expand}\label{wxsizerflagsexpand}
+
+\func{wxSizerFlags\& }{Expand}{\void}
+
+Sets the object of the wxSizerFlags to expand to fill as much area as it can.
+
+
+\membersection{wxSizerFlags::GetDefaultBorder}\label{wxsizerflagsgetdefaultborder}
+
+\func{static int}{GetDefaultBorder}{\void}
+
+Returns the border used by default in \helpref{Border}{wxsizerflagsborder} method.
+
+
+\membersection{wxSizerFlags::Left}\label{wxsizerflagsleft}
+
+\func{wxSizerFlags\& }{Left}{\void}
+
+Aligns the object to the left, shortcut for \texttt{Align(wxALIGN\_LEFT)}
+
+\wxheading{See also}
+
+\helpref{Align}{wxsizerflagsalign}
+
+
+\membersection{wxSizerFlags::FixedMinSize}\label{wxsizerflagsfixedminsize}
+
+\func{wxSizerFlags\& }{FixedMinSize}{\void}
+
+Set the \texttt{wxFIXED\_MINSIZE} flag which indicates that the initial size of
+the window should be also set as its minimal size.
+
+
+\membersection{wxSizerFlags::Proportion}\label{wxsizerflagsproportion}
+
+\func{wxSizerFlags\& }{Proportion}{\param{int }{proportion = 0}}
+
+Sets the proportion of this wxSizerFlags to \arg{proportion}
+
+
+\membersection{wxSizerFlags::Right}\label{wxsizerflagsright}
+
+\func{wxSizerFlags\& }{Right}{\void}
+
+Aligns the object to the right, shortcut for \texttt{Align(wxALIGN\_RIGHT)}
+
+\wxheading{See also}
+
+\helpref{Align}{wxsizerflagsalign}
+
+
+\membersection{wxSizerFlags::Shaped}\label{wxsizerflagsshaped}
+
+\func{wxSizerFlags\& }{Shaped}{\void}
+
+Set the \texttt{wx\_SHAPED} flag which indicates that the elements should
+always keep the fixed width to height ratio equal to its original value.
+
+
+\membersection{wxSizerFlags::Top}\label{wxsizerflagstop}
+
+\func{wxSizerFlags\& }{Top}{\void}
+
+Aligns the object to the top, shortcut for \texttt{Align(wxALIGN\_TOP)}
+
+\wxheading{See also}
+
+\helpref{Align}{wxsizerflagsalign}
+
+
+\membersection{wxSizerFlags::TripleBorder}\label{wxsizerflagstriplebleborder}
+
+\func{wxSizerFlags\& }{TripleBorder}{\param{int }{direction = wxALL}}
+
+Sets the border in the given \arg{direction} having thrice the default border
+size.
+
projects / wxWidgets.git / blobdiff