X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/565215b26a117edbbbb52d62c79ef0fc38d81c39..dad5f99acb6b3400ff73562c03db2f3f21b658cd:/include/wx/generic/splitter.h diff --git a/include/wx/generic/splitter.h b/include/wx/generic/splitter.h index 2502c0222e..09fa572b01 100644 --- a/include/wx/generic/splitter.h +++ b/include/wx/generic/splitter.h @@ -6,34 +6,42 @@ // Created: 01/02/97 // RCS-ID: $Id$ // Copyright: (c) Julian Smart and Markus Holzem -// Licence: wxWindows license +// Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// #ifndef __SPLITTERH_G__ #define __SPLITTERH_G__ #ifdef __GNUG__ -#pragma interface "splitter.h" + #pragma interface "splitter.h" #endif -#include "wx/defs.h" -#include "wx/window.h" -#include "wx/string.h" +#include "wx/window.h" // base class declaration -#define WXSPLITTER_VERSION 1.0 +class WXDLLEXPORT wxSplitterEvent; -#define wxSPLIT_HORIZONTAL 1 -#define wxSPLIT_VERTICAL 2 +// --------------------------------------------------------------------------- +// splitter constants +// --------------------------------------------------------------------------- -#define wxSPLIT_DRAG_NONE 0 -#define wxSPLIT_DRAG_DRAGGING 1 -#define wxSPLIT_DRAG_LEFT_DOWN 2 +enum +{ + wxSPLIT_HORIZONTAL = 1, + wxSPLIT_VERTICAL +}; + +enum +{ + wxSPLIT_DRAG_NONE, + wxSPLIT_DRAG_DRAGGING, + wxSPLIT_DRAG_LEFT_DOWN +}; -/* - * wxSplitterWindow maintains one or two panes, with - * an optional vertical or horizontal split which - * can be used with the mouse or programmatically. - */ +// --------------------------------------------------------------------------- +// wxSplitterWindow maintains one or two panes, with +// an optional vertical or horizontal split which +// can be used with the mouse or programmatically. +// --------------------------------------------------------------------------- // TODO: // 1) Perhaps make the borders sensitive to dragging in order to create a split. @@ -46,32 +54,47 @@ class WXDLLEXPORT wxSplitterWindow: public wxWindow { - DECLARE_DYNAMIC_CLASS(wxSplitterWindow) - - public: +public: //////////////////////////////////////////////////////////////////////////// // Public API // Default constructor - wxSplitterWindow(void); + wxSplitterWindow() + { + Init(); + } // Normal constructor - wxSplitterWindow(wxWindow *parent, const wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, const long style = wxSP_3D|wxCLIP_CHILDREN, const wxString& name = "splitter"); - ~wxSplitterWindow(void); + wxSplitterWindow(wxWindow *parent, wxWindowID id = -1, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + long style = wxSP_3D, + const wxString& name = "splitter") + { + Init(); + Create(parent, id, pos, size, style, name); + } + + ~wxSplitterWindow(); + + bool Create(wxWindow *parent, wxWindowID id = -1, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + long style = wxSP_3D, + const wxString& name = "splitter"); // Gets the only or left/top pane - inline wxWindow *GetWindow1(void) { return m_windowOne; } + wxWindow *GetWindow1() const { return m_windowOne; } // Gets the right/bottom pane - inline wxWindow *GetWindow2(void) { return m_windowTwo; } + wxWindow *GetWindow2() const { return m_windowTwo; } // Sets the split mode - inline void SetSplitMode(const int mode) { m_splitMode = mode; } + void SetSplitMode(int mode) { m_splitMode = mode; } // Gets the split mode - inline int GetSplitMode(void) const { return m_splitMode; }; + int GetSplitMode() const { return m_splitMode; }; // Initialize with one window void Initialize(wxWindow *window); @@ -79,48 +102,65 @@ class WXDLLEXPORT wxSplitterWindow: public wxWindow // Associates the given window with window 2, drawing the appropriate sash // and changing the split mode. // Does nothing and returns FALSE if the window is already split. - // A sashPosition of -1 means choose a default sash position. - bool SplitVertically(wxWindow *window1, wxWindow *window2, const int sashPosition = -1); - bool SplitHorizontally(wxWindow *window1, wxWindow *window2, const int sashPosition = -1); + // A sashPosition of 0 means choose a default sash position, + // negative sashPosition specifies the size of right/lower pane as it's + // absolute value rather than the size of left/upper pane. + virtual bool SplitVertically(wxWindow *window1, + wxWindow *window2, + int sashPosition = 0); + virtual bool SplitHorizontally(wxWindow *window1, + wxWindow *window2, + int sashPosition = 0); // Removes the specified (or second) window from the view // Doesn't actually delete the window. - bool Unsplit(wxWindow *toRemove = NULL); + bool Unsplit(wxWindow *toRemove = (wxWindow *) NULL); + + // Replaces one of the windows with another one (neither old nor new + // parameter should be NULL) + bool ReplaceWindow(wxWindow *winOld, wxWindow *winNew); // Is the window split? - inline bool IsSplit(void) const { return (m_windowTwo != NULL); } + bool IsSplit() const { return (m_windowTwo != NULL); } // Sets the sash size - inline void SetSashSize(const int width) { m_sashSize = width; } + void SetSashSize(int width) { m_sashSize = width; } // Sets the border size - inline void SetBorderSize(const int width) { m_borderSize = width; } + void SetBorderSize(int width) { m_borderSize = width; } // Gets the sash size - inline int GetSashSize(void) const { return m_sashSize; } + int GetSashSize() const { return m_sashSize; } // Gets the border size - inline int GetBorderSize(void) const { return m_borderSize; } + int GetBorderSize() const { return m_borderSize; } // Set the sash position - void SetSashPosition(const int position, const bool redaw = TRUE); + void SetSashPosition(int position, bool redraw = TRUE); // Gets the sash position - inline int GetSashPosition(void) const { return m_sashPosition; } + int GetSashPosition() const { return m_sashPosition; } // If this is zero, we can remove panes by dragging the sash. - inline void SetMinimumPaneSize(const int min) { m_minimumPaneSize = min; } - inline int GetMinimumPaneSize(void) const { return m_minimumPaneSize; } + void SetMinimumPaneSize(int min) { m_minimumPaneSize = min; } + int GetMinimumPaneSize() const { return m_minimumPaneSize; } + + // 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; } // 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 *removed) { removed->Show(FALSE); } + virtual void OnUnsplit(wxWindow *WXUNUSED(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 x, int y); + virtual void OnDoubleClickSash(int WXUNUSED(x), int WXUNUSED(y)) { } //////////////////////////////////////////////////////////////////////////// // Implementation @@ -134,26 +174,47 @@ class WXDLLEXPORT wxSplitterWindow: public wxWindow // Adjusts the panes void OnSize(wxSizeEvent& event); + // In live mode, resize child windows in idle time + void OnIdle(wxIdleEvent& event); + // Draws borders - void DrawBorders(wxDC& dc); + virtual void DrawBorders(wxDC& dc); // Draws the sash - void DrawSash(wxDC& dc); + virtual void DrawSash(wxDC& dc); // Draws the sash tracker (for whilst moving the sash) - void DrawSashTracker(const int x, const int y); + virtual void DrawSashTracker(int x, int y); // Tests for x, y over sash - bool SashHitTest(const int x, const int y, const int tolerance = 2); + virtual bool SashHitTest(int x, int y, int tolerance = 2); // Resizes subwindows - void SizeWindows(void); + virtual void SizeWindows(); // Initialize colours - void InitColours(void); + void InitColours(); + + void SetNeedUpdating(bool needUpdating) { m_needUpdating = needUpdating; } + 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); + void OnSetCursor(wxSetCursorEvent& event); + + void SendUnsplitEvent(wxWindow *winRemoved); + +protected: + void Init(); + - protected: int m_splitMode; + bool m_permitUnsplitAlways; + bool m_needUpdating; // when in live mode, set this to TRUE to resize children in idle wxWindow* m_windowOne; wxWindow* m_windowTwo; int m_dragMode; @@ -174,7 +235,127 @@ class WXDLLEXPORT wxSplitterWindow: public wxWindow wxPen* m_hilightPen; wxBrush* m_faceBrush; wxPen* m_facePen; -DECLARE_EVENT_TABLE() + +private: + DECLARE_DYNAMIC_CLASS(wxSplitterWindow) + DECLARE_EVENT_TABLE() }; -#endif +// ---------------------------------------------------------------------------- +// event class and macros +// ---------------------------------------------------------------------------- + +// we reuse the same class for all splitter event types because this is the +// 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 +{ +public: + wxSplitterEvent(wxEventType type = wxEVT_NULL, + wxSplitterWindow *splitter = (wxSplitterWindow *)NULL) + : wxCommandEvent(type) + { + SetEventObject(splitter); + if (splitter) m_id = splitter->GetId(); + } + + // SASH_POS_CHANGED methods + + // setting the sash position to -1 prevents the change from taking place at + // all + void SetSashPosition(int pos) + { + wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED + || GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING); + + m_data.pos = pos; + } + + int GetSashPosition() const + { + wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED + || GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING); + + return m_data.pos; + } + + // UNSPLIT event methods + wxWindow *GetWindowBeingRemoved() const + { + wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_UNSPLIT ); + + return m_data.win; + } + + // DCLICK event methods + int GetX() const + { + wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_DOUBLECLICKED ); + + return m_data.pt.x; + } + + int GetY() const + { + wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_DOUBLECLICKED ); + + return m_data.pt.y; + } + +private: + friend class WXDLLEXPORT wxSplitterWindow; + + // data for the different types of event + union + { + int pos; // position for SASH_POS_CHANGED event + wxWindow *win; // window being removed for UNSPLIT event + struct + { + int x, y; + } pt; // position of double click for DCLICK event + } m_data; + + DECLARE_DYNAMIC_CLASS(wxSplitterEvent) +}; + +typedef void (wxEvtHandler::*wxSplitterEventFunction)(wxSplitterEvent&); + +#define EVT_SPLITTER_SASH_POS_CHANGED(id, fn) \ + DECLARE_EVENT_TABLE_ENTRY( \ + wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED, \ + id, \ + -1, \ + (wxObjectEventFunction)(wxEventFunction)(wxSplitterEventFunction) &fn, \ + NULL \ + ), + +#define EVT_SPLITTER_SASH_POS_CHANGING(id, fn) \ + DECLARE_EVENT_TABLE_ENTRY( \ + wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING, \ + id, \ + -1, \ + (wxObjectEventFunction)(wxEventFunction)(wxSplitterEventFunction) &fn, \ + NULL \ + ), + +#define EVT_SPLITTER_DCLICK(id, fn) \ + DECLARE_EVENT_TABLE_ENTRY( \ + wxEVT_COMMAND_SPLITTER_DOUBLECLICKED, \ + id, \ + -1, \ + (wxObjectEventFunction)(wxEventFunction)(wxSplitterEventFunction) &fn, \ + NULL \ + ), + +#define EVT_SPLITTER_UNSPLIT(id, fn) \ + DECLARE_EVENT_TABLE_ENTRY( \ + wxEVT_COMMAND_SPLITTER_UNSPLIT, \ + id, \ + -1, \ + (wxObjectEventFunction)(wxEventFunction)(wxSplitterEventFunction) &fn, \ + NULL \ + ), + +#endif // __SPLITTERH_G__