silence gcc warnings about values not handled in switch

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

diff --git a/docs/latex/wx/splitevt.tex b/docs/latex/wx/splitevt.tex
index c2af34411cf4d01acd92963d589adbb63182e2c1..269cfe5ab980f0bb0c95dae583c5d2f573da9c23 100644 (file)
--- a/docs/latex/wx/splitevt.tex
+++ b/docs/latex/wx/splitevt.tex
@@ -3,12 +3,13 @@
 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
 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
+documentation mentions the kind of event(s) for which the given accessor

 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}
 
 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{wxNotifyEvent}{wxnotifyevent}\\

 \helpref{wxCommandEvent}{wxcommandevent}\\
 \helpref{wxEvent}{wxevent}\\
 \helpref{wxObject}{wxobject}
 \helpref{wxCommandEvent}{wxcommandevent}\\
 \helpref{wxEvent}{wxevent}\\
 \helpref{wxObject}{wxobject}


@@ -25,20 +26,23 @@ functions that take a wxSplitterEvent argument.
 \twocolwidtha{10cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_SPLITTER\_SASH\_POS\_CHANGING(id, func)}}{The sash
 \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.}
+position is in the process of being changed. You may prevent this change
+from happening by calling \helpref{Veto}{wxnotifyeventveto} or you may also
+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
 \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.
+position was changed. This event is generated after the user releases the mouse
+after dragging the splitter.

 Processes a wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED event.}
 \twocolitem{{\bf EVT\_SPLITTER\_UNSPLIT(id, func)}}{The splitter has been just
 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
+unsplit. Processes a wxEVT\_COMMAND\_SPLITTER\_UNSPLIT event. This event can't
+be vetoed.}
+\twocolitem{{\bf EVT\_SPLITTER\_DCLICK(id, func)}}{The sash was double

 clicked. The default behaviour is to unsplit the window when this happens
 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.}
+(unless the minimum pane size has been set to a value greater than zero). This
+won't happen if you veto this event. Processes a
+wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED event.}

 \end{twocollist}%
 
 \wxheading{See also}
 \end{twocollist}%
 
 \wxheading{See also}


@@ -55,7 +59,7 @@ Processes a wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED event.}
 \func{}{wxSplitterEvent}{\param{wxEventType}{ eventType = wxEVT\_NULL},
                          \param{wxSplitterWindow *}{ splitter = NULL}}
 
 \func{}{wxSplitterEvent}{\param{wxEventType}{ eventType = wxEVT\_NULL},
                          \param{wxSplitterWindow *}{ splitter = NULL}}
 

-Constructor. Used internally by wxWindows only.
+Constructor. Used internally by wxWidgets only.

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


@@ -101,10 +105,10 @@ wxEVT\_COMMAND\_SPLITTER\_UNSPLIT events.
 
 \membersection{wxSplitterEvent::SetSashPosition}\label{wxsplittereventsetsashposition}
 
 
 \membersection{wxSplitterEvent::SetSashPosition}\label{wxsplittereventsetsashposition}
 

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

 
 In the case of wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events,
 
 In the case of wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events,

-sets the the new sash position. In the case of
+sets the new sash position. In the case of

 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING events, sets the new
 tracking bar position so visual feedback during dragging will
 represent that change that will actually take place. Set to -1 from
 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING events, sets the new
 tracking bar position so visual feedback during dragging will
 represent that change that will actually take place. Set to -1 from


@@ -114,7 +118,7 @@ May only be called while processing
 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING and
 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events.
 
 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING and
 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events.
 

-\wxheading{Paramters}
+\wxheading{Parameters}

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