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 81ed5dd73cbb1aff249dfd4491250a33568ff945..c588beb1eba792eef4b4d5ac0481088f5f3e278f 100644 (file)
--- a/docs/latex/wx/sizer.tex
+++ b/docs/latex/wx/sizer.tex
@@ -1,15 +1,15 @@
 \section{\class{wxSizer}}\label{wxsizer}
 
 \section{\class{wxSizer}}\label{wxsizer}
 

-wxSizer is the abstract base class used for layouting subwindows in a window. You
+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}
 or \helpref{wxStaticBoxSizer}{wxstaticboxsizer}.
 
 cannot use wxSizer directly; instead, you'll have to use \helpref{wxBoxSizer}{wxboxsizer}
 or \helpref{wxStaticBoxSizer}{wxstaticboxsizer}.
 

-The layouting algorithm used by sizers in wxWindows closely related to layouting
+The layout algorithm used by sizers in wxWindows closely related to layout

 in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit. It is
 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
 in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit. It is
 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
 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,13 +21,16 @@ 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.
 
 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}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-

 \membersection{wxSizer::wxSizer}\label{wxsizerwxsizer}
 
 \func{}{wxSizer}{\void}
 \membersection{wxSizer::wxSizer}\label{wxsizerwxsizer}
 
 \func{}{wxSizer}{\void}


@@ -43,11 +46,11 @@ The destructor.
 
 \membersection{wxSizer::Add}\label{wxsizeradd}
 
 
 \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
 
 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


@@ -56,7 +59,7 @@ of the paramters is described here:
 
 \docparam{window}{The window to be added to the sizer. Its initial size (either set explicitly by the
 user or calculated internally when using wxDefaultSize) is interpreted as the minimal and in many
 
 \docparam{window}{The window to be added to the sizer. Its initial size (either set explicitly by the
 user or calculated internally when using wxDefaultSize) is interpreted as the minimal and in many

-cases also the initial size. This is particularly useful in connection with \helpref{SetSizeHint}{wxsizersetsizehints}. }
+cases also the initial size. This is particularly useful in connection with \helpref{SetSizeHint}{wxsizersetsizehints}.}

 
 \docparam{sizer}{The (child-)sizer to be added to the sizer. This allows placing a child sizer in a
 sizer and thus to create hierarchies of sizers (typically a vertical box as the top sizer and several
 
 \docparam{sizer}{The (child-)sizer to be added to the sizer. This allows placing a child sizer in a
 sizer and thus to create hierarchies of sizers (typically a vertical box as the top sizer and several


@@ -69,13 +72,38 @@ using the {\it option} flag and the result will be that the left button will be
 side of the dialog and the right button with the right side - the space in between will shrink and grow with
 the dialog.}
 
 side of the dialog and the right button with the right side - the space in between will shrink and grow with
 the dialog.}
 

+\docparam{option}{Although the meaning of this parameter is undefined in wxSizer, it is used in wxBoxSizer
+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
+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
+the binary OR operator |. Two main behaviours are defined using these flags: One is the border
+around a window: the {\it border} parameter determines the border width whereas the flags given here
+determine where the border may be (wxTOP, wxBOTTOM, wxLEFT, wxRIGHT or wxALL). The other flags
+determine the child window's behaviour if the size of the sizer changes, but - in contrast to
+the {\it option} flag - not in the main orientation, but the respectively other orientation. So
+if you created a wxBoxSizer with the wxVERTICAL option, these flags will be relevant if the
+sizer changes its horizontal size. A child may get resized to completely fill out the new size (using
+either wxGROW or wxEXPAND), may get centered (wxCENTER or wxCENTRE) or may get aligned to either
+side (wxALIGN\_LEFT and wxALIGN\_TOP are set to 0 and thus represent the default, wxALIGN\_RIGHT and
+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}
 
 \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.
 
 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.


@@ -90,7 +118,7 @@ list of items (windows, subsizers or spaces) owned by this sizer.
 
 Removes a child from the sizer. {\it window} is the window to be removed, {\it sizer} the
 equivalent sizer and {\it nth} is the position of the child in the sizer, typically 0 for
 
 Removes a child from the sizer. {\it window} is the window to be removed, {\it sizer} the
 equivalent sizer and {\it nth} is the position of the child in the sizer, typically 0 for

-the first item. This method does not cause any layouting or resizing to take place and does
+the first item. This method does not cause any layout or resizing to take place and does

 not delete the window itself. Call \helpref{wxSizer::Layout}{wxsizerlayout} for updating
 the layout "on screen" after removing a child fom the sizer.
 
 not delete the window itself. Call \helpref{wxSizer::Layout}{wxsizerlayout} for updating
 the layout "on screen" after removing a child fom the sizer.
 


@@ -157,7 +185,8 @@ of \helpref{wxBoxSizer}{wxboxsizer}.
 
 \func{void}{SetSizeHints}{\param{wxWindow* }{window}}
 
 
 \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).
 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).

+