X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cded6aa1c3fe6e6b83346eacee04dc485aeccd42..a25a17732c2d4d34d5d35a5318053dd8c6e29722:/docs/doxygen/overviews/windowsizing.h
diff --git a/docs/doxygen/overviews/windowsizing.h b/docs/doxygen/overviews/windowsizing.h
index 7c05e6c388..a44107d7f2 100644
--- a/docs/doxygen/overviews/windowsizing.h
+++ b/docs/doxygen/overviews/windowsizing.h
@@ -15,7 +15,14 @@ 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.
-Glossary:
+@li @ref overview_windowsizing_glossary
+@li @ref overview_windowsizing_func
+
+
+
+
+
+@section overview_windowsizing_glossary 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
@@ -27,14 +34,20 @@ Glossary:
wxWindow::DoGetBestSize() that a class needs to override if it wants to calculate
its own best size based on its content.
-@li @b "Min Size": the minimal size of a widget is a size that is normally explicitly set
- by the programmer either with the wxWindow::SetMinSize() method or with the
+@li @b "Minimal Size": the minimal size of a widget is a size that is normally explicitly
+ set by the programmer either with the wxWindow::SetMinSize() method or with the
wxWindow::SetSizeHints() method.
- Most controls will also set the min size to the size given in the control's
+ Most controls will also set the minimal size to the size given in the control's
constructor if a non-default value is passed.
Top-level windows such as wxFrame will not allow the user to resize the frame below
the minimal size.
+@li @b "Maximum Size": just like for the minimal size, the maximum size is normally
+ explicitely set by the programmer with the wxWindow::SetMaxSize() method or
+ with wxWindow::SetSizeHints().
+ Top-level windows such as wxFrame will not allow the user to resize the frame above
+ the maximum size.
+
@li @b "Size": the size of a widget can be explicitly set or fetched with the
wxWindow::SetSize() or wxWindow::GetSize() methods.
This size value is the size that the widget is currently using on screen and is
@@ -53,8 +66,15 @@ Glossary:
will fill in the missing size components using the best size and will set the
initial size of the control to the resulting size.
+@li @b "Virtual Size": the virtual size is the size of the potentially viewable
+ area of the widget.
+ The virtual size of a widget may be larger than its actual size and in this
+ case scrollbars will appear to the let the user 'explore' the full contents
+ of the widget.
+ See wxScrolled for more info.
+
-Functions related to sizing:
+@section overview_windowsizing_func Functions related to sizing
@li wxWindow::GetEffectiveMinSize(): returns a blending of the widget's minimal size
and best size, giving precedence to the minimal size.