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 #ifndef WX_PRECOMP
  18     #include "wx/utils.h"
  19 #endif
  20
  21 #include "wx/gtk/private.h"
  22
  23 //-----------------------------------------------------------------------------
  24 // "value_changed" from scrollbar
  25 //-----------------------------------------------------------------------------
  26
  27 extern "C" {
  28 static void
  29 gtk_value_changed(GtkRange* range, wxScrollBar* win)
  30 {
  31     wxEventType eventType = win->GetScrollEventType(range);
  32     if (eventType != wxEVT_NULL)
  33     {
  34         const int orient = win->HasFlag(wxSB_VERTICAL) ? wxVERTICAL : wxHORIZONTAL;
  35         const int i = orient == wxVERTICAL;
  36         const int value = win->GetThumbPosition();
  37         wxScrollEvent event(eventType, win->GetId(), value, orient);
  38         event.SetEventObject(win);
  39         win->m_blockValueChanged[i] = true;
  40         win->GetEventHandler()->ProcessEvent(event);
  41         if (!win->m_isScrolling)
  42         {
  43             wxScrollEvent event(wxEVT_SCROLL_CHANGED, win->GetId(), value, orient);
  44             event.SetEventObject(win);
  45             win->GetEventHandler()->ProcessEvent(event);
  46         }
  47         win->m_blockValueChanged[i] = false;
  48     }
  49 }
  50 }
  51
  52 //-----------------------------------------------------------------------------
  53 // "button_press_event" from scrollbar
  54 //-----------------------------------------------------------------------------
  55
  56 extern "C" {
  57 static gboolean
  58 gtk_button_press_event(GtkRange*, GdkEventButton*, wxScrollBar* win)
  59 {
  60     // don't need to install idle handler, its done from "event" signal
  61
  62     win->m_mouseButtonDown = true;
  63     return false;
  64 }
  65 }
  66
  67 //-----------------------------------------------------------------------------
  68 // "event_after" from scrollbar
  69 //-----------------------------------------------------------------------------
  70
  71 extern "C" {
  72 static void
  73 gtk_event_after(GtkRange* range, GdkEvent* event, wxScrollBar* win)
  74 {
  75     if (event->type == GDK_BUTTON_RELEASE)
  76     {
  77         g_signal_handlers_block_by_func(range, (void*)gtk_event_after, win);
  78
  79         const int value = win->GetThumbPosition();
  80         const int orient = win->HasFlag(wxSB_VERTICAL) ? wxVERTICAL : wxHORIZONTAL;
  81
  82         wxScrollEvent event(wxEVT_SCROLL_THUMBRELEASE, win->GetId(), value, orient);
  83         event.SetEventObject(win);
  84         win->GetEventHandler()->ProcessEvent(event);
  85
  86         wxScrollEvent event2(wxEVT_SCROLL_CHANGED, win->GetId(), value, orient);
  87         event2.SetEventObject(win);
  88         win->GetEventHandler()->ProcessEvent(event2);
  89     }
  90 }
  91 }
  92
  93 //-----------------------------------------------------------------------------
  94 // "button_release_event" from scrollbar
  95 //-----------------------------------------------------------------------------
  96
  97 extern "C" {
  98 static gboolean
  99 gtk_button_release_event(GtkRange* range, GdkEventButton*, wxScrollBar* win)
 100 {
 101     // don't need to install idle handler, its done from "event" signal
 102
 103     win->m_mouseButtonDown = false;
 104     // If thumb tracking
 105     if (win->m_isScrolling)
 106     {
 107         win->m_isScrolling = false;
 108         // Hook up handler to send thumb release event after this emission is finished.
 109         // To allow setting scroll position from event handler, sending event must
 110         // be deferred until after the GtkRange handler for this signal has run
 111         g_signal_handlers_unblock_by_func(range, (void*)gtk_event_after, win);
 112     }
 113
 114     return false;
 115 }
 116 }
 117
 118 //-----------------------------------------------------------------------------
 119 // wxScrollBar
 120 //-----------------------------------------------------------------------------
 121
 122 IMPLEMENT_DYNAMIC_CLASS(wxScrollBar,wxControl)
 123
 124 wxScrollBar::wxScrollBar()
 125 {
 126 }
 127
 128 wxScrollBar::~wxScrollBar()
 129 {
 130 }
 131
 132 bool wxScrollBar::Create(wxWindow *parent, wxWindowID id,
 133            const wxPoint& pos, const wxSize& size,
 134            long style, const wxValidator& validator, const wxString& name )
 135 {
 136     m_needParent = true;
 137
 138     if (!PreCreation( parent, pos, size ) ||
 139         !CreateBase( parent, id, pos, size, style, validator, name ))
 140     {
 141         wxFAIL_MSG( wxT("wxScrollBar creation failed") );
 142         return false;
 143     }
 144
 145     const bool isVertical = (style & wxSB_VERTICAL) != 0;
 146     if (isVertical)
 147         m_widget = gtk_vscrollbar_new( (GtkAdjustment *) NULL );
 148     else
 149         m_widget = gtk_hscrollbar_new( (GtkAdjustment *) NULL );
 150
 151     m_scrollBar[int(isVertical)] = (GtkRange*)m_widget;
 152
 153     g_signal_connect(m_widget, "value_changed",
 154                      G_CALLBACK(gtk_value_changed), this);
 155     g_signal_connect(m_widget, "button_press_event",
 156                      G_CALLBACK(gtk_button_press_event), this);
 157     g_signal_connect(m_widget, "button_release_event",
 158                      G_CALLBACK(gtk_button_release_event), this);
 159
 160     gulong handler_id;
 161     handler_id = g_signal_connect(
 162         m_widget, "event_after", G_CALLBACK(gtk_event_after), this);
 163     g_signal_handler_block(m_widget, handler_id);
 164
 165     m_parent->DoAddChild( this );
 166
 167     PostCreation(size);
 168
 169     return true;
 170 }
 171
 172 int wxScrollBar::GetThumbPosition() const
 173 {
 174     GtkAdjustment* adj = ((GtkRange*)m_widget)->adjustment;
 175     return int(adj->value + 0.5);
 176 }
 177
 178 int wxScrollBar::GetThumbSize() const
 179 {
 180     GtkAdjustment* adj = ((GtkRange*)m_widget)->adjustment;
 181     return int(adj->page_size);
 182 }
 183
 184 int wxScrollBar::GetPageSize() const
 185 {
 186     GtkAdjustment* adj = ((GtkRange*)m_widget)->adjustment;
 187     return int(adj->page_increment);
 188 }
 189
 190 int wxScrollBar::GetRange() const
 191 {
 192     GtkAdjustment* adj = ((GtkRange*)m_widget)->adjustment;
 193     return int(adj->upper);
 194 }
 195
 196 void wxScrollBar::SetThumbPosition( int viewStart )
 197 {
 198     if (GetThumbPosition() != viewStart)
 199     {
 200         GtkAdjustment* adj = ((GtkRange*)m_widget)->adjustment;
 201         const int i = (GtkRange*)m_widget == m_scrollBar[1];
 202         const int max = int(adj->upper - adj->page_size);
 203         if (viewStart > max)
 204             viewStart = max;
 205         if (viewStart < 0)
 206             viewStart = 0;
 207
 208         m_scrollPos[i] =
 209         adj->value = viewStart;
 210         // If a "value_changed" signal emission is not already in progress
 211         if (!m_blockValueChanged[i])
 212         {
 213             gtk_adjustment_value_changed(adj);
 214         }
 215     }
 216 }
 217
 218 void wxScrollBar::SetScrollbar(int position, int thumbSize, int range, int pageSize, bool)
 219 {
 220     if (range == 0)
 221     {
 222         // GtkRange requires upper > lower
 223         range =
 224         thumbSize = 1;
 225     }
 226     if (position > range - thumbSize)
 227         position = range - thumbSize;
 228     if (position < 0)
 229         position = 0;
 230     GtkAdjustment* adj = ((GtkRange*)m_widget)->adjustment;
 231     adj->step_increment = 1;
 232     adj->page_increment = pageSize;
 233     adj->page_size = thumbSize;
 234     adj->upper = range;
 235     SetThumbPosition(position);
 236     gtk_adjustment_changed(adj);
 237 }
 238
 239 void wxScrollBar::SetPageSize( int pageLength )
 240 {
 241     SetScrollbar(GetThumbPosition(), GetThumbSize(), GetRange(), pageLength);
 242 }
 243
 244 void wxScrollBar::SetRange(int range)
 245 {
 246     SetScrollbar(GetThumbPosition(), GetThumbSize(), range, GetPageSize());
 247 }
 248
 249 GdkWindow *wxScrollBar::GTKGetWindow(wxArrayGdkWindows& WXUNUSED(windows)) const
 250 {
 251     return GTK_WIDGET(GTK_RANGE(m_widget))->window;
 252 }
 253
 254 // static
 255 wxVisualAttributes
 256 wxScrollBar::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 257 {
 258     return GetDefaultAttributesFromGTKWidget(gtk_vscrollbar_new);
 259 }
 260
 261 #endif // wxUSE_SCROLLBAR