bugs in splitter docs corrected

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@2525 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/latex/wx/classes.tex

@@ -163,6 +163,7 @@
 \input slider.tex
 \input sckaddr.tex
 \input socket.tex
+\input splitevt.tex
 \input strmsock.tex
 \input spinbutt.tex
 \input splitter.tex

docs/latex/wx/splitevt.tex

@@ -1,12 +1,16 @@
 \section{\class{wxSplitterEvent}}\label{wxsplitterevent}
 
-This class represents the events generated by a splitter control.
+This class represents the events generated by a splitter control. Also there is
+only one event class, the data associated to the different events is not the
+same and so not all accessor functions may be called for each event. The
+documentation mentions the kind of event(s) for which the given acessor
+function makes sense - calling it for other types of events will result in
+assert failure (in debug mode) and will return meaningless results.
 
 \wxheading{Derived from}
 
 \helpref{wxCommandEvent}{wxcommandevent}\\
 \helpref{wxEvent}{wxevent}\\
-\helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \wxheading{Include files}
@@ -18,20 +22,17 @@ This class represents the events generated by a splitter control.
 To process a splitter event, use these event handler macros to direct input to member
 functions that take a wxSplitterEvent argument.
 
-\twocolwidtha{7cm}
+\twocolwidtha{10cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf EVT\_SPLITTER\_SASH\_POS\_CHANGED(id, func)}
+\twocolitem{{\bf EVT\_SPLITTER\_SASH\_POS\_CHANGED(id, func)}}{The sash
-    {The sash position was changed. May be used to prevent the change from
+position was changed. May be used to prevent the change from taking place.
-     taking place or to modify the proposed sash position. Processes
+Processes wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED event.}
-     wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED event.}
+\twocolitem{{\bf EVT\_SPLITTER\_UNSPLIT(id, func)}}{The splitter has been just
-\twocolitem{{\bf EVT\_SPLITTER\_UNSPLIT(id, func)}}
+unsplit. Processes wxEVT\_COMMAND\_SPLITTER\_UNSPLIT event.}
-    {The splitter has been just unsplit. Processes wxEVT\_COMMAND\_SPLITTER\_UNSPLIT
+\twocolitem{{\bf EVT\_SPLITTER\_DOUBLECLICKED(id, func)}}{The sash was double
-     event.}
+clicked. The default behaviour is to unsplit the window when this happens
-\twocolitem{{\bf EVT\_SPLITTER\_DOUBLECLICKED(id, func)}}
+(unless the minimum pane size has been set to a value greater than zero).
-    {The sash was double clicked. The default behaviour is to unsplit the
+Processes wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED event}
-     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}
@@ -48,23 +49,7 @@ functions that take a wxSplitterEvent argument.
 
 Constructor. Used internally by wxWindows only.
 
-
+\membersection{wxSplitterEvent::GetSashPosition}\label{wxsplittereventgetsashposition}
-\membersection{wxSplitterWindow::SetSashPosition}\label{wxsplittereventsetsashposition}
-
-\func{void}{SetSashPosition}{\param{int}{pos}}
-
-Sets the new sash position. Set to -1 to prevent the sash from
-repositioning.
-
-May only be called while processing
-wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events.
-
-\wxheading{Paramters}
-
-\docparam{pos}{New sash position.}
-
-
-\membersection{wxSplitterWindow::GetSashPosition}\label{wxsplittereventgetsashposition}
 
 \constfunc{int}{GetSashPosition}{\void}
 
@@ -74,7 +59,26 @@ May only be called while processing
 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events.
 
 
-\membersection{wxSplitterWindow::GetWindowBeingRemoved}\label{wxsplittereventgetwindowbeingremoved}
+\membersection{wxSplitterEvent::GetX}\label{wxsplittereventgetx}
+
+\constfunc{int}{GetX}{\void}
+
+Returns the x coordinate of the double-click point.
+
+May only be called while processing
+wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED events.
+
+
+\membersection{wxSplitterEvent::GetY}\label{wxsplittereventgety}
+
+\constfunc{int}{GetY}{\void}
+
+Returns the y coordinate of the double-click point.
+
+May only be called while processing
+wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED events.
+
+\membersection{wxSplitterEvent::GetWindowBeingRemoved}\label{wxsplittereventgetwindowbeingremoved}
 
 \constfunc{wxWindow*}{GetWindowBeingRemoved}{\void}
 
@@ -85,25 +89,16 @@ May only be called while processing
 wxEVT\_COMMAND\_SPLITTER\_UNSPLIT events.
 
 
-\membersection{wxSplitterWindow::GetX}\label{wxsplittereventgetx}
+\membersection{wxSplitterEvent::SetSashPosition}\label{wxsplittereventsetsashposition}
 
-\constfunc{int}{GetX}{\void}
+\func{void}{SetSashPosition}{\param{int}{pos}}
 
-Returns the x double-click point.
+Sets the new sash position. Set to -1 from the event handler code to prevent
+the sash from repositioning.
 
 May only be called while processing
-wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED events.
+wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events.
-
-
-\membersection{wxSplitterWindow::GetY}\label{wxsplittereventgety}
-
-\constfunc{int}{GetY}{\void}
-
-Returns the y double-click point.
-
-May only be called while processing
-wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED events.
-
-
 
+\wxheading{Paramters}
 
+\docparam{pos}{New sash position.}

docs/latex/wx/splitter.tex

@@ -34,19 +34,17 @@ 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}
+\twocolwidtha{10cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf EVT\_SPLITTER\_SASH\_POS\_CHANGED(id, func)}
+\twocolitem{{\bf EVT\_SPLITTER\_SASH\_POS\_CHANGED(id, func)}}{The sash
-    {The sash position was changed. May be used to prevent the change from
+position was changed. May be used to prevent the change from taking place.
-     taking place. Processes wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED event.}
+Processes wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED event.}
-\twocolitem{{\bf EVT\_SPLITTER\_UNSPLIT(id, func)}}
+\twocolitem{{\bf EVT\_SPLITTER\_UNSPLIT(id, func)}}{The splitter has been just
-    {The splitter has been just unsplit. Processes wxEVT\_COMMAND\_SPLITTER\_UNSPLIT
+unsplit. Processes wxEVT\_COMMAND\_SPLITTER\_UNSPLIT event.}
-     event.}
+\twocolitem{{\bf EVT\_SPLITTER\_DOUBLECLICKED(id, func)}}{The sash was double
-\twocolitem{{\bf EVT\_SPLITTER\_DOUBLECLICKED(id, func)}}
+clicked. The default behaviour is to unsplit the window when this happens
-    {The sash was double clicked. The default behaviour is to unsplit the
+(unless the minimum pane size has been set to a value greater than zero).
-     window when this happens (unless the minimum pane size has been set to a
+Processes wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED event}
-     value greater than zero). Processes wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED
-     event}
 \end{twocollist}%
 
 \wxheading{See also}

docs/latex/wx/wx.hpj

@@ -1,5 +1,5 @@
 [OPTIONS]
-BMROOT=d:\wx2\wxWind~1\docs/latex/wx ; Assume that bitmaps are where the source is
+BMROOT=. ; Assume that bitmaps are where the source is
 TITLE=wxWindows Manual
 CONTENTS=Contents
 COMPRESS=HIGH