documented wxCONFIG_USE_RELATIVE_PATH

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

diff --git a/docs/latex/wx/splitevt.tex b/docs/latex/wx/splitevt.tex
index 74095f57b8e4961f39c91ff9c335acec9f07c169..05fc81ec1f4c60b5b7e3133c6da96dc039c1dc07 100644 (file)
--- a/docs/latex/wx/splitevt.tex
+++ b/docs/latex/wx/splitevt.tex
@@ -1,12 +1,16 @@
 \section{\class{wxSplitterEvent}}\label{wxsplitterevent}
 
 \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}\\
 
 \wxheading{Derived from}
 
 \helpref{wxCommandEvent}{wxcommandevent}\\
 \helpref{wxEvent}{wxevent}\\

-\helpref{wxEvtHandler}{wxevthandler}\\

 \helpref{wxObject}{wxobject}
 
 \wxheading{Include files}
 \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.
 
 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
 \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 or to modify the proposed sash position. 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}
+\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}
 \end{twocollist}%
 
 \wxheading{See also}


@@ -48,62 +49,56 @@ functions that take a wxSplitterEvent argument.
 
 Constructor. Used internally by wxWindows only.
 
 
 Constructor. Used internally by wxWindows only.
 

+\membersection{wxSplitterEvent::GetSashPosition}\label{wxsplittereventgetsashposition}

 
 

-\membersection{wxSplitterWindow::SetSashPosition}\label{wxsplittereventsetsashposition}
-
-\func{void}{SetSashPosition}{\param{int}{pos}}
+\constfunc{int}{GetSashPosition}{\void}

 
 

-Sets the new sash position. Set to -1 to prevent the sash from
-repositioning.
+Returns the new sash position.

 
 May only be called while processing
 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events.
 
 
 May only be called while processing
 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events.
 

-\wxheading{Paramters}
-
-\docparam{pos}{New sash position.}

 
 

+\membersection{wxSplitterEvent::GetX}\label{wxsplittereventgetx}

 
 

-\membersection{wxSplitterWindow::GetSashPosition}\label{wxsplittereventgetsashposition}
-
-\constfunc{int}{GetSashPosition}{\void}
+\constfunc{int}{GetX}{\void}

 
 

-Returns the new sash position.
+Returns the x coordinate of the double-click point.

 
 May only be called while processing
 
 May only be called while processing

-wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events.
+wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED events.

 
 
 
 

-\membersection{wxSplitterWindow::GetWindowBeingRemoved}\label{wxsplittereventgetwindowbeingremoved}
+\membersection{wxSplitterEvent::GetY}\label{wxsplittereventgety}

 
 

-\constfunc{wxWindow*}{GetWindowBeingRemoved}{\void}
+\constfunc{int}{GetY}{\void}

 
 

-Returns a pointer to the window being removed when a splitter window
-is unsplit.
+Returns the y coordinate of the double-click point.

 
 May only be called while processing
 
 May only be called while processing

-wxEVT\_COMMAND\_SPLITTER\_UNSPLIT events.
-
+wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED events.

 
 

-\membersection{wxSplitterWindow::GetX}\label{wxsplittereventgetx}
+\membersection{wxSplitterEvent::GetWindowBeingRemoved}\label{wxsplittereventgetwindowbeingremoved}

 
 

-\constfunc{int}{GetX}{\void}
+\constfunc{wxWindow*}{GetWindowBeingRemoved}{\void}

 
 

-Returns the x double-click point.
+Returns a pointer to the window being removed when a splitter window
+is unsplit.

 
 May only be called while processing
 
 May only be called while processing

-wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED events.
+wxEVT\_COMMAND\_SPLITTER\_UNSPLIT events.

 
 
 
 

-\membersection{wxSplitterWindow::GetY}\label{wxsplittereventgety}
+\membersection{wxSplitterEvent::SetSashPosition}\label{wxsplittereventsetsashposition}

 
 

-\constfunc{int}{GetY}{\void}
+\func{void}{SetSashPosition}{\param{int}{pos}}

 
 

-Returns the y 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
 
 May only be called while processing

-wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED events.
-
-
+wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events.

 
 

+\wxheading{Paramters}

 
 

+\docparam{pos}{New sash position.}