From: Robin Dunn <robin@alldunn.com>
Date: Fri, 14 Jan 2005 01:58:50 +0000 (+0000)
Subject: Document the Show/Hide behaviour that wxSplitterWindow does to its children.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/e384095a6c8445e95e8a2478bb0bde9f7cfd0f76

Document the Show/Hide behaviour that wxSplitterWindow does to its children.


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

diff --git a/docs/latex/wx/splitter.tex b/docs/latex/wx/splitter.tex
index 164877e8a2..70e6a954c2 100644
--- a/docs/latex/wx/splitter.tex
+++ b/docs/latex/wx/splitter.tex
@@ -178,7 +178,8 @@ Returns the right/bottom pane.
 
 \func{void}{Initialize}{\param{wxWindow* }{window}}
 
-Initializes the splitter window to have one pane.
+Initializes the splitter window to have one pane.  The child window is
+shown if it is currently hidden.
 
 \wxheading{Parameters}
 
@@ -376,7 +377,8 @@ Only sets the internal variable; does not update the display.
 \func{bool}{SplitHorizontally}{\param{wxWindow* }{window1}, \param{wxWindow* }{window2},
  \param{int}{ sashPosition = 0}}
 
-Initializes the top and bottom panes of the splitter window.
+Initializes the top and bottom panes of the splitter window.  The
+child windows are shown if they are currently hidden.
 
 \wxheading{Parameters}
 
@@ -409,7 +411,8 @@ window is not currently split using \helpref{IsSplit}{wxsplitterwindowissplit}.
 \func{bool}{SplitVertically}{\param{wxWindow* }{window1}, \param{wxWindow* }{window2},
  \param{int}{ sashPosition = 0}}
 
-Initializes the left and right panes of the splitter window.
+Initializes the left and right panes of the splitter window.  The
+child windows are shown if they are currently hidden.
 
 \wxheading{Parameters}
 
diff --git a/wxPython/src/_splitter.i b/wxPython/src/_splitter.i
index 6ca3487294..3282c4e43e 100644
--- a/wxPython/src/_splitter.i
+++ b/wxPython/src/_splitter.i
@@ -164,7 +164,7 @@ update the display.", "");
         void , Initialize(wxWindow *window),
         "Initializes the splitter window to have one pane.  This should be
 called if you wish to initially view only a single pane in the
-splitter window.", "");
+splitter window.  The child window is shown if it is currently hidden.", "");
     
 
     // Associates the given window with window 2, drawing the appropriate sash
@@ -178,7 +178,8 @@ splitter window.", "");
         virtual bool , SplitVertically(wxWindow *window1,
                                        wxWindow *window2,
                                        int sashPosition = 0),
-        "Initializes the left and right panes of the splitter window.",
+        "Initializes the left and right panes of the splitter window.  The
+child windows are shown if they are currently hidden.",
         "
     :param window1:       The left pane.
     :param window2:       The right pane.
@@ -195,7 +196,7 @@ split).
 SplitVertically should be called if you wish to initially view two
 panes. It can also be called at any subsequent time, but the
 application should check that the window is not currently split using
-IsSplit.
+`IsSplit`.
 ");
     
 
@@ -203,7 +204,8 @@ IsSplit.
         virtual bool , SplitHorizontally(wxWindow *window1,
                                          wxWindow *window2,
                                          int sashPosition = 0),
-        "Initializes the top and bottom panes of the splitter window.",
+        "Initializes the top and bottom panes of the splitter window.  The
+child windows are shown if they are currently hidden.",
         "
     :param window1:       The top pane.
     :param window2:       The bottom pane.
@@ -220,7 +222,7 @@ split).
 SplitHorizontally should be called if you wish to initially view two
 panes. It can also be called at any subsequent time, but the
 application should check that the window is not currently split using
-IsSplit.
+`IsSplit`.
 ");
 
     
@@ -377,7 +379,7 @@ public:
 
     DocDeclStr(
         void , SetSashPosition(int pos),
-        "This funciton is only meaningful during EVT_SPLITTER_SASH_POS_CHANGING
+        "This function is only meaningful during EVT_SPLITTER_SASH_POS_CHANGING
 and EVT_SPLITTER_SASH_POS_CHANGED events.  In the case of _CHANGED
 events, sets the the new sash position. In the case of _CHANGING
 events, sets the new tracking bar position so visual feedback during