1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 2012 Red Hat, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library 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 GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
22 * - accessible color names
23 * - accessible relations for popups
24 * - api to replace palette
25 * - saving per-application (?)
27 * - use css for swatches
28 * - better popup theming
33 #include "gtkcoloreditorprivate.h"
35 #include "gtkcolorchooserprivate.h"
36 #include "gtkcolorplaneprivate.h"
37 #include "gtkcolorscaleprivate.h"
38 #include "gtkcolorswatchprivate.h"
39 #include "gtkcolorutils.h"
41 #include "gtkorientable.h"
43 #include "gtkoverlay.h"
44 #include "gtkadjustment.h"
46 #include "gtkspinbutton.h"
51 struct _GtkColorEditorPrivate
67 GtkWidget *current_popup;
68 GtkWidget *popdown_focus;
75 guint text_changed : 1;
86 static void gtk_color_editor_iface_init (GtkColorChooserInterface *iface);
88 G_DEFINE_TYPE_WITH_CODE (GtkColorEditor, gtk_color_editor, GTK_TYPE_BOX,
89 G_IMPLEMENT_INTERFACE (GTK_TYPE_COLOR_CHOOSER,
90 gtk_color_editor_iface_init))
93 scale_round (gdouble value, gdouble scale)
95 value = floor (value * scale + 0.5);
96 value = MAX (value, 0);
97 value = MIN (value, scale);
102 entry_set_rgba (GtkColorEditor *editor,
103 const GdkRGBA *color)
107 text = g_strdup_printf ("#%02X%02X%02X",
108 scale_round (color->red, 255),
109 scale_round (color->green, 255),
110 scale_round (color->blue, 255));
111 gtk_entry_set_text (GTK_ENTRY (editor->priv->entry), text);
112 editor->priv->text_changed = FALSE;
117 entry_apply (GtkWidget *entry,
118 GtkColorEditor *editor)
123 if (!editor->priv->text_changed)
126 text = gtk_editable_get_chars (GTK_EDITABLE (editor->priv->entry), 0, -1);
127 if (gdk_rgba_parse (&color, text))
129 color.alpha = gtk_adjustment_get_value (editor->priv->a_adj);
130 gtk_color_chooser_set_rgba (GTK_COLOR_CHOOSER (editor), &color);
133 editor->priv->text_changed = FALSE;
139 entry_focus_out (GtkWidget *entry,
140 GdkEventFocus *event,
141 GtkColorEditor *editor)
143 entry_apply (entry, editor);
148 entry_text_changed (GtkWidget *entry,
150 GtkColorEditor *editor)
152 editor->priv->text_changed = TRUE;
156 hsv_changed (GtkColorEditor *editor)
161 h = gtk_adjustment_get_value (editor->priv->h_adj);
162 s = gtk_adjustment_get_value (editor->priv->s_adj);
163 v = gtk_adjustment_get_value (editor->priv->v_adj);
164 a = gtk_adjustment_get_value (editor->priv->a_adj);
166 gtk_hsv_to_rgb (h, s, v, &color.red, &color.green, &color.blue);
169 gtk_color_swatch_set_rgba (GTK_COLOR_SWATCH (editor->priv->swatch), &color);
170 gtk_color_scale_set_rgba (GTK_COLOR_SCALE (editor->priv->a_slider), &color);
171 entry_set_rgba (editor, &color);
173 g_object_notify (G_OBJECT (editor), "rgba");
177 dismiss_current_popup (GtkColorEditor *editor)
179 if (editor->priv->current_popup)
181 gtk_widget_hide (editor->priv->current_popup);
182 editor->priv->current_popup = NULL;
183 if (editor->priv->popdown_focus)
185 gtk_widget_grab_focus (editor->priv->popdown_focus);
186 editor->priv->popdown_focus = NULL;
192 popup_edit (GtkWidget *widget,
193 GtkColorEditor *editor)
195 GtkWidget *popup = NULL;
199 if (widget == editor->priv->sv_plane)
201 popup = editor->priv->sv_popup;
202 focus = editor->priv->s_entry;
204 else if (widget == editor->priv->h_slider)
206 popup = editor->priv->h_popup;
207 focus = editor->priv->h_entry;
209 else if (widget == editor->priv->a_slider)
211 popup = editor->priv->a_popup;
212 focus = editor->priv->a_entry;
217 dismiss_current_popup (editor);
218 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (editor));
219 editor->priv->popdown_focus = gtk_window_get_focus (GTK_WINDOW (toplevel));
220 editor->priv->current_popup = popup;
221 gtk_widget_show (popup);
222 gtk_widget_grab_focus (focus);
227 popup_key_press (GtkWidget *popup,
229 GtkColorEditor *editor)
231 if (event->keyval == GDK_KEY_Escape)
233 dismiss_current_popup (editor);
241 get_child_position (GtkOverlay *overlay,
243 GtkAllocation *allocation,
244 GtkColorEditor *editor)
250 gtk_widget_get_preferred_size (widget, &req, NULL);
252 allocation->width = req.width;
253 allocation->height = req.height;
255 if (widget == editor->priv->sv_popup)
257 if (gtk_widget_get_direction (GTK_WIDGET (overlay)) == GTK_TEXT_DIR_RTL)
260 allocation->x = gtk_widget_get_allocated_width (GTK_WIDGET (overlay)) - req.width;
261 allocation->y = req.height / 3;
263 else if (widget == editor->priv->h_popup)
265 gtk_widget_get_allocation (editor->priv->h_slider, &alloc);
266 gtk_range_get_slider_range (GTK_RANGE (editor->priv->h_slider), &s, &e);
268 if (gtk_widget_get_direction (GTK_WIDGET (overlay)) == GTK_TEXT_DIR_RTL)
269 gtk_widget_translate_coordinates (editor->priv->h_slider,
270 gtk_widget_get_parent (editor->priv->grid),
271 - req.width, (s + e - req.height) / 2,
272 &allocation->x, &allocation->y);
274 gtk_widget_translate_coordinates (editor->priv->h_slider,
275 gtk_widget_get_parent (editor->priv->grid),
276 alloc.width, (s + e - req.height) / 2,
277 &allocation->x, &allocation->y);
279 else if (widget == editor->priv->a_popup)
281 gtk_widget_get_allocation (editor->priv->a_slider, &alloc);
282 gtk_range_get_slider_range (GTK_RANGE (editor->priv->a_slider), &s, &e);
284 gtk_widget_translate_coordinates (editor->priv->a_slider,
285 gtk_widget_get_parent (editor->priv->grid),
286 (s + e - req.width) / 2, - req.height,
287 &allocation->x, &allocation->y);
292 allocation->x = CLAMP (allocation->x, 0, gtk_widget_get_allocated_width (GTK_WIDGET (overlay)) - req.width);
293 allocation->y = CLAMP (allocation->y, 0, gtk_widget_get_allocated_height (GTK_WIDGET (overlay)) - req.height);
299 value_changed (GtkAdjustment *a,
304 scale = gtk_adjustment_get_upper (as) / gtk_adjustment_get_upper (a);
305 g_signal_handlers_block_by_func (as, value_changed, a);
306 gtk_adjustment_set_value (as, gtk_adjustment_get_value (a) * scale);
307 g_signal_handlers_unblock_by_func (as, value_changed, a);
310 static GtkAdjustment *
311 scaled_adjustment (GtkAdjustment *a,
316 as = gtk_adjustment_new (gtk_adjustment_get_value (a) * scale,
317 gtk_adjustment_get_lower (a) * scale,
318 gtk_adjustment_get_upper (a) * scale,
319 gtk_adjustment_get_step_increment (a) * scale,
320 gtk_adjustment_get_page_increment (a) * scale,
321 gtk_adjustment_get_page_size (a) * scale);
323 g_signal_connect (a, "value-changed", G_CALLBACK (value_changed), as);
324 g_signal_connect (as, "value-changed", G_CALLBACK (value_changed), a);
330 popup_draw (GtkWidget *popup,
332 GtkColorEditor *editor)
334 GtkStyleContext *context;
337 context = gtk_widget_get_style_context (popup);
338 width = gtk_widget_get_allocated_width (popup);
339 height = gtk_widget_get_allocated_height (popup);
341 gtk_render_background (context, cr, 0, 0, width, height);
342 gtk_render_frame (context, cr, 0, 0, width, height);
348 create_popup (GtkColorEditor *editor,
354 g_object_set (contents, "margin", 12, NULL);
356 popup = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
357 gtk_style_context_add_class (gtk_widget_get_style_context (popup), GTK_STYLE_CLASS_TOOLTIP);
358 gtk_container_add (GTK_CONTAINER (popup), contents);
360 gtk_widget_show_all (contents);
361 gtk_widget_set_no_show_all (popup, TRUE);
363 g_signal_connect (popup, "draw", G_CALLBACK (popup_draw), editor);
365 gtk_overlay_add_overlay (GTK_OVERLAY (editor->priv->overlay), popup);
366 g_signal_connect (attach, "popup-menu", G_CALLBACK (popup_edit), editor);
372 gtk_color_editor_init (GtkColorEditor *editor)
378 GtkAdjustment *h_adj, *s_adj, *v_adj, *a_adj;
380 GdkRGBA transparent = { 0, 0, 0, 0 };
382 editor->priv = G_TYPE_INSTANCE_GET_PRIVATE (editor,
383 GTK_TYPE_COLOR_EDITOR,
384 GtkColorEditorPrivate);
385 editor->priv->use_alpha = TRUE;
387 editor->priv->h_adj = h_adj = gtk_adjustment_new (0, 0, 1, 0.01, 0.1, 0);
388 editor->priv->s_adj = s_adj = gtk_adjustment_new (0, 0, 1, 0.01, 0.1, 0);
389 editor->priv->v_adj = v_adj = gtk_adjustment_new (0, 0, 1, 0.01, 0.1, 0);
390 editor->priv->a_adj = a_adj = gtk_adjustment_new (0, 0, 1, 0.01, 0.1, 0);
392 g_object_ref_sink (h_adj);
393 g_object_ref_sink (s_adj);
394 g_object_ref_sink (v_adj);
395 g_object_ref_sink (a_adj);
397 g_signal_connect_swapped (h_adj, "value-changed", G_CALLBACK (hsv_changed), editor);
398 g_signal_connect_swapped (s_adj, "value-changed", G_CALLBACK (hsv_changed), editor);
399 g_signal_connect_swapped (v_adj, "value-changed", G_CALLBACK (hsv_changed), editor);
400 g_signal_connect_swapped (a_adj, "value-changed", G_CALLBACK (hsv_changed), editor);
402 gtk_widget_push_composite_child ();
404 /* Construct the main UI */
405 editor->priv->swatch = swatch = gtk_color_swatch_new ();
406 gtk_widget_set_events (swatch, gtk_widget_get_events (swatch)
407 & ~(GDK_BUTTON_PRESS_MASK
408 | GDK_BUTTON_RELEASE_MASK
410 | GDK_KEY_RELEASE_MASK));
411 gtk_widget_set_can_focus (swatch, FALSE);
413 editor->priv->entry = entry = gtk_entry_new ();
414 atk_obj = gtk_widget_get_accessible (entry);
415 atk_object_set_role (atk_obj, ATK_ROLE_ENTRY);
416 atk_object_set_name (atk_obj, _("Color Name"));
417 g_signal_connect (entry, "activate", G_CALLBACK (entry_apply), editor);
418 g_signal_connect (entry, "notify::text", G_CALLBACK (entry_text_changed), editor);
419 g_signal_connect (entry, "focus-out-event", G_CALLBACK (entry_focus_out), editor);
421 editor->priv->h_slider = slider = gtk_color_scale_new (h_adj, GTK_COLOR_SCALE_HUE);
422 gtk_orientable_set_orientation (GTK_ORIENTABLE (slider), GTK_ORIENTATION_VERTICAL);
423 if (gtk_widget_get_direction (slider) == GTK_TEXT_DIR_RTL)
424 gtk_style_context_add_class (gtk_widget_get_style_context (slider),
425 GTK_STYLE_CLASS_SCALE_HAS_MARKS_ABOVE);
427 gtk_style_context_add_class (gtk_widget_get_style_context (slider),
428 GTK_STYLE_CLASS_SCALE_HAS_MARKS_BELOW);
430 editor->priv->sv_plane = gtk_color_plane_new (h_adj, s_adj, v_adj);
431 gtk_widget_set_size_request (editor->priv->sv_plane, 300, 300);
433 editor->priv->a_slider = slider = gtk_color_scale_new (a_adj, GTK_COLOR_SCALE_ALPHA);
434 gtk_orientable_set_orientation (GTK_ORIENTABLE (slider), GTK_ORIENTATION_HORIZONTAL);
435 gtk_style_context_add_class (gtk_widget_get_style_context (slider),
436 GTK_STYLE_CLASS_SCALE_HAS_MARKS_ABOVE);
438 editor->priv->grid = grid = gtk_grid_new ();
439 gtk_grid_set_row_spacing (GTK_GRID (grid), 12);
440 gtk_grid_set_column_spacing (GTK_GRID (grid), 12);
442 gtk_grid_attach (GTK_GRID (grid), editor->priv->swatch, 1, 0, 1, 1);
443 gtk_grid_attach (GTK_GRID (grid), editor->priv->entry, 2, 0, 1, 1);
444 gtk_grid_attach (GTK_GRID (grid), editor->priv->h_slider, 0, 1, 1, 1);
445 gtk_grid_attach (GTK_GRID (grid), editor->priv->sv_plane, 1, 1, 2, 1);
446 gtk_grid_attach (GTK_GRID (grid), editor->priv->a_slider, 1, 2, 2, 1);
448 /* This extra margin is necessary so we have room to the sides
449 * to place the popups as desired
451 gtk_widget_set_margin_left (grid, 30);
452 gtk_widget_set_margin_right (grid, 30);
454 editor->priv->overlay = gtk_overlay_new ();
455 gtk_widget_override_background_color (editor->priv->overlay, 0, &transparent);
456 gtk_container_add (GTK_CONTAINER (editor->priv->overlay), grid);
458 /* Construct the sv popup */
459 editor->priv->s_entry = entry = gtk_spin_button_new (scaled_adjustment (s_adj, 100), 1, 0);
460 atk_obj = gtk_widget_get_accessible (entry);
461 atk_object_set_name (atk_obj, C_("Color channel", "Saturation"));
462 atk_object_set_role (atk_obj, ATK_ROLE_ENTRY);
463 g_signal_connect (entry, "key-press-event", G_CALLBACK (popup_key_press), editor);
465 editor->priv->v_entry = entry = gtk_spin_button_new (scaled_adjustment (v_adj, 100), 1, 0);
466 atk_obj = gtk_widget_get_accessible (entry);
467 atk_object_set_name (atk_obj, C_("Color channel", "Value"));
468 atk_object_set_role (atk_obj, ATK_ROLE_ENTRY);
469 g_signal_connect (entry, "key-press-event", G_CALLBACK (popup_key_press), editor);
471 grid = gtk_grid_new ();
472 gtk_grid_set_row_spacing (GTK_GRID (grid), 6);
473 gtk_grid_set_column_spacing (GTK_GRID (grid), 6);
475 gtk_grid_attach (GTK_GRID (grid), gtk_label_new (C_("Color channel", "S")), 0, 0, 1, 1);
476 gtk_grid_attach (GTK_GRID (grid), editor->priv->s_entry, 1, 0, 1, 1);
477 gtk_grid_attach (GTK_GRID (grid), gtk_label_new (C_("Color channel", "V")), 0, 1, 1, 1);
478 gtk_grid_attach (GTK_GRID (grid), editor->priv->v_entry, 1, 1, 1, 1);
480 editor->priv->sv_popup = create_popup (editor, editor->priv->sv_plane, grid);
482 /* Construct the h popup */
483 editor->priv->h_entry = entry = gtk_spin_button_new (scaled_adjustment (h_adj, 100), 1, 0);
484 atk_obj = gtk_widget_get_accessible (entry);
485 atk_object_set_name (atk_obj, C_("Color channel", "Hue"));
486 atk_object_set_role (atk_obj, ATK_ROLE_ENTRY);
487 g_signal_connect (entry, "key-press-event", G_CALLBACK (popup_key_press), editor);
489 grid = gtk_grid_new ();
490 gtk_grid_set_column_spacing (GTK_GRID (grid), 6);
492 gtk_grid_attach (GTK_GRID (grid), gtk_label_new (C_("Color channel", "H")), 0, 0, 1, 1);
493 gtk_grid_attach (GTK_GRID (grid), editor->priv->h_entry, 1, 0, 1, 1);
495 editor->priv->h_popup = create_popup (editor, editor->priv->h_slider, grid);
497 /* Construct the a popup */
498 editor->priv->a_entry = entry = gtk_spin_button_new (scaled_adjustment (a_adj, 100), 1, 0);
499 atk_obj = gtk_widget_get_accessible (entry);
500 atk_object_set_name (atk_obj, C_("Color channel", "Alpha"));
501 atk_object_set_role (atk_obj, ATK_ROLE_ENTRY);
502 g_signal_connect (entry, "key-press-event", G_CALLBACK (popup_key_press), editor);
504 grid = gtk_grid_new ();
505 gtk_grid_set_column_spacing (GTK_GRID (grid), 6);
507 gtk_grid_attach (GTK_GRID (grid), gtk_label_new (C_("Color channel", "A")), 0, 0, 1, 1);
508 gtk_grid_attach (GTK_GRID (grid), editor->priv->a_entry, 1, 0, 1, 1);
510 editor->priv->a_popup = create_popup (editor, editor->priv->a_slider, grid);
512 /* Hook up popup positioning */
513 g_signal_connect (editor->priv->overlay, "get-child-position", G_CALLBACK (get_child_position), editor);
514 g_signal_connect (editor, "notify::visible", G_CALLBACK (dismiss_current_popup), NULL);
516 gtk_widget_show_all (editor->priv->overlay);
517 gtk_container_add (GTK_CONTAINER (editor), editor->priv->overlay);
519 gtk_widget_pop_composite_child ();
523 gtk_color_editor_get_property (GObject *object,
528 GtkColorEditor *ce = GTK_COLOR_EDITOR (object);
529 GtkColorChooser *cc = GTK_COLOR_CHOOSER (object);
536 gtk_color_chooser_get_rgba (cc, &color);
537 g_value_set_boxed (value, &color);
541 g_value_set_boolean (value, gtk_widget_get_visible (ce->priv->a_slider));
544 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
550 gtk_color_editor_set_use_alpha (GtkColorEditor *editor,
553 if (editor->priv->use_alpha != use_alpha)
555 editor->priv->use_alpha = use_alpha;
556 gtk_widget_set_visible (editor->priv->a_slider, use_alpha);
557 gtk_color_swatch_set_use_alpha (GTK_COLOR_SWATCH (editor->priv->swatch), use_alpha);
562 gtk_color_editor_set_property (GObject *object,
567 GtkColorEditor *ce = GTK_COLOR_EDITOR (object);
568 GtkColorChooser *cc = GTK_COLOR_CHOOSER (object);
573 gtk_color_chooser_set_rgba (cc, g_value_get_boxed (value));
576 gtk_color_editor_set_use_alpha (ce, g_value_get_boolean (value));
579 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
585 gtk_color_editor_finalize (GObject *object)
587 GtkColorEditor *editor = GTK_COLOR_EDITOR (object);
589 g_clear_object (&editor->priv->h_adj);
590 g_clear_object (&editor->priv->s_adj);
591 g_clear_object (&editor->priv->v_adj);
592 g_clear_object (&editor->priv->a_adj);
594 G_OBJECT_CLASS (gtk_color_editor_parent_class)->finalize (object);
598 gtk_color_editor_class_init (GtkColorEditorClass *class)
600 GObjectClass *object_class = G_OBJECT_CLASS (class);
602 object_class->finalize = gtk_color_editor_finalize;
603 object_class->get_property = gtk_color_editor_get_property;
604 object_class->set_property = gtk_color_editor_set_property;
606 g_object_class_override_property (object_class, PROP_RGBA, "rgba");
607 g_object_class_override_property (object_class, PROP_USE_ALPHA, "use-alpha");
609 g_type_class_add_private (class, sizeof (GtkColorEditorPrivate));
613 gtk_color_editor_get_rgba (GtkColorChooser *chooser,
616 GtkColorEditor *editor = GTK_COLOR_EDITOR (chooser);
619 h = gtk_adjustment_get_value (editor->priv->h_adj);
620 s = gtk_adjustment_get_value (editor->priv->s_adj);
621 v = gtk_adjustment_get_value (editor->priv->v_adj);
622 gtk_hsv_to_rgb (h, s, v, &color->red, &color->green, &color->blue);
623 color->alpha = gtk_adjustment_get_value (editor->priv->a_adj);
627 gtk_color_editor_set_rgba (GtkColorChooser *chooser,
628 const GdkRGBA *color)
630 GtkColorEditor *editor = GTK_COLOR_EDITOR (chooser);
633 gtk_rgb_to_hsv (color->red, color->green, color->blue, &h, &s, &v);
635 gtk_adjustment_set_value (editor->priv->h_adj, h);
636 gtk_adjustment_set_value (editor->priv->s_adj, s);
637 gtk_adjustment_set_value (editor->priv->v_adj, v);
638 gtk_adjustment_set_value (editor->priv->a_adj, color->alpha);
640 gtk_color_swatch_set_rgba (GTK_COLOR_SWATCH (editor->priv->swatch), color);
641 gtk_color_scale_set_rgba (GTK_COLOR_SCALE (editor->priv->a_slider), color);
642 entry_set_rgba (editor, color);
644 g_object_notify (G_OBJECT (editor), "rgba");
648 gtk_color_editor_iface_init (GtkColorChooserInterface *iface)
650 iface->get_rgba = gtk_color_editor_get_rgba;
651 iface->set_rgba = gtk_color_editor_set_rgba;
655 gtk_color_editor_new (void)
657 return (GtkWidget *) g_object_new (GTK_TYPE_COLOR_EDITOR, NULL);