Added config values (commented out) for generating the MS HTML Help

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

diff --git a/docs/latex/wx/splitter.tex b/docs/latex/wx/splitter.tex
index d96ccb9551ab8d6136c32d4329a876df30ef647a..879dc1271402b8ce6532e2b57836f1bb23d95670 100644 (file)
--- a/docs/latex/wx/splitter.tex
+++ b/docs/latex/wx/splitter.tex
@@ -7,6 +7,7 @@ split into two programmatically (perhaps from a menu command), and unsplit
 either programmatically or via the wxSplitterWindow user interface.
 
 Appropriate 3D shading for the Windows 95 user interface is an option.
 either programmatically or via the wxSplitterWindow user interface.
 
 Appropriate 3D shading for the Windows 95 user interface is an option.

+This is also recommended for GTK.

 
 \wxheading{Window styles}
 
 
 \wxheading{Window styles}
 


@@ -14,6 +15,9 @@ Appropriate 3D shading for the Windows 95 user interface is an option.
 \twocolitem{\windowstyle{wxSP\_3D}}{Draws a 3D effect border and sash.}
 \twocolitem{\windowstyle{wxSP\_BORDER}}{Draws a thin black border around the window, and a black sash.}
 \twocolitem{\windowstyle{wxSP\_NOBORDER}}{No border, and a black sash.}
 \twocolitem{\windowstyle{wxSP\_3D}}{Draws a 3D effect border and sash.}
 \twocolitem{\windowstyle{wxSP\_BORDER}}{Draws a thin black border around the window, and a black sash.}
 \twocolitem{\windowstyle{wxSP\_NOBORDER}}{No border, and a black sash.}

+\twocolitem{\windowstyle{wxSP\_PERMIT\_UNSPLIT}}{Always allow to
+unsplit, even with the minimum pane size other than zero.}
+\twocolitem{\windowstyle{wxSP\_LIVE\_UPDATE}}{Don't draw XOR line but resize the child windows immediately.}

 \end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles}.
 \end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles}.


@@ -24,6 +28,39 @@ See also \helpref{window styles overview}{windowstyles}.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \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{10cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_SPLITTER\_SASH\_POS\_CHANGING(id, func)}}{The sash
+position is in the process of being changed. May be used to modify the
+position of the tracking bar to properly reflect the position that
+would be set if the drag were to be completed at this point. Processes
+a wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING event.}
+\twocolitem{{\bf EVT\_SPLITTER\_SASH\_POS\_CHANGED(id, func)}}{The sash
+position was changed. May be used to modify the sash position before
+it is set, or to prevent the change from taking place.
+Processes a wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED event.}
+\twocolitem{{\bf EVT\_SPLITTER\_UNSPLIT(id, func)}}{The splitter has been just
+unsplit. Processes a 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 a wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED event.}
+\end{twocollist}%
+
+\wxheading{See also}
+
+\helpref{wxSplitterEvent}{wxsplitterevent}
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxSplitterWindow::wxSplitterWindow}\label{wxsplitterwindowconstr}
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxSplitterWindow::wxSplitterWindow}\label{wxsplitterwindowconstr}


@@ -32,7 +69,7 @@ See also \helpref{window styles overview}{windowstyles}.
 
 Default constructor.
 
 
 Default constructor.
 

-\func{}{wxSplitterWindow}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id}, \param{int }{x},\rtfsp
+\func{}{wxSplitterWindow}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp

 \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{long }{style=wxSP\_3D}, \param{const wxString\&}{ name = "splitterWindow"}}
 
 \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{long }{style=wxSP\_3D}, \param{const wxString\&}{ name = "splitterWindow"}}
 


@@ -265,7 +302,9 @@ Sets the minimum pane size.
 
 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),
 
 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.
+set a minimum size, for example 20 pixels. If the wxSP\_PERMIT\_UNSPLIT style
+is used when a splitter window is created, the window may be unsplit even
+if minimum size is non-zero.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -379,5 +418,3 @@ which can be overridden for the desired behaviour. By default, the pane being re
 \helpref{wxSplitterWindow::SplitHorizontally}{wxsplitterwindowsplithorizontally}, \helpref{wxSplitterWindow::SplitVertically}{wxsplitterwindowsplitvertically},\rtfsp
 \helpref{wxSplitterWindow::IsSplit}{wxsplitterwindowissplit}, \helpref{wxSplitterWindow::OnUnsplit}{wxsplitterwindowonunsplit}
 
 \helpref{wxSplitterWindow::SplitHorizontally}{wxsplitterwindowsplithorizontally}, \helpref{wxSplitterWindow::SplitVertically}{wxsplitterwindowsplitvertically},\rtfsp
 \helpref{wxSplitterWindow::IsSplit}{wxsplitterwindowissplit}, \helpref{wxSplitterWindow::OnUnsplit}{wxsplitterwindowonunsplit}
 

-
-