src/gtk1/scrolbar.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk1/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 #ifndef WX_PRECOMP
  18     #include "wx/utils.h"
  19     #include "wx/math.h"
  20 #endif
  21
  22 #include "wx/gtk1/private.h"
  23
  24 //-----------------------------------------------------------------------------
  25 // idle system
  26 //-----------------------------------------------------------------------------
  27
  28 extern void wxapp_install_idle_handler();
  29 extern bool g_isIdle;
  30
  31 //-----------------------------------------------------------------------------
  32 // data
  33 //-----------------------------------------------------------------------------
  34
  35 extern bool   g_blockEventsOnDrag;
  36 static wxEventType g_currentUpDownEvent = wxEVT_NULL;
  37
  38 static const float sensitivity = 0.02;
  39
  40 //-----------------------------------------------------------------------------
  41 // "value_changed"
  42 //-----------------------------------------------------------------------------
  43
  44 // FIXME: is GtkScrollType really passed to us as 2nd argument?
  45
  46 extern "C" {
  47 static void gtk_scrollbar_callback( GtkAdjustment *adjust,
  48                                     SCROLLBAR_CBACK_ARG
  49                                     wxScrollBar *win )
  50 {
  51     if (g_isIdle) wxapp_install_idle_handler();
  52
  53     if (!win->m_hasVMT) return;
  54     if (g_blockEventsOnDrag) return;
  55
  56     float diff = adjust->value - win->m_oldPos;
  57     if (fabs(diff) < sensitivity) return;
  58
  59     win->m_oldPos = adjust->value;
  60
  61     wxEventType command = GtkScrollTypeToWx(GET_SCROLL_TYPE(win->m_widget));
  62
  63     double dvalue = adjust->value;
  64     int value = (int)(dvalue < 0 ? dvalue - 0.5 : dvalue + 0.5);
  65
  66     int orient = win->HasFlag(wxSB_VERTICAL) ? wxVERTICAL : wxHORIZONTAL;
  67
  68     // throw a LINEUP / LINEDOWN event if necessary
  69     if (g_currentUpDownEvent != wxEVT_NULL)
  70     {
  71         wxScrollEvent event( g_currentUpDownEvent, win->GetId(), value, orient );
  72         event.SetEventObject( win );
  73         win->HandleWindowEvent( event );
  74     }
  75
  76     // throw other event (wxEVT_SCROLL_THUMBTRACK)
  77     wxScrollEvent event( command, win->GetId(), value, orient );
  78     event.SetEventObject( win );
  79     win->HandleWindowEvent( event );
  80
  81 /*
  82     wxCommandEvent cevent( wxEVT_COMMAND_SCROLLBAR_UPDATED, win->GetId() );
  83     cevent.SetEventObject( win );
  84     win->ProcessEvent( cevent );
  85 */
  86 }
  87 }
  88
  89 //-----------------------------------------------------------------------------
  90 // "button_press_event" from slider
  91 //-----------------------------------------------------------------------------
  92 extern "C" {
  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     // There is no slider field any more
 125     win->m_isScrolling = (gdk_event->window == widget->slider);
 126
 127     return FALSE;
 128 }
 129 }
 130
 131 //-----------------------------------------------------------------------------
 132 // "button_release_event" from slider
 133 //-----------------------------------------------------------------------------
 134
 135 extern "C" {
 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->HandleWindowEvent( 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 //-----------------------------------------------------------------------------
 165 // wxScrollBar
 166 //-----------------------------------------------------------------------------
 167
 168 wxScrollBar::~wxScrollBar()
 169 {
 170 }
 171
 172 bool wxScrollBar::Create(wxWindow *parent, wxWindowID id,
 173            const wxPoint& pos, const wxSize& size,
 174            long style, const wxValidator& validator, const wxString& name )
 175 {
 176     m_needParent = true;
 177     m_acceptsFocus = true;
 178
 179     if (!PreCreation( parent, pos, size ) ||
 180         !CreateBase( parent, id, pos, size, style, validator, name ))
 181     {
 182         wxFAIL_MSG( wxT("wxScrollBar creation failed") );
 183         return false;
 184     }
 185
 186     m_oldPos = 0.0;
 187
 188     if ((style & wxSB_VERTICAL) == wxSB_VERTICAL)
 189         m_widget = gtk_vscrollbar_new( NULL );
 190     else
 191         m_widget = gtk_hscrollbar_new( NULL );
 192
 193     m_adjust = gtk_range_get_adjustment( GTK_RANGE(m_widget) );
 194
 195     gtk_signal_connect( GTK_OBJECT(m_adjust),
 196                         "value_changed",
 197                         (GtkSignalFunc) gtk_scrollbar_callback,
 198                         (gpointer) this );
 199     gtk_signal_connect( GTK_OBJECT(m_widget),
 200                         "button_press_event",
 201                         (GtkSignalFunc)gtk_scrollbar_button_press_callback,
 202                         (gpointer) this );
 203     gtk_signal_connect( GTK_OBJECT(m_widget),
 204                         "button_release_event",
 205                         (GtkSignalFunc)gtk_scrollbar_button_release_callback,
 206                         (gpointer) this );
 207
 208     m_parent->DoAddChild( this );
 209
 210     PostCreation(size);
 211
 212     return true;
 213 }
 214
 215 int wxScrollBar::GetThumbPosition() const
 216 {
 217     double val = m_adjust->value;
 218     return (int)(val < 0 ? val - 0.5 : val + 0.5);
 219 }
 220
 221 int wxScrollBar::GetThumbSize() const
 222 {
 223     return (int)(m_adjust->page_size+0.5);
 224 }
 225
 226 int wxScrollBar::GetPageSize() const
 227 {
 228     return (int)(m_adjust->page_increment+0.5);
 229 }
 230
 231 int wxScrollBar::GetRange() const
 232 {
 233     return (int)(m_adjust->upper+0.5);
 234 }
 235
 236 void wxScrollBar::SetThumbPosition( int viewStart )
 237 {
 238     if (m_isScrolling) return;
 239
 240     float fpos = (float)viewStart;
 241     m_oldPos = fpos;
 242     if (fabs(fpos-m_adjust->value) < 0.2) return;
 243     m_adjust->value = fpos;
 244
 245     gtk_signal_disconnect_by_func( GTK_OBJECT(m_adjust),
 246                         (GtkSignalFunc) gtk_scrollbar_callback,
 247                         (gpointer) this );
 248
 249     gtk_signal_emit_by_name( GTK_OBJECT(m_adjust), "value_changed" );
 250
 251     gtk_signal_connect( GTK_OBJECT(m_adjust),
 252                         "value_changed",
 253                         (GtkSignalFunc) gtk_scrollbar_callback,
 254                         (gpointer) this );
 255 }
 256
 257 void wxScrollBar::SetScrollbar( int position, int thumbSize, int range, int pageSize,
 258       bool WXUNUSED(refresh) )
 259 {
 260     float fpos = (float)position;
 261     float frange = (float)range;
 262     float fthumb = (float)thumbSize;
 263     float fpage = (float)pageSize;
 264
 265     if ((fabs(frange-m_adjust->upper) < 0.2) &&
 266         (fabs(fthumb-m_adjust->page_size) < 0.2) &&
 267         (fabs(fpage-m_adjust->page_increment) < 0.2))
 268     {
 269         SetThumbPosition( position );
 270         return;
 271     }
 272
 273     m_oldPos = fpos;
 274
 275     m_adjust->lower = 0.0;
 276     m_adjust->upper = frange;
 277     m_adjust->value = fpos;
 278     m_adjust->step_increment = 1.0;
 279     m_adjust->page_increment = (float)(wxMax(fpage,0));
 280     m_adjust->page_size = fthumb;
 281
 282     gtk_signal_emit_by_name( GTK_OBJECT(m_adjust), "changed" );
 283 }
 284
 285 /* Backward compatibility */
 286 int wxScrollBar::GetValue() const
 287 {
 288     return GetThumbPosition();
 289 }
 290
 291 void wxScrollBar::SetValue( int viewStart )
 292 {
 293     SetThumbPosition( viewStart );
 294 }
 295
 296 void wxScrollBar::GetValues( int *viewStart, int *viewLength, int *objectLength, int *pageLength ) const
 297 {
 298     int pos = (int)(m_adjust->value+0.5);
 299     int thumb = (int)(m_adjust->page_size+0.5);
 300     int page = (int)(m_adjust->page_increment+0.5);
 301     int range = (int)(m_adjust->upper+0.5);
 302
 303     *viewStart = pos;
 304     *viewLength = range;
 305     *objectLength = thumb;
 306     *pageLength = page;
 307 }
 308
 309 int wxScrollBar::GetViewLength() const
 310 {
 311     return (int)(m_adjust->upper+0.5);
 312 }
 313
 314 int wxScrollBar::GetObjectLength() const
 315 {
 316     return (int)(m_adjust->page_size+0.5);
 317 }
 318
 319 void wxScrollBar::SetPageSize( int pageLength )
 320 {
 321     int pos = (int)(m_adjust->value+0.5);
 322     int thumb = (int)(m_adjust->page_size+0.5);
 323     int range = (int)(m_adjust->upper+0.5);
 324     SetScrollbar( pos, thumb, range, pageLength );
 325 }
 326
 327 void wxScrollBar::SetObjectLength( int objectLength )
 328 {
 329     int pos = (int)(m_adjust->value+0.5);
 330     int page = (int)(m_adjust->page_increment+0.5);
 331     int range = (int)(m_adjust->upper+0.5);
 332     SetScrollbar( pos, objectLength, range, page );
 333 }
 334
 335 void wxScrollBar::SetViewLength( int viewLength )
 336 {
 337     int pos = (int)(m_adjust->value+0.5);
 338     int thumb = (int)(m_adjust->page_size+0.5);
 339     int page = (int)(m_adjust->page_increment+0.5);
 340     SetScrollbar( pos, thumb, viewLength, page );
 341 }
 342
 343 bool wxScrollBar::IsOwnGtkWindow( GdkWindow *window )
 344 {
 345     GtkRange *range = GTK_RANGE(m_widget);
 346     return ( (window == GTK_WIDGET(range)->window)
 347                 || (window == range->trough)
 348                 || (window == range->slider)
 349                 || (window == range->step_forw)
 350                 || (window == range->step_back)
 351            );
 352 }
 353
 354 wxSize wxScrollBar::DoGetBestSize() const
 355 {
 356     return wxControl::DoGetBestSize();
 357 }
 358
 359 // static
 360 wxVisualAttributes
 361 wxScrollBar::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 362 {
 363     return GetDefaultAttributesFromGTKWidget(gtk_vscrollbar_new);
 364 }
 365
 366 #endif // wxUSE_SCROLLBAR