1 /* GTK - The GIMP Toolkit
3 * Copyright (C) 2012 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
23 #include "gtkcolorchooserprivate.h"
24 #include "gtkcolorchooserwidget.h"
25 #include "gtkcoloreditor.h"
26 #include "gtkcolorswatch.h"
30 #include "gtkorientable.h"
31 #include "gtkprivate.h"
33 #include "gtksizegroup.h"
34 #include "gtkalignment.h"
37 * SECTION:gtkcolorchooserwidget
38 * @Short_description: A widget for choosing colors
39 * @Title: GtkColorChooserWidget
40 * @See_also: #GtkColorChooserDialog
42 * The #GtkColorChooserWidget widget lets the user select a
43 * color. By default, the chooser presents a prefined palette
44 * of colors, plus a small number of settable custom colors.
45 * It is also possible to select a different color with the
46 * single-color editor. To enter the single-color editing mode,
47 * use the context menu of any color of the palette, or use the
48 * '+' button to add a new custom color.
50 * The chooser automatically remembers the last selection, as well
53 * To change the initially selected color, use gtk_color_chooser_set_rgba().
54 * To get the selected font use gtk_color_chooser_get_rgba().
56 * The #GtkColorChooserWidget is used in the #GtkColorChooserDialog
57 * to provide a dialog for selecting colors.
62 struct _GtkColorChooserWidgetPrivate
66 GtkSizeGroup *size_group;
68 GtkWidget *custom_label;
72 GtkColorSwatch *current;
75 gboolean has_default_palette;
88 static void gtk_color_chooser_widget_iface_init (GtkColorChooserInterface *iface);
90 G_DEFINE_TYPE_WITH_CODE (GtkColorChooserWidget, gtk_color_chooser_widget, GTK_TYPE_BOX,
91 G_IMPLEMENT_INTERFACE (GTK_TYPE_COLOR_CHOOSER,
92 gtk_color_chooser_widget_iface_init))
95 select_swatch (GtkColorChooserWidget *cc,
96 GtkColorSwatch *swatch)
100 if (cc->priv->current == swatch)
103 if (cc->priv->current != NULL)
104 gtk_color_swatch_set_selected (cc->priv->current, FALSE);
105 gtk_color_swatch_set_selected (swatch, TRUE);
106 cc->priv->current = swatch;
108 gtk_color_swatch_get_rgba (swatch, &color);
109 g_settings_set (cc->priv->settings, "selected-color", "(bdddd)",
110 TRUE, color.red, color.green, color.blue, color.alpha);
112 g_object_notify (G_OBJECT (cc), "rgba");
116 swatch_activate (GtkColorSwatch *swatch,
117 GtkColorChooserWidget *cc)
121 gtk_color_swatch_get_rgba (swatch, &color);
122 _gtk_color_chooser_color_activated (GTK_COLOR_CHOOSER (cc), &color);
126 swatch_customize (GtkColorSwatch *swatch,
127 GtkColorChooserWidget *cc)
131 gtk_color_swatch_get_rgba (swatch, &color);
132 gtk_color_chooser_set_rgba (GTK_COLOR_CHOOSER (cc->priv->editor), &color);
134 gtk_widget_hide (cc->priv->palette);
135 gtk_widget_show (cc->priv->editor);
139 swatch_selected (GtkColorSwatch *swatch,
141 GtkColorChooserWidget *cc)
143 select_swatch (cc, swatch);
147 connect_swatch_signals (GtkWidget *p,
150 g_signal_connect (p, "activate", G_CALLBACK (swatch_activate), data);
151 g_signal_connect (p, "customize", G_CALLBACK (swatch_customize), data);
152 g_signal_connect (p, "notify::selected", G_CALLBACK (swatch_selected), data);
156 button_activate (GtkColorSwatch *swatch,
157 GtkColorChooserWidget *cc)
159 /* somewhat random, makes the hairline nicely visible */
160 GdkRGBA color = { 0.75, 0.25, 0.25, 1.0 };
162 gtk_color_chooser_set_rgba (GTK_COLOR_CHOOSER (cc->priv->editor), &color);
164 gtk_widget_hide (cc->priv->palette);
165 gtk_widget_show (cc->priv->editor);
169 connect_button_signals (GtkWidget *p,
172 g_signal_connect (p, "activate", G_CALLBACK (button_activate), data);
176 save_custom_colors (GtkColorChooserWidget *cc)
178 GVariantBuilder builder;
184 g_variant_builder_init (&builder, G_VARIANT_TYPE ("a(dddd)"));
187 while ((child = gtk_grid_get_child_at (GTK_GRID (cc->priv->custom), i, 0)) != NULL)
190 if (gtk_color_swatch_get_rgba (GTK_COLOR_SWATCH (child), &color))
191 g_variant_builder_add (&builder, "(dddd)",
192 color.red, color.green, color.blue, color.alpha);
195 variant = g_variant_builder_end (&builder);
196 g_settings_set_value (cc->priv->settings, "custom-colors", variant);
200 connect_custom_signals (GtkWidget *p,
203 connect_swatch_signals (p, data);
204 g_signal_connect_swapped (p, "notify::rgba",
205 G_CALLBACK (save_custom_colors), data);
209 gtk_color_chooser_widget_set_use_alpha (GtkColorChooserWidget *cc,
217 cc->priv->use_alpha = use_alpha;
218 gtk_color_chooser_set_use_alpha (GTK_COLOR_CHOOSER (cc->priv->editor), use_alpha);
220 palettes = gtk_container_get_children (GTK_CONTAINER (cc->priv->palette));
221 for (p = palettes; p; p = p->next)
225 if (!GTK_IS_GRID (grid))
228 children = gtk_container_get_children (GTK_CONTAINER (grid));
229 for (l = children; l; l = l->next)
232 gtk_color_swatch_set_use_alpha (GTK_COLOR_SWATCH (swatch), use_alpha);
234 g_list_free (children);
236 g_list_free (palettes);
238 gtk_widget_queue_draw (GTK_WIDGET (cc));
242 gtk_color_chooser_widget_set_show_editor (GtkColorChooserWidget *cc,
243 gboolean show_editor)
247 GdkRGBA color = { 0.75, 0.25, 0.25, 1.0 };
249 if (cc->priv->current)
250 gtk_color_swatch_get_rgba (cc->priv->current, &color);
251 gtk_color_chooser_set_rgba (GTK_COLOR_CHOOSER (cc->priv->editor), &color);
254 gtk_widget_set_visible (cc->priv->editor, show_editor);
255 gtk_widget_set_visible (cc->priv->palette, !show_editor);
258 /* UI construction {{{1 */
261 add_palette (GtkColorChooserWidget *cc,
263 gint colors_per_line,
273 grid = gtk_grid_new ();
274 gtk_widget_set_margin_bottom (grid, 12);
275 gtk_grid_set_row_spacing (GTK_GRID (grid), 2);
276 gtk_grid_set_column_spacing (GTK_GRID (grid), 4);
277 gtk_container_add (GTK_CONTAINER (cc->priv->palette), grid);
280 right = colors_per_line - 1;
281 if (gtk_widget_get_direction (GTK_WIDGET (cc)) == GTK_TEXT_DIR_RTL)
288 for (i = 0; i < n_colors; i++)
290 p = gtk_color_swatch_new ();
291 gtk_color_swatch_set_rgba (GTK_COLOR_SWATCH (p), &colors[i]);
292 connect_swatch_signals (p, cc);
294 line = i / colors_per_line;
295 pos = i % colors_per_line;
299 gtk_grid_attach (GTK_GRID (grid), p, pos, line, 1, 1);
301 gtk_color_swatch_set_corner_radii (GTK_COLOR_SWATCH (p), 10, 1, 1, 10);
302 else if (pos == right)
303 gtk_color_swatch_set_corner_radii (GTK_COLOR_SWATCH (p), 1, 10, 10, 1);
305 gtk_color_swatch_set_corner_radii (GTK_COLOR_SWATCH (p), 1, 1, 1, 1);
309 gtk_grid_attach (GTK_GRID (grid), p, line, pos, 1, 1);
312 gtk_color_swatch_set_corner_radii (GTK_COLOR_SWATCH (p), 10, 10, 1, 1);
313 else if (pos == colors_per_line - 1)
314 gtk_color_swatch_set_corner_radii (GTK_COLOR_SWATCH (p), 1, 1, 10, 10);
316 gtk_color_swatch_set_corner_radii (GTK_COLOR_SWATCH (p), 1, 1, 1, 1);
320 gtk_widget_show_all (grid);
324 remove_default_palette (GtkColorChooserWidget *cc)
329 if (!cc->priv->has_default_palette)
332 children = gtk_container_get_children (GTK_CONTAINER (cc->priv->palette));
333 for (l = children; l; l = l->next)
336 if (widget == cc->priv->custom_label || widget == cc->priv->custom)
338 gtk_container_remove (GTK_CONTAINER (cc->priv->palette), widget);
340 g_list_free (children);
342 cc->priv->has_default_palette = FALSE;
346 add_default_palette (GtkColorChooserWidget *cc)
348 const gchar *default_colors[9][3] = {
349 { "#ef2929", "#cc0000", "#a40000" }, /* Scarlet Red */
350 { "#fcaf3e", "#f57900", "#ce5c00" }, /* Orange */
351 { "#fce94f", "#edd400", "#c4a000" }, /* Butter */
352 { "#8ae234", "#73d216", "#4e9a06" }, /* Chameleon */
353 { "#729fcf", "#3465a4", "#204a87" }, /* Sky Blue */
354 { "#ad7fa8", "#75507b", "#5c3566" }, /* Plum */
355 { "#e9b96e", "#c17d11", "#8f5902" }, /* Chocolate */
356 { "#888a85", "#555753", "#2e3436" }, /* Aluminum 1 */
357 { "#eeeeec", "#d3d7cf", "#babdb6" } /* Aluminum 2 */
359 const gchar *default_grays[9] = {
373 for (i = 0; i < 9; i++)
374 for (j = 0; j < 3; j++)
375 gdk_rgba_parse (&colors[i*3 + j], default_colors[i][j]);
377 add_palette (cc, FALSE, 3, 9*3, colors);
379 for (i = 0; i < 9; i++)
380 gdk_rgba_parse (&colors[i], default_grays[i]);
382 add_palette (cc, TRUE, 9, 9, colors);
384 cc->priv->has_default_palette = TRUE;
388 gtk_color_chooser_widget_init (GtkColorChooserWidget *cc)
392 GtkWidget *alignment;
401 cc->priv = G_TYPE_INSTANCE_GET_PRIVATE (cc, GTK_TYPE_COLOR_CHOOSER_WIDGET, GtkColorChooserWidgetPrivate);
403 gtk_orientable_set_orientation (GTK_ORIENTABLE (cc), GTK_ORIENTATION_VERTICAL);
404 cc->priv->palette = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
405 gtk_container_add (GTK_CONTAINER (cc), cc->priv->palette);
407 add_default_palette (cc);
409 cc->priv->custom = grid = gtk_grid_new ();
410 g_object_set (grid, "margin-top", 12, NULL);
411 gtk_grid_set_column_spacing (GTK_GRID (grid), 4);
412 gtk_box_pack_end (GTK_BOX (cc->priv->palette), grid, FALSE, TRUE, 0);
414 /* translators: label for the custom section in the color chooser */
415 cc->priv->custom_label = label = gtk_label_new (_("Custom"));
416 gtk_widget_set_halign (label, GTK_ALIGN_START);
417 gtk_box_pack_end (GTK_BOX (cc->priv->palette), label, FALSE, TRUE, 0);
419 cc->priv->button = button = gtk_color_swatch_new ();
420 gtk_color_swatch_set_corner_radii (GTK_COLOR_SWATCH (button), 10, 10, 10, 10);
421 connect_button_signals (button, cc);
422 gtk_color_swatch_set_icon (GTK_COLOR_SWATCH (button), "list-add-symbolic");
423 gtk_grid_attach (GTK_GRID (grid), button, 0, 0, 1, 1);
425 cc->priv->settings = g_settings_new_with_path ("org.gtk.Settings.ColorChooser",
426 "/org/gtk/settings/color-chooser/");
427 variant = g_settings_get_value (cc->priv->settings, "custom-colors");
428 g_variant_iter_init (&iter, variant);
431 while (g_variant_iter_loop (&iter, "(dddd)", &color.red, &color.green, &color.blue, &color.alpha))
434 p = gtk_color_swatch_new ();
435 gtk_color_swatch_set_corner_radii (GTK_COLOR_SWATCH (p), 1, 1, 1, 1);
436 gtk_color_swatch_set_rgba (GTK_COLOR_SWATCH (p), &color);
437 gtk_color_swatch_set_can_drop (GTK_COLOR_SWATCH (p), TRUE);
438 connect_custom_signals (p, cc);
439 gtk_grid_attach (GTK_GRID (grid), p, i, 0, 1, 1);
444 g_variant_unref (variant);
448 if (gtk_widget_get_direction (GTK_WIDGET (cc)) == GTK_TEXT_DIR_LTR)
450 gtk_color_swatch_set_corner_radii (GTK_COLOR_SWATCH (p), 1, 10, 10, 1);
451 gtk_color_swatch_set_corner_radii (GTK_COLOR_SWATCH (button), 10, 1, 1, 10);
455 gtk_color_swatch_set_corner_radii (GTK_COLOR_SWATCH (button), 1, 10, 10, 1);
456 gtk_color_swatch_set_corner_radii (GTK_COLOR_SWATCH (p), 10, 1, 1, 10);
460 cc->priv->editor = gtk_color_editor_new ();
461 alignment = gtk_alignment_new (0.5, 0.5, 0, 0);
462 gtk_container_add (GTK_CONTAINER (cc), alignment);
463 gtk_container_add (GTK_CONTAINER (alignment), cc->priv->editor);
465 g_settings_get (cc->priv->settings, "selected-color", "(bdddd)",
467 &color.red, &color.green, &color.blue, &color.alpha);
469 gtk_color_chooser_set_rgba (GTK_COLOR_CHOOSER (cc), &color);
471 gtk_widget_show_all (GTK_WIDGET (cc));
472 gtk_widget_hide (GTK_WIDGET (cc->priv->editor));
473 gtk_widget_hide (GTK_WIDGET (cc));
475 gtk_widget_set_no_show_all (cc->priv->palette, TRUE);
476 gtk_widget_set_no_show_all (cc->priv->editor, TRUE);
478 cc->priv->size_group = gtk_size_group_new (GTK_SIZE_GROUP_HORIZONTAL);
479 gtk_size_group_add_widget (cc->priv->size_group, cc->priv->palette);
480 gtk_size_group_add_widget (cc->priv->size_group, alignment);
483 /* GObject implementation {{{1 */
486 gtk_color_chooser_widget_get_property (GObject *object,
491 GtkColorChooserWidget *cw = GTK_COLOR_CHOOSER_WIDGET (object);
492 GtkColorChooser *cc = GTK_COLOR_CHOOSER (object);
500 gtk_color_chooser_get_rgba (cc, &color);
501 g_value_set_boxed (value, &color);
505 g_value_set_boolean (value, cw->priv->use_alpha);
507 case PROP_SHOW_EDITOR:
508 g_value_set_boolean (value, gtk_widget_get_visible (cw->priv->editor));
511 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
517 gtk_color_chooser_widget_set_property (GObject *object,
522 GtkColorChooserWidget *cc = GTK_COLOR_CHOOSER_WIDGET (object);
527 gtk_color_chooser_set_rgba (GTK_COLOR_CHOOSER (cc),
528 g_value_get_boxed (value));
531 gtk_color_chooser_widget_set_use_alpha (cc,
532 g_value_get_boolean (value));
534 case PROP_SHOW_EDITOR:
535 gtk_color_chooser_widget_set_show_editor (cc,
536 g_value_get_boolean (value));
539 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
545 gtk_color_chooser_widget_finalize (GObject *object)
547 GtkColorChooserWidget *cc = GTK_COLOR_CHOOSER_WIDGET (object);
549 g_object_unref (cc->priv->size_group);
550 g_object_unref (cc->priv->settings);
552 G_OBJECT_CLASS (gtk_color_chooser_widget_parent_class)->finalize (object);
556 gtk_color_chooser_widget_class_init (GtkColorChooserWidgetClass *class)
558 GObjectClass *object_class = G_OBJECT_CLASS (class);
560 object_class->get_property = gtk_color_chooser_widget_get_property;
561 object_class->set_property = gtk_color_chooser_widget_set_property;
562 object_class->finalize = gtk_color_chooser_widget_finalize;
564 g_object_class_override_property (object_class, PROP_RGBA, "rgba");
565 g_object_class_override_property (object_class, PROP_USE_ALPHA, "use-alpha");
568 * GtkColorChooserWidget:show-editor:
570 * The ::show-editor property is %TRUE when the color chooser
571 * is showing the single-color editor. It can be set to switch
572 * the color chooser into single-color editing mode.
576 g_object_class_install_property (object_class, PROP_SHOW_EDITOR,
577 g_param_spec_boolean ("show-editor", P_("Show editor"), P_("Show editor"),
578 FALSE, GTK_PARAM_READWRITE));
580 g_type_class_add_private (object_class, sizeof (GtkColorChooserWidgetPrivate));
583 /* GtkColorChooser implementation {{{1 */
586 gtk_color_chooser_widget_get_rgba (GtkColorChooser *chooser,
589 GtkColorChooserWidget *cc = GTK_COLOR_CHOOSER_WIDGET (chooser);
591 if (gtk_widget_get_visible (cc->priv->editor))
592 gtk_color_chooser_get_rgba (GTK_COLOR_CHOOSER (cc->priv->editor), color);
593 else if (cc->priv->current)
594 gtk_color_swatch_get_rgba (cc->priv->current, color);
603 if (!cc->priv->use_alpha)
608 add_custom_color (GtkColorChooserWidget *cc,
609 const GdkRGBA *color)
614 last = gtk_grid_get_child_at (GTK_GRID (cc->priv->custom), 8, 0);
617 gtk_container_remove (GTK_CONTAINER (cc->priv->custom), last);
618 last = gtk_grid_get_child_at (GTK_GRID (cc->priv->custom), 7, 0);
619 gtk_color_swatch_set_corner_radii (GTK_COLOR_SWATCH (last), 1, 10, 10, 1);
622 gtk_color_swatch_set_corner_radii (GTK_COLOR_SWATCH (cc->priv->button), 10, 1, 1, 10);
624 p = gtk_color_swatch_new ();
625 gtk_color_swatch_set_rgba (GTK_COLOR_SWATCH (p), color);
626 gtk_color_swatch_set_can_drop (GTK_COLOR_SWATCH (p), TRUE);
627 connect_custom_signals (p, cc);
629 if (gtk_grid_get_child_at (GTK_GRID (cc->priv->custom), 1, 0) != NULL)
630 gtk_color_swatch_set_corner_radii (GTK_COLOR_SWATCH (p), 1, 1, 1, 1);
632 gtk_color_swatch_set_corner_radii (GTK_COLOR_SWATCH (p), 1, 10, 10, 1);
634 gtk_grid_insert_next_to (GTK_GRID (cc->priv->custom), cc->priv->button, GTK_POS_RIGHT);
635 gtk_grid_attach (GTK_GRID (cc->priv->custom), p, 1, 0, 1, 1);
638 select_swatch (cc, GTK_COLOR_SWATCH (p));
639 save_custom_colors (cc);
643 gtk_color_chooser_widget_set_rgba (GtkColorChooser *chooser,
644 const GdkRGBA *color)
646 GtkColorChooserWidget *cc = GTK_COLOR_CHOOSER_WIDGET (chooser);
649 GtkColorSwatch *swatch;
653 palettes = gtk_container_get_children (GTK_CONTAINER (cc->priv->palette));
654 for (p = palettes; p; p = p->next)
657 if (!GTK_IS_GRID (grid))
660 children = gtk_container_get_children (GTK_CONTAINER (grid));
661 for (l = children; l; l = l->next)
664 gtk_color_swatch_get_rgba (swatch, &c);
665 if (!cc->priv->use_alpha)
666 c.alpha = color->alpha;
667 if (gdk_rgba_equal (color, &c))
669 select_swatch (cc, swatch);
670 g_list_free (children);
674 g_list_free (children);
676 g_list_free (palettes);
678 add_custom_color (cc, color);
682 gtk_color_chooser_widget_add_palette (GtkColorChooser *chooser,
684 gint colors_per_line,
688 GtkColorChooserWidget *cc = GTK_COLOR_CHOOSER_WIDGET (chooser);
690 remove_default_palette (cc);
691 add_palette (cc, horizontal, colors_per_line, n_colors, colors);
695 gtk_color_chooser_widget_iface_init (GtkColorChooserInterface *iface)
697 iface->get_rgba = gtk_color_chooser_widget_get_rgba;
698 iface->set_rgba = gtk_color_chooser_widget_set_rgba;
699 iface->add_palette = gtk_color_chooser_widget_add_palette;
702 /* Public API {{{1 */
705 * gtk_color_chooser_widget_new:
707 * Creates a new #GtkColorChooserWidget.
709 * Returns: a new #GtkColorChooserWidget
714 gtk_color_chooser_widget_new (void)
716 return g_object_new (GTK_TYPE_COLOR_CHOOSER_WIDGET, NULL);
719 /* vim:set foldmethod=marker: */