]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/generic/splitter.h
Applied patch [ 619705 ] Fixes wxApp::GetComCtl32Version
[wxWidgets.git] / include / wx / generic / splitter.h
index 94e371330020e0849723950caf4a7dc0b92f46bd..c11307d69afd4900880baf6bf575ac4663ea9eb3 100644 (file)
@@ -1,18 +1,18 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////
-// Name:        splitter.h
+// Name:        wx/splitter.h
 // Purpose:     wxSplitterWindow class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Purpose:     wxSplitterWindow class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:     wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __SPLITTERH_G__
 #define __SPLITTERH_G__
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __SPLITTERH_G__
 #define __SPLITTERH_G__
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(__APPLE__)
     #pragma interface "splitter.h"
 #endif
 
     #pragma interface "splitter.h"
 #endif
 
@@ -71,7 +71,7 @@ public:
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      long style = wxSP_3D,
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      long style = wxSP_3D,
-                     const wxString& name = "splitter")
+                     const wxString& name = wxT("splitter"))
     {
         Init();
         Create(parent, id, pos, size, style, name);
     {
         Init();
         Create(parent, id, pos, size, style, name);
@@ -83,7 +83,7 @@ public:
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      long style = wxSP_3D,
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      long style = wxSP_3D,
-                     const wxString& name = "splitter");
+                     const wxString& name = wxT("splitter"));
 
     // Gets the only or left/top pane
     wxWindow *GetWindow1() const { return m_windowOne; }
 
     // Gets the only or left/top pane
     wxWindow *GetWindow1() const { return m_windowOne; }
@@ -151,25 +151,31 @@ public:
     int GetSashPosition() const { return m_sashPosition; }
 
     // If this is zero, we can remove panes by dragging the sash.
     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; }
 
     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.
     // 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.
 
     // 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.
 
     // 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
 
 ////////////////////////////////////////////////////////////////////////////
 // Implementation
@@ -208,14 +214,14 @@ public:
     bool GetNeedUpdating() const { return m_needUpdating ; }
 
 protected:
     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
+#if defined(__WXMSW__) || defined(__WXMAC__)
     void OnSetCursor(wxSetCursorEvent& event);
     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
 
 protected:
     // common part of all ctors
@@ -232,6 +238,22 @@ protected:
     // get either width or height depending on the split mode
     int GetWindowSize() 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
+    //
+    // returns TRUE if the sash position has been changed, FALSE otherwise
+    bool DoSetSashPosition(int sashPos);
+
+    // set the sash position and send an event about it having been changed
+    void SetSashPositionAndNotify(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
     wxSplitMode m_splitMode;
     bool        m_permitUnsplitAlways;
     bool        m_needUpdating; // when in live mode, set this to TRUE to resize children in idle
@@ -243,11 +265,13 @@ protected:
     int         m_borderSize;
     int         m_sashSize;     // Sash width or height
     int         m_sashPosition; // Number of pixels from left or top
     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;
     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;
     wxPen*      m_sashTrackerPen;
     wxPen*      m_lightShadowPen;
     wxPen*      m_mediumShadowPen;
@@ -261,6 +285,7 @@ private:
 
     DECLARE_DYNAMIC_CLASS(wxSplitterWindow)
     DECLARE_EVENT_TABLE()
 
     DECLARE_DYNAMIC_CLASS(wxSplitterWindow)
     DECLARE_EVENT_TABLE()
+    DECLARE_NO_COPY_CLASS(wxSplitterWindow)
 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------
@@ -271,12 +296,12 @@ private:
 // 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
 // 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)
 {
 public:
     wxSplitterEvent(wxEventType type = wxEVT_NULL,
                     wxSplitterWindow *splitter = (wxSplitterWindow *)NULL)
-        : wxCommandEvent(type)
+        : wxNotifyEvent(type)
     {
         SetEventObject(splitter);
         if (splitter) m_id = splitter->GetId();
     {
         SetEventObject(splitter);
         if (splitter) m_id = splitter->GetId();