wxWidgets/docs/latex/wx/splitevt.tex

\section{\class{wxSplitterEvent}}\label{wxsplitterevent}

This class represents the events generated by a splitter control.

\wxheading{Derived from}

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

\wxheading{Include files}

<wx/splitter.h>

\wxheading{Event table macros}

To process a splitter event, use these event handler macros to direct input to member
functions that take a 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 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}
\end{twocollist}%

\wxheading{See also}

\helpref{wxSplitterWindow}{wxsplitterwindow},\rtfsp
\helpref{Event handling overview}{eventhandlingoverview}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxSplitterEvent::wxSplitterEvent}\label{wxsplittereventconstr}

\func{}{wxSplitterEvent}{\param{wxEventType}{ eventType = wxEVT\_NULL},
                         \param{wxSplitterWindow *}{ splitter = NULL}}

Constructor. Used internally by wxWindows only.


\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}

Returns the new sash position.

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


\membersection{wxSplitterWindow::GetWindowBeingRemoved}\label{wxsplittereventgetwindowbeingremoved}

\constfunc{wxWindow*}{GetWindowBeingRemoved}{\void}

Returns a pointer to the window being removed when a splitter window
is unsplit.

May only be called while processing
wxEVT\_COMMAND\_SPLITTER\_UNSPLIT events.


\membersection{wxSplitterWindow::GetX}\label{wxsplittereventgetx}

\constfunc{int}{GetX}{\void}

Returns the x double-click point.

May only be called while processing
wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED 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.