added optional parameter to SetSizer, to allow replacing a window's

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

diff --git a/docs/latex/wx/sizer.tex b/docs/latex/wx/sizer.tex
index 7c83d6edc9c7198550c61ad3f2c3f157b2958af4..f39b4aeabc30ee747b12f8927b567725269d62ae 100644 (file)
--- a/docs/latex/wx/sizer.tex
+++ b/docs/latex/wx/sizer.tex
@@ -1,8 +1,11 @@
 \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 will have to use \helpref{wxBoxSizer}{wxboxsizer}, 
-\helpref{wxStaticBoxSizer}{wxstaticboxsizer} or \helpref{wxNotebookSizer}{wxnotebooksizer}.
+cannot use wxSizer directly; instead, you will have to use one of the sizer
+classes derived from it. Currently there are \helpref{wxBoxSizer}{wxboxsizer}, 
+\helpref{wxStaticBoxSizer}{wxstaticboxsizer},
+\helpref{wxNotebookSizer}{wxnotebooksizer}, \helpref{wxGridSizer}{wxgridsizer} 
+and \helpref{wxFlexGridSizer}{wxflexgridsizer}.
 
 The layout algorithm used by sizers in wxWindows is closely related to layout
 in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit. It is
@@ -30,6 +33,10 @@ capabilities for the various virtual methods.}
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{See also}
+
+\helpref{Sizer overview}{sizeroverview}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxSizer::wxSizer}\label{wxsizerwxsizer}
@@ -80,20 +87,28 @@ children of the same wxBoxSizer. For example, you might have a horizontal wxBoxS
 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 horizontal 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. However this is not - in contrast to
-the {\it option} flag - in the main orientation, but in 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), it may get proportionally resized (wxSHAPED), it may get centered (wxALIGN\_CENTER
-or wxALIGN\_CENTRE) or it 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).
-With proportional resize, a child may also be centered in the main orientation using
-wxALIGN\_CENTER\_VERTICAL (same as wxALIGN\_CENTRE\_VERTICAL) and wxALIGN\_CENTER\_HORIZONTAL
-(same as wxALIGN\_CENTRE\_HORIZONTAL) flags.}
+\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.
+However this is not - in contrast to the {\it option} flag - in the main
+orientation, but in 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), it may get proportionally
+resized (wxSHAPED), it may get centered (wxALIGN\_CENTER or wxALIGN\_CENTRE)
+or it 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). With proportional resize, a child may also be centered
+in the main orientation using wxALIGN\_CENTER\_VERTICAL (same as
+wxALIGN\_CENTRE\_VERTICAL) and wxALIGN\_CENTER\_HORIZONTAL (same as
+wxALIGN\_CENTRE\_HORIZONTAL) flags. Finally, you can also specify
+wxADJUST\_MINSIZE flag to make the minimal size of the control dynamically adjust
+to the value returned by its \helpref{GetBestSize()}{wxwindowgetbestsize}
+method - this allows, for example, for correct relayouting of a static text
+control even if its text is changed during run-time.}
 
 \docparam{border}{Determines the border width, if the {\it flag} parameter is set to any border.}