src/gtk/scrolbar.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/scrolbar.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10
  11 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  12 #pragma implementation "scrolbar.h"
  13 #endif
  14
  15 // For compilers that support precompilation, includes "wx.h".
  16 #include "wx/wxprec.h"
  17
  18 #if wxUSE_SCROLLBAR
  19
  20 #include "wx/scrolbar.h"
  21
  22 #include "wx/utils.h"
  23
  24 #include <math.h>
  25
  26 #include "wx/gtk/private.h"
  27
  28 //-----------------------------------------------------------------------------
  29 // idle system
  30 //-----------------------------------------------------------------------------
  31
  32 extern void wxapp_install_idle_handler();
  33 extern bool g_isIdle;
  34
  35 //-----------------------------------------------------------------------------
  36 // data
  37 //-----------------------------------------------------------------------------
  38
  39 extern bool   g_blockEventsOnDrag;
  40 extern bool   g_blockEventsOnScroll;
  41
  42 static const float sensitivity = 0.02;
  43
  44 //-----------------------------------------------------------------------------
  45 // "value_changed"
  46 //-----------------------------------------------------------------------------
  47
  48 // FIXME: is GtkScrollType really passed to us as 2nd argument?
  49
  50 static void gtk_scrollbar_callback( GtkAdjustment *adjust,
  51                                     SCROLLBAR_CBACK_ARG
  52                                     wxScrollBar *win )
  53 {
  54     if (g_isIdle) wxapp_install_idle_handler();
  55
  56     if (!win->m_hasVMT) return;
  57     if (g_blockEventsOnDrag) return;
  58
  59     float diff = adjust->value - win->m_oldPos;
  60     if (fabs(diff) < sensitivity) return;
  61
  62     win->m_oldPos = adjust->value;
  63
  64     wxEventType command = GtkScrollTypeToWx(GET_SCROLL_TYPE(win->m_widget));
  65
  66     double dvalue = adjust->value;
  67     int value = (int)(dvalue < 0 ? dvalue - 0.5 : dvalue + 0.5);
  68
  69     int orient = win->HasFlag(wxSB_VERTICAL) ? wxVERTICAL : wxHORIZONTAL;
  70
  71     wxScrollEvent event( command, win->GetId(), value, orient );
  72     event.SetEventObject( win );
  73     win->GetEventHandler()->ProcessEvent( event );
  74
  75 /*
  76     wxCommandEvent cevent( wxEVT_COMMAND_SCROLLBAR_UPDATED, win->GetId() );
  77     cevent.SetEventObject( win );
  78     win->ProcessEvent( cevent );
  79 */
  80 }
  81
  82 //-----------------------------------------------------------------------------
  83 // "button_press_event" from slider
  84 //-----------------------------------------------------------------------------
  85
  86 static gint gtk_scrollbar_button_press_callback( GtkRange *widget,
  87                                                  GdkEventButton *gdk_event,
  88                                                  wxScrollBar *win )
  89 {
  90     if (g_isIdle) wxapp_install_idle_handler();
  91
  92 //  g_blockEventsOnScroll = TRUE;  doesn't work in DialogEd
  93
  94     // FIXME: there is no slider field any more, what was meant here?
  95 #ifndef __WXGTK20__
  96     win->m_isScrolling = (gdk_event->window == widget->slider);
  97 #endif
  98
  99     return FALSE;
 100 }
 101
 102 //-----------------------------------------------------------------------------
 103 // "button_release_event" from slider
 104 //-----------------------------------------------------------------------------
 105
 106 static gint
 107 gtk_scrollbar_button_release_callback( GtkRange *WXUNUSED(widget),
 108                                        GdkEventButton *WXUNUSED(gdk_event),
 109                                        wxScrollBar *win )
 110 {
 111     if (g_isIdle)
 112         wxapp_install_idle_handler();
 113
 114 //  g_blockEventsOnScroll = FALSE;
 115
 116     if (win->m_isScrolling)
 117     {
 118         wxEventType command = wxEVT_SCROLL_THUMBRELEASE;
 119         int value = (int)ceil(win->m_adjust->value);
 120         int orient = win->HasFlag(wxSB_VERTICAL) ? wxVERTICAL : wxHORIZONTAL;
 121
 122         wxScrollEvent event( command, win->GetId(), value, orient );
 123         event.SetEventObject( win );
 124         win->GetEventHandler()->ProcessEvent( event );
 125     }
 126
 127     win->m_isScrolling = FALSE;
 128
 129     return FALSE;
 130 }
 131
 132 //-----------------------------------------------------------------------------
 133 // wxScrollBar
 134 //-----------------------------------------------------------------------------
 135
 136 IMPLEMENT_DYNAMIC_CLASS(wxScrollBar,wxControl)
 137
 138 wxScrollBar::~wxScrollBar()
 139 {
 140 }
 141
 142 bool wxScrollBar::Create(wxWindow *parent, wxWindowID id,
 143            const wxPoint& pos, const wxSize& size,
 144            long style, const wxValidator& validator, const wxString& name )
 145 {
 146     m_needParent = TRUE;
 147     m_acceptsFocus = TRUE;
 148
 149     if (!PreCreation( parent, pos, size ) ||
 150         !CreateBase( parent, id, pos, size, style, validator, name ))
 151     {
 152         wxFAIL_MSG( wxT("wxScrollBar creation failed") );
 153         return FALSE;
 154     }
 155
 156     m_oldPos = 0.0;
 157
 158     if ((style & wxSB_VERTICAL) == wxSB_VERTICAL)
 159         m_widget = gtk_vscrollbar_new( (GtkAdjustment *) NULL );
 160     else
 161         m_widget = gtk_hscrollbar_new( (GtkAdjustment *) NULL );
 162
 163     m_adjust = gtk_range_get_adjustment( GTK_RANGE(m_widget) );
 164
 165     gtk_signal_connect( GTK_OBJECT(m_adjust),
 166                         "value_changed",
 167                         (GtkSignalFunc) gtk_scrollbar_callback,
 168                         (gpointer) this );
 169
 170     gtk_signal_connect( GTK_OBJECT(m_widget),
 171                         "button_press_event",
 172                         (GtkSignalFunc)gtk_scrollbar_button_press_callback,
 173                         (gpointer) this );
 174
 175     gtk_signal_connect( GTK_OBJECT(m_widget),
 176                         "button_release_event",
 177                         (GtkSignalFunc)gtk_scrollbar_button_release_callback,
 178                         (gpointer) this );
 179
 180     m_parent->DoAddChild( this );
 181
 182     PostCreation(size);
 183
 184     return TRUE;
 185 }
 186
 187 int wxScrollBar::GetThumbPosition() const
 188 {
 189     double val = m_adjust->value;
 190     return (int)(val < 0 ? val - 0.5 : val + 0.5);
 191 }
 192
 193 int wxScrollBar::GetThumbSize() const
 194 {
 195     return (int)(m_adjust->page_size+0.5);
 196 }
 197
 198 int wxScrollBar::GetPageSize() const
 199 {
 200     return (int)(m_adjust->page_increment+0.5);
 201 }
 202
 203 int wxScrollBar::GetRange() const
 204 {
 205     return (int)(m_adjust->upper+0.5);
 206 }
 207
 208 void wxScrollBar::SetThumbPosition( int viewStart )
 209 {
 210     if (m_isScrolling) return;
 211
 212     float fpos = (float)viewStart;
 213     m_oldPos = fpos;
 214     if (fabs(fpos-m_adjust->value) < 0.2) return;
 215     m_adjust->value = fpos;
 216
 217     gtk_signal_disconnect_by_func( GTK_OBJECT(m_adjust),
 218                         (GtkSignalFunc) gtk_scrollbar_callback,
 219                         (gpointer) this );
 220
 221     gtk_signal_emit_by_name( GTK_OBJECT(m_adjust), "value_changed" );
 222
 223     gtk_signal_connect( GTK_OBJECT(m_adjust),
 224                         "value_changed",
 225                         (GtkSignalFunc) gtk_scrollbar_callback,
 226                         (gpointer) this );
 227 }
 228
 229 void wxScrollBar::SetScrollbar( int position, int thumbSize, int range, int pageSize,
 230       bool WXUNUSED(refresh) )
 231 {
 232     float fpos = (float)position;
 233     float frange = (float)range;
 234     float fthumb = (float)thumbSize;
 235     float fpage = (float)pageSize;
 236
 237     if ((fabs(frange-m_adjust->upper) < 0.2) &&
 238         (fabs(fthumb-m_adjust->page_size) < 0.2) &&
 239         (fabs(fpage-m_adjust->page_increment) < 0.2))
 240     {
 241         SetThumbPosition( position );
 242         return;
 243     }
 244
 245     m_oldPos = fpos;
 246
 247     m_adjust->lower = 0.0;
 248     m_adjust->upper = frange;
 249     m_adjust->value = fpos;
 250     m_adjust->step_increment = 1.0;
 251     m_adjust->page_increment = (float)(wxMax(fpage,0));
 252     m_adjust->page_size = fthumb;
 253
 254     gtk_signal_emit_by_name( GTK_OBJECT(m_adjust), "changed" );
 255 }
 256
 257 /* Backward compatibility */
 258 int wxScrollBar::GetValue() const
 259 {
 260     return GetThumbPosition();
 261 }
 262
 263 void wxScrollBar::SetValue( int viewStart )
 264 {
 265     SetThumbPosition( viewStart );
 266 }
 267
 268 void wxScrollBar::GetValues( int *viewStart, int *viewLength, int *objectLength, int *pageLength ) const
 269 {
 270     int pos = (int)(m_adjust->value+0.5);
 271     int thumb = (int)(m_adjust->page_size+0.5);
 272     int page = (int)(m_adjust->page_increment+0.5);
 273     int range = (int)(m_adjust->upper+0.5);
 274
 275     *viewStart = pos;
 276     *viewLength = range;
 277     *objectLength = thumb;
 278     *pageLength = page;
 279 }
 280
 281 int wxScrollBar::GetViewLength() const
 282 {
 283     return (int)(m_adjust->upper+0.5);
 284 }
 285
 286 int wxScrollBar::GetObjectLength() const
 287 {
 288     return (int)(m_adjust->page_size+0.5);
 289 }
 290
 291 void wxScrollBar::SetPageSize( int pageLength )
 292 {
 293     int pos = (int)(m_adjust->value+0.5);
 294     int thumb = (int)(m_adjust->page_size+0.5);
 295     int range = (int)(m_adjust->upper+0.5);
 296     SetScrollbar( pos, thumb, range, pageLength );
 297 }
 298
 299 void wxScrollBar::SetObjectLength( int objectLength )
 300 {
 301     int pos = (int)(m_adjust->value+0.5);
 302     int page = (int)(m_adjust->page_increment+0.5);
 303     int range = (int)(m_adjust->upper+0.5);
 304     SetScrollbar( pos, objectLength, range, page );
 305 }
 306
 307 void wxScrollBar::SetViewLength( int viewLength )
 308 {
 309     int pos = (int)(m_adjust->value+0.5);
 310     int thumb = (int)(m_adjust->page_size+0.5);
 311     int page = (int)(m_adjust->page_increment+0.5);
 312     SetScrollbar( pos, thumb, viewLength, page );
 313 }
 314
 315 bool wxScrollBar::IsOwnGtkWindow( GdkWindow *window )
 316 {
 317     GtkRange *range = GTK_RANGE(m_widget);
 318     return ( (window == GTK_WIDGET(range)->window)
 319 #ifndef __WXGTK20__
 320                 || (window == range->trough)
 321                 || (window == range->slider)
 322                 || (window == range->step_forw)
 323                 || (window == range->step_back)
 324 #endif // GTK+ 1.x
 325            );
 326 }
 327
 328 wxSize wxScrollBar::DoGetBestSize() const
 329 {
 330     return wxControl::DoGetBestSize();
 331 }
 332
 333 // static
 334 wxVisualAttributes
 335 wxScrollBar::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 336 {
 337     return GetDefaultAttributesFromGTKWidget(gtk_vscrollbar_new);
 338 }
 339
 340 #endif