]> git.saurik.com Git - wxWidgets.git/blobdiff - src/gtk/slider.cpp
fixes #10358
[wxWidgets.git] / src / gtk / slider.cpp
index 5d115ba3b87651642e5bc06a620f8110a31d909a..b2a24b3640b0de11ef788da6345d9ba2e37fb2bd 100644 (file)
 /////////////////////////////////////////////////////////////////////////////
-// Name:        slider.cpp
+// Name:        src/gtk/slider.cpp
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling
-// Licence:           wxWindows licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifdef __GNUG__
-#pragma implementation "slider.h"
-#endif
-
-#include "wx/slider.h"
+// For compilers that support precompilation, includes "wx.h".
+#include "wx/wxprec.h"
 
 #if wxUSE_SLIDER
 
-#include "wx/utils.h"
-#include <math.h>
-
-#include "gdk/gdk.h"
-#include "gtk/gtk.h"
+#include "wx/slider.h"
 
-//-----------------------------------------------------------------------------
-// idle system
-//-----------------------------------------------------------------------------
+#ifndef WX_PRECOMP
+    #include "wx/utils.h"
+    #include "wx/math.h"
+#endif
 
-extern void wxapp_install_idle_handler();
-extern bool g_isIdle;
+#include <gtk/gtk.h>
 
 //-----------------------------------------------------------------------------
 // data
 //-----------------------------------------------------------------------------
 
-extern bool   g_blockEventsOnDrag;
+extern bool g_blockEventsOnDrag;
 
-//-----------------------------------------------------------------------------
-// "value_changed"
-//-----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
+// helper functions
+// ----------------------------------------------------------------------------
 
-static void gtk_slider_callback( GtkWidget *WXUNUSED(widget), wxSlider *win )
-{ 
-    if (g_isIdle) wxapp_install_idle_handler();
-
-    if (!win->m_hasVMT) return;
-    if (g_blockEventsOnDrag) return;
-    
-    float diff = win->m_adjust->value - win->m_oldPos;
-    if (fabs(diff) < 0.2) return;
-    win->m_oldPos = win->m_adjust->value;
-  
-    wxEventType command = wxEVT_NULL;
-  
-    float line_step = win->m_adjust->step_increment;
-    float page_step = win->m_adjust->page_increment;
-  
-    if (fabs(win->m_adjust->value-win->m_adjust->lower) < 0.2) command = wxEVT_SCROLL_BOTTOM;
-    else if (fabs(win->m_adjust->value-win->m_adjust->upper) < 0.2) command = wxEVT_SCROLL_TOP;
-    else if (fabs(diff-line_step) < 0.2) command = wxEVT_SCROLL_LINEDOWN;
-    else if (fabs(diff+line_step) < 0.2) command = wxEVT_SCROLL_LINEUP;
-    else if (fabs(diff-page_step) < 0.2) command = wxEVT_SCROLL_PAGEDOWN;
-    else if (fabs(diff+page_step) < 0.2) command = wxEVT_SCROLL_PAGEUP;
-    else command = wxEVT_SCROLL_THUMBTRACK;
-
-    int value = (int)ceil(win->m_adjust->value);
-      
-    int orient = wxHORIZONTAL;
-    if (win->GetWindowStyleFlag() & wxSB_VERTICAL == wxSB_VERTICAL) orient = wxVERTICAL;
-  
-    wxScrollEvent event( command, win->GetId(), value, orient );
-    event.SetEventObject( win );
-    win->GetEventHandler()->ProcessEvent( event );
-  
-    wxCommandEvent cevent( wxEVT_COMMAND_SLIDER_UPDATED, win->GetId() );
-    cevent.SetEventObject( win );
-    win->GetEventHandler()->ProcessEvent( cevent );
-}
+// process a scroll event
+static void
+ProcessScrollEvent(wxSlider *win, wxEventType evtType)
+{
+    const int orient = win->HasFlag(wxSL_VERTICAL) ? wxVERTICAL
+                                                   : wxHORIZONTAL;
 
-//-----------------------------------------------------------------------------
-// wxSlider
-//-----------------------------------------------------------------------------
+    const int value = win->GetValue();
 
-IMPLEMENT_DYNAMIC_CLASS(wxSlider,wxControl)
+    // if we have any "special" event (i.e. the value changed by a line or a
+    // page), send this specific event first
+    if ( evtType != wxEVT_NULL )
+    {
+        wxScrollEvent event( evtType, win->GetId(), value, orient );
+        event.SetEventObject( win );
+        win->HandleWindowEvent( event );
+    }
+
+    // but, in any case, except if we're dragging the slider (and so the change
+    // is not definitive), send a generic "changed" event
+    if ( evtType != wxEVT_SCROLL_THUMBTRACK )
+    {
+        wxScrollEvent event(wxEVT_SCROLL_CHANGED, win->GetId(), value, orient);
+        event.SetEventObject( win );
+        win->HandleWindowEvent( event );
+    }
+
+    // and also generate a command event for compatibility
+    wxCommandEvent event( wxEVT_COMMAND_SLIDER_UPDATED, win->GetId() );
+    event.SetEventObject( win );
+    event.SetInt( value );
+    win->HandleWindowEvent( event );
+}
 
-wxSlider::wxSlider(void)
+static inline wxEventType GtkScrollTypeToWx(int scrollType)
 {
+    wxEventType eventType;
+    switch (scrollType)
+    {
+    case GTK_SCROLL_STEP_BACKWARD:
+    case GTK_SCROLL_STEP_LEFT:
+    case GTK_SCROLL_STEP_UP:
+        eventType = wxEVT_SCROLL_LINEUP;
+        break;
+    case GTK_SCROLL_STEP_DOWN:
+    case GTK_SCROLL_STEP_FORWARD:
+    case GTK_SCROLL_STEP_RIGHT:
+        eventType = wxEVT_SCROLL_LINEDOWN;
+        break;
+    case GTK_SCROLL_PAGE_BACKWARD:
+    case GTK_SCROLL_PAGE_LEFT:
+    case GTK_SCROLL_PAGE_UP:
+        eventType = wxEVT_SCROLL_PAGEUP;
+        break;
+    case GTK_SCROLL_PAGE_DOWN:
+    case GTK_SCROLL_PAGE_FORWARD:
+    case GTK_SCROLL_PAGE_RIGHT:
+        eventType = wxEVT_SCROLL_PAGEDOWN;
+        break;
+    case GTK_SCROLL_START:
+        eventType = wxEVT_SCROLL_TOP;
+        break;
+    case GTK_SCROLL_END:
+        eventType = wxEVT_SCROLL_BOTTOM;
+        break;
+    case GTK_SCROLL_JUMP:
+        eventType = wxEVT_SCROLL_THUMBTRACK;
+        break;
+    default:
+        wxFAIL_MSG(_T("Unknown GtkScrollType"));
+        eventType = wxEVT_NULL;
+        break;
+    }
+    return eventType;
 }
 
-wxSlider::~wxSlider(void)
+// Determine if increment is the same as +/-x, allowing for some small
+//   difference due to possible inexactness in floating point arithmetic
+static inline bool IsScrollIncrement(double increment, double x)
 {
+    wxASSERT(increment > 0);
+    const double tolerance = 1.0 / 1024;
+    return fabs(increment - fabs(x)) < tolerance;
 }
 
-bool wxSlider::Create(wxWindow *parent, wxWindowID id,
-        int value, int minValue, int maxValue,
-        const wxPoint& pos, const wxSize& size,
-        long style, const wxValidator& validator, const wxString& name )
+//-----------------------------------------------------------------------------
+// "value_changed"
+//-----------------------------------------------------------------------------
+
+extern "C" {
+static void
+gtk_value_changed(GtkRange* range, wxSlider* win)
 {
-    m_acceptsFocus = TRUE;
-    m_needParent = TRUE;
-  
-    if (!PreCreation( parent, pos, size ) ||
-        !CreateBase( parent, id, pos, size, style, validator, name ))
+    GtkAdjustment* adj = gtk_range_get_adjustment (range);
+    const int pos = wxRound(adj->value);
+    const double oldPos = win->m_pos;
+    win->m_pos = adj->value;
+
+    if (!win->m_hasVMT || g_blockEventsOnDrag)
+        return;
+
+    if (win->m_blockScrollEvent)
     {
-        wxFAIL_MSG( _T("wxSlider creation failed") );
-       return FALSE;
+        win->m_scrollEventType = GTK_SCROLL_NONE;
+        return;
     }
 
-    m_oldPos = 0.0;
-
-    if (style & wxSL_VERTICAL)
-        m_widget = gtk_vscale_new( (GtkAdjustment *) NULL );
-    else
-        m_widget = gtk_hscale_new( (GtkAdjustment *) NULL );
-    
-    if (style & wxSL_LABELS)
+    wxEventType eventType = wxEVT_NULL;
+    if (win->m_isScrolling)
+    {
+        eventType = wxEVT_SCROLL_THUMBTRACK;
+    }
+    else if (win->m_scrollEventType != GTK_SCROLL_NONE)
+    {
+        // Scroll event from "move-slider" (keyboard)
+        eventType = GtkScrollTypeToWx(win->m_scrollEventType);
+    }
+    else if (win->m_mouseButtonDown)
     {
-        gtk_scale_set_draw_value( GTK_SCALE( m_widget ), TRUE );
-        
-        /* labels need more space and too small window will
-           cause junk to appear on the dialog */
-        if (style & wxSL_VERTICAL)
+        // Difference from last change event
+        const double diff = adj->value - oldPos;
+        const bool isDown = diff > 0;
+
+        if (IsScrollIncrement(adj->page_increment, diff))
         {
-            wxSize sz( size );
-            if (sz.x < 35)
-            {
-                sz.x = 35;
-                SetSize( sz );
-            }
+            eventType = isDown ? wxEVT_SCROLL_PAGEDOWN : wxEVT_SCROLL_PAGEUP;
+        }
+        else if (wxIsSameDouble(adj->value, 0))
+        {
+            eventType = wxEVT_SCROLL_PAGEUP;
+        }
+        else if (wxIsSameDouble(adj->value, adj->upper))
+        {
+            eventType = wxEVT_SCROLL_PAGEDOWN;
         }
         else
         {
-            wxSize sz( size );
-            if (sz.y < 35)
-            {
-                sz.y = 35;
-                SetSize( sz );
-            }
+            // Assume track event
+            eventType = wxEVT_SCROLL_THUMBTRACK;
+            // Remember that we're tracking
+            win->m_isScrolling = true;
         }
     }
-    else
-        gtk_scale_set_draw_value( GTK_SCALE( m_widget ), FALSE );
-
-    m_adjust = gtk_range_get_adjustment( GTK_RANGE(m_widget) );
-  
-    gtk_signal_connect( GTK_OBJECT(m_adjust), 
-                        "value_changed",
-                        (GtkSignalFunc) gtk_slider_callback, 
-                        (gpointer) this );
-        
-    SetRange( minValue, maxValue );
-    SetValue( value );
-  
-    m_parent->DoAddChild( this );
-  
-    PostCreation();
-  
-    SetBackgroundColour( parent->GetBackgroundColour() );
-
-    Show( TRUE );
-    
-    return TRUE;
+
+    win->m_scrollEventType = GTK_SCROLL_NONE;
+
+    // If integral position has changed
+    if (wxRound(oldPos) != pos)
+    {
+        ProcessScrollEvent(win, eventType);
+        win->m_needThumbRelease = eventType == wxEVT_SCROLL_THUMBTRACK;
+    }
+}
 }
 
-int wxSlider::GetValue(void) const
+//-----------------------------------------------------------------------------
+// "move_slider" (keyboard event)
+//-----------------------------------------------------------------------------
+
+extern "C" {
+static void
+gtk_move_slider(GtkRange*, GtkScrollType scrollType, wxSlider* win)
 {
-    return (int)(m_adjust->value+0.5);
+    // Save keyboard scroll type for "value_changed" handler
+    win->m_scrollEventType = scrollType;
+}
 }
 
-void wxSlider::SetValue( int value )
+//-----------------------------------------------------------------------------
+// "button_press_event"
+//-----------------------------------------------------------------------------
+
+extern "C" {
+static gboolean
+gtk_button_press_event(GtkWidget*, GdkEventButton*, wxSlider* win)
 {
-    float fpos = (float)value;
-    m_oldPos = fpos;
-    if (fabs(fpos-m_adjust->value) < 0.2) return;
-    
-    m_adjust->value = fpos;
-  
-    gtk_signal_emit_by_name( GTK_OBJECT(m_adjust), "value_changed" );
+    win->m_mouseButtonDown = true;
+
+    return false;
+}
 }
 
-void wxSlider::SetRange( int minValue, int maxValue )
+//-----------------------------------------------------------------------------
+// "event_after"
+//-----------------------------------------------------------------------------
+
+extern "C" {
+static void
+gtk_event_after(GtkRange* range, GdkEvent* event, wxSlider* win)
 {
-    float fmin = (float)minValue;
-    float fmax = (float)maxValue;
-      
-    if ((fabs(fmin-m_adjust->lower) < 0.2) &&
-        (fabs(fmax-m_adjust->upper) < 0.2))
+    if (event->type == GDK_BUTTON_RELEASE)
     {
-        return;
-    }
-      
-    m_adjust->lower = fmin;
-    m_adjust->upper = fmax;
+        g_signal_handlers_block_by_func(range, (gpointer) gtk_event_after, win);
 
-    gtk_signal_emit_by_name( GTK_OBJECT(m_adjust), "changed" );
+        if (win->m_needThumbRelease)
+        {
+            win->m_needThumbRelease = false;
+            ProcessScrollEvent(win, wxEVT_SCROLL_THUMBRELEASE);
+        }
+        // Keep slider at an integral position
+        win->m_blockScrollEvent = true;
+        gtk_range_set_value(GTK_RANGE (win->m_widget), win->GetValue());
+        win->m_blockScrollEvent = false;
+    }
 }
+}
+
+//-----------------------------------------------------------------------------
+// "button_release_event"
+//-----------------------------------------------------------------------------
 
-int wxSlider::GetMin(void) const
+extern "C" {
+static gboolean
+gtk_button_release_event(GtkRange* range, GdkEventButton*, wxSlider* win)
 {
-    return (int)ceil(m_adjust->lower);
+    win->m_mouseButtonDown = false;
+    if (win->m_isScrolling)
+    {
+        win->m_isScrolling = false;
+        g_signal_handlers_unblock_by_func(range, (gpointer) gtk_event_after, win);
+    }
+    return false;
 }
+}
+
+//-----------------------------------------------------------------------------
+// "format_value"
+//-----------------------------------------------------------------------------
 
-int wxSlider::GetMax(void) const
+extern "C" {
+static gchar* gtk_format_value(GtkScale*, double value, void*)
 {
-    return (int)ceil(m_adjust->upper);
+    // Format value as nearest integer
+    return g_strdup_printf("%d", wxRound(value));
+}
 }
 
-void wxSlider::SetPageSize( int pageSize )
-{
-    float fpage = (float)pageSize;
-      
-    if (fabs(fpage-m_adjust->page_increment) < 0.2) return;
-      
-    m_adjust->page_increment = fpage;
+//-----------------------------------------------------------------------------
+// wxSlider
+//-----------------------------------------------------------------------------
 
-    gtk_signal_emit_by_name( GTK_OBJECT(m_adjust), "changed" );
-}
+IMPLEMENT_DYNAMIC_CLASS(wxSlider,wxControl)
 
-int wxSlider::GetPageSize(void) const
+wxSlider::wxSlider()
 {
-    return (int)ceil(m_adjust->page_increment);
+    m_pos = 0;
+    m_scrollEventType = GTK_SCROLL_NONE;
+    m_needThumbRelease = false;
+    m_blockScrollEvent = false;
 }
 
-void wxSlider::SetThumbLength( int len )
+bool wxSlider::Create(wxWindow *parent,
+                      wxWindowID id,
+                      int value,
+                      int minValue,
+                      int maxValue,
+                      const wxPoint& pos,
+                      const wxSize& size,
+                      long style,
+                      const wxValidator& validator,
+                      const wxString& name)
 {
-    float flen = (float)len;
-      
-    if (fabs(flen-m_adjust->page_size) < 0.2) return;
-      
-    m_adjust->page_size = flen;
+    m_pos = value;
+    m_scrollEventType = GTK_SCROLL_NONE;
+
+    if (!PreCreation( parent, pos, size ) ||
+        !CreateBase( parent, id, pos, size, style, validator, name ))
+    {
+        wxFAIL_MSG( wxT("wxSlider creation failed") );
+        return false;
+    }
+
+    if (style & wxSL_VERTICAL)
+        m_widget = gtk_vscale_new( (GtkAdjustment *) NULL );
+    else
+        m_widget = gtk_hscale_new( (GtkAdjustment *) NULL );
+    g_object_ref(m_widget);
 
-    gtk_signal_emit_by_name( GTK_OBJECT(m_adjust), "changed" );
+    gtk_scale_set_draw_value(GTK_SCALE (m_widget), (style & wxSL_LABELS) != 0);
+    // Keep full precision in position value
+    gtk_scale_set_digits(GTK_SCALE (m_widget), -1);
+
+    if (style & wxSL_INVERSE)
+        gtk_range_set_inverted( GTK_RANGE(m_widget), TRUE );
+
+    g_signal_connect(m_widget, "button_press_event", G_CALLBACK(gtk_button_press_event), this);
+    g_signal_connect(m_widget, "button_release_event", G_CALLBACK(gtk_button_release_event), this);
+    g_signal_connect(m_widget, "move_slider", G_CALLBACK(gtk_move_slider), this);
+    g_signal_connect(m_widget, "format_value", G_CALLBACK(gtk_format_value), NULL);
+    g_signal_connect(m_widget, "value_changed", G_CALLBACK(gtk_value_changed), this);
+    gulong handler_id = g_signal_connect(m_widget, "event_after", G_CALLBACK(gtk_event_after), this);
+    g_signal_handler_block(m_widget, handler_id);
+
+    SetRange( minValue, maxValue );
+
+    // don't call the public SetValue() as it won't do anything unless the
+    // value really changed
+    GTKSetValue( value );
+
+    m_parent->DoAddChild( this );
+
+    PostCreation(size);
+
+    return true;
 }
 
-int wxSlider::GetThumbLength(void) const
+int wxSlider::GetValue() const
 {
-    return (int)ceil(m_adjust->page_size);
+    return wxRound(m_pos);
 }
 
-void wxSlider::SetLineSize( int WXUNUSED(lineSize) )
+void wxSlider::SetValue( int value )
 {
+    if (GetValue() != value)
+        GTKSetValue(value);
 }
 
-int wxSlider::GetLineSize(void) const
+void wxSlider::GTKSetValue(int value)
 {
-    return 0;
+    m_blockScrollEvent = true;
+    gtk_range_set_value(GTK_RANGE (m_widget), value);
+    m_blockScrollEvent = false;
 }
 
-void wxSlider::SetTick( int WXUNUSED(tickPos) )
+void wxSlider::SetRange( int minValue, int maxValue )
 {
+    m_blockScrollEvent = true;
+    if (minValue == maxValue)
+       maxValue++;
+    gtk_range_set_range(GTK_RANGE (m_widget), minValue, maxValue);
+    gtk_range_set_increments(GTK_RANGE (m_widget), 1, (maxValue - minValue + 9) / 10);
+    m_blockScrollEvent = false;
 }
 
-void wxSlider::SetTickFreq( int WXUNUSED(n), int WXUNUSED(pos) )
+int wxSlider::GetMin() const
 {
+    return int(gtk_range_get_adjustment (GTK_RANGE (m_widget))->lower);
 }
 
-int wxSlider::GetTickFreq(void) const
+int wxSlider::GetMax() const
 {
-    return 0;
+    return int(gtk_range_get_adjustment (GTK_RANGE (m_widget))->upper);
 }
 
-void wxSlider::ClearTicks(void)
+void wxSlider::SetPageSize( int pageSize )
 {
+    m_blockScrollEvent = true;
+    gtk_range_set_increments(GTK_RANGE (m_widget), GetLineSize(), pageSize);
+    m_blockScrollEvent = false;
 }
 
-void wxSlider::SetSelection( int WXUNUSED(minPos), int WXUNUSED(maxPos) )
+int wxSlider::GetPageSize() const
 {
+    return int(gtk_range_get_adjustment (GTK_RANGE (m_widget))->page_increment);
 }
 
-int wxSlider::GetSelEnd(void) const
+// GTK does not support changing the size of the slider
+void wxSlider::SetThumbLength(int)
 {
-    return 0;
 }
 
-int wxSlider::GetSelStart(void) const
+int wxSlider::GetThumbLength() const
 {
     return 0;
 }
 
-void wxSlider::ClearSel(void)
+void wxSlider::SetLineSize( int lineSize )
 {
+    m_blockScrollEvent = true;
+    gtk_range_set_increments(GTK_RANGE (m_widget), lineSize, GetPageSize());
+    m_blockScrollEvent = false;
 }
 
-bool wxSlider::IsOwnGtkWindow( GdkWindow *window )
+int wxSlider::GetLineSize() const
 {
-    GtkRange *range = GTK_RANGE(m_widget);
-    return ( (window == GTK_WIDGET(range)->window) ||
-             (window == range->trough) ||
-             (window == range->slider) ||
-             (window == range->step_forw) ||
-             (window == range->step_back) );
+    return int(gtk_range_get_adjustment (GTK_RANGE (m_widget))->step_increment);
 }
 
-void wxSlider::ApplyWidgetStyle()
+GdkWindow *wxSlider::GTKGetWindow(wxArrayGdkWindows& WXUNUSED(windows)) const
 {
-    SetWidgetStyle();
-    gtk_widget_set_style( m_widget, m_widgetStyle );
+    return GTK_RANGE(m_widget)->event_window;
 }
 
-#endif
+// static
+wxVisualAttributes
+wxSlider::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
+{
+    return GetDefaultAttributesFromGTKWidget(gtk_vscale_new);
+}
+
+#endif // wxUSE_SLIDER