make it clear that the size returned by Fit() is window, not client, size

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@25655 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/sizer.tex b/docs/latex/wx/sizer.tex
index 74951d8f52cb92f513a5951e573b8d84e8af9f7d..b28edf74e548d50a574698e9effbfab7513672ef 100644 (file)
--- a/docs/latex/wx/sizer.tex
+++ b/docs/latex/wx/sizer.tex
@@ -39,6 +39,7 @@ capabilities for the various virtual methods.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

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


@@ -46,12 +47,14 @@ capabilities for the various virtual methods.}
 The constructor. Note that wxSizer is an abstract base class and may not
 be instantiated.
 
 The constructor. Note that wxSizer is an abstract base class and may not
 be instantiated.
 

+

 \membersection{wxSizer::\destruct{wxSizer}}\label{wxsizerdtor}
 
 \func{}{\destruct{wxSizer}}{\void}
 
 The destructor.
 
 \membersection{wxSizer::\destruct{wxSizer}}\label{wxsizerdtor}
 
 \func{}{\destruct{wxSizer}}{\void}
 
 The destructor.
 

+

 \membersection{wxSizer::Add}\label{wxsizeradd}
 
 \func{void}{Add}{\param{wxWindow* }{window}, \param{int }{proportion = 0},\param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 \membersection{wxSizer::Add}\label{wxsizeradd}
 
 \func{void}{Add}{\param{wxWindow* }{window}, \param{int }{proportion = 0},\param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}


@@ -115,6 +118,7 @@ control even if its text is changed during run-time.}
 item, for use in derived classes when sizing information is more
 complex than the {\it proportion} and {\it flag} will allow for.}
 
 item, for use in derived classes when sizing information is more
 complex than the {\it proportion} and {\it flag} will allow for.}
 

+

 \membersection{wxSizer::CalcMin}\label{wxsizercalcmin}
 
 \func{wxSize}{CalcMin}{\void}
 \membersection{wxSizer::CalcMin}\label{wxsizercalcmin}
 
 \func{wxSize}{CalcMin}{\void}


@@ -122,6 +126,7 @@ complex than the {\it proportion} and {\it flag} will allow for.}
 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.
 
 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.
 

+

 \membersection{wxSizer::Detach}\label{wxsizerdetach}
 
 \func{bool}{Detach}{\param{wxWindow* }{window}}
 \membersection{wxSizer::Detach}\label{wxsizerdetach}
 
 \func{bool}{Detach}{\param{wxWindow* }{window}}


@@ -142,6 +147,7 @@ Returns true if the child item was found and detached, false otherwise.
 
 \helpref{wxSizer::Remove}{wxsizerremove}
 
 
 \helpref{wxSizer::Remove}{wxsizerremove}
 

+

 \membersection{wxSizer::Fit}\label{wxsizerfit}
 
 \func{wxSize}{Fit}{\param{wxWindow* }{window}}
 \membersection{wxSizer::Fit}\label{wxsizerfit}
 
 \func{wxSize}{Fit}{\param{wxWindow* }{window}}


@@ -150,6 +156,9 @@ Tell the sizer to resize the {\it window} to match the sizer's minimal size. Thi
 is commonly done in the constructor of the window itself, see sample in the description
 of \helpref{wxBoxSizer}{wxboxsizer}. Returns the new size.
 
 is commonly done in the constructor of the window itself, see sample in the description
 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}}


@@ -164,18 +173,21 @@ windows which manage it.
 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars},\rtfsp
 \helpref{wxSizer::SetVirtualSizeHints}{wxsizersetvirtualsizehints}
 
 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars},\rtfsp
 \helpref{wxSizer::SetVirtualSizeHints}{wxsizersetvirtualsizehints}
 

+

 \membersection{wxSizer::GetSize}\label{wxsizergetsize}
 
 \func{wxSize}{GetSize}{\void}
 
 Returns the current size of the sizer.
 
 \membersection{wxSizer::GetSize}\label{wxsizergetsize}
 
 \func{wxSize}{GetSize}{\void}
 
 Returns the current size of the sizer.
 

+

 \membersection{wxSizer::GetPosition}\label{wxsizergetposition}
 
 \func{wxPoint}{GetPosition}{\void}
 
 Returns the current position of the sizer.
 
 \membersection{wxSizer::GetPosition}\label{wxsizergetposition}
 
 \func{wxPoint}{GetPosition}{\void}
 
 Returns the current position of the sizer.
 

+

 \membersection{wxSizer::GetMinSize}\label{wxsizergetminsize}
 
 \func{wxSize}{GetMinSize}{\void}
 \membersection{wxSizer::GetMinSize}\label{wxsizergetminsize}
 
 \func{wxSize}{GetMinSize}{\void}


@@ -184,6 +196,7 @@ Returns the minimal size of the sizer. This is either the combined minimal
 size of all the children and their borders or the minimal size set by 
 \helpref{SetMinSize}{wxsizersetminsize}, depending on which is bigger.
 
 size of all the children and their borders or the minimal size set by 
 \helpref{SetMinSize}{wxsizersetminsize}, depending on which is bigger.
 

+

 \membersection{wxSizer::Insert}\label{wxsizerinsert}
 
 \func{void}{Insert}{\param{size\_t }{index}, \param{wxWindow* }{window}, \param{int }{proportion = 0},\param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 \membersection{wxSizer::Insert}\label{wxsizerinsert}
 
 \func{void}{Insert}{\param{size\_t }{index}, \param{wxWindow* }{window}, \param{int }{proportion = 0},\param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}


@@ -198,6 +211,7 @@ Insert a child into the sizer before any existing item at {\it index}.
 
 See \helpref{wxSizer::Add}{wxsizeradd} for the meaning of the other parameters.
 
 
 See \helpref{wxSizer::Add}{wxsizeradd} for the meaning of the other parameters.
 

+

 \membersection{wxSizer::Layout}\label{wxsizerlayout}
 
 \func{void}{Layout}{\void}
 \membersection{wxSizer::Layout}\label{wxsizerlayout}
 
 \func{void}{Layout}{\void}


@@ -206,6 +220,7 @@ Call this to force layout of the children anew, e.g. after having added a child
 to or removed a child (window, other sizer or space) from the sizer while keeping
 the current dimension.
 
 to or removed a child (window, other sizer or space) from the sizer while keeping
 the current dimension.
 

+

 \membersection{wxSizer::Prepend}\label{wxsizerprepend}
 
 \func{void}{Prepend}{\param{wxWindow* }{window}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 \membersection{wxSizer::Prepend}\label{wxsizerprepend}
 
 \func{void}{Prepend}{\param{wxWindow* }{window}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}


@@ -217,6 +232,7 @@ the current dimension.
 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.
 

+

 \membersection{wxSizer::RecalcSizes}\label{wxsizerrecalcsizes}
 
 \func{void}{RecalcSizes}{\void}
 \membersection{wxSizer::RecalcSizes}\label{wxsizerrecalcsizes}
 
 \func{void}{RecalcSizes}{\void}


@@ -225,6 +241,7 @@ This method is abstract and has to be overwritten by any derived class.
 Here, the sizer will do the actual calculation of its children's positions
 and sizes.
 
 Here, the sizer will do the actual calculation of its children's positions
 and sizes.
 

+

 \membersection{wxSizer::Remove}\label{wxsizerremove}
 
 \func{bool}{Remove}{\param{wxWindow* }{window}}
 \membersection{wxSizer::Remove}\label{wxsizerremove}
 
 \func{bool}{Remove}{\param{wxWindow* }{window}}


@@ -246,6 +263,7 @@ method that will both detach and destroy a wxWindow item.
 
 Returns true if the child item was found and removed, false otherwise.
 
 
 Returns true if the child item was found and removed, false otherwise.
 

+

 \membersection{wxSizer::SetDimension}\label{wxsizersetdimension}
 
 \func{void}{SetDimension}{\param{int }{x}, \param{int }{y}, \param{int }{width}, \param{int }{height}}
 \membersection{wxSizer::SetDimension}\label{wxsizersetdimension}
 
 \func{void}{SetDimension}{\param{int }{x}, \param{int }{y}, \param{int }{width}, \param{int }{height}}


@@ -254,6 +272,7 @@ Call this to force the sizer to take the given dimension and thus force the item
 by the sizer to resize themselves according to the rules defined by the parameter in the 
 \helpref{Add}{wxsizeradd} and \helpref{Prepend}{wxsizerprepend} methods.
 
 by the sizer to resize themselves according to the rules defined by the parameter in the 
 \helpref{Add}{wxsizeradd} and \helpref{Prepend}{wxsizerprepend} methods.
 

+

 \membersection{wxSizer::SetMinSize}\label{wxsizersetminsize}
 
 \func{void}{SetMinSize}{\param{int }{width}, \param{int }{height}}
 \membersection{wxSizer::SetMinSize}\label{wxsizersetminsize}
 
 \func{void}{SetMinSize}{\param{int }{width}, \param{int }{height}}


@@ -266,6 +285,7 @@ method \helpref{GetMinSize}{wxsizergetminsize} will return either the minimal si
 as requested by its children or the minimal size set here, depending on which is
 bigger.
 
 as requested by its children or the minimal size set here, depending on which is
 bigger.
 

+

 \membersection{wxSizer::SetItemMinSize}\label{wxsizersetitemminsize}
 
 \func{void}{SetItemMinSize}{\param{wxWindow* }{window}, \param{int}{ width}, \param{int}{ height}}
 \membersection{wxSizer::SetItemMinSize}\label{wxsizersetitemminsize}
 
 \func{void}{SetItemMinSize}{\param{wxWindow* }{window}, \param{int}{ width}, \param{int}{ height}}


@@ -278,6 +298,7 @@ Set an item's minimum size by window, sizer, or position. The item will be found
 in the sizer's descendants. This function enables an application to set the size of an item
 after initial creation.
 
 in the sizer's descendants. This function enables an application to set the size of an item
 after initial creation.
 

+

 \membersection{wxSizer::SetSizeHints}\label{wxsizersetsizehints}
 
 \func{void}{SetSizeHints}{\param{wxWindow* }{window}}
 \membersection{wxSizer::SetSizeHints}\label{wxsizersetsizehints}
 
 \func{void}{SetSizeHints}{\param{wxWindow* }{window}}


@@ -287,6 +308,7 @@ match the sizer's minimal size.  This is commonly done in the constructor of the
 see sample in the description of \helpref{wxBoxSizer}{wxboxsizer} if the window is resizable
 (as are many dialogs under Unix and frames on probably all platforms).
 
 see sample in the description of \helpref{wxBoxSizer}{wxboxsizer} if the window is resizable
 (as are many dialogs under Unix and frames on probably all platforms).
 

+

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


@@ -298,6 +320,7 @@ minimal size. For windows with managed scrollbars this will set them appropriate
 
 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}
 
 
 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}
 

+

 \membersection{wxSizer::Show}\label{wxsizershow}
 
 \func{void}{Show}{\param{wxWindow* }{window}, \param{bool }{show = true}}
 \membersection{wxSizer::Show}\label{wxsizershow}
 
 \func{void}{Show}{\param{wxWindow* }{window}, \param{bool }{show = true}}