]> git.saurik.com Git - wxWidgets.git/blame - include/wx/generic/splitter.h
Script updates
[wxWidgets.git] / include / wx / generic / splitter.h
CommitLineData
c801d85f 1/////////////////////////////////////////////////////////////////////////////
3e58dcb9 2// Name: wx/splitter.h
c801d85f
KB
3// Purpose: wxSplitterWindow class
4// Author: Julian Smart
5// Modified by:
6// Created: 01/02/97
7// RCS-ID: $Id$
371a5b4e 8// Copyright: (c) Julian Smart
65571936 9// Licence: wxWindows licence
c801d85f
KB
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef __SPLITTERH_G__
13#define __SPLITTERH_G__
14
12028905 15#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
42e69d6b 16 #pragma interface "splitter.h"
c801d85f
KB
17#endif
18
42e69d6b 19#include "wx/window.h" // base class declaration
0013a77b 20#include "wx/containr.h" // wxControlContainer
c801d85f 21
42e69d6b 22class WXDLLEXPORT wxSplitterEvent;
c801d85f 23
42e69d6b
VZ
24// ---------------------------------------------------------------------------
25// splitter constants
26// ---------------------------------------------------------------------------
c801d85f 27
2e8cc3e8 28enum wxSplitMode
42e69d6b
VZ
29{
30 wxSPLIT_HORIZONTAL = 1,
31 wxSPLIT_VERTICAL
32};
c801d85f 33
42e69d6b
VZ
34enum
35{
36 wxSPLIT_DRAG_NONE,
37 wxSPLIT_DRAG_DRAGGING,
38 wxSPLIT_DRAG_LEFT_DOWN
39};
40
41// ---------------------------------------------------------------------------
42// wxSplitterWindow maintains one or two panes, with
43// an optional vertical or horizontal split which
44// can be used with the mouse or programmatically.
45// ---------------------------------------------------------------------------
c801d85f
KB
46
47// TODO:
48// 1) Perhaps make the borders sensitive to dragging in order to create a split.
49// The MFC splitter window manages scrollbars as well so is able to
50// put sash buttons on the scrollbars, but we probably don't want to go down
51// this path.
77ffb593 52// 2) for wxWidgets 2.0, we must find a way to set the WS_CLIPCHILDREN style
c801d85f
KB
53// to prevent flickering. (WS_CLIPCHILDREN doesn't work in all cases so can't be
54// standard).
55
56class WXDLLEXPORT wxSplitterWindow: public wxWindow
57{
0d559d69 58public:
c801d85f
KB
59
60////////////////////////////////////////////////////////////////////////////
61// Public API
62
63 // Default constructor
9948d31f 64 wxSplitterWindow()
f6bcfd97
BP
65 {
66 Init();
67 }
c801d85f
KB
68
69 // Normal constructor
ca65c044 70 wxSplitterWindow(wxWindow *parent, wxWindowID id = wxID_ANY,
0d559d69
VZ
71 const wxPoint& pos = wxDefaultPosition,
72 const wxSize& size = wxDefaultSize,
dead66ba 73 long style = wxSP_3D,
2b5f62a0 74 const wxString& name = wxT("splitter"))
f6bcfd97
BP
75 {
76 Init();
77 Create(parent, id, pos, size, style, name);
78 }
79
6b55490a 80 virtual ~wxSplitterWindow();
c801d85f 81
ca65c044 82 bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,
f6bcfd97
BP
83 const wxPoint& pos = wxDefaultPosition,
84 const wxSize& size = wxDefaultSize,
dead66ba 85 long style = wxSP_3D,
2b5f62a0 86 const wxString& name = wxT("splitter"));
f6bcfd97 87
c801d85f 88 // Gets the only or left/top pane
0d559d69 89 wxWindow *GetWindow1() const { return m_windowOne; }
c801d85f
KB
90
91 // Gets the right/bottom pane
0d559d69 92 wxWindow *GetWindow2() const { return m_windowTwo; }
c801d85f
KB
93
94 // Sets the split mode
2e8cc3e8
VZ
95 void SetSplitMode(int mode)
96 {
97 wxASSERT_MSG( mode == wxSPLIT_VERTICAL || mode == wxSPLIT_HORIZONTAL,
98 _T("invalid split mode") );
99
100 m_splitMode = (wxSplitMode)mode;
101 }
c801d85f
KB
102
103 // Gets the split mode
2e8cc3e8 104 wxSplitMode GetSplitMode() const { return m_splitMode; };
c801d85f
KB
105
106 // Initialize with one window
107 void Initialize(wxWindow *window);
108
109 // Associates the given window with window 2, drawing the appropriate sash
110 // and changing the split mode.
4395fb21 111 // Does nothing and returns false if the window is already split.
0d559d69
VZ
112 // A sashPosition of 0 means choose a default sash position,
113 // negative sashPosition specifies the size of right/lower pane as it's
114 // absolute value rather than the size of left/upper pane.
cce4b3fe
VZ
115 virtual bool SplitVertically(wxWindow *window1,
116 wxWindow *window2,
2e8cc3e8
VZ
117 int sashPosition = 0)
118 { return DoSplit(wxSPLIT_VERTICAL, window1, window2, sashPosition); }
cce4b3fe
VZ
119 virtual bool SplitHorizontally(wxWindow *window1,
120 wxWindow *window2,
2e8cc3e8
VZ
121 int sashPosition = 0)
122 { return DoSplit(wxSPLIT_HORIZONTAL, window1, window2, sashPosition); }
c801d85f
KB
123
124 // Removes the specified (or second) window from the view
125 // Doesn't actually delete the window.
c67daf87 126 bool Unsplit(wxWindow *toRemove = (wxWindow *) NULL);
c801d85f 127
3ad5e06b
VZ
128 // Replaces one of the windows with another one (neither old nor new
129 // parameter should be NULL)
130 bool ReplaceWindow(wxWindow *winOld, wxWindow *winNew);
131
7e521b01
JS
132 // Make sure the child window sizes are updated. This is useful
133 // for reducing flicker by updating the sizes before a
134 // window is shown, if you know the overall size is correct.
135 void UpdateSize();
136
c801d85f 137 // Is the window split?
0d559d69 138 bool IsSplit() const { return (m_windowTwo != NULL); }
c801d85f
KB
139
140 // Sets the sash size
b3208e11 141 void SetSashSize(int WXUNUSED(width)) { }
c801d85f
KB
142
143 // Sets the border size
b3208e11 144 void SetBorderSize(int WXUNUSED(width)) { }
c801d85f
KB
145
146 // Gets the sash size
b3208e11 147 int GetSashSize() const;
c801d85f
KB
148
149 // Gets the border size
b3208e11 150 int GetBorderSize() const;
c801d85f
KB
151
152 // Set the sash position
4395fb21 153 void SetSashPosition(int position, bool redraw = true);
c801d85f
KB
154
155 // Gets the sash position
0d559d69 156 int GetSashPosition() const { return m_sashPosition; }
c801d85f
KB
157
158 // If this is zero, we can remove panes by dragging the sash.
ca39e409 159 void SetMinimumPaneSize(int min);
0d559d69
VZ
160 int GetMinimumPaneSize() const { return m_minimumPaneSize; }
161
3e58dcb9
VZ
162 // NB: the OnXXX() functions below are for backwards compatibility only,
163 // don't use them in new code but handle the events instead!
164
165 // called when the sash position is about to change, may return a new value
166 // for the sash or -1 to prevent the change from happening at all
167 virtual int OnSashPositionChanging(int newSashPosition);
168
0d559d69 169 // Called when the sash position is about to be changed, return
4395fb21 170 // false from here to prevent the change from taking place.
021e7626 171 // Repositions sash to minimum position if pane would be too small.
0d559d69 172 // newSashPosition here is always positive or zero.
3e58dcb9 173 virtual bool OnSashPositionChange(int newSashPosition);
c801d85f
KB
174
175 // If the sash is moved to an extreme position, a subwindow
176 // is removed from the splitter window, and the app is
177 // notified. The app should delete or hide the window.
3e58dcb9 178 virtual void OnUnsplit(wxWindow *removed);
c801d85f
KB
179
180 // Called when the sash is double-clicked.
181 // The default behaviour is to remove the sash if the
182 // minimum pane size is zero.
3e58dcb9 183 virtual void OnDoubleClickSash(int x, int y);
c801d85f
KB
184
185////////////////////////////////////////////////////////////////////////////
186// Implementation
187
188 // Paints the border and sash
189 void OnPaint(wxPaintEvent& event);
190
191 // Handles mouse events
192 void OnMouseEvent(wxMouseEvent& ev);
193
194 // Adjusts the panes
195 void OnSize(wxSizeEvent& event);
196
72195a0f 197 // In live mode, resize child windows in idle time
5180055b 198 void OnInternalIdle();
72195a0f 199
c801d85f 200 // Draws the sash
f6bcfd97 201 virtual void DrawSash(wxDC& dc);
c801d85f
KB
202
203 // Draws the sash tracker (for whilst moving the sash)
f6bcfd97 204 virtual void DrawSashTracker(int x, int y);
c801d85f
KB
205
206 // Tests for x, y over sash
b3208e11 207 virtual bool SashHitTest(int x, int y, int tolerance = 5);
c801d85f
KB
208
209 // Resizes subwindows
f6bcfd97 210 virtual void SizeWindows();
c801d85f 211
f6bcfd97
BP
212 void SetNeedUpdating(bool needUpdating) { m_needUpdating = needUpdating; }
213 bool GetNeedUpdating() const { return m_needUpdating ; }
214
53409666
SC
215#ifdef __WXMAC__
216 virtual bool MacClipGrandChildren() const { return true ; }
217#endif
0d559d69 218protected:
3e58dcb9 219 // event handlers
91ce04cf 220#if defined(__WXMSW__) || defined(__WXMAC__)
43b5058d 221 void OnSetCursor(wxSetCursorEvent& event);
3e58dcb9 222#endif // wxMSW
42e69d6b 223
4395fb21 224 // send the given event, return false if the event was processed and vetoed
3e58dcb9
VZ
225 // by the user code
226 inline bool DoSendEvent(wxSplitterEvent& event);
42e69d6b 227
8062a6ab 228protected:
6b55490a 229 // common part of all ctors
f6bcfd97 230 void Init();
2e8cc3e8
VZ
231
232 // common part of SplitVertically() and SplitHorizontally()
233 bool DoSplit(wxSplitMode mode,
234 wxWindow *window1, wxWindow *window2,
235 int sashPosition);
236
d76ac8ed 237 // adjusts sash position with respect to min. pane and window sizes
2e8cc3e8
VZ
238 int AdjustSashPosition(int sashPos) const;
239
240 // get either width or height depending on the split mode
241 int GetWindowSize() const;
74c57d1f
VZ
242
243 // convert the user specified sash position which may be > 0 (as is), < 0
244 // (specifying the size of the right pane) or 0 (use default) to the real
245 // position to be passed to DoSetSashPosition()
246 int ConvertSashPosition(int sashPos) const;
247
248 // set the real sash position, sashPos here must be positive
63ec9dbb 249 //
4395fb21 250 // returns true if the sash position has been changed, false otherwise
63ec9dbb
VZ
251 bool DoSetSashPosition(int sashPos);
252
253 // set the sash position and send an event about it having been changed
254 void SetSashPositionAndNotify(int sashPos);
f6bcfd97 255
af99040c
VZ
256 // callbacks executed when we detect that the mouse has entered or left
257 // the sash
258 virtual void OnEnterSash();
259 virtual void OnLeaveSash();
260
153b7996
VZ
261 // set the cursor appropriate for the current split mode
262 void SetResizeCursor();
263
af99040c
VZ
264 // redraw the splitter if its "hotness" changed if necessary
265 void RedrawIfHotSensitive(bool isHot);
266
2e8cc3e8 267 wxSplitMode m_splitMode;
c801d85f
KB
268 wxWindow* m_windowOne;
269 wxWindow* m_windowTwo;
270 int m_dragMode;
271 int m_oldX;
272 int m_oldY;
c801d85f 273 int m_sashPosition; // Number of pixels from left or top
ca39e409 274 int m_requestedSashPosition;
153b7996 275 int m_sashPositionCurrent; // while dragging
c801d85f
KB
276 int m_firstX;
277 int m_firstY;
278 int m_minimumPaneSize;
153b7996
VZ
279 wxCursor m_sashCursorWE;
280 wxCursor m_sashCursorNS;
b3208e11 281 wxPen *m_sashTrackerPen;
0d559d69 282
4395fb21 283 // when in live mode, set this to true to resize children in idle
af99040c
VZ
284 bool m_needUpdating:1;
285 bool m_permitUnsplitAlways:1;
286 bool m_isHot:1;
4395fb21 287 bool m_checkRequestedSashPosition:1;
af99040c 288
0d559d69 289private:
6b55490a
VZ
290 WX_DECLARE_CONTROL_CONTAINER();
291
0d559d69
VZ
292 DECLARE_DYNAMIC_CLASS(wxSplitterWindow)
293 DECLARE_EVENT_TABLE()
22f3361e 294 DECLARE_NO_COPY_CLASS(wxSplitterWindow)
c801d85f
KB
295};
296
42e69d6b
VZ
297// ----------------------------------------------------------------------------
298// event class and macros
299// ----------------------------------------------------------------------------
300
301// we reuse the same class for all splitter event types because this is the
302// usual wxWin convention, but the three event types have different kind of
303// data associated with them, so the accessors can be only used if the real
304// event type matches with the one for which the accessors make sense
3e58dcb9 305class WXDLLEXPORT wxSplitterEvent : public wxNotifyEvent
42e69d6b
VZ
306{
307public:
308 wxSplitterEvent(wxEventType type = wxEVT_NULL,
309 wxSplitterWindow *splitter = (wxSplitterWindow *)NULL)
3e58dcb9 310 : wxNotifyEvent(type)
42e69d6b
VZ
311 {
312 SetEventObject(splitter);
0656d2e6 313 if (splitter) m_id = splitter->GetId();
42e69d6b
VZ
314 }
315
316 // SASH_POS_CHANGED methods
317
318 // setting the sash position to -1 prevents the change from taking place at
319 // all
320 void SetSashPosition(int pos)
321 {
370938d9
UB
322 wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED
323 || GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING);
42e69d6b
VZ
324
325 m_data.pos = pos;
326 }
327
328 int GetSashPosition() const
329 {
370938d9
UB
330 wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED
331 || GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING);
42e69d6b
VZ
332
333 return m_data.pos;
334 }
335
336 // UNSPLIT event methods
337 wxWindow *GetWindowBeingRemoved() const
338 {
339 wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_UNSPLIT );
340
341 return m_data.win;
342 }
343
344 // DCLICK event methods
345 int GetX() const
346 {
347 wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_DOUBLECLICKED );
348
349 return m_data.pt.x;
350 }
351
352 int GetY() const
353 {
354 wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_DOUBLECLICKED );
355
356 return m_data.pt.y;
357 }
358
359private:
d5a07b9e 360 friend class WXDLLEXPORT wxSplitterWindow;
42e69d6b
VZ
361
362 // data for the different types of event
363 union
364 {
365 int pos; // position for SASH_POS_CHANGED event
366 wxWindow *win; // window being removed for UNSPLIT event
367 struct
368 {
369 int x, y;
370 } pt; // position of double click for DCLICK event
371 } m_data;
372
fc7a2a60 373 DECLARE_DYNAMIC_CLASS_NO_COPY(wxSplitterEvent)
42e69d6b
VZ
374};
375
376typedef void (wxEvtHandler::*wxSplitterEventFunction)(wxSplitterEvent&);
377
378#define EVT_SPLITTER_SASH_POS_CHANGED(id, fn) \
2e4df4bf 379 DECLARE_EVENT_TABLE_ENTRY( \
42e69d6b
VZ
380 wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED, \
381 id, \
ca65c044 382 wxID_ANY, \
3a818b15 383 (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ), \
42e69d6b 384 NULL \
82a5f02c 385 ),
42e69d6b 386
370938d9 387#define EVT_SPLITTER_SASH_POS_CHANGING(id, fn) \
2e4df4bf 388 DECLARE_EVENT_TABLE_ENTRY( \
370938d9
UB
389 wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING, \
390 id, \
ca65c044 391 wxID_ANY, \
3a818b15 392 (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ), \
370938d9 393 NULL \
82a5f02c 394 ),
370938d9
UB
395
396#define EVT_SPLITTER_DCLICK(id, fn) \
2e4df4bf 397 DECLARE_EVENT_TABLE_ENTRY( \
370938d9 398 wxEVT_COMMAND_SPLITTER_DOUBLECLICKED, \
42e69d6b 399 id, \
ca65c044 400 wxID_ANY, \
3a818b15 401 (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ), \
42e69d6b 402 NULL \
82a5f02c 403 ),
42e69d6b
VZ
404
405#define EVT_SPLITTER_UNSPLIT(id, fn) \
2e4df4bf 406 DECLARE_EVENT_TABLE_ENTRY( \
42e69d6b
VZ
407 wxEVT_COMMAND_SPLITTER_UNSPLIT, \
408 id, \
ca65c044 409 wxID_ANY, \
3a818b15 410 (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ), \
42e69d6b 411 NULL \
82a5f02c 412 ),
42e69d6b 413
0d559d69 414#endif // __SPLITTERH_G__