ugh. Nesting the (per class) plugin sentries can require them to

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

diff --git a/docs/latex/wx/layalgor.tex b/docs/latex/wx/layalgor.tex
index bd5846854cc6765c1f130b96ab5acb3be669763c..76a36feb10fbbff32aed2a1ac59bd783874c1832 100644 (file)
--- a/docs/latex/wx/layalgor.tex
+++ b/docs/latex/wx/layalgor.tex
@@ -40,7 +40,7 @@ bottom of the remaining client area. This scheme implies that order of window cr
 Say you wish to have an extra toolbar at the top of the frame, a project window to the left of
 the MDI client window, and an output window above the status bar. You should therefore create
 the windows in this order: toolbar, output window, project window. This ensures that the toolbar and
-output window take up space at the top and bottom, then the remaining height in between is used for
+output window take up space at the top and bottom, and then the remaining height inbetween is used for
 the project window.
 
 wxLayoutAlgorithm is quite independent of the way in which
@@ -58,6 +58,10 @@ way of specifying layouts for which the normal constraint system is unsuitable.
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/laywin.h>
+
 \wxheading{Event handling}
 
 The algorithm object does not respond to events, but itself generates the
@@ -114,6 +118,14 @@ Default constructor.
 
 Destructor.
 
+\membersection{wxLayoutAlgorithm::LayoutFrame}\label{wxlayoutalgorithmlayoutframe}
+
+\constfunc{bool}{LayoutFrame}{\param{wxFrame* }{frame}, \param{wxWindow*}{ mainWindow = NULL}}
+
+Lays out the children of a normal frame. {\it mainWindow} is set to occupy the remaining space.
+
+This function simply calls \helpref{wxLayoutAlgorithm::LayoutWindow}{wxlayoutalgorithmlayoutwindow}.
+
 \membersection{wxLayoutAlgorithm::LayoutMDIFrame}\label{wxlayoutalgorithmlayoutmdiframe}
 
 \constfunc{bool}{LayoutMDIFrame}{\param{wxMDIParentFrame* }{frame}, \param{wxRect*}{ rect = NULL}}
@@ -123,11 +135,14 @@ given rectangle will be used as a starting point instead of the frame's client a
 
 The MDI client window is set to occupy the remaining space.
 
-\membersection{wxLayoutAlgorithm::LayoutFrame}\label{wxlayoutalgorithmlayoutframe}
+\membersection{wxLayoutAlgorithm::LayoutWindow}\label{wxlayoutalgorithmlayoutwindow}
 
-\constfunc{bool}{LayoutFrame}{\param{wxFrame* }{frame}, \param{wxWindow*}{ mainWindow}}
+\constfunc{bool}{LayoutWindow}{\param{wxWindow* }{parent}, \param{wxWindow*}{ mainWindow = NULL}}
 
-Lays out the children of a normal frame.
+Lays out the children of a normal frame or other window.
 
-{\it mainWindow} is set to occupy the remaining space.
+{\it mainWindow} is set to occupy the remaining space. If this is not specified, then
+the last window that responds to a calculate layout event in query mode will get the remaining space
+(that is, a non-query OnCalculateLayout event will not be sent to this window and the window will be set
+to the remaining size).