X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e4bbf3c2b944352e40055eb69862cc00571447ae..5a20d2ced0a0779b5d8b1cc8064f8404b2727e92:/docs/latex/wx/splitevt.tex diff --git a/docs/latex/wx/splitevt.tex b/docs/latex/wx/splitevt.tex index 74095f57b8..269cfe5ab9 100644 --- a/docs/latex/wx/splitevt.tex +++ b/docs/latex/wx/splitevt.tex @@ -1,12 +1,17 @@ \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 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} +\helpref{wxNotifyEvent}{wxnotifyevent}\\ \helpref{wxCommandEvent}{wxcommandevent}\\ \helpref{wxEvent}{wxevent}\\ -\helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} \wxheading{Include files} @@ -18,20 +23,26 @@ 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)} - {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\_CHANGING(id, func)}}{The sash +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 +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 +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 +(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} @@ -39,71 +50,75 @@ functions that take a wxSplitterEvent argument. \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. +Constructor. Used internally by wxWidgets only. -\membersection{wxSplitterWindow::SetSashPosition}\label{wxsplittereventsetsashposition} +\membersection{wxSplitterEvent::GetSashPosition}\label{wxsplittereventgetsashposition} -\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\_CHANGING and 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 -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 -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 -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. +In the case of wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events, +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 +the event handler code to prevent repositioning. May only be called while processing -wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED events. - +wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING and +wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events. +\wxheading{Parameters} +\docparam{pos}{New sash position.}