- virtual bool SplitVertically(wxWindow *window1,
- wxWindow *window2,
- int sashPosition = 0);
-
- virtual bool SplitHorizontally(wxWindow *window1,
- wxWindow *window2,
- int sashPosition = 0);
-
- // Removes the specified (or second) window from the view
- // Doesn't actually delete the window.
- bool Unsplit(wxWindow *toRemove = NULL);
-
- // Replaces one of the windows with another one (neither old nor new
- // parameter should be NULL)
- bool ReplaceWindow(wxWindow *winOld, wxWindow *winNew);
-
- // Is the window split?
- bool IsSplit() const;
-
- // Sets the sash size
- void SetSashSize(int width);
-
- // Sets the border size
- void SetBorderSize(int width);
-
- // Gets the sash size
- int GetSashSize() const;
-
- // Gets the border size
- int GetBorderSize() const;
-
- // Set the sash position
- void SetSashPosition(int position, bool redraw = True);
-
- // Gets the sash position
- int GetSashPosition() const;
-
- // If this is zero, we can remove panes by dragging the sash.
- void SetMinimumPaneSize(int min);
- int GetMinimumPaneSize() const;
-
-
- // Tests for x, y over sash
- virtual bool SashHitTest(int x, int y, int tolerance = 5);
-
- // Resizes subwindows
- virtual void SizeWindows();
+
+ DocDeclStr(
+ virtual bool , SplitVertically(wxWindow *window1,
+ wxWindow *window2,
+ int sashPosition = 0),
+ "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.
+ :param sashPosition: The initial position of the sash. If this
+ value is positive, it specifies the size of the left
+ pane. If it is negative, it is absolute value gives
+ the size of the right pane. Finally, specify 0
+ (default) to choose the default position (half of
+ the total window width).
+
+Returns True if successful, False otherwise (the window was already
+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`.
+");
+
+
+ DocDeclStr(
+ virtual bool , SplitHorizontally(wxWindow *window1,
+ wxWindow *window2,
+ int sashPosition = 0),
+ "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.
+ :param sashPosition: The initial position of the sash. If this
+ value is positive, it specifies the size of the
+ upper pane. If it is negative, it is absolute value
+ gives the size of the lower pane. Finally, specify 0
+ (default) to choose the default position (half of
+ the total window height).
+
+Returns True if successful, False otherwise (the window was already
+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`.
+");
+
+
+
+ DocDeclStr(
+ bool , Unsplit(wxWindow *toRemove = NULL),
+ "Unsplits the window. Pass the pane to remove, or None to remove the
+right or bottom pane. Returns True if successful, False otherwise (the
+window was not split).
+
+This function will not actually delete the pane being
+removed; it sends EVT_SPLITTER_UNSPLIT which can be handled
+for the desired behaviour. By default, the pane being
+removed is only hidden.", "");
+
+
+
+ DocDeclStr(
+ bool , ReplaceWindow(wxWindow *winOld, wxWindow *winNew),
+ "This function replaces one of the windows managed by the
+SplitterWindow with another one. It is in general better to use it
+instead of calling Unsplit() and then resplitting the window back
+because it will provoke much less flicker. It is valid to call this
+function whether the splitter has two windows or only one.
+
+Both parameters should be non-None and winOld must specify one of the
+windows managed by the splitter. If the parameters are incorrect or
+the window couldn't be replaced, False is returned. Otherwise the
+function will return True, but please notice that it will not Destroy
+the replaced window and you may wish to do it yourself.", "");
+
+
+ DocDeclStr(
+ void , UpdateSize(),
+ "Causes any pending sizing of the sash and child panes to take place
+immediately.
+
+Such resizing normally takes place in idle time, in order to wait for
+layout to be completed. However, this can cause unacceptable flicker
+as the panes are resized after the window has been shown. To work
+around this, you can perform window layout (for example by sending a
+size event to the parent window), and then call this function, before
+showing the top-level window.", "");
+
+
+
+ DocDeclStr(
+ bool , IsSplit() const,
+ "Is the window split?", "");
+
+
+ DocDeclStr(
+ void , SetSashSize(int width),
+ "Sets the sash size. Currently a NOP.", "");
+
+
+ DocDeclStr(
+ void , SetBorderSize(int width),
+ "Sets the border size. Currently a NOP.", "");
+
+
+ DocDeclStr(
+ int , GetSashSize() const,
+ "Gets the sash size", "");
+
+
+ DocDeclStr(
+ int , GetBorderSize() const,
+ "Gets the border size", "");
+
+
+ DocDeclStr(
+ 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.", "");
+
+
+ DocDeclStr(
+ int , GetSashPosition() const,
+ "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.
+
+The default minimum pane size is zero, which means that either pane
+can be reduced to zero by dragging the sash, thus removing one of the
+panes. To prevent this behaviour (and veto out-of-range sash
+dragging), set a minimum size, for example 20 pixels. If the
+wx.SP_PERMIT_UNSPLIT style is used when a splitter window is created,
+the window may be unsplit even if minimum size is non-zero.", "");
+
+ DocDeclStr(
+ int , GetMinimumPaneSize() const,
+ "Gets the minimum pane size in pixels.", "");
+
+
+ DocDeclStr(
+ virtual bool , SashHitTest(int x, int y, int tolerance = 5),
+ "Tests for x, y over the sash", "");
+
+
+ DocDeclStr(
+ virtual void , SizeWindows(),
+ "Resizes subwindows", "");
+
projects / wxWidgets.git / blobdiff