docs/latex/wx/splitevt.tex

   1 \section{\class{wxSplitterEvent}}\label{wxsplitterevent}
   2
   3 This class represents the events generated by a splitter control. Also there is
   4 only one event class, the data associated to the different events is not the
   5 same and so not all accessor functions may be called for each event. The
   6 documentation mentions the kind of event(s) for which the given accessor
   7 function makes sense: calling it for other types of events will result
   8 in assert failure (in debug mode) and will return meaningless results.
   9
  10 \wxheading{Derived from}
  11
  12 \helpref{wxNotifyEvent}{wxnotifyevent}\\
  13 \helpref{wxCommandEvent}{wxcommandevent}\\
  14 \helpref{wxEvent}{wxevent}\\
  15 \helpref{wxObject}{wxobject}
  16
  17 \wxheading{Include files}
  18
  19 <wx/splitter.h>
  20
  21 \wxheading{Library}
  22
  23 \helpref{wxCore}{librarieslist}
  24
  25 \wxheading{Event table macros}
  26
  27 To process a splitter event, use these event handler macros to direct input to member
  28 functions that take a wxSplitterEvent argument.
  29
  30 \twocolwidtha{10cm}
  31 \begin{twocollist}\itemsep=0pt
  32 \twocolitem{{\bf EVT\_SPLITTER\_SASH\_POS\_CHANGING(id, func)}}{The sash
  33 position is in the process of being changed. You may prevent this change
  34 from happening by calling \helpref{Veto}{wxnotifyeventveto} or you may also
  35 modify the position of the tracking bar to properly reflect the position that
  36 would be set if the drag were to be completed at this point. Processes a
  37 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING event.}
  38 \twocolitem{{\bf EVT\_SPLITTER\_SASH\_POS\_CHANGED(id, func)}}{The sash
  39 position was changed. This event is generated after the user releases the mouse
  40 after dragging the splitter.
  41 Processes a wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED event.}
  42 \twocolitem{{\bf EVT\_SPLITTER\_UNSPLIT(id, func)}}{The splitter has been just
  43 unsplit. Processes a wxEVT\_COMMAND\_SPLITTER\_UNSPLIT event. This event can't
  44 be vetoed.}
  45 \twocolitem{{\bf EVT\_SPLITTER\_DCLICK(id, func)}}{The sash was double
  46 clicked. The default behaviour is to unsplit the window when this happens
  47 (unless the minimum pane size has been set to a value greater than zero). This
  48 won't happen if you veto this event. Processes a
  49 wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED event.}
  50 \end{twocollist}%
  51
  52 \wxheading{See also}
  53
  54 \helpref{wxSplitterWindow}{wxsplitterwindow},\rtfsp
  55 \helpref{Event handling overview}{eventhandlingoverview}
  56
  57
  58 \latexignore{\rtfignore{\wxheading{Members}}}
  59
  60
  61 \membersection{wxSplitterEvent::wxSplitterEvent}\label{wxsplittereventconstr}
  62
  63 \func{}{wxSplitterEvent}{\param{wxEventType}{ eventType = wxEVT\_NULL},
  64                          \param{wxSplitterWindow *}{ splitter = NULL}}
  65
  66 Constructor. Used internally by wxWidgets only.
  67
  68
  69 \membersection{wxSplitterEvent::GetSashPosition}\label{wxsplittereventgetsashposition}
  70
  71 \constfunc{int}{GetSashPosition}{\void}
  72
  73 Returns the new sash position.
  74
  75 May only be called while processing
  76 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING and
  77 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events.
  78
  79
  80 \membersection{wxSplitterEvent::GetX}\label{wxsplittereventgetx}
  81
  82 \constfunc{int}{GetX}{\void}
  83
  84 Returns the x coordinate of the double-click point.
  85
  86 May only be called while processing
  87 wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED events.
  88
  89
  90 \membersection{wxSplitterEvent::GetY}\label{wxsplittereventgety}
  91
  92 \constfunc{int}{GetY}{\void}
  93
  94 Returns the y coordinate of the double-click point.
  95
  96 May only be called while processing
  97 wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED events.
  98
  99 \membersection{wxSplitterEvent::GetWindowBeingRemoved}\label{wxsplittereventgetwindowbeingremoved}
 100
 101 \constfunc{wxWindow*}{GetWindowBeingRemoved}{\void}
 102
 103 Returns a pointer to the window being removed when a splitter window
 104 is unsplit.
 105
 106 May only be called while processing
 107 wxEVT\_COMMAND\_SPLITTER\_UNSPLIT events.
 108
 109
 110 \membersection{wxSplitterEvent::SetSashPosition}\label{wxsplittereventsetsashposition}
 111
 112 \func{void}{SetSashPosition}{\param{int}{ pos}}
 113
 114 In the case of wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events,
 115 sets the new sash position. In the case of
 116 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING events, sets the new
 117 tracking bar position so visual feedback during dragging will
 118 represent that change that will actually take place. Set to -1 from
 119 the event handler code to prevent repositioning.
 120
 121 May only be called while processing
 122 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING and
 123 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events.
 124
 125 \wxheading{Parameters}
 126
 127 \docparam{pos}{New sash position.}
 128