docs corrections and docs for Chris' wxImage::SaveFile(filename_only) patch

[wxWidgets.git] / src / gtk1 / scrolbar.cpp

diff --git a/src/gtk1/scrolbar.cpp b/src/gtk1/scrolbar.cpp
index 37396d960552a9eb0c100ea1fac5860fb852cb90..b8fc5dbf9756318f883693a942c68b4bd8ea8537 100644 (file)
--- a/src/gtk1/scrolbar.cpp
+++ b/src/gtk1/scrolbar.cpp
@@ -1,11 +1,10 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        scrolbar.cpp
+// Name:        src/gtk/scrolbar.cpp

 // Purpose:
 // Author:      Robert Roebling
 // Purpose:
 // Author:      Robert Roebling

-// Created:     01/02/97
-// Id:
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
-// Licence:    wxWindows licence
+// Id:          $Id$
+// Copyright:   (c) 1998 Robert Roebling
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 
 /////////////////////////////////////////////////////////////////////////////
 
 


@@ -13,204 +12,324 @@
 #pragma implementation "scrolbar.h"
 #endif
 
 #pragma implementation "scrolbar.h"
 #endif
 

+#include "wx/defs.h"
+
+#if wxUSE_SCROLLBAR
+

 #include "wx/scrolbar.h"
 #include "wx/scrolbar.h"

+

 #include "wx/utils.h"
 
 #include "wx/utils.h"
 

+#include <math.h>
+
+#include "wx/gtk/private.h"
+
+//-----------------------------------------------------------------------------
+// idle system
+//-----------------------------------------------------------------------------
+
+extern void wxapp_install_idle_handler();
+extern bool g_isIdle;
+

 //-----------------------------------------------------------------------------
 // data
 //-----------------------------------------------------------------------------
 
 extern bool   g_blockEventsOnDrag;
 //-----------------------------------------------------------------------------
 // data
 //-----------------------------------------------------------------------------
 
 extern bool   g_blockEventsOnDrag;

+extern bool   g_blockEventsOnScroll;
+
+static const float sensitivity = 0.02;

 
 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------

-// wxScrollBar
+// "value_changed"

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-static void gtk_scrollbar_callback( GtkWidget *WXUNUSED(widget), wxScrollBar *win )
+// FIXME: is GtkScrollType really passed to us as 2nd argument?
+
+static void gtk_scrollbar_callback( GtkAdjustment *adjust,
+                                    SCROLLBAR_CBACK_ARG
+                                    wxScrollBar *win )

 { 
 { 

-  if (!win->HasVMT()) return;
-  if (g_blockEventsOnDrag) return;
+    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;
-  
-  wxEventType command = wxEVT_NULL;
-  
-  float line_step = win->m_adjust->step_increment;
-  float page_step = win->m_adjust->page_increment;
-  
-  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;
+    float diff = adjust->value - win->m_oldPos;
+    if (fabs(diff) < sensitivity) return;
+    
+    win->m_oldPos = adjust->value;

 
 

-  int value = (int)(win->m_adjust->value+0.5);
+    wxEventType command = GtkScrollTypeToWx(GET_SCROLL_TYPE(win->m_widget));
+
+    double dvalue = adjust->value;
+    int value = (int)(dvalue < 0 ? dvalue - 0.5 : dvalue + 0.5);

       
       

-  int orient = wxHORIZONTAL;
-  if (win->GetWindowStyleFlag() & wxSB_VERTICAL == wxSB_VERTICAL) orient = wxHORIZONTAL;
+    int orient = win->HasFlag(wxSB_VERTICAL) ? wxVERTICAL : wxHORIZONTAL;

   
   

-  wxScrollEvent event( command, win->GetId(), value, orient );
-  event.SetEventObject( win );
-  win->GetEventHandler()->ProcessEvent( event );
+    wxScrollEvent event( command, win->GetId(), value, orient );
+    event.SetEventObject( win );
+    win->GetEventHandler()->ProcessEvent( event );

   
 /*
   
 /*

-  wxCommandEvent cevent( wxEVT_COMMAND_SCROLLBAR_UPDATED, win->GetId() );
-  cevent.SetEventObject( win );
-  win->ProcessEvent( cevent );
+    wxCommandEvent cevent( wxEVT_COMMAND_SCROLLBAR_UPDATED, win->GetId() );
+    cevent.SetEventObject( win );
+    win->ProcessEvent( cevent );

 */
 */

-};
+}

 
 

-IMPLEMENT_DYNAMIC_CLASS(wxScrollBar,wxControl)
+//-----------------------------------------------------------------------------
+// "button_press_event" from slider
+//-----------------------------------------------------------------------------

 
 

-wxScrollBar::wxScrollBar(wxWindow *parent, wxWindowID id,
-           const wxPoint& pos, const wxSize& size,
-           long style, const wxString& name )
+static gint gtk_scrollbar_button_press_callback( GtkRange *widget, 
+                                                 GdkEventButton *gdk_event, 
+                                                 wxScrollBar *win )
+{
+    if (g_isIdle) wxapp_install_idle_handler();
+
+//  g_blockEventsOnScroll = TRUE;  doesn't work in DialogEd
+
+    // FIXME: there is no slider field any more, what was meant here?
+#ifndef __WXGTK20__
+    win->m_isScrolling = (gdk_event->window == widget->slider);
+#endif
+  
+    return FALSE;
+}
+
+//-----------------------------------------------------------------------------
+// "button_release_event" from slider
+//-----------------------------------------------------------------------------
+
+static gint gtk_scrollbar_button_release_callback( GtkRange *WXUNUSED(widget), 
+                                                   GdkEventButton *WXUNUSED(gdk_event), 
+                                                   wxScrollBar *win )

 {
 {

-  Create( parent, id, pos, size, style, name );
-};
+    if (g_isIdle) wxapp_install_idle_handler();
+    
+//  g_blockEventsOnScroll = FALSE;
+  
+    if (win->m_isScrolling)
+    {
+        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.SetEventObject( win );
+        win->GetEventHandler()->ProcessEvent( event );
+    }
+      
+    win->m_isScrolling = FALSE;
+    
+    return FALSE;
+}

 
 

-wxScrollBar::~wxScrollBar(void)
+//-----------------------------------------------------------------------------
+// wxScrollBar
+//-----------------------------------------------------------------------------
+
+IMPLEMENT_DYNAMIC_CLASS(wxScrollBar,wxControl)
+
+wxScrollBar::~wxScrollBar()

 {
 {

-};
+}

 
 bool wxScrollBar::Create(wxWindow *parent, wxWindowID id,
            const wxPoint& pos, const wxSize& size,
 
 bool wxScrollBar::Create(wxWindow *parent, wxWindowID id,
            const wxPoint& pos, const wxSize& size,

-           long style, const wxString& name )
+           long style, const wxValidator& validator, const wxString& name )

 {
 {

-  m_needParent = TRUE;
+    m_needParent = TRUE;
+    m_acceptsFocus = TRUE;

   
   

-  PreCreation( parent, id, pos, size, style, name );
-  
-  m_oldPos = 0.0;
+    if (!PreCreation( parent, pos, size ) ||
+        !CreateBase( parent, id, pos, size, style, validator, name ))
+    {
+        wxFAIL_MSG( wxT("wxScrollBar creation failed") );
+        return FALSE;
+    }

 
 

-  if (style & wxSB_VERTICAL == wxSB_VERTICAL)
-    m_widget = gtk_hscrollbar_new( NULL );
-  else
-    m_widget = gtk_vscrollbar_new( NULL );
-    
-  m_adjust = gtk_range_get_adjustment( GTK_RANGE(m_widget) );
+    m_oldPos = 0.0;
+
+    if ((style & wxSB_VERTICAL) == wxSB_VERTICAL)
+        m_widget = gtk_vscrollbar_new( (GtkAdjustment *) NULL );
+    else
+        m_widget = gtk_hscrollbar_new( (GtkAdjustment *) NULL );
+
+    m_adjust = gtk_range_get_adjustment( GTK_RANGE(m_widget) );
+  
+    gtk_signal_connect( GTK_OBJECT(m_adjust), 
+                        "value_changed",
+                        (GtkSignalFunc) gtk_scrollbar_callback, 
+                        (gpointer) this );

   
   

-  gtk_signal_connect (GTK_OBJECT (m_adjust), "value_changed",
-                     (GtkSignalFunc) gtk_scrollbar_callback, (gpointer) this );
+    gtk_signal_connect( GTK_OBJECT(m_widget), 
+                        "button_press_event",
+                        (GtkSignalFunc)gtk_scrollbar_button_press_callback, 
+                        (gpointer) this );
+
+    gtk_signal_connect( GTK_OBJECT(m_widget), 
+                        "button_release_event",
+                        (GtkSignalFunc)gtk_scrollbar_button_release_callback, 
+                        (gpointer) this );
+
+    m_parent->DoAddChild( this );

   
   

-  PostCreation();
+    PostCreation();

   
   

-  Show( TRUE );
+    SetBackgroundColour( parent->GetBackgroundColour() );
+
+    Show( TRUE );

     
     

-  return TRUE;
-};
+    return TRUE;
+}

 
 

-int wxScrollBar::GetPosition(void) const
+int wxScrollBar::GetThumbPosition() const

 {
 {

-  return (int)(m_adjust->value+0.5);
-};
+    double val = m_adjust->value;
+    return (int)(val < 0 ? val - 0.5 : val + 0.5);
+}

 
 int wxScrollBar::GetThumbSize() const
 {
 
 int wxScrollBar::GetThumbSize() const
 {

-  return (int)(m_adjust->page_size+0.5);
-};
+    return (int)(m_adjust->page_size+0.5);
+}

 
 int wxScrollBar::GetPageSize() const
 {
 
 int wxScrollBar::GetPageSize() const
 {

-  return (int)(m_adjust->page_increment+0.5);
-};
+    return (int)(m_adjust->page_increment+0.5);
+}

 
 int wxScrollBar::GetRange() const
 {
 
 int wxScrollBar::GetRange() const
 {

-  return (int)(m_adjust->upper+0.5);
-};
+    return (int)(m_adjust->upper+0.5);
+}

 
 

-void wxScrollBar::SetPosition( int viewStart )
+void wxScrollBar::SetThumbPosition( int viewStart )

 {
 {

-  float fpos = (float)viewStart;
-  m_oldPos = fpos;
-  if (fabs(fpos-m_adjust->value) < 0.2) return;
-  m_adjust->value = fpos;
+    if (m_isScrolling) return;
+  
+    float fpos = (float)viewStart;
+    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" );
-};
+    gtk_signal_disconnect_by_func( GTK_OBJECT(m_adjust), 
+                        (GtkSignalFunc) gtk_scrollbar_callback, 
+                        (gpointer) this );
+                        
+    gtk_signal_emit_by_name( GTK_OBJECT(m_adjust), "value_changed" );
+    
+    gtk_signal_connect( GTK_OBJECT(m_adjust), 
+                        "value_changed",
+                        (GtkSignalFunc) gtk_scrollbar_callback, 
+                        (gpointer) this );
+}

 
 void wxScrollBar::SetScrollbar( int position, int thumbSize, int range, int pageSize,
       bool WXUNUSED(refresh) )
 {
 
 void wxScrollBar::SetScrollbar( int position, int thumbSize, int range, int pageSize,
       bool WXUNUSED(refresh) )
 {

-  float fpos = (float)position;
-  m_oldPos = fpos;
-  float frange = (float)range;
-  float fthumb = (float)thumbSize;
-  float fpage = (float)pageSize;
-      
-  if ((fabs(fpos-m_adjust->value) < 0.2) &&
-      (fabs(frange-m_adjust->upper) < 0.2) &&
-      (fabs(fthumb-m_adjust->page_size) < 0.2) &&
-      (fabs(fpage-m_adjust->page_increment) < 0.2))
-      return;
+    float fpos = (float)position;
+    float frange = (float)range;
+    float fthumb = (float)thumbSize;
+    float fpage = (float)pageSize;

       
       

-  m_adjust->lower = 0.0;
-  m_adjust->upper = frange;
-  m_adjust->value = fpos;
-  m_adjust->step_increment = 1.0;
-  m_adjust->page_increment = (float)(wxMax(fpage-2,0));
-  m_adjust->page_size = fthumb;
+    if ((fabs(frange-m_adjust->upper) < 0.2) &&
+        (fabs(fthumb-m_adjust->page_size) < 0.2) &&
+        (fabs(fpage-m_adjust->page_increment) < 0.2))
+    {
+        SetThumbPosition( position );
+        return;
+    }
+  
+    m_oldPos = fpos;
+  
+    m_adjust->lower = 0.0;
+    m_adjust->upper = frange;
+    m_adjust->value = fpos;
+    m_adjust->step_increment = 1.0;
+    m_adjust->page_increment = (float)(wxMax(fpage,0));
+    m_adjust->page_size = fthumb;

 
 

-  gtk_signal_emit_by_name( GTK_OBJECT(m_adjust), "changed" );
-};
+    gtk_signal_emit_by_name( GTK_OBJECT(m_adjust), "changed" );
+}

 
 

-// Backward compatibility
-int wxScrollBar::GetValue(void) const
+/* Backward compatibility */
+int wxScrollBar::GetValue() const

 {
 {

-  return GetPosition();
-};
+    return GetThumbPosition();
+}

 
 void wxScrollBar::SetValue( int viewStart )
 {
 
 void wxScrollBar::SetValue( int viewStart )
 {

-  SetPosition( viewStart );
-};
+    SetThumbPosition( viewStart );
+}

 
 void wxScrollBar::GetValues( int *viewStart, int *viewLength, int *objectLength, int *pageLength ) const
 {
 
 void wxScrollBar::GetValues( int *viewStart, int *viewLength, int *objectLength, int *pageLength ) const
 {

-  int pos = (int)(m_adjust->value+0.5);
-  int thumb = (int)(m_adjust->page_size+0.5);
-  int page = (int)(m_adjust->page_increment+0.5);
-  int range = (int)(m_adjust->upper+0.5);
+    int pos = (int)(m_adjust->value+0.5);
+    int thumb = (int)(m_adjust->page_size+0.5);
+    int page = (int)(m_adjust->page_increment+0.5);
+    int range = (int)(m_adjust->upper+0.5);

   
   

-  *viewStart = pos;
-  *viewLength = range;
-  *objectLength = thumb;
-  *pageLength = page;
-};
+    *viewStart = pos;
+    *viewLength = range;
+    *objectLength = thumb;
+    *pageLength = page;
+}

 
 int wxScrollBar::GetViewLength() const
 {
 
 int wxScrollBar::GetViewLength() const
 {

-  return (int)(m_adjust->upper+0.5);
-};
+    return (int)(m_adjust->upper+0.5);
+}

 
 int wxScrollBar::GetObjectLength() const
 {
 
 int wxScrollBar::GetObjectLength() const
 {

-  return (int)(m_adjust->page_size+0.5);
-};
+    return (int)(m_adjust->page_size+0.5);
+}

 
 void wxScrollBar::SetPageSize( int pageLength )
 {
 
 void wxScrollBar::SetPageSize( int pageLength )
 {

-  int pos = (int)(m_adjust->value+0.5);
-  int thumb = (int)(m_adjust->page_size+0.5);
-  int range = (int)(m_adjust->upper+0.5);
-  SetScrollbar( pos, thumb, range, pageLength );
-};
+    int pos = (int)(m_adjust->value+0.5);
+    int thumb = (int)(m_adjust->page_size+0.5);
+    int range = (int)(m_adjust->upper+0.5);
+    SetScrollbar( pos, thumb, range, pageLength );
+}

 
 void wxScrollBar::SetObjectLength( int objectLength )
 {
 
 void wxScrollBar::SetObjectLength( int objectLength )
 {

-  int pos = (int)(m_adjust->value+0.5);
-  int page = (int)(m_adjust->page_increment+0.5);
-  int range = (int)(m_adjust->upper+0.5);
-  SetScrollbar( pos, objectLength, range, page );
-};
+    int pos = (int)(m_adjust->value+0.5);
+    int page = (int)(m_adjust->page_increment+0.5);
+    int range = (int)(m_adjust->upper+0.5);
+    SetScrollbar( pos, objectLength, range, page );
+}

 
 void wxScrollBar::SetViewLength( int viewLength )
 {
 
 void wxScrollBar::SetViewLength( int viewLength )
 {

-  int pos = (int)(m_adjust->value+0.5);
-  int thumb = (int)(m_adjust->page_size+0.5);
-  int page = (int)(m_adjust->page_increment+0.5);
-  SetScrollbar( pos, thumb, viewLength, page );
-};
+    int pos = (int)(m_adjust->value+0.5);
+    int thumb = (int)(m_adjust->page_size+0.5);
+    int page = (int)(m_adjust->page_increment+0.5);
+    SetScrollbar( pos, thumb, viewLength, page );
+}
+
+bool wxScrollBar::IsOwnGtkWindow( GdkWindow *window )
+{
+    GtkRange *range = GTK_RANGE(m_widget);
+    return ( (window == GTK_WIDGET(range)->window)
+#ifndef __WXGTK20__
+                || (window == range->trough)
+                || (window == range->slider)
+                || (window == range->step_forw)
+                || (window == range->step_back)
+#endif // GTK+ 1.x
+           );
+}

 
 

+void wxScrollBar::ApplyWidgetStyle()
+{
+    SetWidgetStyle();
+    gtk_widget_set_style( m_widget, m_widgetStyle );
+}
+
+#endif