better integration of the window sizing overview in the wx docs; revised it removing python-like syntaxes; misc fixes to the wording

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

docs/doxygen/overviews/windowsizing.h

@@ -8,91 +8,85 @@
 
 /**
 
-@page overview_windowsizing Window Sizes
+@page overview_windowsizing Window Sizing Overview
 
 It can sometimes be confusing to keep track of the various size-related
 attributes of a wxWindow, how they relate to each other, and how they interact
 with sizers. This document will attempt to clear the fog a little, and give
 some simple explanations of things.
 
-@b BestSize: The best size of a widget depends on what kind of widget it is,
+Glossary:
+
+@li @b "Best Size": the best size of a widget depends on what kind of widget it is,
     and usually also on the contents of the widget. For example a wxListBox's best
     size will be calculated based on how many items it has, up to a certain limit,
     or a wxButton's best size will be calculated based on its label size, but
     normally won't be smaller than the platform default button size (unless a style
-flag overrides that). Get the picture? There is a special virtual method in the
+    flag overrides that).
-C++ window classes called @c DoGetBestSize() that a class needs to override if
+    There is a special virtual method in the C++ window classes called
-it wants to calculate its own best size based on its content. The default
+    wxWindow::DoGetBestSize() that a class needs to override if it wants to calculate
-@c DoGetBestSize() is designed for use in container windows, such as wxPanel,
+    its own best size based on its content.
-and works something like this:
 
--# If the window has a sizer then it is used to calculate the best size.
+@li @b "Min Size": the minimal size of a widget is a size that is normally explicitly set
--# Otherwise if the window has layout constraints then that is used to
+    by the programmer either with the wxWindow::SetMinSize() method or with the
-   calculate the best size.
+    wxWindow::SetSizeHints() method.
--# Otherwise if the window has children then the best size is set to be large
+    Most controls will also set the min size to the size given in the control's
-   enough to show all the children.
+    constructor if a non-default value is passed.
--# Otherwise if there are no children then the window's min size will be used
+    Top-level windows such as wxFrame will not allow the user to resize the frame below
-   for the best size.
+    the minimal size.
--# Otherwise if there is no min size set, then the current size is used for the
-   best size.
 
-@b MinSize: The min size of a widget is a size that is normally explicitly set
+@li @b "Size": the size of a widget can be explicitly set or fetched with the
-by the programmer either with the @c SetMinSize() method or the
+    wxWindow::SetSize() or wxWindow::GetSize() methods.
-@c SetSizeHints() method. Most controls will also set the min size to the size
+    This size value is the size that the widget is currently using on screen and is
-given in the control's constructor if a non-default value is passed. Top-level
+    the way to change the size of something that is not being managed by a sizer.
-windows such as wxFrame will not allow the user to resize the frame below the
-min size.
 
-@b Size: The size of a widget can be explicitly set or fetched with the
+@li @b "Client Size": the client size represents the widget's area inside of any
-@c SetSize() or @c GetSize() methods. This size value is the size that the
-widget is currently using on screen and is the way to change the size of
-something that is not being managed by a sizer.
-
-@b ClientSize: The client size represents the widget's area inside of any
     borders belonging to the widget and is the area that can be drawn upon in a
     @c EVT_PAINT event. If a widget doesn't have a border then its client size is
     the same as its size.
 
-@b InitialSize: The initial size of a widget is the size given to the
+@li @b "Initial Size": the initial size of a widget is the size given to the
-constructor of the widget, if any.  As mentioned above most controls will also
+    constructor of the widget, if any.
-set this size value as the control's min size. If the size passed to the
+    As mentioned above most controls will also set this size value as the control's
-constructor is the default @c wxDefaultSize, or if the size is not fully
+    minimal size. If the size passed to the constructor is the default ::wxDefaultSize,
-specified (such as wxSize(150,-1)) then most controls will fill in the missing
+    or if the size is not fully specified (such as wxSize(150,-1)) then most controls
-size components using the best size and will set the initial size of the
+    will fill in the missing size components using the best size and will set the
-control to the resulting size.
+    initial size of the control to the resulting size.
 
-@b GetEffectiveMinSize(): (formerly @c GetBestFittingSize) A blending of the
+
-widget's min size and best size, giving precedence to the min size. For
+Functions related to sizing:
-example, if a widget's min size is set to (150, -1) and the best size is
+
+@li wxWindow::GetEffectiveMinSize(): returns a blending of the widget's minimal size
+    and best size, giving precedence to the minimal size.
+    For example, if a widget's min size is set to (150, -1) and the best size is
     (80, 22) then the best fitting size is (150, 22). If the min size is (50, 20)
     then the best fitting size is (50, 20). This method is what is called by the
-sizers when determining what the requirements of each item in the sizer is, and
+    sizers when determining what the requirements of each item in the sizer is,
-is used for calculating the overall minimum needs of the sizer.
+    and is used for calculating the overall minimum needs of the sizer.
 
-@b SetInitialSize(size): (formerly @c SetBestFittingSize) This is a little
+@li wxWindow::SetInitialSize(): this is a little different than the typical size
-different than the typical size setters. Rather than just setting an
+    setters. Rather than just setting an "initial size" attribute it actually sets
-"initial size" attribute it actually sets the minsize to the value passed in,
+    the minimal size to the value passed in, blends that value with the best size,
-blends that value with the best size, and then sets the size of the widget to
+    and then sets the size of the widget to be the result.
-be the result. So you can consider this method to be a "Smart SetSize". This
+    So you can consider this method to be a "Smart SetSize". This method is what is
-method is what is called by the constructor of most controls to set the minsize
+    called by the constructor of most controls to set the minimal size and the initial
-and initial size of the control.
+    size of the control.
 
-@b window.Fit(): The @c Fit() method sets the size of a window to fit around
+@li wxWindow::Fit(): this method sets the size of a window to fit around its children.
-its children. If it has no children then nothing is done, if it does have
+    If it has no children then nothing is done, if it does have children then the size
-children then the size of the window is set to the window's best size.
+    of the window is set to the window's best size.
 
-@b sizer.Fit(window): This sets the size of the window to be large enough to
+@li wxSizer::Fit(): this sets the size of the window to be large enough to
     accommodate the minimum size needed by the sizer, (along with a few other
-constraints...) If the sizer is the one that is assigned to the window then
+    constraints...). If the sizer is the one that is assigned to the window then
-this should be equivalent to @c window.Fit().
+    this should be equivalent to wxWindow::Fit().
 
-@b sizer.Layout(): Recalculates the minimum space needed by each item in the
+@li wxSizer::Layout(): recalculates the minimum space needed by each item in the
-sizer, and then lays out the items within the space currently allotted to the
+    sizer, and then lays out the items within the space currently allotted to the sizer.
-sizer.
 
-@b window.Layout(): If the window has a sizer then it sets the space given to
+@li wxWindow::Layout(): if the window has a sizer then it sets the space given to
     the sizer to the current size of the window, which results in a call to
-@c sizer.Layout(). If the window has layout constraints instead of a sizer then
+    wxSizer::Layout(). If the window has layout constraints instead of a sizer then
     the constraints algorithm is run. The @c Layout() method is what is called by
     the default @c EVT_SIZE handler for container windows.
 

interface/window.h

@@ -445,6 +445,20 @@ public:
         Gets the size which best suits the window: for a control, it would be
         the minimal size which doesn't truncate the control, for a panel - the
         same size as it would have after a call to Fit().
+
+        The default implementation of this function is designed for use in container
+        windows, such as wxPanel, and works something like this:
+        -# If the window has a sizer then it is used to calculate the best size.
+        -# Otherwise if the window has layout constraints then those are used to
+           calculate the best size.
+        -# Otherwise if the window has children then the best size is set to be large
+           enough to show all the children.
+        -# Otherwise if there are no children then the window's minimal size will be
+           used as its best size.
+        -# Otherwise if there is no minimal size set, then the current size is used
+           for the best size.
+
+        @see @ref overview_windowsizing
     */
     virtual wxSize DoGetBestSize() const;
 
@@ -544,13 +558,22 @@ public:
                                       wxWindow* parent = NULL);
 
     /**
-        Sizes the window so that it fits around its subwindows. This function won't do
+        Sizes the window so that it fits around its subwindows.
-        anything if there are no subwindows and will only really work correctly if
-        sizers are used for the subwindows layout. Also, if the window has exactly one
-        subwindow it is better (faster and the result is more precise as Fit adds some
-        margin to account for fuzziness of its calculations) to call
 
-        instead of calling Fit.
+        This function won't do anything if there are no subwindows and will only really
+        work correctly if sizers are used for the subwindows layout.
+
+        Also, if the window has exactly one subwindow it is better (faster and the result
+        is more precise as Fit() adds some margin to account for fuzziness of its calculations)
+        to call:
+
+        @begincode
+            window->SetClientSize(child->GetSize());
+        @endcode
+
+        instead of calling Fit().
+
+        @see @ref overview_windowsizing
     */
     virtual void Fit();
 
@@ -596,8 +619,7 @@ public:
     wxAccessible* GetAccessible();
 
     /**
-        This method is deprecated, use GetEffectiveMinSize()
+        This method is deprecated, use GetEffectiveMinSize() instead.
-        instead.
     */
     wxSize GetAdjustedBestSize() const;
 
@@ -771,11 +793,11 @@ public:
     wxDropTarget* GetDropTarget() const;
 
     /**
-        Merges the window's best size into the min size and returns the
+        Merges the window's best size into the min size and returns the result.
-        result.  This is the value used by sizers to determine the appropriate
+        This is the value used by sizers to determine the appropriate
         ammount of space to allocate for the widget.
 
-        @see GetBestSize(), SetInitialSize()
+        @see GetBestSize(), SetInitialSize(), @ref overview_windowsizing
     */
     wxSize GetEffectiveMinSize() const;
 
@@ -1375,9 +1397,11 @@ public:
     /**
         Invokes the constraint-based layout algorithm or the sizer-based algorithm
         for this window.
-        See SetAutoLayout(): when auto
+
-        layout is on, this function gets called automatically when the window is
+        See SetAutoLayout(): when auto layout is on, this function gets called automatically
-        resized.
+        when the window is resized.
+
+        @see @ref overview_windowsizing
     */
     void Layout();
 
@@ -2055,15 +2079,18 @@ public:
 
     /**
         A @e smart SetSize that will fill in default size components with the
-        window's @e best size values.  Also sets the window's minsize to
+        window's @e best size values.
-        the value passed in for use with sizers.  This means that if a full or
+
-        partial size is passed to this function then the sizers will use that
+        Also sets the window's minsize to the value passed in for use with sizers.
-        size instead of the results of GetBestSize to determine the minimum
+        This means that if a full or partial size is passed to this function then
-        needs of the window for layout.
+        the sizers will use that size instead of the results of GetBestSize() to
+        determine the minimum needs of the window for layout.
+
         Most controls will use this to set their initial size, and their min
         size to the passed in value (if any.)
 
-        @see SetSize(), GetBestSize(), GetEffectiveMinSize()
+        @see SetSize(), GetBestSize(), GetEffectiveMinSize(),
+             @ref overview_windowsizing
     */
     void SetInitialSize(const wxSize& size = wxDefaultSize);