updates for wxPython docs

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

diff --git a/docs/latex/wx/sizer.tex b/docs/latex/wx/sizer.tex
index e0cc3faa329b1ec17d25940d0332044881dfa848..c588beb1eba792eef4b4d5ac0481088f5f3e278f 100644 (file)
--- a/docs/latex/wx/sizer.tex
+++ b/docs/latex/wx/sizer.tex
@@ -1,7 +1,7 @@
 \section{\class{wxSizer}}\label{wxsizer}
 
 wxSizer is the abstract base class used for laying out subwindows in a window. You
-cannot use wxSizer directly; instead, you'll have to use \helpref{wxBoxSizer}{wxboxsizer} 
+cannot use wxSizer directly; instead, you'll have to use \helpref{wxBoxSizer}{wxboxsizer}
 or \helpref{wxStaticBoxSizer}{wxstaticboxsizer}.
 
 The layout algorithm used by sizers in wxWindows closely related to layout
@@ -9,7 +9,7 @@ in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit. It
 based upon the idea of the individual subwindows reporting their minimal required
 size and their ability to get stretched if the size of the parent window has changed.
 This will most often mean, that the programmer does not set the original size of
-the dialog in the beginning, rather the top-most sizer will get queried and it will 
+the dialog in the beginning, rather the top-most sizer will get queried and it will
 then query its children. Its children can be normal windows or other sizers, so that
 a hierachy of sizer can be constructed. Note that sizer are not derived from wxWindows
 and thus do not interfere with tab ordering and require very little resources compared
@@ -21,6 +21,10 @@ 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 intial dialog size will automatically be bigger on Motif than on Windows.
 
+\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.}
+
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
@@ -42,11 +46,11 @@ The destructor.
 
 \membersection{wxSizer::Add}\label{wxsizeradd}
 
-\func{void}{Add}{\param{wxWindow* }{window}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
+\func{void}{Add}{\param{wxWindow* }{window}, \param{int }{option = 0},\param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
-\func{void}{Add}{\param{wxSizer* }{sizer}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
+\func{void}{Add}{\param{wxSizer* }{sizer}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
-\func{void}{Add}{\param{int }{width}, \param{int }{height}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
+\func{void}{Add}{\param{int }{width}, \param{int }{height}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
 Adds the {\it window} to the sizer. As wxSizer itself is an abstract class, the parameters
 have no meaning in the wxSizer class itself, but as there currently is only one class
@@ -72,7 +76,7 @@ the dialog.}
 to indicate if a child of a sizer can change its size in the main orientation of the wxBoxSizer - where
 0 stands for not changable and a value of more than zero in interpreted relative to the value of other
 children of the same wxBoxSizer. You might, e.g., have a horizontal wxBoxSizer with three children, two
-of which are supposed to change their size with the sizer, then the two stretchable windows would get a 
+of which are supposed to change their size with the sizer, then the two stretchable windows would get a
 value of 1 each to make them grow and shrink equally with the sizer's vertical dimension.}
 
 \docparam{flag}{This parameter can be used to set a number of flags which can be combined using
@@ -89,13 +93,17 @@ wxALIGN\_BOTTOM have their obvious meaning.}
 
 \docparam{border}{Determines the border width, if the {\it flag} parameter is set to any border.}
 
+\docparam{userData}{Allows an extra object to be attached to the sizer
+item, for use in derived classes when sizing information is more
+complex than what {\it option} and {\it flag} will allow for.}
+
 \membersection{wxSizer::Prepend}\label{wxsizerprepend}
 
-\func{void}{Prepend}{\param{wxWindow* }{window}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
+\func{void}{Prepend}{\param{wxWindow* }{window}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
-\func{void}{Prepend}{\param{wxSizer* }{sizer}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
+\func{void}{Prepend}{\param{wxSizer* }{sizer}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
-\func{void}{Prepend}{\param{int }{width}, \param{int }{height}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
+\func{void}{Prepend}{\param{int }{width}, \param{int }{height}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border= 0}, \param{wxObject* }{userData = NULL}}
 
 Same as \helpref{wxSizer::Add}{wxsizeradd}, but prepends the items to the beginning of the
 list of items (windows, subsizers or spaces) owned by this sizer.
@@ -177,7 +185,7 @@ of \helpref{wxBoxSizer}{wxboxsizer}.
 
 \func{void}{SetSizeHints}{\param{wxWindow* }{window}}
 
-Tell the sizer to set the minimal size of the {\it window} to match the sizer's minimal size. 
+Tell the sizer to set the minimal size of the {\it window} to match the sizer's minimal size.
 This is commonly done in the constructor of the window itself, see sample in the description
 of \helpref{wxBoxSizer}{wxboxsizer} if the window is resizable (as many dialogs under Unix and
 frames on probably all platforms).