/////////////////////////////////////////////////////////////////////////////
-// Name: splitter.h
+// Name: wx/splitter.h
// Purpose: wxSplitterWindow class
// Author: Julian Smart
// Modified by:
#endif
#include "wx/window.h" // base class declaration
+#include "wx/containr.h" // wxControlContainer
class WXDLLEXPORT wxSplitterEvent;
// splitter constants
// ---------------------------------------------------------------------------
-enum
+enum wxSplitMode
{
wxSPLIT_HORIZONTAL = 1,
wxSPLIT_VERTICAL
wxSPLIT_DRAG_LEFT_DOWN
};
-class WXDLLEXPORT wxControlContainer;
-
// ---------------------------------------------------------------------------
// wxSplitterWindow maintains one or two panes, with
// an optional vertical or horizontal split which
// Public API
// Default constructor
- wxSplitterWindow() : m_container(this)
+ wxSplitterWindow()
{
Init();
}
const wxSize& size = wxDefaultSize,
long style = wxSP_3D,
const wxString& name = "splitter")
- : m_container(this)
{
Init();
Create(parent, id, pos, size, style, name);
wxWindow *GetWindow2() const { return m_windowTwo; }
// Sets the split mode
- void SetSplitMode(int mode) { m_splitMode = mode; }
+ void SetSplitMode(int mode)
+ {
+ wxASSERT_MSG( mode == wxSPLIT_VERTICAL || mode == wxSPLIT_HORIZONTAL,
+ _T("invalid split mode") );
+
+ m_splitMode = (wxSplitMode)mode;
+ }
// Gets the split mode
- int GetSplitMode() const { return m_splitMode; };
+ wxSplitMode GetSplitMode() const { return m_splitMode; };
// Initialize with one window
void Initialize(wxWindow *window);
// absolute value rather than the size of left/upper pane.
virtual bool SplitVertically(wxWindow *window1,
wxWindow *window2,
- int sashPosition = 0);
+ int sashPosition = 0)
+ { return DoSplit(wxSPLIT_VERTICAL, window1, window2, sashPosition); }
virtual bool SplitHorizontally(wxWindow *window1,
wxWindow *window2,
- int sashPosition = 0);
+ int sashPosition = 0)
+ { return DoSplit(wxSPLIT_HORIZONTAL, window1, window2, sashPosition); }
// Removes the specified (or second) window from the view
// Doesn't actually delete the window.
int GetSashPosition() const { return m_sashPosition; }
// If this is zero, we can remove panes by dragging the sash.
- void SetMinimumPaneSize(int min) { m_minimumPaneSize = min; }
+ void SetMinimumPaneSize(int min);
int GetMinimumPaneSize() const { return m_minimumPaneSize; }
+ // NB: the OnXXX() functions below are for backwards compatibility only,
+ // don't use them in new code but handle the events instead!
+
+ // called when the sash position is about to change, may return a new value
+ // for the sash or -1 to prevent the change from happening at all
+ virtual int OnSashPositionChanging(int newSashPosition);
+
// Called when the sash position is about to be changed, return
// FALSE from here to prevent the change from taking place.
// Repositions sash to minimum position if pane would be too small.
// newSashPosition here is always positive or zero.
- virtual bool OnSashPositionChange(int WXUNUSED(newSashPosition))
- { return TRUE; }
+ virtual bool OnSashPositionChange(int newSashPosition);
// If the sash is moved to an extreme position, a subwindow
// is removed from the splitter window, and the app is
// notified. The app should delete or hide the window.
- virtual void OnUnsplit(wxWindow *WXUNUSED(removed)) { }
+ virtual void OnUnsplit(wxWindow *removed);
// Called when the sash is double-clicked.
// The default behaviour is to remove the sash if the
// minimum pane size is zero.
- virtual void OnDoubleClickSash(int WXUNUSED(x), int WXUNUSED(y)) { }
+ virtual void OnDoubleClickSash(int x, int y);
////////////////////////////////////////////////////////////////////////////
// Implementation
bool GetNeedUpdating() const { return m_needUpdating ; }
protected:
- // our event handlers
- void OnSashPosChanged(wxSplitterEvent& event);
- void OnSashPosChanging(wxSplitterEvent& event);
- void OnDoubleClick(wxSplitterEvent& event);
- void OnUnsplitEvent(wxSplitterEvent& event);
+ // event handlers
+#ifdef __WXMSW__
void OnSetCursor(wxSetCursorEvent& event);
+#endif // wxMSW
- void SendUnsplitEvent(wxWindow *winRemoved);
+ // send the given event, return FALSE if the event was processed and vetoed
+ // by the user code
+ inline bool DoSendEvent(wxSplitterEvent& event);
protected:
// common part of all ctors
void Init();
- int m_splitMode;
+ // common part of SplitVertically() and SplitHorizontally()
+ bool DoSplit(wxSplitMode mode,
+ wxWindow *window1, wxWindow *window2,
+ int sashPosition);
+
+ // adjusts sash position with respect to min. pane and window sizes
+ int AdjustSashPosition(int sashPos) const;
+
+ // get either width or height depending on the split mode
+ int GetWindowSize() const;
+
+ // convert the user specified sash position which may be > 0 (as is), < 0
+ // (specifying the size of the right pane) or 0 (use default) to the real
+ // position to be passed to DoSetSashPosition()
+ int ConvertSashPosition(int sashPos) const;
+
+ // set the real sash position, sashPos here must be positive
+ void DoSetSashPosition(int sashPos);
+
+ // set the cursor appropriate for the current split mode
+ void SetResizeCursor();
+
+ wxSplitMode m_splitMode;
bool m_permitUnsplitAlways;
bool m_needUpdating; // when in live mode, set this to TRUE to resize children in idle
wxWindow* m_windowOne;
int m_borderSize;
int m_sashSize; // Sash width or height
int m_sashPosition; // Number of pixels from left or top
+ int m_requestedSashPosition;
+ int m_sashPositionCurrent; // while dragging
int m_firstX;
int m_firstY;
int m_minimumPaneSize;
- wxCursor* m_sashCursorWE;
- wxCursor* m_sashCursorNS;
+ wxCursor m_sashCursorWE;
+ wxCursor m_sashCursorNS;
wxPen* m_sashTrackerPen;
wxPen* m_lightShadowPen;
wxPen* m_mediumShadowPen;
// usual wxWin convention, but the three event types have different kind of
// data associated with them, so the accessors can be only used if the real
// event type matches with the one for which the accessors make sense
-class WXDLLEXPORT wxSplitterEvent : public wxCommandEvent
+class WXDLLEXPORT wxSplitterEvent : public wxNotifyEvent
{
public:
wxSplitterEvent(wxEventType type = wxEVT_NULL,
wxSplitterWindow *splitter = (wxSplitterWindow *)NULL)
- : wxCommandEvent(type)
+ : wxNotifyEvent(type)
{
SetEventObject(splitter);
if (splitter) m_id = splitter->GetId();
projects / wxWidgets.git / blobdiff