added wxListBox::HitTest() from Ryan (patch 1446207)

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

diff --git a/docs/latex/wx/sizer.tex b/docs/latex/wx/sizer.tex
index c93d40cb4d8b1b20cbd736970a5f52e3bbf8c7d2..a0c77ab75748b2903758d97b3bb24ac7d2c5ddae 100644 (file)
--- a/docs/latex/wx/sizer.tex
+++ b/docs/latex/wx/sizer.tex
@@ -25,6 +25,12 @@ or different window (dialog item) sizes on different platforms without problems.
 the standard font as well as the overall design of Motif widgets requires more space than
 on Windows, the initial dialog size will automatically be bigger on Motif than on Windows.
 
 the standard font as well as the overall design of Motif widgets requires more space than
 on Windows, the initial dialog size will automatically be bigger on Motif than on Windows.
 

+Sizers may also be used to control the layout of custom drawn items on the window.  The
+Add, Insert, and Prepend functions return a pointer to the newly added wxSizerItem. Just
+add empty space of the desired size and attributes, and then use the wxSizerItem::GetRect
+method to determine where the drawing operations should take place.
+
+

 \pythonnote{If you wish to create a sizer class in wxPython you should
 derive the class from {\tt wxPySizer} in order to get Python-aware
 capabilities for the various virtual methods.}
 \pythonnote{If you wish to create a sizer class in wxPython you should
 derive the class from {\tt wxPySizer} in order to get Python-aware
 capabilities for the various virtual methods.}


@@ -62,8 +68,12 @@ The destructor.
 
 \membersection{wxSizer::Add}\label{wxsizeradd}
 
 
 \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{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}}
 \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 +152,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.}
 
 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}
 
 
 \membersection{wxSizer::AddSpacer}\label{wxsizeraddspacer}
 


@@ -254,8 +266,12 @@ size of all the children and their borders or the minimal size set by
 
 \membersection{wxSizer::Insert}\label{wxsizerinsert}
 
 
 \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{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}}
 \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 +310,12 @@ the current dimension.
 
 \membersection{wxSizer::Prepend}\label{wxsizerprepend}
 
 
 \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{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}}
 \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}}


@@ -364,7 +384,7 @@ by the sizer to resize themselves according to the rules defined by the paramete
 
 \func{void}{SetMinSize}{\param{int }{width}, \param{int }{height}}
 
 
 \func{void}{SetMinSize}{\param{int }{width}, \param{int }{height}}
 

-\func{void}{SetMinSize}{\param{wxSize }{size}}
+\func{void}{SetMinSize}{\param{const wxSize\& }{size}}

 
 Call this to give the sizer a minimal size. Normally, the sizer will calculate its
 minimal size based purely on how much space its children need. After calling this
 
 Call this to give the sizer a minimal size. Normally, the sizer will calculate its
 minimal size based purely on how much space its children need. After calling this


@@ -430,20 +450,23 @@ are the only two sizer classes that can size rows/columns independently.
 
 \section{\class{wxSizerFlags}}\label{wxsizerflags}
 
 
 \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.
 
 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}.
 
 
 
 \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}}
 
 
 \func{wxSizerFlags\& }{Align}{\param{int }{align = 0}}
 


@@ -451,8 +474,14 @@ Sets the alignment of this wxSizerFlags to \tt{align}.
 
 Note that if this method is not called, the wxSizerFlags has no specified alignment.
 
 
 Note that if this method is not called, the wxSizerFlags has no specified alignment.
 

+\wxheading{See also}

 
 

-\membersection{wxSizer::Border}\label{wxsizerflagsborder}
+\helpref{Left}{wxsizerflagsleft},\\
+\helpref{Right}{wxsizerflagsright},\\
+\helpref{Centre}{wxsizerflagscentre}
+
+
+\membersection{wxSizerFlags::Border}\label{wxsizerflagsborder}

 
 \func{wxSizerFlags\& }{Border}{\param{int }{direction}, \param{int }{borderinpixels}}
 
 
 \func{wxSizerFlags\& }{Border}{\param{int }{direction}, \param{int }{borderinpixels}}
 


@@ -463,53 +492,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}.
 
 
 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.
 
 
 
 \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.
 
 
 
 \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.
 
 
 
 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}
+\membersection{wxSizerFlags::Left}\label{wxsizerflagsleft}

 
 

-Obtains the number of pixels assigned to this wxSizerFlags border.
+\func{wxSizerFlags\& }{Left}{\void}

 
 

+Aligns the object to the left, shortcut for \texttt{Align(wxALIGN\_LEFT)}

 
 

-\membersection{wxSizer::GetFlags}\label{wxsizerflagsgetflags}
-
-\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}