Version

[wxWidgets.git] / wxPython / src / _splitter.i

diff --git a/wxPython/src/_splitter.i b/wxPython/src/_splitter.i
index 962e8e0ad9294caf00bcd1f37dc2c8693653e5e4..3282c4e43e7f0c85c83163c6deb8092d6fd305b1 100644 (file)
--- a/wxPython/src/_splitter.i
+++ b/wxPython/src/_splitter.i
@@ -104,6 +104,8 @@ Events
 
 
 
+MustHaveApp(wxSplitterWindow);
+
 class wxSplitterWindow: public wxWindow
 {
 public:
@@ -162,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
@@ -176,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.
@@ -193,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`.
 ");
     
 
@@ -201,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.
@@ -218,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`.
 ");
 
     
@@ -272,12 +276,12 @@ showing the top-level window.", "");
 
     DocDeclStr(
         void , SetSashSize(int width),
-        "Sets the sash size", "");
+        "Sets the sash size.  Currently a NOP.", "");
     
 
     DocDeclStr(
         void , SetBorderSize(int width),
-        "Sets the border size", "");
+        "Sets the border size. Currently a NOP.", "");
     
 
     DocDeclStr(
@@ -291,7 +295,7 @@ showing the top-level window.", "");
     
 
     DocDeclStr(
-        void , SetSashPosition(int position, bool redraw = True),
+        void , SetSashPosition(int position, bool redraw = true),
         "Sets the sash position, in pixels.  If redraw is Ttrue then the panes
 are resized and the sash and border are redrawn.", "");
     
@@ -301,6 +305,33 @@ are resized and the sash and border are redrawn.", "");
         "Returns the surrent sash position.", "");
     
 
+    DocDeclStr(
+        void , SetSashGravity(double gravity),
+        "Set the sash gravity.  Gravity is a floating-point factor between 0.0
+and 1.0 which controls position of sash while resizing the
+`wx.SplitterWindow`.  The gravity specifies how much the left/top
+window will grow while resizing.","
+
+Example values:
+
+    ======= =======================================
+    0.0      Only the bottom or right window is
+             automaticaly resized.
+    0.5      Both windows grow equally.
+    1.0      Only left/top window grows.
+
+The default value of sash gravity is 0.0. That value is compatible
+with the previous (before gravity was introduced) behaviour of the 
+`wx.SplitterWindow`.");
+
+    DocDeclStr(
+        double , GetSashGravity() const,
+        "Gets the sash gravity.
+
+:see: `SetSashGravity`
+", "");
+    
+
     DocDeclStr(
         void , SetMinimumPaneSize(int min),
         "Sets the minimum pane size in pixels.
@@ -348,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