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