gimp/libgimpwidgets/gimpcolorhexentry.c

/* LIBGIMP - The GIMP Library
 * Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
 *
 * gimpcolorhexentry.c
 * Copyright (C) 2004  Sven Neumann <sven@gimp.org>
 *
 * This library is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library.  If not, see
 * <https://www.gnu.org/licenses/>.
 */

#include "config.h"

#include <string.h>

#include <gegl.h>
#include <gtk/gtk.h>
#include <gdk/gdkkeysyms.h>

#include "libgimpcolor/gimpcolor.h"

#include "gimpwidgetstypes.h"

#include "gimpcellrenderercolor.h"
#include "gimpcolorhexentry.h"
#include "gimphelpui.h"

#include "libgimp/libgimp-intl.h"


/**
 * SECTION: gimpcolorhexentry
 * @title: GimpColorHexEntry
 * @short_description: Widget for entering a color's hex triplet.
 *
 * Widget for entering a color's hex triplet. The syntax follows CSS and
 * SVG specifications, which means that only sRGB colors are supported.
 **/


enum
{
  COLOR_CHANGED,
  LAST_SIGNAL
};

enum
{
  COLUMN_NAME,
  COLUMN_COLOR,
  NUM_COLUMNS
};


typedef struct _GimpColorHexEntryPrivate
{
  GeglColor *color;
} GimpColorHexEntryPrivate;


static void      gimp_color_hex_entry_constructed (GObject            *object);
static void      gimp_color_hex_entry_finalize    (GObject            *object);

static gboolean  gimp_color_hex_entry_events      (GtkWidget          *widget,
                                                   GdkEvent           *event);

static gboolean  gimp_color_hex_entry_matched     (GtkEntryCompletion *completion,
                                                   GtkTreeModel       *model,
                                                   GtkTreeIter        *iter,
                                                   GimpColorHexEntry  *entry);


G_DEFINE_TYPE_WITH_PRIVATE (GimpColorHexEntry, gimp_color_hex_entry,
                            GTK_TYPE_ENTRY)

#define parent_class gimp_color_hex_entry_parent_class

static guint entry_signals[LAST_SIGNAL] = { 0 };


static void
gimp_color_hex_entry_class_init (GimpColorHexEntryClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

  entry_signals[COLOR_CHANGED] =
    g_signal_new ("color-changed",
                  G_TYPE_FROM_CLASS (klass),
                  G_SIGNAL_RUN_FIRST,
                  G_STRUCT_OFFSET (GimpColorHexEntryClass, color_changed),
                  NULL, NULL, NULL,
                  G_TYPE_NONE, 0);

  object_class->constructed = gimp_color_hex_entry_constructed;
  object_class->finalize    = gimp_color_hex_entry_finalize;

  klass->color_changed      = NULL;
}

static void
gimp_color_hex_entry_init (GimpColorHexEntry *entry)
{
  GimpColorHexEntryPrivate *private;
  GtkEntryCompletion       *completion;
  GtkCellRenderer          *cell;
  GtkListStore             *store;
  GeglColor               **colors;
  const gchar             **names;
  gint                      i;

  private = gimp_color_hex_entry_get_instance_private (entry);

  /* GtkEntry's minimum size is way too large, set a reasonable one
   * for our use case
   */
  gtk_entry_set_width_chars (GTK_ENTRY (entry), 8);

  gimp_help_set_help_data (GTK_WIDGET (entry),
                           _("Hexadecimal color notation as used in HTML and "
                             "CSS.  This entry also accepts CSS color names."),
                           NULL);

  private->color = gegl_color_new ("black");

  store = gtk_list_store_new (NUM_COLUMNS, G_TYPE_STRING, GEGL_TYPE_COLOR);

  names = gimp_color_list_names (&colors);

  for (i = 0; names[i] != NULL; i++)
    {
      GtkTreeIter  iter;
      GeglColor   *named_color = colors[i];

      gtk_list_store_append (store, &iter);
      gtk_list_store_set (store, &iter,
                          COLUMN_NAME,  names[i],
                          COLUMN_COLOR, named_color,
                          -1);
    }

  gimp_color_array_free (colors);
  g_free (names);

  completion = g_object_new (GTK_TYPE_ENTRY_COMPLETION,
                             "model", store,
                             NULL);
  g_object_unref (store);

  cell = gimp_cell_renderer_color_new ();
  gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (completion), cell, FALSE);
  gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (completion), cell,
                                  "color", COLUMN_COLOR,
                                  NULL);

  gtk_entry_completion_set_text_column (completion, COLUMN_NAME);

  gtk_entry_set_completion (GTK_ENTRY (entry), completion);
  g_object_unref (completion);

  g_signal_connect (entry, "focus-out-event",
                    G_CALLBACK (gimp_color_hex_entry_events),
                    NULL);
  g_signal_connect (entry, "key-press-event",
                    G_CALLBACK (gimp_color_hex_entry_events),
                    NULL);

  g_signal_connect (completion, "match-selected",
                    G_CALLBACK (gimp_color_hex_entry_matched),
                    entry);
}

static void
gimp_color_hex_entry_constructed (GObject *object)
{
  G_OBJECT_CLASS (parent_class)->constructed (object);

  gtk_entry_set_text (GTK_ENTRY (object), "000000");
}

static void
gimp_color_hex_entry_finalize (GObject *object)
{
  GimpColorHexEntry        *entry   = GIMP_COLOR_HEX_ENTRY (object);
  GimpColorHexEntryPrivate *private = gimp_color_hex_entry_get_instance_private (entry);

  g_object_unref (private->color);

  G_OBJECT_CLASS (parent_class)->finalize (object);
}

/**
 * gimp_color_hex_entry_new:
 *
 * Returns: a new #GimpColorHexEntry widget
 *
 * Since: 2.2
 **/
GtkWidget *
gimp_color_hex_entry_new (void)
{
  return g_object_new (GIMP_TYPE_COLOR_HEX_ENTRY, NULL);
}

/**
 * gimp_color_hex_entry_set_color:
 * @entry: a #GimpColorHexEntry widget
 * @color: the color to set.
 *
 * Sets the color displayed by a #GimpColorHexEntry. If the new color
 * is different to the previously set color, the "color-changed"
 * signal is emitted.
 *
 * Since: 2.2
 **/
void
gimp_color_hex_entry_set_color (GimpColorHexEntry *entry,
                                GeglColor         *color)
{
  GimpColorHexEntryPrivate *private;

  g_return_if_fail (GIMP_IS_COLOR_HEX_ENTRY (entry));
  g_return_if_fail (GEGL_IS_COLOR (color));

  private = gimp_color_hex_entry_get_instance_private (entry);

  if (! gimp_color_is_perceptually_identical (private->color, color))
    {
      gchar  buffer[8];
      guchar rgb[3];

      g_object_unref (private->color);
      private->color = gegl_color_duplicate (color);

      gegl_color_get_pixel (color, babl_format ("R'G'B' u8"), rgb);
      g_snprintf (buffer, sizeof (buffer), "%.2x%.2x%.2x", rgb[0], rgb[1], rgb[2]);

      gtk_entry_set_text (GTK_ENTRY (entry), buffer);

      /* move cursor to the end */
      gtk_editable_set_position (GTK_EDITABLE (entry), -1);

     g_signal_emit (entry, entry_signals[COLOR_CHANGED], 0);
    }
}

/**
 * gimp_color_hex_entry_get_color:
 * @entry: a #GimpColorHexEntry widget
 *
 * Retrieves the color value displayed by a #GimpColorHexEntry.
 *
 * Returns: (transfer full): the color stored in @entry.
 *
 * Since: 2.2
 **/
GeglColor *
gimp_color_hex_entry_get_color (GimpColorHexEntry *entry)
{
  GimpColorHexEntryPrivate *private;

  g_return_val_if_fail (GIMP_IS_COLOR_HEX_ENTRY (entry), NULL);

  private = gimp_color_hex_entry_get_instance_private (entry);

  return gegl_color_duplicate (private->color);
}

static gboolean
gimp_color_hex_entry_events (GtkWidget *widget,
                             GdkEvent  *event)
{
  GimpColorHexEntry        *entry   = GIMP_COLOR_HEX_ENTRY (widget);
  GimpColorHexEntryPrivate *private = gimp_color_hex_entry_get_instance_private (entry);

  switch (event->type)
    {
    case GDK_KEY_PRESS:
      {
        GdkEventKey *kevent = (GdkEventKey *) event;

        if (kevent->keyval != GDK_KEY_Return   &&
            kevent->keyval != GDK_KEY_KP_Enter &&
            kevent->keyval != GDK_KEY_ISO_Enter)
          break;
        /*  else fall through  */
      }

    case GDK_FOCUS_CHANGE:
      {
        const gchar *text;
        gchar        buffer[8];
        guchar       rgb[3];

        text = gtk_entry_get_text (GTK_ENTRY (widget));

        gegl_color_get_pixel (private->color, babl_format ("R'G'B' u8"), rgb);
        g_snprintf (buffer, sizeof (buffer), "%.2x%.2x%.2x", rgb[0], rgb[1], rgb[2]);

        if (g_ascii_strcasecmp (buffer, text) != 0)
          {
            GeglColor *color = NULL;
            gsize      len   = strlen (text);

            if (len > 0 &&
                ((color = gimp_color_parse_hex_substring (text, len)) ||
                 (color = gimp_color_parse_name (text))))
              {
                gimp_color_hex_entry_set_color (entry, color);
                g_object_unref (color);
              }
            else
              {
                gtk_entry_set_text (GTK_ENTRY (entry), buffer);
              }
          }
      }
      break;

    default:
      /*  do nothing  */
      break;
    }

  return FALSE;
}

static gboolean
gimp_color_hex_entry_matched (GtkEntryCompletion *completion,
                              GtkTreeModel       *model,
                              GtkTreeIter        *iter,
                              GimpColorHexEntry  *entry)
{
  gchar     *name  = NULL;
  GeglColor *color = NULL;

  gtk_tree_model_get (model, iter,
                      COLUMN_NAME, &name,
                      -1);

  if ((color = gimp_color_parse_name (name)))
    gimp_color_hex_entry_set_color (entry, color);

  g_free (name);
  g_clear_object (&color);

  return TRUE;
}