docs/latex/wx/splitevt.tex

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