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();
 183
 184     SetBestSize(size);
 185
 186     SetBackgroundColour( parent->GetBackgroundColour() );
 187
 188     Show( TRUE );
 189
 190     return TRUE;
 191 }
 192
 193 int wxScrollBar::GetThumbPosition() const
 194 {
 195     double val = m_adjust->value;
 196     return (int)(val < 0 ? val - 0.5 : val + 0.5);
 197 }
 198
 199 int wxScrollBar::GetThumbSize() const
 200 {
 201     return (int)(m_adjust->page_size+0.5);
 202 }
 203
 204 int wxScrollBar::GetPageSize() const
 205 {
 206     return (int)(m_adjust->page_increment+0.5);
 207 }
 208
 209 int wxScrollBar::GetRange() const
 210 {
 211     return (int)(m_adjust->upper+0.5);
 212 }
 213
 214 void wxScrollBar::SetThumbPosition( int viewStart )
 215 {
 216     if (m_isScrolling) return;
 217
 218     float fpos = (float)viewStart;
 219     m_oldPos = fpos;
 220     if (fabs(fpos-m_adjust->value) < 0.2) return;
 221     m_adjust->value = fpos;
 222
 223     gtk_signal_disconnect_by_func( GTK_OBJECT(m_adjust),
 224                         (GtkSignalFunc) gtk_scrollbar_callback,
 225                         (gpointer) this );
 226
 227     gtk_signal_emit_by_name( GTK_OBJECT(m_adjust), "value_changed" );
 228
 229     gtk_signal_connect( GTK_OBJECT(m_adjust),
 230                         "value_changed",
 231                         (GtkSignalFunc) gtk_scrollbar_callback,
 232                         (gpointer) this );
 233 }
 234
 235 void wxScrollBar::SetScrollbar( int position, int thumbSize, int range, int pageSize,
 236       bool WXUNUSED(refresh) )
 237 {
 238     float fpos = (float)position;
 239     float frange = (float)range;
 240     float fthumb = (float)thumbSize;
 241     float fpage = (float)pageSize;
 242
 243     if ((fabs(frange-m_adjust->upper) < 0.2) &&
 244         (fabs(fthumb-m_adjust->page_size) < 0.2) &&
 245         (fabs(fpage-m_adjust->page_increment) < 0.2))
 246     {
 247         SetThumbPosition( position );
 248         return;
 249     }
 250
 251     m_oldPos = fpos;
 252
 253     m_adjust->lower = 0.0;
 254     m_adjust->upper = frange;
 255     m_adjust->value = fpos;
 256     m_adjust->step_increment = 1.0;
 257     m_adjust->page_increment = (float)(wxMax(fpage,0));
 258     m_adjust->page_size = fthumb;
 259
 260     gtk_signal_emit_by_name( GTK_OBJECT(m_adjust), "changed" );
 261 }
 262
 263 /* Backward compatibility */
 264 int wxScrollBar::GetValue() const
 265 {
 266     return GetThumbPosition();
 267 }
 268
 269 void wxScrollBar::SetValue( int viewStart )
 270 {
 271     SetThumbPosition( viewStart );
 272 }
 273
 274 void wxScrollBar::GetValues( int *viewStart, int *viewLength, int *objectLength, int *pageLength ) const
 275 {
 276     int pos = (int)(m_adjust->value+0.5);
 277     int thumb = (int)(m_adjust->page_size+0.5);
 278     int page = (int)(m_adjust->page_increment+0.5);
 279     int range = (int)(m_adjust->upper+0.5);
 280
 281     *viewStart = pos;
 282     *viewLength = range;
 283     *objectLength = thumb;
 284     *pageLength = page;
 285 }
 286
 287 int wxScrollBar::GetViewLength() const
 288 {
 289     return (int)(m_adjust->upper+0.5);
 290 }
 291
 292 int wxScrollBar::GetObjectLength() const
 293 {
 294     return (int)(m_adjust->page_size+0.5);
 295 }
 296
 297 void wxScrollBar::SetPageSize( int pageLength )
 298 {
 299     int pos = (int)(m_adjust->value+0.5);
 300     int thumb = (int)(m_adjust->page_size+0.5);
 301     int range = (int)(m_adjust->upper+0.5);
 302     SetScrollbar( pos, thumb, range, pageLength );
 303 }
 304
 305 void wxScrollBar::SetObjectLength( int objectLength )
 306 {
 307     int pos = (int)(m_adjust->value+0.5);
 308     int page = (int)(m_adjust->page_increment+0.5);
 309     int range = (int)(m_adjust->upper+0.5);
 310     SetScrollbar( pos, objectLength, range, page );
 311 }
 312
 313 void wxScrollBar::SetViewLength( int viewLength )
 314 {
 315     int pos = (int)(m_adjust->value+0.5);
 316     int thumb = (int)(m_adjust->page_size+0.5);
 317     int page = (int)(m_adjust->page_increment+0.5);
 318     SetScrollbar( pos, thumb, viewLength, page );
 319 }
 320
 321 bool wxScrollBar::IsOwnGtkWindow( GdkWindow *window )
 322 {
 323     GtkRange *range = GTK_RANGE(m_widget);
 324     return ( (window == GTK_WIDGET(range)->window)
 325 #ifndef __WXGTK20__
 326                 || (window == range->trough)
 327                 || (window == range->slider)
 328                 || (window == range->step_forw)
 329                 || (window == range->step_back)
 330 #endif // GTK+ 1.x
 331            );
 332 }
 333
 334 void wxScrollBar::ApplyWidgetStyle()
 335 {
 336     SetWidgetStyle();
 337     gtk_widget_set_style( m_widget, m_widgetStyle );
 338 }
 339
 340 wxSize wxScrollBar::DoGetBestSize() const
 341 {
 342     return wxControl::DoGetBestSize();
 343 }
 344
 345 #endif