Added wxEVT_SCROLL[WIN]_THUMBRELEASE

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@5965 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

include/wx/event.h

@@ -120,6 +120,7 @@ extern const wxEventType wxEVT_SCROLL_LINEDOWN;
 extern const wxEventType wxEVT_SCROLL_PAGEUP;
 extern const wxEventType wxEVT_SCROLL_PAGEDOWN;
 extern const wxEventType wxEVT_SCROLL_THUMBTRACK;
+extern const wxEventType wxEVT_SCROLL_THUMBRELEASE;
 
  /*
   * Scroll events from wxWindow
@@ -131,6 +132,7 @@ extern const wxEventType wxEVT_SCROLLWIN_LINEDOWN;
 extern const wxEventType wxEVT_SCROLLWIN_PAGEUP;
 extern const wxEventType wxEVT_SCROLLWIN_PAGEDOWN;
 extern const wxEventType wxEVT_SCROLLWIN_THUMBTRACK;
+extern const wxEventType wxEVT_SCROLLWIN_THUMBRELEASE;
 
  /*
   * System events
@@ -356,6 +358,7 @@ const wxEventType wxEVT_SCROLL_LINEDOWN =                   wxEVT_FIRST + 303;
 const wxEventType wxEVT_SCROLL_PAGEUP =                     wxEVT_FIRST + 304;
 const wxEventType wxEVT_SCROLL_PAGEDOWN =                   wxEVT_FIRST + 305;
 const wxEventType wxEVT_SCROLL_THUMBTRACK =                 wxEVT_FIRST + 306;
+const wxEventType wxEVT_SCROLL_THUMBRELEASE =               wxEVT_FIRST + 307;
 
  /*
   * Scroll events from wxWindow
@@ -367,6 +370,7 @@ const wxEventType wxEVT_SCROLLWIN_LINEDOWN =                wxEVT_FIRST + 323;
 const wxEventType wxEVT_SCROLLWIN_PAGEUP =                  wxEVT_FIRST + 324;
 const wxEventType wxEVT_SCROLLWIN_PAGEDOWN =                wxEVT_FIRST + 325;
 const wxEventType wxEVT_SCROLLWIN_THUMBTRACK =              wxEVT_FIRST + 326;
+const wxEventType wxEVT_SCROLLWIN_THUMBRELEASE =            wxEVT_FIRST + 327;
 
  /*
   * System events
@@ -726,6 +730,7 @@ private:
  wxEVT_SCROLL_PAGEUP
  wxEVT_SCROLL_PAGEDOWN
  wxEVT_SCROLL_THUMBTRACK
+ wxEVT_SCROLL_THUMBRELEASE
 */
 
 class WXDLLEXPORT wxScrollEvent : public wxCommandEvent
@@ -744,14 +749,8 @@ public:
 
     int GetOrientation() const { return (int) m_extraLong ; }
     int GetPosition() const { return m_commandInt ; }
-    bool IsScrolling() const { return m_isScrolling; }
     void SetOrientation(int orient) { m_extraLong = (long) orient; }
     void SetPosition(int pos) { m_commandInt = pos; }
-    void SetScrolling(bool isScrolling) { m_isScrolling = isScrolling; }
-
-    void CopyObject(wxObject& obj) const;
-public:
-    bool m_isScrolling;
 };
 
 // ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
@@ -764,6 +763,7 @@ public:
  wxEVT_SCROLLWIN_PAGEUP
  wxEVT_SCROLLWIN_PAGEDOWN
  wxEVT_SCROLLWIN_THUMBTRACK
+ wxEVT_SCROLLWIN_THUMBRELEASE
 */
 
 class WXDLLEXPORT wxScrollWinEvent : public wxEvent
@@ -781,16 +781,13 @@ public:
 
     int GetOrientation() const { return (int) m_extraLong ; }
     int GetPosition() const { return m_commandInt ; }
-    bool IsScrolling() const { return m_isScrolling; }
     void SetOrientation(int orient) { m_extraLong = (long) orient; }
     void SetPosition(int pos) { m_commandInt = pos; }
-    void SetScrolling(bool isScrolling) { m_isScrolling = isScrolling; }
 
     void CopyObject(wxObject& object_dest) const;
 public:
     int               m_commandInt;    // Additional information
     long              m_extraLong;
-    bool              m_isScrolling;
 };
 
 // Mouse event class
@@ -1893,7 +1890,8 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
   { wxEVT_SCROLLWIN_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\
   { wxEVT_SCROLLWIN_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\
   { wxEVT_SCROLLWIN_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\
-  { wxEVT_SCROLLWIN_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
+  { wxEVT_SCROLLWIN_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\
+  { wxEVT_SCROLLWIN_THUMBRELEASE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
 
 #define EVT_SCROLLWIN_TOP(func) { wxEVT_SCROLLWIN_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
 #define EVT_SCROLLWIN_BOTTOM(func) { wxEVT_SCROLLWIN_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
@@ -1902,6 +1900,7 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
 #define EVT_SCROLLWIN_PAGEUP(func) { wxEVT_SCROLLWIN_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
 #define EVT_SCROLLWIN_PAGEDOWN(func) { wxEVT_SCROLLWIN_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
 #define EVT_SCROLLWIN_THUMBTRACK(func) { wxEVT_SCROLLWIN_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
+#define EVT_SCROLLWIN_THUMBRELEASE(func) { wxEVT_SCROLLWIN_THUMBRELEASE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
 
 // Scrolling from wxSlider and wxScrollBar
 #define EVT_SCROLL(func) \
@@ -1911,7 +1910,8 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
   { wxEVT_SCROLL_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
   { wxEVT_SCROLL_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
   { wxEVT_SCROLL_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
-  { wxEVT_SCROLL_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
+  { wxEVT_SCROLL_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
+  { wxEVT_SCROLL_THUMBRELEASE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
 
 #define EVT_SCROLL_TOP(func) { wxEVT_SCROLL_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
 #define EVT_SCROLL_BOTTOM(func) { wxEVT_SCROLL_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
@@ -1920,6 +1920,7 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
 #define EVT_SCROLL_PAGEUP(func) { wxEVT_SCROLL_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
 #define EVT_SCROLL_PAGEDOWN(func) { wxEVT_SCROLL_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
 #define EVT_SCROLL_THUMBTRACK(func) { wxEVT_SCROLL_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
+#define EVT_SCROLL_THUMBRELEASE(func) { wxEVT_SCROLL_THUMBRELEASE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
 
 // Scrolling from wxSlider and wxScrollBar, with an id
 #define EVT_COMMAND_SCROLL(id, func) \
@@ -1929,7 +1930,8 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
   { wxEVT_SCROLL_LINEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
   { wxEVT_SCROLL_PAGEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
   { wxEVT_SCROLL_PAGEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
-  { wxEVT_SCROLL_THUMBTRACK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
+  { wxEVT_SCROLL_THUMBTRACK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
+  { wxEVT_SCROLL_THUMBRELEASE, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
 
 #define EVT_COMMAND_SCROLL_TOP(id, func) { wxEVT_SCROLL_TOP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
 #define EVT_COMMAND_SCROLL_BOTTOM(id, func) { wxEVT_SCROLL_BOTTOM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
@@ -1938,6 +1940,7 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
 #define EVT_COMMAND_SCROLL_PAGEUP(id, func) { wxEVT_SCROLL_PAGEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
 #define EVT_COMMAND_SCROLL_PAGEDOWN(id, func) { wxEVT_SCROLL_PAGEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
 #define EVT_COMMAND_SCROLL_THUMBTRACK(id, func) { wxEVT_SCROLL_THUMBTRACK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
+#define EVT_COMMAND_SCROLL_THUMBRELEASE(id, func) { wxEVT_SCROLL_THUMBRELEASE, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
 
 // Convenience macros for commonly-used commands
 #define EVT_BUTTON(id, fn) { wxEVT_COMMAND_BUTTON_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },

samples/scroll/scroll.cpp

@@ -254,8 +254,7 @@ void MyCanvas::OnScrollWin( wxCommandEvent &WXUNUSED(event) )
 
 void MyCanvas::OnScroll( wxScrollWinEvent &event )
 {
-    if (( event.GetEventType() == wxEVT_SCROLLWIN_THUMBTRACK ) &&
+    if (( event.GetEventType() == wxEVT_SCROLLWIN_THUMBRELEASE ))
-        ( !event.IsScrolling() ))
     {
         wxLogMessage( "Thumb released; position: %u", event.GetPosition() );
     }

src/common/event.cpp

@@ -124,6 +124,7 @@ const wxEventType wxEVT_SCROLL_LINEDOWN =                   wxEVT_FIRST + 303;
 const wxEventType wxEVT_SCROLL_PAGEUP =                     wxEVT_FIRST + 304;
 const wxEventType wxEVT_SCROLL_PAGEDOWN =                   wxEVT_FIRST + 305;
 const wxEventType wxEVT_SCROLL_THUMBTRACK =                 wxEVT_FIRST + 306;
+const wxEventType wxEVT_SCROLL_THUMBRELEASE =               wxEVT_FIRST + 307;
 
  /*
   * Scroll events from wxWindow
@@ -135,6 +136,7 @@ const wxEventType wxEVT_SCROLLWIN_LINEDOWN =                wxEVT_FIRST + 323;
 const wxEventType wxEVT_SCROLLWIN_PAGEUP =                  wxEVT_FIRST + 324;
 const wxEventType wxEVT_SCROLLWIN_PAGEDOWN =                wxEVT_FIRST + 325;
 const wxEventType wxEVT_SCROLLWIN_THUMBTRACK =              wxEVT_FIRST + 326;
+const wxEventType wxEVT_SCROLLWIN_THUMBRELEASE =            wxEVT_FIRST + 327;
 
  /*
   * System events
@@ -419,16 +421,6 @@ wxScrollEvent::wxScrollEvent(wxEventType commandType,
 {
     m_extraLong = orient;
     m_commandInt = pos;
-    m_isScrolling = TRUE;
-}
-
-void wxScrollEvent::CopyObject(wxObject& obj_d) const
-{
-    wxScrollEvent *obj = (wxScrollEvent*)&obj_d;
-
-    wxCommandEvent::CopyObject(obj_d);
-
-    obj->m_isScrolling  = m_isScrolling;
 }
 
 /*
@@ -442,7 +434,6 @@ wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType,
     m_eventType = commandType;
     m_extraLong = orient;
     m_commandInt = pos;
-    m_isScrolling = TRUE;
 }
 
 void wxScrollWinEvent::CopyObject(wxObject& obj_d) const
@@ -453,7 +444,6 @@ void wxScrollWinEvent::CopyObject(wxObject& obj_d) const
 
     obj->m_extraLong    = m_extraLong;
     obj->m_commandInt   = m_commandInt;
-    obj->m_isScrolling  = m_isScrolling;
 }
 
 /*

src/gtk/scrolbar.cpp

@@ -109,12 +109,11 @@ static gint gtk_scrollbar_button_release_callback( GtkRange *WXUNUSED(widget),
   
     if (win->m_isScrolling)
     {
-        wxEventType command = wxEVT_SCROLL_THUMBTRACK;
+        wxEventType command = wxEVT_SCROLL_THUMBRELEASE;
         int value = (int)ceil(win->m_adjust->value);
         int dir = win->HasFlag(wxSB_VERTICAL) ? wxVERTICAL : wxHORIZONTAL;
 
         wxScrollEvent event( command, value, dir );
-        event.SetScrolling( FALSE );
         event.SetEventObject( win );
         win->GetEventHandler()->ProcessEvent( event );
     }

src/gtk/window.cpp

@@ -1615,7 +1615,7 @@ static gint gtk_scrollbar_button_release_callback( GtkRange *widget,
 
     if (win->m_isScrolling)
     {
-        wxEventType command = wxEVT_SCROLLWIN_THUMBTRACK;
+        wxEventType command = wxEVT_SCROLLWIN_THUMBRELEASE;
         int value = -1;
         int dir = -1;
     
@@ -1632,7 +1632,6 @@ static gint gtk_scrollbar_button_release_callback( GtkRange *widget,
         }
         
         wxScrollWinEvent event( command, value, dir );
-        event.SetScrolling( FALSE );
         event.SetEventObject( win );
         win->GetEventHandler()->ProcessEvent( event );
     }

src/gtk1/scrolbar.cpp

@@ -109,12 +109,11 @@ static gint gtk_scrollbar_button_release_callback( GtkRange *WXUNUSED(widget),
   
     if (win->m_isScrolling)
     {
-        wxEventType command = wxEVT_SCROLL_THUMBTRACK;
+        wxEventType command = wxEVT_SCROLL_THUMBRELEASE;
         int value = (int)ceil(win->m_adjust->value);
         int dir = win->HasFlag(wxSB_VERTICAL) ? wxVERTICAL : wxHORIZONTAL;
 
         wxScrollEvent event( command, value, dir );
-        event.SetScrolling( FALSE );
         event.SetEventObject( win );
         win->GetEventHandler()->ProcessEvent( event );
     }

src/gtk1/window.cpp

@@ -1615,7 +1615,7 @@ static gint gtk_scrollbar_button_release_callback( GtkRange *widget,
 
     if (win->m_isScrolling)
     {
-        wxEventType command = wxEVT_SCROLLWIN_THUMBTRACK;
+        wxEventType command = wxEVT_SCROLLWIN_THUMBRELEASE;
         int value = -1;
         int dir = -1;
     
@@ -1632,7 +1632,6 @@ static gint gtk_scrollbar_button_release_callback( GtkRange *widget,
         }
         
         wxScrollWinEvent event( command, value, dir );
-        event.SetScrolling( FALSE );
         event.SetEventObject( win );
         win->GetEventHandler()->ProcessEvent( event );
     }

src/msw/scrolbar.cpp

@@ -131,7 +131,6 @@ bool wxScrollBar::MSWOnScroll(int WXUNUSED(orientation), WXWORD wParam,
     wxEventType scrollEvent = wxEVT_NULL;
 
     int nScrollInc;
-    bool isScrolling = TRUE;
     switch ( wParam )
     {
         case SB_TOP:
@@ -165,8 +164,9 @@ bool wxScrollBar::MSWOnScroll(int WXUNUSED(orientation), WXWORD wParam,
             break;
 
         case SB_THUMBPOSITION:
-            isScrolling = FALSE;
+            nScrollInc = pos - position;
-            /* fall-through */
+            scrollEvent = wxEVT_SCROLL_THUMBRELEASE;
+            break;
 
         case SB_THUMBTRACK:
             nScrollInc = pos - position;
@@ -177,10 +177,10 @@ bool wxScrollBar::MSWOnScroll(int WXUNUSED(orientation), WXWORD wParam,
             nScrollInc = 0;
     }
 
-    if (( nScrollInc == 0 ) && isScrolling )
+    // don't process the event if there is no displacement,
+    // unless this is a thumb release event.
+    if (( nScrollInc == 0 ) && ( scrollEvent != wxEVT_SCROLL_THUMBRELEASE ))
     {
-        // no event to process, so don't process it
-        // GRG: always process SB_THUMBPOSITION !
         return FALSE;
     }
 
@@ -195,7 +195,6 @@ bool wxScrollBar::MSWOnScroll(int WXUNUSED(orientation), WXWORD wParam,
     wxScrollEvent event(scrollEvent, m_windowId);
     event.SetPosition(new_pos);
     event.SetEventObject( this );
-    event.SetScrolling(isScrolling);
 
     return GetEventHandler()->ProcessEvent(event);
 }

src/msw/window.cpp

@@ -3431,8 +3431,8 @@ bool wxWindow::MSWOnScroll(int orientation, WXWORD wParam,
         break;
 
     case SB_THUMBPOSITION:
-        event.m_isScrolling = FALSE;
+        event.m_eventType = wxEVT_SCROLLWIN_THUMBRELEASE;
-        /* fall-through */
+        break;
 
     case SB_THUMBTRACK:
         event.m_eventType = wxEVT_SCROLLWIN_THUMBTRACK;