1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/gtk/slider.cpp
4 // Author: Robert Roebling
6 // Copyright: (c) 1998 Robert Roebling
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
10 // For compilers that support precompilation, includes "wx.h".
11 #include "wx/wxprec.h"
15 #include "wx/slider.h"
23 #include "wx/gtk/private/gtk2-compat.h"
25 //-----------------------------------------------------------------------------
27 //-----------------------------------------------------------------------------
29 extern bool g_blockEventsOnDrag
;
31 // ----------------------------------------------------------------------------
33 // ----------------------------------------------------------------------------
35 // process a scroll event
37 ProcessScrollEvent(wxSlider
*win
, wxEventType evtType
)
39 const int orient
= win
->HasFlag(wxSL_VERTICAL
) ? wxVERTICAL
42 const int value
= win
->GetValue();
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
)
48 wxScrollEvent
event( evtType
, win
->GetId(), value
, orient
);
49 event
.SetEventObject( win
);
50 win
->HandleWindowEvent( event
);
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
55 if ( evtType
!= wxEVT_SCROLL_THUMBTRACK
)
57 wxScrollEvent
event(wxEVT_SCROLL_CHANGED
, win
->GetId(), value
, orient
);
58 event
.SetEventObject( win
);
59 win
->HandleWindowEvent( event
);
62 // and also generate a command event for compatibility
63 wxCommandEvent
event( wxEVT_COMMAND_SLIDER_UPDATED
, win
->GetId() );
64 event
.SetEventObject( win
);
65 event
.SetInt( value
);
66 win
->HandleWindowEvent( event
);
69 static inline wxEventType
GtkScrollTypeToWx(int scrollType
)
71 wxEventType eventType
;
74 case GTK_SCROLL_STEP_BACKWARD
:
75 case GTK_SCROLL_STEP_LEFT
:
76 case GTK_SCROLL_STEP_UP
:
77 eventType
= wxEVT_SCROLL_LINEUP
;
79 case GTK_SCROLL_STEP_DOWN
:
80 case GTK_SCROLL_STEP_FORWARD
:
81 case GTK_SCROLL_STEP_RIGHT
:
82 eventType
= wxEVT_SCROLL_LINEDOWN
;
84 case GTK_SCROLL_PAGE_BACKWARD
:
85 case GTK_SCROLL_PAGE_LEFT
:
86 case GTK_SCROLL_PAGE_UP
:
87 eventType
= wxEVT_SCROLL_PAGEUP
;
89 case GTK_SCROLL_PAGE_DOWN
:
90 case GTK_SCROLL_PAGE_FORWARD
:
91 case GTK_SCROLL_PAGE_RIGHT
:
92 eventType
= wxEVT_SCROLL_PAGEDOWN
;
94 case GTK_SCROLL_START
:
95 eventType
= wxEVT_SCROLL_TOP
;
98 eventType
= wxEVT_SCROLL_BOTTOM
;
100 case GTK_SCROLL_JUMP
:
101 eventType
= wxEVT_SCROLL_THUMBTRACK
;
104 wxFAIL_MSG(wxT("Unknown GtkScrollType"));
105 eventType
= wxEVT_NULL
;
111 // Determine if increment is the same as +/-x, allowing for some small
112 // difference due to possible inexactness in floating point arithmetic
113 static inline bool IsScrollIncrement(double increment
, double x
)
115 wxASSERT(increment
> 0);
116 const double tolerance
= 1.0 / 1024;
117 return fabs(increment
- fabs(x
)) < tolerance
;
120 //-----------------------------------------------------------------------------
122 //-----------------------------------------------------------------------------
126 gtk_value_changed(GtkRange
* range
, wxSlider
* win
)
128 const double value
= gtk_range_get_value(range
);
129 const double oldPos
= win
->m_pos
;
132 if (g_blockEventsOnDrag
)
135 if (win
->GTKEventsDisabled())
137 win
->m_scrollEventType
= GTK_SCROLL_NONE
;
141 wxEventType eventType
= wxEVT_NULL
;
142 if (win
->m_isScrolling
)
144 eventType
= wxEVT_SCROLL_THUMBTRACK
;
146 else if (win
->m_scrollEventType
!= GTK_SCROLL_NONE
)
148 // Scroll event from "move-slider" (keyboard)
149 eventType
= GtkScrollTypeToWx(win
->m_scrollEventType
);
151 else if (win
->m_mouseButtonDown
)
153 // Difference from last change event
154 const double diff
= value
- oldPos
;
155 const bool isDown
= diff
> 0;
157 GtkAdjustment
* adj
= gtk_range_get_adjustment(range
);
158 if (IsScrollIncrement(gtk_adjustment_get_page_increment(adj
), diff
))
160 eventType
= isDown
? wxEVT_SCROLL_PAGEDOWN
: wxEVT_SCROLL_PAGEUP
;
162 else if (wxIsSameDouble(value
, 0))
164 eventType
= wxEVT_SCROLL_PAGEUP
;
166 else if (wxIsSameDouble(value
, gtk_adjustment_get_upper(adj
)))
168 eventType
= wxEVT_SCROLL_PAGEDOWN
;
172 // Assume track event
173 eventType
= wxEVT_SCROLL_THUMBTRACK
;
174 // Remember that we're tracking
175 win
->m_isScrolling
= true;
179 win
->m_scrollEventType
= GTK_SCROLL_NONE
;
181 // If integral position has changed
182 if (wxRound(oldPos
) != wxRound(value
))
184 ProcessScrollEvent(win
, eventType
);
185 win
->m_needThumbRelease
= eventType
== wxEVT_SCROLL_THUMBTRACK
;
190 //-----------------------------------------------------------------------------
191 // "move_slider" (keyboard event)
192 //-----------------------------------------------------------------------------
196 gtk_move_slider(GtkRange
*, GtkScrollType scrollType
, wxSlider
* win
)
198 // Save keyboard scroll type for "value_changed" handler
199 win
->m_scrollEventType
= scrollType
;
203 //-----------------------------------------------------------------------------
204 // "button_press_event"
205 //-----------------------------------------------------------------------------
209 gtk_button_press_event(GtkWidget
*, GdkEventButton
*, wxSlider
* win
)
211 win
->m_mouseButtonDown
= true;
217 //-----------------------------------------------------------------------------
219 //-----------------------------------------------------------------------------
223 gtk_event_after(GtkRange
* range
, GdkEvent
* event
, wxSlider
* win
)
225 if (event
->type
== GDK_BUTTON_RELEASE
)
227 g_signal_handlers_block_by_func(range
, (gpointer
) gtk_event_after
, win
);
229 if (win
->m_needThumbRelease
)
231 win
->m_needThumbRelease
= false;
232 ProcessScrollEvent(win
, wxEVT_SCROLL_THUMBRELEASE
);
234 // Keep slider at an integral position
235 win
->GTKDisableEvents();
236 gtk_range_set_value(GTK_RANGE (win
->m_scale
), win
->GetValue());
237 win
->GTKEnableEvents();
242 //-----------------------------------------------------------------------------
243 // "button_release_event"
244 //-----------------------------------------------------------------------------
248 gtk_button_release_event(GtkRange
* range
, GdkEventButton
*, wxSlider
* win
)
250 win
->m_mouseButtonDown
= false;
251 if (win
->m_isScrolling
)
253 win
->m_isScrolling
= false;
254 g_signal_handlers_unblock_by_func(range
, (gpointer
) gtk_event_after
, win
);
260 //-----------------------------------------------------------------------------
262 //-----------------------------------------------------------------------------
265 static gchar
* gtk_format_value(GtkScale
*, double value
, void*)
267 // Format value as nearest integer
268 return g_strdup_printf("%d", wxRound(value
));
272 //-----------------------------------------------------------------------------
274 //-----------------------------------------------------------------------------
281 wxSlider::~wxSlider()
283 if (m_scale
&& m_scale
!= m_widget
)
284 GTKDisconnect(m_scale
);
287 bool wxSlider::Create(wxWindow
*parent
,
295 const wxValidator
& validator
,
296 const wxString
& name
)
299 m_scrollEventType
= GTK_SCROLL_NONE
;
300 m_needThumbRelease
= false;
301 m_blockScrollEvent
= false;
303 if (!PreCreation( parent
, pos
, size
) ||
304 !CreateBase( parent
, id
, pos
, size
, style
, validator
, name
))
306 wxFAIL_MSG( wxT("wxSlider creation failed") );
311 if (style
& wxSL_VERTICAL
)
312 m_scale
= gtk_vscale_new( NULL
);
314 m_scale
= gtk_hscale_new( NULL
);
316 if (style
& wxSL_MIN_MAX_LABELS
)
318 gtk_widget_show( m_scale
);
320 if (style
& wxSL_VERTICAL
)
321 m_widget
= gtk_hbox_new(false, 0);
323 m_widget
= gtk_vbox_new(false, 0);
324 gtk_container_add( GTK_CONTAINER(m_widget
), m_scale
);
327 if (style
& wxSL_VERTICAL
)
328 box
= gtk_vbox_new(false,0);
330 box
= gtk_hbox_new(false,0);
331 gtk_widget_show(box
);
332 gtk_container_add( GTK_CONTAINER(m_widget
), box
);
334 m_minLabel
= gtk_label_new(NULL
);
335 gtk_widget_show( m_minLabel
);
336 gtk_container_add( GTK_CONTAINER(box
), m_minLabel
);
337 gtk_box_set_child_packing( GTK_BOX(box
), m_minLabel
, FALSE
, FALSE
, 0, GTK_PACK_START
);
339 // expanding empty space between the min/max labels
340 GtkWidget
*space
= gtk_label_new(NULL
);
341 gtk_widget_show( space
);
342 gtk_container_add( GTK_CONTAINER(box
), space
);
343 gtk_box_set_child_packing( GTK_BOX(box
), space
, TRUE
, FALSE
, 0, GTK_PACK_START
);
345 m_maxLabel
= gtk_label_new(NULL
);
346 gtk_widget_show( m_maxLabel
);
347 gtk_container_add( GTK_CONTAINER(box
), m_maxLabel
);
348 gtk_box_set_child_packing( GTK_BOX(box
), m_maxLabel
, FALSE
, FALSE
, 0, GTK_PACK_END
);
356 g_object_ref(m_widget
);
358 const bool showValueLabel
= (style
& wxSL_VALUE_LABEL
) != 0;
359 gtk_scale_set_draw_value(GTK_SCALE (m_scale
), showValueLabel
);
360 if ( showValueLabel
)
362 // position the label appropriately: notice that wxSL_DIRECTION flags
363 // specify the position of the ticks, not label, under MSW and so the
364 // label is on the opposite side
365 GtkPositionType posLabel
;
366 if ( style
& wxSL_VERTICAL
)
368 if ( style
& wxSL_LEFT
)
369 posLabel
= GTK_POS_RIGHT
;
370 else // if ( style & wxSL_RIGHT ) -- this is also the default
371 posLabel
= GTK_POS_LEFT
;
373 else // horizontal slider
375 if ( style
& wxSL_TOP
)
376 posLabel
= GTK_POS_BOTTOM
;
377 else // if ( style & wxSL_BOTTOM) -- this is again the default
378 posLabel
= GTK_POS_TOP
;
381 gtk_scale_set_value_pos( GTK_SCALE(m_scale
), posLabel
);
384 // Keep full precision in position value
385 gtk_scale_set_digits(GTK_SCALE (m_scale
), -1);
387 if (style
& wxSL_INVERSE
)
388 gtk_range_set_inverted( GTK_RANGE(m_scale
), TRUE
);
390 g_signal_connect(m_scale
, "button_press_event", G_CALLBACK(gtk_button_press_event
), this);
391 g_signal_connect(m_scale
, "button_release_event", G_CALLBACK(gtk_button_release_event
), this);
392 g_signal_connect(m_scale
, "move_slider", G_CALLBACK(gtk_move_slider
), this);
393 g_signal_connect(m_scale
, "format_value", G_CALLBACK(gtk_format_value
), NULL
);
394 g_signal_connect(m_scale
, "value_changed", G_CALLBACK(gtk_value_changed
), this);
395 gulong handler_id
= g_signal_connect(m_scale
, "event_after", G_CALLBACK(gtk_event_after
), this);
396 g_signal_handler_block(m_scale
, handler_id
);
398 SetRange( minValue
, maxValue
);
400 // don't call the public SetValue() as it won't do anything unless the
401 // value really changed
402 GTKSetValue( value
);
404 m_parent
->DoAddChild( this );
411 void wxSlider::GTKDisableEvents()
413 m_blockScrollEvent
= true;
416 void wxSlider::GTKEnableEvents()
418 m_blockScrollEvent
= false;
421 bool wxSlider::GTKEventsDisabled() const
423 return m_blockScrollEvent
;
426 int wxSlider::GetValue() const
428 return wxRound(m_pos
);
431 void wxSlider::SetValue( int value
)
433 if (GetValue() != value
)
437 void wxSlider::GTKSetValue(int value
)
440 gtk_range_set_value(GTK_RANGE (m_scale
), value
);
441 // GTK only updates value label if handle moves at least 1 pixel
442 gtk_widget_queue_draw(m_scale
);
446 void wxSlider::SetRange( int minValue
, int maxValue
)
449 if (minValue
== maxValue
)
451 gtk_range_set_range(GTK_RANGE (m_scale
), minValue
, maxValue
);
452 gtk_range_set_increments(GTK_RANGE (m_scale
), 1, (maxValue
- minValue
+ 9) / 10);
455 if (HasFlag(wxSL_MIN_MAX_LABELS
))
459 str
.Printf( "%d", minValue
);
460 if (HasFlag(wxSL_INVERSE
))
461 gtk_label_set_text( GTK_LABEL(m_maxLabel
), str
.utf8_str() );
463 gtk_label_set_text( GTK_LABEL(m_minLabel
), str
.utf8_str() );
465 str
.Printf( "%d", maxValue
);
466 if (HasFlag(wxSL_INVERSE
))
467 gtk_label_set_text( GTK_LABEL(m_minLabel
), str
.utf8_str() );
469 gtk_label_set_text( GTK_LABEL(m_maxLabel
), str
.utf8_str() );
474 int wxSlider::GetMin() const
476 GtkAdjustment
* adj
= gtk_range_get_adjustment(GTK_RANGE(m_scale
));
477 return int(gtk_adjustment_get_lower(adj
));
480 int wxSlider::GetMax() const
482 GtkAdjustment
* adj
= gtk_range_get_adjustment(GTK_RANGE(m_scale
));
483 return int(gtk_adjustment_get_upper(adj
));
486 void wxSlider::SetPageSize( int pageSize
)
489 gtk_range_set_increments(GTK_RANGE (m_scale
), GetLineSize(), pageSize
);
493 int wxSlider::GetPageSize() const
495 GtkAdjustment
* adj
= gtk_range_get_adjustment(GTK_RANGE(m_scale
));
496 return int(gtk_adjustment_get_page_increment(adj
));
499 // GTK does not support changing the size of the slider
500 void wxSlider::SetThumbLength(int)
504 int wxSlider::GetThumbLength() const
509 void wxSlider::SetLineSize( int lineSize
)
512 gtk_range_set_increments(GTK_RANGE (m_scale
), lineSize
, GetPageSize());
516 int wxSlider::GetLineSize() const
518 GtkAdjustment
* adj
= gtk_range_get_adjustment(GTK_RANGE(m_scale
));
519 return int(gtk_adjustment_get_step_increment(adj
));
522 GdkWindow
*wxSlider::GTKGetWindow(wxArrayGdkWindows
& WXUNUSED(windows
)) const
525 // no access to internal GdkWindows
528 return GTK_RANGE(m_scale
)->event_window
;
534 wxSlider::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
536 return GetDefaultAttributesFromGTKWidget(gtk_vscale_new
);
539 #endif // wxUSE_SLIDER