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