]> git.saurik.com Git - wxWidgets.git/blame - src/gtk/slider.cpp
missing commit
[wxWidgets.git] / src / gtk / slider.cpp
CommitLineData
c801d85f 1/////////////////////////////////////////////////////////////////////////////
de6185e2 2// Name: src/gtk/slider.cpp
c801d85f
KB
3// Purpose:
4// Author: Robert Roebling
f96aa4d9
RR
5// Id: $Id$
6// Copyright: (c) 1998 Robert Roebling
65571936 7// Licence: wxWindows licence
c801d85f
KB
8/////////////////////////////////////////////////////////////////////////////
9
14f355c2
VS
10// For compilers that support precompilation, includes "wx.h".
11#include "wx/wxprec.h"
12
de6185e2
WS
13#if wxUSE_SLIDER
14
c801d85f 15#include "wx/slider.h"
dcf924a3 16
de6185e2
WS
17#ifndef WX_PRECOMP
18 #include "wx/utils.h"
23f826bd 19 #include "wx/math.h"
de6185e2 20#endif
dcf924a3 21
a1abca32 22#include <gtk/gtk.h>
385e8575 23#include "wx/gtk/private/gtk2-compat.h"
83624f79 24
66bd6b93
RR
25//-----------------------------------------------------------------------------
26// data
27//-----------------------------------------------------------------------------
28
1e6feb95 29extern bool g_blockEventsOnDrag;
66bd6b93 30
2b024653
VZ
31// ----------------------------------------------------------------------------
32// helper functions
33// ----------------------------------------------------------------------------
34
2b024653
VZ
35// process a scroll event
36static void
12a480c1 37ProcessScrollEvent(wxSlider *win, wxEventType evtType)
2b024653 38{
46c48053
VZ
39 const int orient = win->HasFlag(wxSL_VERTICAL) ? wxVERTICAL
40 : wxHORIZONTAL;
2b024653 41
12a480c1 42 const int value = win->GetValue();
2b024653 43
46c48053
VZ
44 // if we have any "special" event (i.e. the value changed by a line or a
45 // page), send this specific event first
46 if ( evtType != wxEVT_NULL )
47 {
48 wxScrollEvent event( evtType, win->GetId(), value, orient );
49 event.SetEventObject( win );
937013e0 50 win->HandleWindowEvent( event );
46c48053
VZ
51 }
52
53 // but, in any case, except if we're dragging the slider (and so the change
54 // is not definitive), send a generic "changed" event
8e3e14c4
VZ
55 if ( evtType != wxEVT_SCROLL_THUMBTRACK )
56 {
46c48053
VZ
57 wxScrollEvent event(wxEVT_SCROLL_CHANGED, win->GetId(), value, orient);
58 event.SetEventObject( win );
937013e0 59 win->HandleWindowEvent( event );
8e3e14c4
VZ
60 }
61
46c48053 62 // and also generate a command event for compatibility
ce7fe42e 63 wxCommandEvent event( wxEVT_SLIDER, win->GetId() );
46c48053
VZ
64 event.SetEventObject( win );
65 event.SetInt( value );
937013e0 66 win->HandleWindowEvent( event );
2b024653 67}
57a1fd73 68
12a480c1
PC
69static inline wxEventType GtkScrollTypeToWx(int scrollType)
70{
71 wxEventType eventType;
72 switch (scrollType)
73 {
74 case GTK_SCROLL_STEP_BACKWARD:
75 case GTK_SCROLL_STEP_LEFT:
76 case GTK_SCROLL_STEP_UP:
77 eventType = wxEVT_SCROLL_LINEUP;
78 break;
79 case GTK_SCROLL_STEP_DOWN:
80 case GTK_SCROLL_STEP_FORWARD:
81 case GTK_SCROLL_STEP_RIGHT:
82 eventType = wxEVT_SCROLL_LINEDOWN;
83 break;
84 case GTK_SCROLL_PAGE_BACKWARD:
85 case GTK_SCROLL_PAGE_LEFT:
86 case GTK_SCROLL_PAGE_UP:
87 eventType = wxEVT_SCROLL_PAGEUP;
88 break;
89 case GTK_SCROLL_PAGE_DOWN:
90 case GTK_SCROLL_PAGE_FORWARD:
91 case GTK_SCROLL_PAGE_RIGHT:
92 eventType = wxEVT_SCROLL_PAGEDOWN;
93 break;
94 case GTK_SCROLL_START:
95 eventType = wxEVT_SCROLL_TOP;
96 break;
97 case GTK_SCROLL_END:
98 eventType = wxEVT_SCROLL_BOTTOM;
99 break;
100 case GTK_SCROLL_JUMP:
101 eventType = wxEVT_SCROLL_THUMBTRACK;
102 break;
103 default:
9a83f860 104 wxFAIL_MSG(wxT("Unknown GtkScrollType"));
12a480c1
PC
105 eventType = wxEVT_NULL;
106 break;
107 }
108 return eventType;
109}
110
111// Determine if increment is the same as +/-x, allowing for some small
112// difference due to possible inexactness in floating point arithmetic
113static inline bool IsScrollIncrement(double increment, double x)
114{
115 wxASSERT(increment > 0);
116 const double tolerance = 1.0 / 1024;
117 return fabs(increment - fabs(x)) < tolerance;
118}
119
c801d85f 120//-----------------------------------------------------------------------------
97b3455a 121// "value_changed"
c801d85f
KB
122//-----------------------------------------------------------------------------
123
865bb325 124extern "C" {
12a480c1
PC
125static void
126gtk_value_changed(GtkRange* range, wxSlider* win)
80810ca3 127{
385e8575 128 const double value = gtk_range_get_value(range);
12a480c1 129 const double oldPos = win->m_pos;
385e8575 130 win->m_pos = value;
559f60ef 131
8ab75332 132 if (g_blockEventsOnDrag)
559f60ef
PC
133 return;
134
c092ed38 135 if (win->GTKEventsDisabled())
12a480c1
PC
136 {
137 win->m_scrollEventType = GTK_SCROLL_NONE;
2b024653 138 return;
12a480c1 139 }
80810ca3 140
12a480c1
PC
141 wxEventType eventType = wxEVT_NULL;
142 if (win->m_isScrolling)
143 {
144 eventType = wxEVT_SCROLL_THUMBTRACK;
145 }
146 else if (win->m_scrollEventType != GTK_SCROLL_NONE)
147 {
148 // Scroll event from "move-slider" (keyboard)
149 eventType = GtkScrollTypeToWx(win->m_scrollEventType);
150 }
151 else if (win->m_mouseButtonDown)
152 {
153 // Difference from last change event
385e8575 154 const double diff = value - oldPos;
12a480c1 155 const bool isDown = diff > 0;
2d17d68f 156
385e8575
PC
157 GtkAdjustment* adj = gtk_range_get_adjustment(range);
158 if (IsScrollIncrement(gtk_adjustment_get_page_increment(adj), diff))
12a480c1
PC
159 {
160 eventType = isDown ? wxEVT_SCROLL_PAGEDOWN : wxEVT_SCROLL_PAGEUP;
161 }
385e8575 162 else if (wxIsSameDouble(value, 0))
12a480c1
PC
163 {
164 eventType = wxEVT_SCROLL_PAGEUP;
165 }
385e8575 166 else if (wxIsSameDouble(value, gtk_adjustment_get_upper(adj)))
12a480c1
PC
167 {
168 eventType = wxEVT_SCROLL_PAGEDOWN;
169 }
170 else
171 {
172 // Assume track event
173 eventType = wxEVT_SCROLL_THUMBTRACK;
174 // Remember that we're tracking
175 win->m_isScrolling = true;
176 }
177 }
178
179 win->m_scrollEventType = GTK_SCROLL_NONE;
180
181 // If integral position has changed
385e8575 182 if (wxRound(oldPos) != wxRound(value))
12a480c1 183 {
12a480c1
PC
184 ProcessScrollEvent(win, eventType);
185 win->m_needThumbRelease = eventType == wxEVT_SCROLL_THUMBTRACK;
186 }
187}
188}
80810ca3 189
12a480c1
PC
190//-----------------------------------------------------------------------------
191// "move_slider" (keyboard event)
192//-----------------------------------------------------------------------------
193
194extern "C" {
195static void
196gtk_move_slider(GtkRange*, GtkScrollType scrollType, wxSlider* win)
197{
198 // Save keyboard scroll type for "value_changed" handler
199 win->m_scrollEventType = scrollType;
200}
2b024653 201}
80810ca3 202
12a480c1
PC
203//-----------------------------------------------------------------------------
204// "button_press_event"
205//-----------------------------------------------------------------------------
206
207extern "C" {
208static gboolean
209gtk_button_press_event(GtkWidget*, GdkEventButton*, wxSlider* win)
2b024653 210{
12a480c1 211 win->m_mouseButtonDown = true;
80810ca3 212
12a480c1
PC
213 return false;
214}
2b024653 215}
80810ca3 216
c918b2cd
PC
217//-----------------------------------------------------------------------------
218// "event_after"
219//-----------------------------------------------------------------------------
220
12a480c1 221extern "C" {
c918b2cd
PC
222static void
223gtk_event_after(GtkRange* range, GdkEvent* event, wxSlider* win)
2b024653 224{
c918b2cd 225 if (event->type == GDK_BUTTON_RELEASE)
12a480c1 226 {
20c3174d 227 g_signal_handlers_block_by_func(range, (gpointer) gtk_event_after, win);
c918b2cd
PC
228
229 if (win->m_needThumbRelease)
230 {
231 win->m_needThumbRelease = false;
232 ProcessScrollEvent(win, wxEVT_SCROLL_THUMBRELEASE);
233 }
234 // Keep slider at an integral position
c092ed38
RR
235 win->GTKDisableEvents();
236 gtk_range_set_value(GTK_RANGE (win->m_scale), win->GetValue());
237 win->GTKEnableEvents();
12a480c1 238 }
12a480c1
PC
239}
240}
2b024653 241
12a480c1
PC
242//-----------------------------------------------------------------------------
243// "button_release_event"
244//-----------------------------------------------------------------------------
2b024653 245
12a480c1
PC
246extern "C" {
247static gboolean
c918b2cd 248gtk_button_release_event(GtkRange* range, GdkEventButton*, wxSlider* win)
12a480c1
PC
249{
250 win->m_mouseButtonDown = false;
251 if (win->m_isScrolling)
252 {
c918b2cd 253 win->m_isScrolling = false;
20c3174d 254 g_signal_handlers_unblock_by_func(range, (gpointer) gtk_event_after, win);
12a480c1
PC
255 }
256 return false;
257}
6de97a3b 258}
2b024653 259
12a480c1
PC
260//-----------------------------------------------------------------------------
261// "format_value"
262//-----------------------------------------------------------------------------
263
264extern "C" {
265static gchar* gtk_format_value(GtkScale*, double value, void*)
266{
267 // Format value as nearest integer
23f826bd 268 return g_strdup_printf("%d", wxRound(value));
12a480c1 269}
865bb325 270}
c801d85f 271
97b3455a
RR
272//-----------------------------------------------------------------------------
273// wxSlider
274//-----------------------------------------------------------------------------
275
12a480c1
PC
276wxSlider::wxSlider()
277{
8ab75332
PC
278 m_scale = NULL;
279}
280
281wxSlider::~wxSlider()
282{
283 if (m_scale && m_scale != m_widget)
284 GTKDisconnect(m_scale);
12a480c1
PC
285}
286
e8375af8
VZ
287bool wxSlider::Create(wxWindow *parent,
288 wxWindowID id,
289 int value,
290 int minValue,
291 int maxValue,
292 const wxPoint& pos,
293 const wxSize& size,
294 long style,
295 const wxValidator& validator,
296 const wxString& name)
c801d85f 297{
3824e0db
VZ
298 m_pos = value;
299 m_scrollEventType = GTK_SCROLL_NONE;
8ab75332
PC
300 m_needThumbRelease = false;
301 m_blockScrollEvent = false;
3824e0db 302
4dcaf11a
RR
303 if (!PreCreation( parent, pos, size ) ||
304 !CreateBase( parent, id, pos, size, style, validator, name ))
305 {
223d09f6 306 wxFAIL_MSG( wxT("wxSlider creation failed") );
de6185e2 307 return false;
4dcaf11a 308 }
eec4500d 309
1897abe1
PC
310 const bool isVertical = (style & wxSL_VERTICAL) != 0;
311 m_scale = gtk_scale_new(GtkOrientation(isVertical), NULL);
80810ca3 312
c092ed38
RR
313 if (style & wxSL_MIN_MAX_LABELS)
314 {
315 gtk_widget_show( m_scale );
eec4500d 316
1897abe1
PC
317 m_widget = gtk_box_new(GtkOrientation(!isVertical), 0);
318 gtk_box_pack_start(GTK_BOX(m_widget), m_scale, true, true, 0);
c092ed38 319
1897abe1 320 GtkWidget* box = gtk_box_new(GtkOrientation(isVertical), 0);
c092ed38 321 gtk_widget_show(box);
1897abe1 322 gtk_box_pack_start(GTK_BOX(m_widget), box, true, true, 0);
eec4500d 323
c092ed38 324 m_minLabel = gtk_label_new(NULL);
c092ed38 325 gtk_widget_show( m_minLabel );
1897abe1 326 gtk_box_pack_start(GTK_BOX(box), m_minLabel, false, false, 0);
eec4500d 327
c092ed38
RR
328 // expanding empty space between the min/max labels
329 GtkWidget *space = gtk_label_new(NULL);
c092ed38 330 gtk_widget_show( space );
1897abe1 331 gtk_box_pack_start(GTK_BOX(box), space, true, false, 0);
eec4500d 332
c092ed38 333 m_maxLabel = gtk_label_new(NULL);
c092ed38 334 gtk_widget_show( m_maxLabel );
1897abe1 335 gtk_box_pack_end(GTK_BOX(box), m_maxLabel, false, false, 0);
c092ed38
RR
336 }
337 else
338 {
339 m_widget = m_scale;
340 m_maxLabel = NULL;
341 m_minLabel = NULL;
342 }
907f5902 343 g_object_ref(m_widget);
eec4500d 344
c0a9fe92
VZ
345 const bool showValueLabel = (style & wxSL_VALUE_LABEL) != 0;
346 gtk_scale_set_draw_value(GTK_SCALE (m_scale), showValueLabel );
347 if ( showValueLabel )
3312ee03 348 {
c0a9fe92
VZ
349 // position the label appropriately: notice that wxSL_DIRECTION flags
350 // specify the position of the ticks, not label, under MSW and so the
351 // label is on the opposite side
352 GtkPositionType posLabel;
353 if ( style & wxSL_VERTICAL )
354 {
355 if ( style & wxSL_LEFT )
356 posLabel = GTK_POS_RIGHT;
357 else // if ( style & wxSL_RIGHT ) -- this is also the default
358 posLabel = GTK_POS_LEFT;
359 }
360 else // horizontal slider
361 {
362 if ( style & wxSL_TOP )
363 posLabel = GTK_POS_BOTTOM;
364 else // if ( style & wxSL_BOTTOM) -- this is again the default
365 posLabel = GTK_POS_TOP;
366 }
eec4500d 367
c0a9fe92 368 gtk_scale_set_value_pos( GTK_SCALE(m_scale), posLabel );
f050bdbd 369 }
eec4500d 370
12a480c1 371 // Keep full precision in position value
c092ed38 372 gtk_scale_set_digits(GTK_SCALE (m_scale), -1);
80810ca3 373
1e219378 374 if (style & wxSL_INVERSE)
c092ed38 375 gtk_range_set_inverted( GTK_RANGE(m_scale), TRUE );
1e219378 376
c092ed38
RR
377 g_signal_connect(m_scale, "button_press_event", G_CALLBACK(gtk_button_press_event), this);
378 g_signal_connect(m_scale, "button_release_event", G_CALLBACK(gtk_button_release_event), this);
379 g_signal_connect(m_scale, "move_slider", G_CALLBACK(gtk_move_slider), this);
380 g_signal_connect(m_scale, "format_value", G_CALLBACK(gtk_format_value), NULL);
381 g_signal_connect(m_scale, "value_changed", G_CALLBACK(gtk_value_changed), this);
382 gulong handler_id = g_signal_connect(m_scale, "event_after", G_CALLBACK(gtk_event_after), this);
383 g_signal_handler_block(m_scale, handler_id);
91b167dd 384
2d17d68f 385 SetRange( minValue, maxValue );
3824e0db
VZ
386
387 // don't call the public SetValue() as it won't do anything unless the
388 // value really changed
389 GTKSetValue( value );
80810ca3 390
f03fc89f 391 m_parent->DoAddChild( this );
80810ca3 392
abdeb9e7 393 PostCreation(size);
80810ca3 394
de6185e2 395 return true;
6de97a3b 396}
c801d85f 397
c092ed38
RR
398void wxSlider::GTKDisableEvents()
399{
400 m_blockScrollEvent = true;
401}
402
403void wxSlider::GTKEnableEvents()
404{
405 m_blockScrollEvent = false;
406}
407
408bool wxSlider::GTKEventsDisabled() const
409{
410 return m_blockScrollEvent;
411}
412
1e1fafb9 413int wxSlider::GetValue() const
c801d85f 414{
23f826bd 415 return wxRound(m_pos);
6de97a3b 416}
c801d85f 417
debe6624 418void wxSlider::SetValue( int value )
c801d85f 419{
12a480c1 420 if (GetValue() != value)
3824e0db
VZ
421 GTKSetValue(value);
422}
423
424void wxSlider::GTKSetValue(int value)
425{
c092ed38
RR
426 GTKDisableEvents();
427 gtk_range_set_value(GTK_RANGE (m_scale), value);
ba9eca1a
PC
428 // GTK only updates value label if handle moves at least 1 pixel
429 gtk_widget_queue_draw(m_scale);
c092ed38 430 GTKEnableEvents();
6de97a3b 431}
c801d85f 432
debe6624 433void wxSlider::SetRange( int minValue, int maxValue )
c801d85f 434{
c092ed38 435 GTKDisableEvents();
908eeca8
RR
436 if (minValue == maxValue)
437 maxValue++;
c092ed38
RR
438 gtk_range_set_range(GTK_RANGE (m_scale), minValue, maxValue);
439 gtk_range_set_increments(GTK_RANGE (m_scale), 1, (maxValue - minValue + 9) / 10);
440 GTKEnableEvents();
eec4500d 441
c092ed38
RR
442 if (HasFlag(wxSL_MIN_MAX_LABELS))
443 {
444 wxString str;
eec4500d 445
c092ed38
RR
446 str.Printf( "%d", minValue );
447 if (HasFlag(wxSL_INVERSE))
448 gtk_label_set_text( GTK_LABEL(m_maxLabel), str.utf8_str() );
449 else
450 gtk_label_set_text( GTK_LABEL(m_minLabel), str.utf8_str() );
eec4500d 451
c092ed38
RR
452 str.Printf( "%d", maxValue );
453 if (HasFlag(wxSL_INVERSE))
454 gtk_label_set_text( GTK_LABEL(m_minLabel), str.utf8_str() );
455 else
456 gtk_label_set_text( GTK_LABEL(m_maxLabel), str.utf8_str() );
eec4500d 457
c092ed38 458 }
6de97a3b 459}
c801d85f 460
1e1fafb9 461int wxSlider::GetMin() const
c801d85f 462{
385e8575
PC
463 GtkAdjustment* adj = gtk_range_get_adjustment(GTK_RANGE(m_scale));
464 return int(gtk_adjustment_get_lower(adj));
6de97a3b 465}
c801d85f 466
1e1fafb9 467int wxSlider::GetMax() const
c801d85f 468{
385e8575
PC
469 GtkAdjustment* adj = gtk_range_get_adjustment(GTK_RANGE(m_scale));
470 return int(gtk_adjustment_get_upper(adj));
6de97a3b 471}
c801d85f 472
debe6624 473void wxSlider::SetPageSize( int pageSize )
c801d85f 474{
c092ed38
RR
475 GTKDisableEvents();
476 gtk_range_set_increments(GTK_RANGE (m_scale), GetLineSize(), pageSize);
477 GTKEnableEvents();
6de97a3b 478}
c801d85f 479
1e1fafb9 480int wxSlider::GetPageSize() const
c801d85f 481{
385e8575
PC
482 GtkAdjustment* adj = gtk_range_get_adjustment(GTK_RANGE(m_scale));
483 return int(gtk_adjustment_get_page_increment(adj));
6de97a3b 484}
c801d85f 485
12a480c1
PC
486// GTK does not support changing the size of the slider
487void wxSlider::SetThumbLength(int)
c801d85f 488{
6de97a3b 489}
c801d85f 490
1e1fafb9 491int wxSlider::GetThumbLength() const
c801d85f 492{
12a480c1 493 return 0;
6de97a3b 494}
c801d85f 495
98a0564e 496void wxSlider::SetLineSize( int lineSize )
c801d85f 497{
c092ed38
RR
498 GTKDisableEvents();
499 gtk_range_set_increments(GTK_RANGE (m_scale), lineSize, GetPageSize());
500 GTKEnableEvents();
6de97a3b 501}
c801d85f 502
1e1fafb9 503int wxSlider::GetLineSize() const
c801d85f 504{
385e8575
PC
505 GtkAdjustment* adj = gtk_range_get_adjustment(GTK_RANGE(m_scale));
506 return int(gtk_adjustment_get_step_increment(adj));
6de97a3b 507}
c801d85f 508
ef5c70f9 509GdkWindow *wxSlider::GTKGetWindow(wxArrayGdkWindows& WXUNUSED(windows)) const
b4071e91 510{
9dc44eff
PC
511#ifdef __WXGTK3__
512 // no access to internal GdkWindows
513 return NULL;
514#else
c092ed38 515 return GTK_RANGE(m_scale)->event_window;
9dc44eff 516#endif
b4071e91
RR
517}
518
9d522606
RD
519// static
520wxVisualAttributes
521wxSlider::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
522{
1897abe1 523 return GetDefaultAttributesFromGTKWidget(gtk_scale_new(GTK_ORIENTATION_VERTICAL, NULL));
9d522606
RD
524}
525
de6185e2 526#endif // wxUSE_SLIDER