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