2 Copyright (C) 2006 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 $Id: fastmeter.h 570 2006-06-07 21:21:21Z sampo $
25 #include "pbd/stacktrace.h"
27 #include "gtkmm2ext/cairo_widget.h"
28 #include "gtkmm2ext/keyboard.h"
29 #include "gtkmm2ext/pixfader.h"
30 #include "gtkmm2ext/utils.h"
32 using namespace Gtkmm2ext;
36 #define CORNER_RADIUS 2.5
38 #define CORNER_OFFSET 1
39 #define FADER_RESERVE 6
41 std::list<PixFader::FaderImage*> PixFader::_patterns;
43 PixFader::PixFader (Gtk::Adjustment& adj, int orientation, int fader_length, int fader_girth)
45 , _span (fader_length)
46 , _girth (fader_girth)
47 , _min_span (fader_length)
48 , _min_girth (fader_girth)
49 , _orien (orientation)
54 , _centered_text (true)
55 , _display_unity_line (true)
58 _default_value = adjustment.get_value();
59 update_unity_position ();
62 Gdk::BUTTON_PRESS_MASK
63 | Gdk::BUTTON_RELEASE_MASK
64 | Gdk::POINTER_MOTION_MASK
66 | Gdk::ENTER_NOTIFY_MASK
67 | Gdk::LEAVE_NOTIFY_MASK
70 adjustment.signal_value_changed().connect (mem_fun (*this, &PixFader::adjustment_changed));
71 adjustment.signal_changed().connect (mem_fun (*this, &PixFader::adjustment_changed));
74 DrawingArea::set_size_request(_girth, _span);
76 DrawingArea::set_size_request(_span, _girth);
80 PixFader::~PixFader ()
82 if (_parent_style_change) _parent_style_change.disconnect();
83 if (_layout) _layout.clear (); // drop reference to existing layout
87 PixFader::find_pattern (double afr, double afg, double afb,
88 double abr, double abg, double abb,
91 for (list<FaderImage*>::iterator f = _patterns.begin(); f != _patterns.end(); ++f) {
92 if ((*f)->matches (afr, afg, afb, abr, abg, abb, w, h)) {
100 PixFader::create_patterns ()
102 Gdk::Color c = get_style()->get_fg (get_state());
107 fg = c.get_green_p ();
108 fb = c.get_blue_p ();
110 c = get_style()->get_bg (get_state());
113 bg = c.get_green_p ();
114 bb = c.get_blue_p ();
116 cairo_surface_t* surface;
119 if (get_width() <= 1 || get_height() <= 1) {
123 if ((_pattern = find_pattern (fr, fg, fb, br, bg, bb, get_width(), get_height())) != 0) {
124 /* found it - use it */
128 if (_orien == VERT) {
130 surface = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, get_width(), get_height() * 2.0);
131 tc = cairo_create (surface);
133 /* paint background + border */
135 cairo_pattern_t* shade_pattern = cairo_pattern_create_linear (0.0, 0.0, get_width(), 0);
136 cairo_pattern_add_color_stop_rgba (shade_pattern, 0, br*0.4,bg*0.4,bb*0.4, 1.0);
137 cairo_pattern_add_color_stop_rgba (shade_pattern, 0.25, br*0.6,bg*0.6,bb*0.6, 1.0);
138 cairo_pattern_add_color_stop_rgba (shade_pattern, 1, br*0.8,bg*0.8,bb*0.8, 1.0);
139 cairo_set_source (tc, shade_pattern);
140 cairo_rectangle (tc, 0, 0, get_width(), get_height() * 2.0);
143 cairo_pattern_destroy (shade_pattern);
145 /* paint lower shade */
147 shade_pattern = cairo_pattern_create_linear (0.0, 0.0, get_width() - 2 - CORNER_OFFSET , 0);
148 cairo_pattern_add_color_stop_rgba (shade_pattern, 0, fr*0.8,fg*0.8,fb*0.8, 1.0);
149 cairo_pattern_add_color_stop_rgba (shade_pattern, 1, fr*0.6,fg*0.6,fb*0.6, 1.0);
150 cairo_set_source (tc, shade_pattern);
151 Gtkmm2ext::rounded_top_half_rectangle (tc, CORNER_OFFSET, get_height() + CORNER_OFFSET,
152 get_width() - CORNER_SIZE, get_height(), CORNER_RADIUS);
155 cairo_pattern_destroy (shade_pattern);
157 _pattern = cairo_pattern_create_for_surface (surface);
161 surface = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, get_width() * 2.0, get_height());
162 tc = cairo_create (surface);
164 /* paint right shade (background section)*/
166 cairo_pattern_t* shade_pattern = cairo_pattern_create_linear (0.0, 0.0, 0.0, get_height());
167 cairo_pattern_add_color_stop_rgba (shade_pattern, 0, br*0.4,bg*0.4,bb*0.4, 1.0);
168 cairo_pattern_add_color_stop_rgba (shade_pattern, 0.25, br*0.6,bg*0.6,bb*0.6, 1.0);
169 cairo_pattern_add_color_stop_rgba (shade_pattern, 1, br*0.8,bg*0.8,bb*0.8, 1.0);
170 cairo_set_source (tc, shade_pattern);
171 cairo_rectangle (tc, 0, 0, get_width() * 2.0, get_height());
174 /* paint left shade (active section/foreground) */
176 shade_pattern = cairo_pattern_create_linear (0.0, 0.0, 0.0, get_height());
177 cairo_pattern_add_color_stop_rgba (shade_pattern, 0, fr*0.8,fg*0.8,fb*0.8, 1.0);
178 cairo_pattern_add_color_stop_rgba (shade_pattern, 1, fr*0.6,fg*0.6,fb*0.6, 1.0);
179 cairo_set_source (tc, shade_pattern);
180 Gtkmm2ext::rounded_right_half_rectangle (tc, CORNER_OFFSET, CORNER_OFFSET,
181 get_width() - CORNER_OFFSET, get_height() - CORNER_SIZE, CORNER_RADIUS);
183 cairo_pattern_destroy (shade_pattern);
185 _pattern = cairo_pattern_create_for_surface (surface);
188 /* cache it for others to use */
190 _patterns.push_back (new FaderImage (_pattern, fr, fg, fb, br, bg, bb, get_width(), get_height()));
193 cairo_surface_destroy (surface);
197 PixFader::on_expose_event (GdkEventExpose* ev)
199 Cairo::RefPtr<Cairo::Context> context = get_window()->create_cairo_context();
200 cairo_t* cr = context->cobj();
202 // clip to expose area
203 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
211 /* this isn't supposed to be happen, but some wackiness whereby
212 * the pixfader ends up with a 1xN or Nx1 size allocation
213 * leads to it. the basic wackiness needs fixing but we
214 * shouldn't crash. just fill in the expose area with
218 CairoWidget::set_source_rgb_a (cr, get_style()->get_bg (get_state()), 1);
219 cairo_rectangle (cr, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
225 int ds = display_span ();
226 const float w = get_width();
227 const float h = get_height();
229 CairoWidget::set_source_rgb_a (cr, get_parent_bg(), 1);
230 cairo_rectangle (cr, 0, 0, w, h);
233 cairo_set_line_width (cr, 2);
234 cairo_set_source_rgba (cr, 0, 0, 0, 1.0);
236 cairo_matrix_t matrix;
237 Gtkmm2ext::rounded_rectangle (cr, CORNER_OFFSET, CORNER_OFFSET, w-CORNER_SIZE, h-CORNER_SIZE, CORNER_RADIUS);
238 // we use a 'trick' here: The stoke is off by .5px but filling the interior area
239 // after a stroke of 2px width results in an outline of 1px
240 cairo_stroke_preserve(cr);
242 if (_orien == VERT) {
244 if (ds > h - FADER_RESERVE - CORNER_OFFSET) {
245 ds = h - FADER_RESERVE - CORNER_OFFSET;
248 if (!CairoWidget::flat_buttons() ) {
249 cairo_set_source (cr, _pattern);
250 cairo_matrix_init_translate (&matrix, 0, (h - ds));
251 cairo_pattern_set_matrix (_pattern, &matrix);
253 CairoWidget::set_source_rgb_a (cr, get_style()->get_bg (get_state()), 1);
255 CairoWidget::set_source_rgb_a (cr, get_style()->get_fg (get_state()), 1);
256 Gtkmm2ext::rounded_rectangle (cr, CORNER_OFFSET, ds + CORNER_OFFSET,
257 w - CORNER_SIZE, h - ds - CORNER_SIZE, CORNER_RADIUS);
263 if (ds < FADER_RESERVE) {
269 * if ds == w, the pattern does not need to be translated
270 * if ds == 0 (or FADER_RESERVE), the pattern needs to be moved
271 * w to the left, which is -w in pattern space, and w in user space
272 * if ds == 10, then the pattern needs to be moved w - 10
273 * to the left, which is -(w-10) in pattern space, which
274 * is (w - 10) in user space
275 * thus: translation = (w - ds)
278 if (!CairoWidget::flat_buttons() ) {
279 cairo_set_source (cr, _pattern);
280 cairo_matrix_init_translate (&matrix, w - ds, 0);
281 cairo_pattern_set_matrix (_pattern, &matrix);
283 CairoWidget::set_source_rgb_a (cr, get_style()->get_bg (get_state()), 1);
285 CairoWidget::set_source_rgb_a (cr, get_style()->get_fg (get_state()), 1);
286 Gtkmm2ext::rounded_rectangle (cr, CORNER_OFFSET, CORNER_OFFSET,
287 ds - CORNER_SIZE, h - CORNER_SIZE, CORNER_RADIUS);
292 /* draw the unity-position line if it's not at either end*/
293 if (_display_unity_line && _unity_loc > CORNER_RADIUS) {
294 context->set_line_width (1);
295 context->set_line_cap (Cairo::LINE_CAP_ROUND);
296 Gdk::Color c = get_style()->get_fg (Gtk::STATE_ACTIVE);
297 context->set_source_rgba (c.get_red_p() * 1.5, c.get_green_p() * 1.5, c.get_blue_p() * 1.5, 0.85);
298 if (_orien == VERT) {
299 if (_unity_loc < h - CORNER_RADIUS) {
300 context->move_to (1.5, _unity_loc + CORNER_OFFSET + .5);
301 context->line_to (_girth - 1.5, _unity_loc + CORNER_OFFSET + .5);
305 if (_unity_loc < w - CORNER_RADIUS) {
306 context->move_to (_unity_loc - CORNER_OFFSET + .5, 1.5);
307 context->line_to (_unity_loc - CORNER_OFFSET + .5, _girth - 1.5);
313 if (_layout && !_text.empty() && _orien == HORIZ) {
315 if (_centered_text) {
317 cairo_move_to (cr, (w - _text_width)/2.0, h/2.0 - _text_height/2.0);
318 } else if (ds > .5 * w) {
319 cairo_move_to (cr, CORNER_OFFSET + 3, h/2.0 - _text_height/2.0);
320 cairo_set_operator(cr, CAIRO_OPERATOR_XOR);
322 cairo_move_to (cr, w - _text_width - CORNER_OFFSET - 3, h/2.0 - _text_height/2.0);
324 CairoWidget::set_source_rgb_a (cr, get_style()->get_text (get_state()), 1);
325 pango_cairo_show_layout (cr, _layout->gobj());
329 if (!get_sensitive()) {
330 Gtkmm2ext::rounded_rectangle (cr, CORNER_OFFSET, CORNER_OFFSET, w-CORNER_SIZE, h-CORNER_SIZE, CORNER_RADIUS);
331 cairo_set_source_rgba (cr, 0.505, 0.517, 0.525, 0.4);
333 } else if (_hovering) {
334 Gtkmm2ext::rounded_rectangle (cr, CORNER_OFFSET, CORNER_OFFSET, w-CORNER_SIZE, h-CORNER_SIZE, CORNER_RADIUS);
335 cairo_set_source_rgba (cr, 0.905, 0.917, 0.925, 0.1);
345 PixFader::on_size_request (GtkRequisition* req)
347 if (_orien == VERT) {
348 req->width = (_min_girth ? _min_girth : -1);
349 req->height = (_min_span ? _min_span : -1);
351 req->height = (_min_girth ? _min_girth : -1);
352 req->width = (_min_span ? _min_span : -1);
357 PixFader::on_size_allocate (Gtk::Allocation& alloc)
359 DrawingArea::on_size_allocate(alloc);
361 if (_orien == VERT) {
362 _girth = alloc.get_width ();
363 _span = alloc.get_height ();
365 _girth = alloc.get_height ();
366 _span = alloc.get_width ();
370 /* recreate patterns in case we've changed size */
374 update_unity_position ();
378 PixFader::on_button_press_event (GdkEventButton* ev)
380 if (ev->type != GDK_BUTTON_PRESS) {
384 gdk_pointer_ungrab (GDK_CURRENT_TIME);
390 if (ev->button != 1 && ev->button != 2) {
396 _grab_loc = (_orien == VERT) ? ev->y : ev->x;
397 _grab_start = (_orien == VERT) ? ev->y : ev->x;
398 _grab_window = ev->window;
400 gdk_pointer_grab(ev->window,false,
401 GdkEventMask( Gdk::POINTER_MOTION_MASK | Gdk::BUTTON_PRESS_MASK |Gdk::BUTTON_RELEASE_MASK),
404 if (ev->button == 2) {
405 set_adjustment_from_event (ev);
412 PixFader::on_button_release_event (GdkEventButton* ev)
414 double ev_pos = (_orien == VERT) ? ev->y : ev->x;
416 switch (ev->button) {
421 gdk_pointer_ungrab (GDK_CURRENT_TIME);
425 Keyboard::magic_widget_drop_focus();
429 if (ev_pos == _grab_start) {
430 /* no motion - just a click */
431 const double slider_pos = display_span();
432 ev_pos = rint(ev_pos);
434 if (ev->state & Keyboard::TertiaryModifier) {
435 adjustment.set_value (_default_value);
436 } else if (ev->state & Keyboard::GainFineScaleModifier) {
437 adjustment.set_value (adjustment.get_lower());
438 } else if (ev_pos == slider_pos) {
439 ; // click on current position, no move.
440 } else if ((_orien == VERT && ev_pos < slider_pos) || (_orien == HORIZ && ev_pos > slider_pos)) {
441 /* above the current display height, remember X Window coords */
442 adjustment.set_value (adjustment.get_value() + adjustment.get_step_increment());
444 adjustment.set_value (adjustment.get_value() - adjustment.get_step_increment());
456 set_adjustment_from_event (ev);
457 gdk_pointer_ungrab (GDK_CURRENT_TIME);
469 PixFader::on_scroll_event (GdkEventScroll* ev)
474 if (ev->state & Keyboard::GainFineScaleModifier) {
475 if (ev->state & Keyboard::GainExtraFineScaleModifier) {
484 if (_orien == VERT) {
486 /* should left/right scroll affect vertical faders ? */
488 switch (ev->direction) {
491 adjustment.set_value (adjustment.get_value() + (adjustment.get_page_increment() * scale));
494 case GDK_SCROLL_DOWN:
495 adjustment.set_value (adjustment.get_value() - (adjustment.get_page_increment() * scale));
503 /* up/down scrolls should definitely affect horizontal faders
504 because they are so much easier to use
507 switch (ev->direction) {
509 case GDK_SCROLL_RIGHT:
511 adjustment.set_value (adjustment.get_value() + (adjustment.get_page_increment() * scale));
514 case GDK_SCROLL_LEFT:
515 case GDK_SCROLL_DOWN:
516 adjustment.set_value (adjustment.get_value() - (adjustment.get_page_increment() * scale));
527 PixFader::on_motion_notify_event (GdkEventMotion* ev)
531 double const ev_pos = (_orien == VERT) ? ev->y : ev->x;
533 if (ev->window != _grab_window) {
535 _grab_window = ev->window;
539 if (ev->state & Keyboard::GainFineScaleModifier) {
540 if (ev->state & Keyboard::GainExtraFineScaleModifier) {
547 double const delta = ev_pos - _grab_loc;
550 double fract = (delta / _span);
552 fract = min (1.0, fract);
553 fract = max (-1.0, fract);
555 // X Window is top->bottom for 0..Y
557 if (_orien == VERT) {
561 adjustment.set_value (adjustment.get_value() + scale * fract * (adjustment.get_upper() - adjustment.get_lower()));
568 PixFader::adjustment_changed ()
570 if (display_span() != _last_drawn) {
575 /** @return pixel offset of the current value from the right or bottom of the fader */
577 PixFader::display_span ()
579 float fract = (adjustment.get_value () - adjustment.get_lower()) / ((adjustment.get_upper() - adjustment.get_lower()));
581 if (_orien == VERT) {
582 ds = (int)rint (_span * (1.0 - fract));
584 ds = (int)rint (_span * fract);
591 PixFader::update_unity_position ()
593 if (_orien == VERT) {
594 _unity_loc = (int) rint (_span * (1 - ((_default_value - adjustment.get_lower()) / (adjustment.get_upper() - adjustment.get_lower())))) - 1;
596 _unity_loc = (int) rint ((_default_value - adjustment.get_lower()) * _span / (adjustment.get_upper() - adjustment.get_lower()));
603 PixFader::on_enter_notify_event (GdkEventCrossing*)
606 Keyboard::magic_widget_grab_focus ();
612 PixFader::on_leave_notify_event (GdkEventCrossing*)
616 Keyboard::magic_widget_drop_focus();
623 PixFader::set_adjustment_from_event (GdkEventButton* ev)
625 double fract = (_orien == VERT) ? (1.0 - (ev->y / _span)) : (ev->x / _span);
627 fract = min (1.0, fract);
628 fract = max (0.0, fract);
630 adjustment.set_value (fract * (adjustment.get_upper () - adjustment.get_lower ()));
634 PixFader::set_default_value (float d)
637 update_unity_position ();
641 PixFader::show_unity_line (bool yn )
643 if (yn == _display_unity_line) return;
644 _display_unity_line = yn;
649 PixFader::set_text (const std::string& str, bool centered, bool expose)
651 if (_layout && _text == str) {
654 if (!_layout && !str.empty()) {
655 _layout = Pango::Layout::create (get_pango_context());
659 _centered_text = centered;
661 _layout->set_text (str);
662 _layout->get_pixel_size (_text_width, _text_height);
664 if (expose) queue_draw ();
669 PixFader::on_state_changed (Gtk::StateType old_state)
671 Widget::on_state_changed (old_state);
677 PixFader::on_style_changed (const Glib::RefPtr<Gtk::Style>&)
680 std::string txt = _layout->get_text();
681 _layout.clear (); // drop reference to existing layout
683 set_text (txt, _centered_text, false);
685 /* patterns are cached and re-created as needed
686 * during 'expose' in the GUI thread */
692 PixFader::get_parent_bg ()
694 Widget* parent = get_parent ();
697 if (parent->get_has_window()) {
700 parent = parent->get_parent();
703 if (parent && parent->get_has_window()) {
704 if (_current_parent != parent) {
705 if (_parent_style_change) _parent_style_change.disconnect();
706 _current_parent = parent;
707 _parent_style_change = parent->signal_style_changed().connect (mem_fun (*this, &PixFader::on_style_changed));
709 return parent->get_style ()->get_bg (parent->get_state());
712 return get_style ()->get_bg (get_state());