From 809d2918ccd01ac029ff3d0bc3a143c140832862 Mon Sep 17 00:00:00 2001 From: Blake-Madden <66873089+Blake-Madden@users.noreply.github.com> Date: Sun, 26 Feb 2023 16:32:14 -0500 Subject: [PATCH] Document wxSplitterWindow::SetSashPosition() argument better Explain the special meaning of 0 and negative values in this function. Closes #23299. --- interface/wx/splitter.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/interface/wx/splitter.h b/interface/wx/splitter.h index 3c4bfac29e..4ff835b2ee 100644 --- a/interface/wx/splitter.h +++ b/interface/wx/splitter.h @@ -352,7 +352,10 @@ public: Sets the sash position. @param position - The sash position in pixels. + The sash position in pixels.\n + Note that a position of @c 0 will set the sash to the middle of the window.\n + A negative value will "wrap around" the sash's position. For example, @c -10 + will place the sash at @c 10 units from right of the splitter window. @param redraw If @true, resizes the panes and redraws the sash and border.