no changes, just come cleanup and more comments

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

diff --git a/docs/latex/wx/sizer.tex b/docs/latex/wx/sizer.tex
index 5d2816d0307fa76d55e30aeca40c1df287c64258..8800335c251224b46695a4d9fc2050b23bd951ee 100644 (file)
--- a/docs/latex/wx/sizer.tex
+++ b/docs/latex/wx/sizer.tex
@@ -4,8 +4,10 @@ wxSizer is the abstract base class used for laying out subwindows in a window. Y
 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},
 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{wxGridSizer}{wxgridsizer} 
-\helpref{wxFlexGridSizer}{wxflexgridsizer} and \helpref{wxGridBagSizer}{wxgridbagsizer}.
+\helpref{wxGridSizer}{wxgridsizer},
+\helpref{wxFlexGridSizer}{wxflexgridsizer},
+\helpref{wxWrapSizer}{wxwrapsizer}
+ and \helpref{wxGridBagSizer}{wxgridbagsizer}.

 
 The layout algorithm used by sizers in wxWidgets is closely related to layout
 in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit. It is
 
 The layout algorithm used by sizers in wxWidgets is closely related to layout
 in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit. It is


@@ -43,8 +45,7 @@ capabilities for the various virtual methods.}
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

-\helpref{wxObject}{wxobject}\\
-\helpref{wxClientDataContainer}{wxclientdatacontainer}
+\helpref{wxObject}{wxobject}

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -186,7 +187,7 @@ Adds stretchable space to the sizer. More readable way of calling
 \func{wxSize}{CalcMin}{\void}
 
 This method is abstract and has to be overwritten by any derived class.
 \func{wxSize}{CalcMin}{\void}
 
 This method is abstract and has to be overwritten by any derived class.

-Here, the sizer will do the actual calculation of its children minimal sizes.
+Here, the sizer will do the actual calculation of its children's minimal sizes.

 
 
 \membersection{wxSizer::Clear}\label{wxsizerclear}
 
 
 \membersection{wxSizer::Clear}\label{wxsizerclear}


@@ -221,13 +222,11 @@ Returns true if the child item was found and detached, false otherwise.
 
 \func{wxSize}{Fit}{\param{wxWindow* }{window}}
 
 
 \func{wxSize}{Fit}{\param{wxWindow* }{window}}
 

-Tell the sizer to resize the \arg{window} to match the sizer's minimal size. This
-is commonly done in the constructor of the window itself, see sample in the description
+Tell the sizer to resize the \arg{window} so that its client area matchesthe 
+sizer's minimal size. This is commonly done in the constructor of the window
+itself, see sample in the description

 of \helpref{wxBoxSizer}{wxboxsizer}. Returns the new size.
 
 of \helpref{wxBoxSizer}{wxboxsizer}. Returns the new size.
 

-For a top level window this is the total window size, not client size.
-
-

 \membersection{wxSizer::FitInside}\label{wxsizerfitinside}
 
 \func{void}{FitInside}{\param{wxWindow* }{window}}
 \membersection{wxSizer::FitInside}\label{wxsizerfitinside}
 
 \func{void}{FitInside}{\param{wxWindow* }{window}}


@@ -275,6 +274,18 @@ Use parameter \arg{recursive} to search in subsizers too.
 
 Returns pointer to item or NULL.
 
 
 Returns pointer to item or NULL.
 

+\membersection{wxSizer::GetItemById}\label{wxsizergetitembyid}
+
+\func{wxSizerItem *}{GetItemById}{\param{int }{id}, \param{bool }{recursive = false}}
+
+Finds item of the sizer which has the given \arg{id}.  This \arg{id} is not the
+window id but the id of the wxSizerItem itself.  This is mainly useful for
+retrieving the sizers created from XRC resources. 
+
+Use parameter \arg{recursive} to search in subsizers too.
+
+Returns pointer to item or \NULL.
+

 
 \membersection{wxSizer::GetSize}\label{wxsizergetsize}
 
 
 \membersection{wxSizer::GetSize}\label{wxsizergetsize}
 


@@ -514,10 +525,12 @@ passed to it. This only makes sense when {\it window} is actually a
 wxDialog, since SetSizeHints only has any effect in these classes. 
 It does nothing in normal windows or controls.
 
 wxDialog, since SetSizeHints only has any effect in these classes. 
 It does nothing in normal windows or controls.
 

-This method is commonly invoked in the constructor of a toplevel window itself
-(see the sample in the description of \helpref{wxBoxSizer}{wxboxsizer}) if the
+This method is implicitly used by \helpref{wxWindow::SetSizerAndFit}{wxwindowsetsizerandfit} 
+which is commonly invoked in the constructor of a toplevel window itself (see
+the sample in the description of \helpref{wxBoxSizer}{wxboxsizer}) if the

 toplevel window is resizable.
 
 toplevel window is resizable.
 

+

 \membersection{wxSizer::SetVirtualSizeHints}\label{wxsizersetvirtualsizehints}
 
 \func{void}{SetVirtualSizeHints}{\param{wxWindow* }{window}}
 \membersection{wxSizer::SetVirtualSizeHints}\label{wxsizersetvirtualsizehints}
 
 \func{void}{SetVirtualSizeHints}{\param{wxWindow* }{window}}


@@ -561,7 +574,7 @@ allows you to specify all parameters using the named methods instead. For
 example, instead of
 
 \begin{verbatim}
 example, instead of
 
 \begin{verbatim}

-    sizer->Add(ctrl, 0, wxEXPAND | wxBORDER, 10);
+    sizer->Add(ctrl, 0, wxEXPAND | wxALL, 10);

 \end{verbatim}
 
 you can now write
 \end{verbatim}
 
 you can now write