Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@31357 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2005-01-14 01:58:50 +00:00
parent 8f93b07538
commit e384095a6c
2 changed files with 14 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/latex/wx/splitter.tex
View File

@@ -178,7 +178,8 @@ Returns the right/bottom pane.
\func{void}{Initialize}{\param{wxWindow* }{window}} \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} \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}, \func{bool}{SplitHorizontally}{\param{wxWindow* }{window1}, \param{wxWindow* }{window2},
\param{int}{ sashPosition = 0}} \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} \wxheading{Parameters}
@@ -409,7 +411,8 @@ window is not currently split using \helpref{IsSplit}{wxsplitterwindowissplit}.
\func{bool}{SplitVertically}{\param{wxWindow* }{window1}, \param{wxWindow* }{window2}, \func{bool}{SplitVertically}{\param{wxWindow* }{window1}, \param{wxWindow* }{window2},
\param{int}{ sashPosition = 0}} \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} \wxheading{Parameters}

14
wxPython/src/_splitter.i
View File

@@ -164,7 +164,7 @@ update the display.", "");
void , Initialize(wxWindow *window), void , Initialize(wxWindow *window),
"Initializes the splitter window to have one pane. This should be "Initializes the splitter window to have one pane. This should be
called if you wish to initially view only a single pane in the 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 // Associates the given window with window 2, drawing the appropriate sash
@@ -178,7 +178,8 @@ splitter window.", "");
virtual bool , SplitVertically(wxWindow *window1, virtual bool , SplitVertically(wxWindow *window1,
wxWindow *window2, wxWindow *window2,
int sashPosition = 0), 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 window1: The left pane.
:param window2: The right pane. :param window2: The right pane.
@@ -195,7 +196,7 @@ split).
SplitVertically should be called if you wish to initially view two SplitVertically should be called if you wish to initially view two
panes. It can also be called at any subsequent time, but the panes. It can also be called at any subsequent time, but the
application should check that the window is not currently split using application should check that the window is not currently split using
IsSplit. `IsSplit`.
"); ");
@@ -203,7 +204,8 @@ IsSplit.
virtual bool , SplitHorizontally(wxWindow *window1, virtual bool , SplitHorizontally(wxWindow *window1,
wxWindow *window2, wxWindow *window2,
int sashPosition = 0), 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 window1: The top pane.
:param window2: The bottom pane. :param window2: The bottom pane.
@@ -220,7 +222,7 @@ split).
SplitHorizontally should be called if you wish to initially view two SplitHorizontally should be called if you wish to initially view two
panes. It can also be called at any subsequent time, but the panes. It can also be called at any subsequent time, but the
application should check that the window is not currently split using application should check that the window is not currently split using
IsSplit. `IsSplit`.
"); ");
@@ -377,7 +379,7 @@ public:
DocDeclStr( DocDeclStr(
void , SetSashPosition(int pos), 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 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 the new sash position. In the case of _CHANGING
events, sets the new tracking bar position so visual feedback during events, sets the new tracking bar position so visual feedback during