1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxSplitterWindow class
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef __SPLITTERH_G__
13 #define __SPLITTERH_G__
15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
16 #pragma interface "splitter.h"
19 #include "wx/window.h" // base class declaration
20 #include "wx/containr.h" // wxControlContainer
22 class WXDLLEXPORT wxSplitterEvent
;
24 // ---------------------------------------------------------------------------
26 // ---------------------------------------------------------------------------
30 wxSPLIT_HORIZONTAL
= 1,
37 wxSPLIT_DRAG_DRAGGING
,
38 wxSPLIT_DRAG_LEFT_DOWN
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 // ---------------------------------------------------------------------------
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
52 // 2) for wxWidgets 2.0, we must find a way to set the WS_CLIPCHILDREN style
53 // to prevent flickering. (WS_CLIPCHILDREN doesn't work in all cases so can't be
56 class WXDLLEXPORT wxSplitterWindow
: public wxWindow
60 ////////////////////////////////////////////////////////////////////////////
63 // Default constructor
70 wxSplitterWindow(wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
71 const wxPoint
& pos
= wxDefaultPosition
,
72 const wxSize
& size
= wxDefaultSize
,
74 const wxString
& name
= wxT("splitter"))
77 Create(parent
, id
, pos
, size
, style
, name
);
80 virtual ~wxSplitterWindow();
82 bool Create(wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
83 const wxPoint
& pos
= wxDefaultPosition
,
84 const wxSize
& size
= wxDefaultSize
,
86 const wxString
& name
= wxT("splitter"));
88 // Gets the only or left/top pane
89 wxWindow
*GetWindow1() const { return m_windowOne
; }
91 // Gets the right/bottom pane
92 wxWindow
*GetWindow2() const { return m_windowTwo
; }
94 // Sets the split mode
95 void SetSplitMode(int mode
)
97 wxASSERT_MSG( mode
== wxSPLIT_VERTICAL
|| mode
== wxSPLIT_HORIZONTAL
,
98 _T("invalid split mode") );
100 m_splitMode
= (wxSplitMode
)mode
;
103 // Gets the split mode
104 wxSplitMode
GetSplitMode() const { return m_splitMode
; };
106 // Initialize with one window
107 void Initialize(wxWindow
*window
);
109 // Associates the given window with window 2, drawing the appropriate sash
110 // and changing the split mode.
111 // Does nothing and returns false if the window is already split.
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.
115 virtual bool SplitVertically(wxWindow
*window1
,
117 int sashPosition
= 0)
118 { return DoSplit(wxSPLIT_VERTICAL
, window1
, window2
, sashPosition
); }
119 virtual bool SplitHorizontally(wxWindow
*window1
,
121 int sashPosition
= 0)
122 { return DoSplit(wxSPLIT_HORIZONTAL
, window1
, window2
, sashPosition
); }
124 // Removes the specified (or second) window from the view
125 // Doesn't actually delete the window.
126 bool Unsplit(wxWindow
*toRemove
= (wxWindow
*) NULL
);
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
);
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.
137 // Is the window split?
138 bool IsSplit() const { return (m_windowTwo
!= NULL
); }
140 // Sets the sash size
141 void SetSashSize(int WXUNUSED(width
)) { }
143 // Sets the border size
144 void SetBorderSize(int WXUNUSED(width
)) { }
146 // Gets the sash size
147 int GetSashSize() const;
149 // Gets the border size
150 int GetBorderSize() const;
152 // Set the sash position
153 void SetSashPosition(int position
, bool redraw
= true);
155 // Gets the sash position
156 int GetSashPosition() const { return m_sashPosition
; }
158 // If this is zero, we can remove panes by dragging the sash.
159 void SetMinimumPaneSize(int min
);
160 int GetMinimumPaneSize() const { return m_minimumPaneSize
; }
162 // NB: the OnXXX() functions below are for backwards compatibility only,
163 // don't use them in new code but handle the events instead!
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
);
169 // Called when the sash position is about to be changed, return
170 // false from here to prevent the change from taking place.
171 // Repositions sash to minimum position if pane would be too small.
172 // newSashPosition here is always positive or zero.
173 virtual bool OnSashPositionChange(int newSashPosition
);
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.
178 virtual void OnUnsplit(wxWindow
*removed
);
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.
183 virtual void OnDoubleClickSash(int x
, int y
);
185 ////////////////////////////////////////////////////////////////////////////
188 // Paints the border and sash
189 void OnPaint(wxPaintEvent
& event
);
191 // Handles mouse events
192 void OnMouseEvent(wxMouseEvent
& ev
);
195 void OnSize(wxSizeEvent
& event
);
197 // In live mode, resize child windows in idle time
198 void OnInternalIdle();
201 virtual void DrawSash(wxDC
& dc
);
203 // Draws the sash tracker (for whilst moving the sash)
204 virtual void DrawSashTracker(int x
, int y
);
206 // Tests for x, y over sash
207 virtual bool SashHitTest(int x
, int y
, int tolerance
= 5);
209 // Resizes subwindows
210 virtual void SizeWindows();
212 void SetNeedUpdating(bool needUpdating
) { m_needUpdating
= needUpdating
; }
213 bool GetNeedUpdating() const { return m_needUpdating
; }
217 #if defined(__WXMSW__) || defined(__WXMAC__)
218 void OnSetCursor(wxSetCursorEvent
& event
);
221 // send the given event, return false if the event was processed and vetoed
223 inline bool DoSendEvent(wxSplitterEvent
& event
);
226 // common part of all ctors
229 // common part of SplitVertically() and SplitHorizontally()
230 bool DoSplit(wxSplitMode mode
,
231 wxWindow
*window1
, wxWindow
*window2
,
234 // adjusts sash position with respect to min. pane and window sizes
235 int AdjustSashPosition(int sashPos
) const;
237 // get either width or height depending on the split mode
238 int GetWindowSize() const;
240 // convert the user specified sash position which may be > 0 (as is), < 0
241 // (specifying the size of the right pane) or 0 (use default) to the real
242 // position to be passed to DoSetSashPosition()
243 int ConvertSashPosition(int sashPos
) const;
245 // set the real sash position, sashPos here must be positive
247 // returns true if the sash position has been changed, false otherwise
248 bool DoSetSashPosition(int sashPos
);
250 // set the sash position and send an event about it having been changed
251 void SetSashPositionAndNotify(int sashPos
);
253 // callbacks executed when we detect that the mouse has entered or left
255 virtual void OnEnterSash();
256 virtual void OnLeaveSash();
258 // set the cursor appropriate for the current split mode
259 void SetResizeCursor();
261 // redraw the splitter if its "hotness" changed if necessary
262 void RedrawIfHotSensitive(bool isHot
);
264 wxSplitMode m_splitMode
;
265 wxWindow
* m_windowOne
;
266 wxWindow
* m_windowTwo
;
270 int m_sashPosition
; // Number of pixels from left or top
271 int m_requestedSashPosition
;
272 int m_sashPositionCurrent
; // while dragging
275 int m_minimumPaneSize
;
276 wxCursor m_sashCursorWE
;
277 wxCursor m_sashCursorNS
;
278 wxPen
*m_sashTrackerPen
;
280 // when in live mode, set this to true to resize children in idle
281 bool m_needUpdating
:1;
282 bool m_permitUnsplitAlways
:1;
284 bool m_checkRequestedSashPosition
:1;
287 WX_DECLARE_CONTROL_CONTAINER();
289 DECLARE_DYNAMIC_CLASS(wxSplitterWindow
)
290 DECLARE_EVENT_TABLE()
291 DECLARE_NO_COPY_CLASS(wxSplitterWindow
)
294 // ----------------------------------------------------------------------------
295 // event class and macros
296 // ----------------------------------------------------------------------------
298 // we reuse the same class for all splitter event types because this is the
299 // usual wxWin convention, but the three event types have different kind of
300 // data associated with them, so the accessors can be only used if the real
301 // event type matches with the one for which the accessors make sense
302 class WXDLLEXPORT wxSplitterEvent
: public wxNotifyEvent
305 wxSplitterEvent(wxEventType type
= wxEVT_NULL
,
306 wxSplitterWindow
*splitter
= (wxSplitterWindow
*)NULL
)
307 : wxNotifyEvent(type
)
309 SetEventObject(splitter
);
310 if (splitter
) m_id
= splitter
->GetId();
313 // SASH_POS_CHANGED methods
315 // setting the sash position to -1 prevents the change from taking place at
317 void SetSashPosition(int pos
)
319 wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED
320 || GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING
);
325 int GetSashPosition() const
327 wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED
328 || GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING
);
333 // UNSPLIT event methods
334 wxWindow
*GetWindowBeingRemoved() const
336 wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_UNSPLIT
);
341 // DCLICK event methods
344 wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_DOUBLECLICKED
);
351 wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_DOUBLECLICKED
);
357 friend class WXDLLEXPORT wxSplitterWindow
;
359 // data for the different types of event
362 int pos
; // position for SASH_POS_CHANGED event
363 wxWindow
*win
; // window being removed for UNSPLIT event
367 } pt
; // position of double click for DCLICK event
370 DECLARE_DYNAMIC_CLASS_NO_COPY(wxSplitterEvent
)
373 typedef void (wxEvtHandler::*wxSplitterEventFunction
)(wxSplitterEvent
&);
375 #define EVT_SPLITTER_SASH_POS_CHANGED(id, fn) \
376 DECLARE_EVENT_TABLE_ENTRY( \
377 wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED, \
380 (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ), \
384 #define EVT_SPLITTER_SASH_POS_CHANGING(id, fn) \
385 DECLARE_EVENT_TABLE_ENTRY( \
386 wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING, \
389 (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ), \
393 #define EVT_SPLITTER_DCLICK(id, fn) \
394 DECLARE_EVENT_TABLE_ENTRY( \
395 wxEVT_COMMAND_SPLITTER_DOUBLECLICKED, \
398 (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ), \
402 #define EVT_SPLITTER_UNSPLIT(id, fn) \
403 DECLARE_EVENT_TABLE_ENTRY( \
404 wxEVT_COMMAND_SPLITTER_UNSPLIT, \
407 (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ), \
411 #endif // __SPLITTERH_G__