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
   8 in 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\_CHANGING(id, func)}}{The sash
  28 position is in the process of being changed. May be used to modify the
  29 position of the tracking bar to properly reflect the position that
  30 would be set if the drag were to be completed at this point. Processes
  31 a wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING event.}
  32 \twocolitem{{\bf EVT\_SPLITTER\_SASH\_POS\_CHANGED(id, func)}}{The sash
  33 position was changed. May be used to modify the sash position before
  34 it is set, or to prevent the change from taking place.
  35 Processes a wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED event.}
  36 \twocolitem{{\bf EVT\_SPLITTER\_UNSPLIT(id, func)}}{The splitter has been just
  37 unsplit. Processes a wxEVT\_COMMAND\_SPLITTER\_UNSPLIT event.}
  38 \twocolitem{{\bf EVT\_SPLITTER\_DOUBLECLICKED(id, func)}}{The sash was double
  39 clicked. The default behaviour is to unsplit the window when this happens
  40 (unless the minimum pane size has been set to a value greater than zero).
  41 Processes a wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED event.}
  42 \end{twocollist}%
  43
  44 \wxheading{See also}
  45
  46 \helpref{wxSplitterWindow}{wxsplitterwindow},\rtfsp
  47 \helpref{Event handling overview}{eventhandlingoverview}
  48
  49
  50 \latexignore{\rtfignore{\wxheading{Members}}}
  51
  52
  53 \membersection{wxSplitterEvent::wxSplitterEvent}\label{wxsplittereventconstr}
  54
  55 \func{}{wxSplitterEvent}{\param{wxEventType}{ eventType = wxEVT\_NULL},
  56                          \param{wxSplitterWindow *}{ splitter = NULL}}
  57
  58 Constructor. Used internally by wxWindows only.
  59
  60
  61 \membersection{wxSplitterEvent::GetSashPosition}\label{wxsplittereventgetsashposition}
  62
  63 \constfunc{int}{GetSashPosition}{\void}
  64
  65 Returns the new sash position.
  66
  67 May only be called while processing
  68 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING and
  69 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events.
  70
  71
  72 \membersection{wxSplitterEvent::GetX}\label{wxsplittereventgetx}
  73
  74 \constfunc{int}{GetX}{\void}
  75
  76 Returns the x coordinate of the double-click point.
  77
  78 May only be called while processing
  79 wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED events.
  80
  81
  82 \membersection{wxSplitterEvent::GetY}\label{wxsplittereventgety}
  83
  84 \constfunc{int}{GetY}{\void}
  85
  86 Returns the y coordinate of the double-click point.
  87
  88 May only be called while processing
  89 wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED events.
  90
  91 \membersection{wxSplitterEvent::GetWindowBeingRemoved}\label{wxsplittereventgetwindowbeingremoved}
  92
  93 \constfunc{wxWindow*}{GetWindowBeingRemoved}{\void}
  94
  95 Returns a pointer to the window being removed when a splitter window
  96 is unsplit.
  97
  98 May only be called while processing
  99 wxEVT\_COMMAND\_SPLITTER\_UNSPLIT events.
 100
 101
 102 \membersection{wxSplitterEvent::SetSashPosition}\label{wxsplittereventsetsashposition}
 103
 104 \func{void}{SetSashPosition}{\param{int}{pos}}
 105
 106 In the case of wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events,
 107 sets the the new sash position. In the case of
 108 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING events, sets the new
 109 tracking bar position so visual feedback during dragging will
 110 represent that change that will actually take place. Set to -1 from
 111 the event handler code to prevent repositioning.
 112
 113 May only be called while processing
 114 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING and
 115 wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events.
 116
 117 \wxheading{Paramters}
 118
 119 \docparam{pos}{New sash position.}
 120