Added a reference to the splitter event class and macros.

[wxWidgets.git] / docs / latex / wx / splitter.tex

diff --git a/docs/latex/wx/splitter.tex b/docs/latex/wx/splitter.tex
index bf1087b6c8e46ea1472627b17fc4d9e19b0f1e88..e6b53d0f35ccec7819593cd0e73c494a6005bd3a 100644 (file)
--- a/docs/latex/wx/splitter.tex
+++ b/docs/latex/wx/splitter.tex
@@ -24,6 +24,35 @@ See also \helpref{window styles overview}{windowstyles}.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/splitter.h>
+
+\wxheading{Event handling}
+
+To process input from a splitter control, use the following event handler
+macros to direct input to member functions that take a 
+\helpref{wxSplitterEvent}{wxsplitterevent} argument.
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_SPLITTER\_SASH\_POS\_CHANGED(id, func)}
+    {The sash position was changed. May be used to prevent the change from
+     taking place. Processes wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED event.}
+\twocolitem{{\bf EVT\_SPLITTER\_UNSPLIT(id, func)}}
+    {The splitter has been just unsplit. Processes wxEVT\_COMMAND\_SPLITTER\_UNSPLIT
+     event.}
+\twocolitem{{\bf EVT\_SPLITTER\_DOUBLECLICKED(id, func)}}
+    {The sash was double clicked. The default behaviour is to unsplit the
+     window when this happens (unless the minimum pane size has been set to a
+     value greater than zero). Processes wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED
+     event}
+\end{twocollist}%
+
+\wxheading{See also}
+
+\helpref{wxSplitterEvent}{wxsplitterevent}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxSplitterWindow::wxSplitterWindow}\label{wxsplitterwindowconstr}
@@ -205,10 +234,32 @@ user. It may return FALSE to prevent the change or TRUE to allow it.
 The default implementation of this function verifies that the sizes of both 
 panes of the splitter are greater than minimum pane size.
 
+\membersection{wxSplitterWindow::ReplaceWindow}\label{wxsplitterwindowreplacewindow}
+
+\func{bool}{ReplaceWindow}{\param{wxWindow * }{winOld}, \param{wxWindow * }{winNew}}
+
+This function replaces one of the windows managed by the wxSplitterWindow 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
+(if any). It is valid to call this function whether the splitter has two
+windows or only one.
+
+Both parameters should be non NULL and {\it 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 delete the replaced window and you
+may wish to do it yourself.
+
 \wxheading{See also}
 
 \helpref{wxSplitterWindow::GetMinimumPaneSize}{wxsplitterwindowgetminimumpanesize}
 
+\wxheading{See also}
+
+\helpref{wxSplitterWindow::Unsplit}{wxsplitterwindowunsplit}\\
+\helpref{wxSplitterWindow::SplitVertically}{wxsplitterwindowsplitvertically}\\
+\helpref{wxSplitterWindow::SplitHorizontally}{wxsplitterwindowsplithorizontally}
+
 \membersection{wxSplitterWindow::SetSashPosition}\label{wxsplitterwindowsetsashposition}
 
 \func{void}{SetSashPosition}{\param{int }{position}, \param{const bool}{ redraw = TRUE}}