]>
Commit | Line | Data |
---|---|---|
42e69d6b VZ |
1 | \section{\class{wxSplitterEvent}}\label{wxsplitterevent} |
2 | ||
65e78240 VZ |
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. | |
42e69d6b VZ |
9 | |
10 | \wxheading{Derived from} | |
11 | ||
12 | \helpref{wxCommandEvent}{wxcommandevent}\\ | |
13 | \helpref{wxEvent}{wxevent}\\ | |
42e69d6b VZ |
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 | ||
65e78240 | 25 | \twocolwidtha{10cm} |
42e69d6b | 26 | \begin{twocollist}\itemsep=0pt |
65e78240 VZ |
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} | |
42e69d6b VZ |
36 | \end{twocollist}% |
37 | ||
38 | \wxheading{See also} | |
39 | ||
e4bbf3c2 UB |
40 | \helpref{wxSplitterWindow}{wxsplitterwindow},\rtfsp |
41 | \helpref{Event handling overview}{eventhandlingoverview} | |
42e69d6b VZ |
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 | ||
65e78240 | 52 | \membersection{wxSplitterEvent::GetSashPosition}\label{wxsplittereventgetsashposition} |
e4bbf3c2 | 53 | |
65e78240 | 54 | \constfunc{int}{GetSashPosition}{\void} |
e4bbf3c2 | 55 | |
65e78240 | 56 | Returns the new sash position. |
e4bbf3c2 UB |
57 | |
58 | May only be called while processing | |
59 | wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events. | |
60 | ||
e4bbf3c2 | 61 | |
65e78240 | 62 | \membersection{wxSplitterEvent::GetX}\label{wxsplittereventgetx} |
e4bbf3c2 | 63 | |
65e78240 | 64 | \constfunc{int}{GetX}{\void} |
e4bbf3c2 | 65 | |
65e78240 | 66 | Returns the x coordinate of the double-click point. |
e4bbf3c2 UB |
67 | |
68 | May only be called while processing | |
65e78240 | 69 | wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED events. |
e4bbf3c2 UB |
70 | |
71 | ||
65e78240 | 72 | \membersection{wxSplitterEvent::GetY}\label{wxsplittereventgety} |
e4bbf3c2 | 73 | |
65e78240 | 74 | \constfunc{int}{GetY}{\void} |
e4bbf3c2 | 75 | |
65e78240 | 76 | Returns the y coordinate of the double-click point. |
e4bbf3c2 UB |
77 | |
78 | May only be called while processing | |
65e78240 | 79 | wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED events. |
e4bbf3c2 | 80 | |
65e78240 | 81 | \membersection{wxSplitterEvent::GetWindowBeingRemoved}\label{wxsplittereventgetwindowbeingremoved} |
e4bbf3c2 | 82 | |
65e78240 | 83 | \constfunc{wxWindow*}{GetWindowBeingRemoved}{\void} |
e4bbf3c2 | 84 | |
65e78240 VZ |
85 | Returns a pointer to the window being removed when a splitter window |
86 | is unsplit. | |
e4bbf3c2 UB |
87 | |
88 | May only be called while processing | |
65e78240 | 89 | wxEVT\_COMMAND\_SPLITTER\_UNSPLIT events. |
e4bbf3c2 UB |
90 | |
91 | ||
65e78240 | 92 | \membersection{wxSplitterEvent::SetSashPosition}\label{wxsplittereventsetsashposition} |
e4bbf3c2 | 93 | |
65e78240 | 94 | \func{void}{SetSashPosition}{\param{int}{pos}} |
e4bbf3c2 | 95 | |
65e78240 VZ |
96 | Sets the new sash position. Set to -1 from the event handler code to prevent |
97 | the sash from repositioning. | |
e4bbf3c2 UB |
98 | |
99 | May only be called while processing | |
65e78240 | 100 | wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events. |
e4bbf3c2 | 101 | |
65e78240 | 102 | \wxheading{Paramters} |
e4bbf3c2 | 103 | |
65e78240 | 104 | \docparam{pos}{New sash position.} |