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)"));
186 children = gtk_container_get_children (GTK_CONTAINER (cc->priv->custom));
187 for (l = g_list_nth (children, 1); l != NULL; l = l->next)
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);
198 g_list_free (children);
202 connect_custom_signals (GtkWidget *p,
205 connect_swatch_signals (p, data);
206 g_signal_connect_swapped (p, "notify::rgba",
207 G_CALLBACK (save_custom_colors), data);
211 gtk_color_chooser_widget_set_use_alpha (GtkColorChooserWidget *cc,
219 cc->priv->use_alpha = use_alpha;
220 gtk_color_chooser_set_use_alpha (GTK_COLOR_CHOOSER (cc->priv->editor), use_alpha);
222 palettes = gtk_container_get_children (GTK_CONTAINER (cc->priv->palette));
223 for (p = palettes; p; p = p->next)
227 if (!GTK_IS_GRID (grid))
230 children = gtk_container_get_children (GTK_CONTAINER (grid));
231 for (l = children; l; l = l->next)
234 gtk_color_swatch_set_use_alpha (GTK_COLOR_SWATCH (swatch), use_alpha);
236 g_list_free (children);
238 g_list_free (palettes);
240 gtk_widget_queue_draw (GTK_WIDGET (cc));
244 gtk_color_chooser_widget_set_show_editor (GtkColorChooserWidget *cc,
245 gboolean show_editor)
249 GdkRGBA color = { 0.75, 0.25, 0.25, 1.0 };
251 if (cc->priv->current)
252 gtk_color_swatch_get_rgba (cc->priv->current, &color);
253 gtk_color_chooser_set_rgba (GTK_COLOR_CHOOSER (cc->priv->editor), &color);
256 gtk_widget_set_visible (cc->priv->editor, show_editor);
257 gtk_widget_set_visible (cc->priv->palette, !show_editor);
260 /* UI construction {{{1 */
263 add_palette (GtkColorChooserWidget *cc,
265 gint colors_per_line,
275 grid = gtk_grid_new ();
276 gtk_widget_set_margin_bottom (grid, 12);
277 gtk_grid_set_row_spacing (GTK_GRID (grid), 2);
278 gtk_grid_set_column_spacing (GTK_GRID (grid), 4);
279 gtk_container_add (GTK_CONTAINER (cc->priv->palette), grid);
282 right = colors_per_line - 1;
283 if (gtk_widget_get_direction (GTK_WIDGET (cc)) == GTK_TEXT_DIR_RTL)
290 for (i = 0; i < n_colors; i++)
292 p = gtk_color_swatch_new ();
293 gtk_color_swatch_set_rgba (GTK_COLOR_SWATCH (p), &colors[i]);
294 connect_swatch_signals (p, cc);
296 line = i / colors_per_line;
297 pos = i % colors_per_line;
302 gtk_style_context_add_class (gtk_widget_get_style_context (p), GTK_STYLE_CLASS_LEFT);
303 else if (pos == right)
304 gtk_style_context_add_class (gtk_widget_get_style_context (p), GTK_STYLE_CLASS_RIGHT);
306 gtk_grid_attach (GTK_GRID (grid), p, pos, line, 1, 1);
311 gtk_style_context_add_class (gtk_widget_get_style_context (p), GTK_STYLE_CLASS_TOP);
312 else if (pos == colors_per_line - 1)
313 gtk_style_context_add_class (gtk_widget_get_style_context (p), GTK_STYLE_CLASS_BOTTOM);
315 gtk_grid_attach (GTK_GRID (grid), p, line, pos, 1, 1);
319 gtk_widget_show_all (grid);
323 remove_default_palette (GtkColorChooserWidget *cc)
328 if (!cc->priv->has_default_palette)
331 children = gtk_container_get_children (GTK_CONTAINER (cc->priv->palette));
332 for (l = children; l; l = l->next)
335 if (widget == cc->priv->custom_label || widget == cc->priv->custom)
337 gtk_container_remove (GTK_CONTAINER (cc->priv->palette), widget);
339 g_list_free (children);
341 cc->priv->has_default_palette = FALSE;
345 add_default_palette (GtkColorChooserWidget *cc)
347 const gchar *default_colors[9][3] = {
348 { "#ef2929", "#cc0000", "#a40000" }, /* Scarlet Red */
349 { "#fcaf3e", "#f57900", "#ce5c00" }, /* Orange */
350 { "#fce94f", "#edd400", "#c4a000" }, /* Butter */
351 { "#8ae234", "#73d216", "#4e9a06" }, /* Chameleon */
352 { "#729fcf", "#3465a4", "#204a87" }, /* Sky Blue */
353 { "#ad7fa8", "#75507b", "#5c3566" }, /* Plum */
354 { "#e9b96e", "#c17d11", "#8f5902" }, /* Chocolate */
355 { "#888a85", "#555753", "#2e3436" }, /* Aluminum 1 */
356 { "#eeeeec", "#d3d7cf", "#babdb6" } /* Aluminum 2 */
358 const gchar *default_grays[9] = {
372 for (i = 0; i < 9; i++)
373 for (j = 0; j < 3; j++)
374 gdk_rgba_parse (&colors[i*3 + j], default_colors[i][j]);
376 add_palette (cc, FALSE, 3, 9*3, colors);
378 for (i = 0; i < 9; i++)
379 gdk_rgba_parse (&colors[i], default_grays[i]);
381 add_palette (cc, TRUE, 9, 9, colors);
383 cc->priv->has_default_palette = TRUE;
387 gtk_color_chooser_widget_init (GtkColorChooserWidget *cc)
391 GtkWidget *alignment;
400 cc->priv = G_TYPE_INSTANCE_GET_PRIVATE (cc, GTK_TYPE_COLOR_CHOOSER_WIDGET, GtkColorChooserWidgetPrivate);
402 gtk_orientable_set_orientation (GTK_ORIENTABLE (cc), GTK_ORIENTATION_VERTICAL);
403 cc->priv->palette = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
404 gtk_container_add (GTK_CONTAINER (cc), cc->priv->palette);
406 add_default_palette (cc);
408 cc->priv->custom = box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 4);
409 g_object_set (box, "margin-top", 12, NULL);
410 gtk_box_pack_end (GTK_BOX (cc->priv->palette), box, FALSE, TRUE, 0);
412 /* translators: label for the custom section in the color chooser */
413 cc->priv->custom_label = label = gtk_label_new (_("Custom"));
414 gtk_widget_set_halign (label, GTK_ALIGN_START);
415 gtk_box_pack_end (GTK_BOX (cc->priv->palette), label, FALSE, TRUE, 0);
417 cc->priv->button = button = gtk_color_swatch_new ();
418 connect_button_signals (button, cc);
419 gtk_color_swatch_set_icon (GTK_COLOR_SWATCH (button), "list-add-symbolic");
420 gtk_container_add (GTK_CONTAINER (box), button);
422 cc->priv->settings = g_settings_new_with_path ("org.gtk.Settings.ColorChooser",
423 "/org/gtk/settings/color-chooser/");
424 variant = g_settings_get_value (cc->priv->settings, "custom-colors");
425 g_variant_iter_init (&iter, variant);
428 while (g_variant_iter_loop (&iter, "(dddd)", &color.red, &color.green, &color.blue, &color.alpha))
431 p = gtk_color_swatch_new ();
432 gtk_color_swatch_set_rgba (GTK_COLOR_SWATCH (p), &color);
433 gtk_color_swatch_set_can_drop (GTK_COLOR_SWATCH (p), TRUE);
434 connect_custom_signals (p, cc);
435 gtk_container_add (GTK_CONTAINER (box), p);
440 g_variant_unref (variant);
442 cc->priv->editor = gtk_color_editor_new ();
443 alignment = gtk_alignment_new (0.5, 0.5, 0, 0);
444 gtk_container_add (GTK_CONTAINER (cc), alignment);
445 gtk_container_add (GTK_CONTAINER (alignment), cc->priv->editor);
447 g_settings_get (cc->priv->settings, "selected-color", "(bdddd)",
449 &color.red, &color.green, &color.blue, &color.alpha);
451 gtk_color_chooser_set_rgba (GTK_COLOR_CHOOSER (cc), &color);
453 gtk_widget_show_all (GTK_WIDGET (cc));
454 gtk_widget_hide (GTK_WIDGET (cc->priv->editor));
455 gtk_widget_hide (GTK_WIDGET (cc));
457 gtk_widget_set_no_show_all (cc->priv->palette, TRUE);
458 gtk_widget_set_no_show_all (cc->priv->editor, TRUE);
460 cc->priv->size_group = gtk_size_group_new (GTK_SIZE_GROUP_HORIZONTAL);
461 gtk_size_group_add_widget (cc->priv->size_group, cc->priv->palette);
462 gtk_size_group_add_widget (cc->priv->size_group, alignment);
465 /* GObject implementation {{{1 */
468 gtk_color_chooser_widget_get_property (GObject *object,
473 GtkColorChooserWidget *cw = GTK_COLOR_CHOOSER_WIDGET (object);
474 GtkColorChooser *cc = GTK_COLOR_CHOOSER (object);
482 gtk_color_chooser_get_rgba (cc, &color);
483 g_value_set_boxed (value, &color);
487 g_value_set_boolean (value, cw->priv->use_alpha);
489 case PROP_SHOW_EDITOR:
490 g_value_set_boolean (value, gtk_widget_get_visible (cw->priv->editor));
493 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
499 gtk_color_chooser_widget_set_property (GObject *object,
504 GtkColorChooserWidget *cc = GTK_COLOR_CHOOSER_WIDGET (object);
509 gtk_color_chooser_set_rgba (GTK_COLOR_CHOOSER (cc),
510 g_value_get_boxed (value));
513 gtk_color_chooser_widget_set_use_alpha (cc,
514 g_value_get_boolean (value));
516 case PROP_SHOW_EDITOR:
517 gtk_color_chooser_widget_set_show_editor (cc,
518 g_value_get_boolean (value));
521 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
527 gtk_color_chooser_widget_finalize (GObject *object)
529 GtkColorChooserWidget *cc = GTK_COLOR_CHOOSER_WIDGET (object);
531 g_object_unref (cc->priv->size_group);
532 g_object_unref (cc->priv->settings);
534 G_OBJECT_CLASS (gtk_color_chooser_widget_parent_class)->finalize (object);
538 gtk_color_chooser_widget_class_init (GtkColorChooserWidgetClass *class)
540 GObjectClass *object_class = G_OBJECT_CLASS (class);
542 object_class->get_property = gtk_color_chooser_widget_get_property;
543 object_class->set_property = gtk_color_chooser_widget_set_property;
544 object_class->finalize = gtk_color_chooser_widget_finalize;
546 g_object_class_override_property (object_class, PROP_RGBA, "rgba");
547 g_object_class_override_property (object_class, PROP_USE_ALPHA, "use-alpha");
550 * GtkColorChooserWidget:show-editor:
552 * The ::show-editor property is %TRUE when the color chooser
553 * is showing the single-color editor. It can be set to switch
554 * the color chooser into single-color editing mode.
558 g_object_class_install_property (object_class, PROP_SHOW_EDITOR,
559 g_param_spec_boolean ("show-editor", P_("Show editor"), P_("Show editor"),
560 FALSE, GTK_PARAM_READWRITE));
562 g_type_class_add_private (object_class, sizeof (GtkColorChooserWidgetPrivate));
565 /* GtkColorChooser implementation {{{1 */
568 gtk_color_chooser_widget_get_rgba (GtkColorChooser *chooser,
571 GtkColorChooserWidget *cc = GTK_COLOR_CHOOSER_WIDGET (chooser);
573 if (gtk_widget_get_visible (cc->priv->editor))
574 gtk_color_chooser_get_rgba (GTK_COLOR_CHOOSER (cc->priv->editor), color);
575 else if (cc->priv->current)
576 gtk_color_swatch_get_rgba (cc->priv->current, color);
585 if (!cc->priv->use_alpha)
590 add_custom_color (GtkColorChooserWidget *cc,
591 const GdkRGBA *color)
597 children = gtk_container_get_children (GTK_CONTAINER (cc->priv->custom));
598 if (g_list_length (children) == 8)
600 last = g_list_last (children)->data;
601 gtk_widget_destroy (last);
604 g_list_free (children);
606 p = gtk_color_swatch_new ();
607 gtk_color_swatch_set_rgba (GTK_COLOR_SWATCH (p), color);
608 gtk_color_swatch_set_can_drop (GTK_COLOR_SWATCH (p), TRUE);
609 connect_custom_signals (p, cc);
611 gtk_container_add (GTK_CONTAINER (cc->priv->custom), p);
612 gtk_box_reorder_child (GTK_BOX (cc->priv->custom), p, 1);
615 select_swatch (cc, GTK_COLOR_SWATCH (p));
616 save_custom_colors (cc);
620 gtk_color_chooser_widget_set_rgba (GtkColorChooser *chooser,
621 const GdkRGBA *color)
623 GtkColorChooserWidget *cc = GTK_COLOR_CHOOSER_WIDGET (chooser);
626 GtkColorSwatch *swatch;
630 palettes = gtk_container_get_children (GTK_CONTAINER (cc->priv->palette));
631 for (p = palettes; p; p = p->next)
634 if (!GTK_IS_GRID (w) && !GTK_IS_BOX (w))
637 children = gtk_container_get_children (GTK_CONTAINER (w));
638 for (l = children; l; l = l->next)
641 gtk_color_swatch_get_rgba (swatch, &c);
642 if (!cc->priv->use_alpha)
643 c.alpha = color->alpha;
644 if (gdk_rgba_equal (color, &c))
646 select_swatch (cc, swatch);
647 g_list_free (children);
651 g_list_free (children);
653 g_list_free (palettes);
655 add_custom_color (cc, color);
659 gtk_color_chooser_widget_add_palette (GtkColorChooser *chooser,
661 gint colors_per_line,
665 GtkColorChooserWidget *cc = GTK_COLOR_CHOOSER_WIDGET (chooser);
667 remove_default_palette (cc);
668 add_palette (cc, horizontal, colors_per_line, n_colors, colors);
672 gtk_color_chooser_widget_iface_init (GtkColorChooserInterface *iface)
674 iface->get_rgba = gtk_color_chooser_widget_get_rgba;
675 iface->set_rgba = gtk_color_chooser_widget_set_rgba;
676 iface->add_palette = gtk_color_chooser_widget_add_palette;
679 /* Public API {{{1 */
682 * gtk_color_chooser_widget_new:
684 * Creates a new #GtkColorChooserWidget.
686 * Returns: a new #GtkColorChooserWidget
691 gtk_color_chooser_widget_new (void)
693 return g_object_new (GTK_TYPE_COLOR_CHOOSER_WIDGET, NULL);
696 /* vim:set foldmethod=marker: */