Document interaction of wxSplitterWindow gravity with initial size.

Document the somewhat counter intuitive (but difficult to change) behaviour of
the splitter when both sash position and gravity are set.

See #15996.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@75976 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2014-02-22 14:54:31 +00:00
parent b1a92006b9
commit 0415f0ab05

View File

@@ -324,6 +324,15 @@ public:
That value is compatible with previous (before gravity was introduced) That value is compatible with previous (before gravity was introduced)
behaviour of wxSplitterWindow. behaviour of wxSplitterWindow.
Notice that when sash gravity for a newly created splitter window, it
is often necessary to explicitly set the splitter size using SetSize()
to ensure that is big enough for its initial sash position. Otherwise,
i.e. if the window is created with the default tiny size and only
resized to its correct size later, the initial sash position will be
affected by the gravity and typically result in sash being at the
rightmost position for the gravity of 1. See the example code creating
wxSplitterWindow in the splitter sample for more details.
@see GetSashGravity() @see GetSashGravity()
*/ */
void SetSashGravity(double gravity); void SetSashGravity(double gravity);