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 acessor
   7 function makes sense - calling it for other types of events will result in
   8 assert failure (in debug mode) and will return meaningless results.
   9
  10 \wxheading{Derived from}
  11
  12 \helpref{wxCommandEvent}{wxcommandevent}\\
  13 \helpref{wxEvent}{wxevent}\\
  14 \helpref{wxObject}{wxobject}
  15
  16 \wxheading{Include files}
  17
  18 <wx/splitter.h>
  19
  20 \wxheading{Event table macros}
  21
  22 To process a splitter event, use these event handler macros to direct input to member
  23 functions that take a wxSplitterEvent argument.
  24
  25 \twocolwidtha{10cm}
  26 \begin{twocollist}\itemsep=0pt
  27 \twocolitem{{\bf EVT\_SPLITTER\_SASH\_POS\_CHANGED(id, func)}}{The sash
  28 position was changed. May be used to prevent the change from taking place.
  29 Processes wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED event.}
  30 \twocolitem{{\bf EVT\_SPLITTER\_UNSPLIT(id, func)}}{The splitter has been just
  31 unsplit. Processes wxEVT\_COMMAND\_SPLITTER\_UNSPLIT event.}
  32 \twocolitem{{\bf EVT\_SPLITTER\_DOUBLECLICKED(id, func)}}{The sash was double
  33 clicked. The default behaviour is to unsplit the window when this happens
  34 (unless the minimum pane size has been set to a value greater than zero).
  35 Processes wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED event}
  36 \end{twocollist}%
  37
  38 \wxheading{See also}
  39
  40 \helpref{wxSplitterWindow}{wxsplitterwindow},\rtfsp
  41 \helpref{Event handling overview}{eventhandlingoverview}
  42
  43 \latexignore{\rtfignore{\wxheading{Members}}}
  44
  45 \membersection{wxSplitterEvent::wxSplitterEvent}\label{wxsplittereventconstr}
  46
  47 \func{}{wxSplitterEvent}{\param{wxEventType}{ eventType = wxEVT\_NULL},
  48                          \param{wxSplitterWindow *}{ splitter = NULL}}
  49
  50 Constructor. Used internally by wxWindows only.
  51
  52 \membersection{wxSplitterEvent::GetSashPosition}\label{wxsplittereventgetsashposition}
  53
  54 \constfunc{int}{GetSashPosition}{\void}
  55
  56 Returns the new sash position.
  57
  58 May only be called while processing
  59 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events.
  60
  61
  62 \membersection{wxSplitterEvent::GetX}\label{wxsplittereventgetx}
  63
  64 \constfunc{int}{GetX}{\void}
  65
  66 Returns the x coordinate of the double-click point.
  67
  68 May only be called while processing
  69 wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED events.
  70
  71
  72 \membersection{wxSplitterEvent::GetY}\label{wxsplittereventgety}
  73
  74 \constfunc{int}{GetY}{\void}
  75
  76 Returns the y coordinate of the double-click point.
  77
  78 May only be called while processing
  79 wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED events.
  80
  81 \membersection{wxSplitterEvent::GetWindowBeingRemoved}\label{wxsplittereventgetwindowbeingremoved}
  82
  83 \constfunc{wxWindow*}{GetWindowBeingRemoved}{\void}
  84
  85 Returns a pointer to the window being removed when a splitter window
  86 is unsplit.
  87
  88 May only be called while processing
  89 wxEVT\_COMMAND\_SPLITTER\_UNSPLIT events.
  90
  91
  92 \membersection{wxSplitterEvent::SetSashPosition}\label{wxsplittereventsetsashposition}
  93
  94 \func{void}{SetSashPosition}{\param{int}{pos}}
  95
  96 Sets the new sash position. Set to -1 from the event handler code to prevent
  97 the sash from repositioning.
  98
  99 May only be called while processing
 100 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events.
 101
 102 \wxheading{Paramters}
 103
 104 \docparam{pos}{New sash position.}