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