gimp/app/widgets/gimppropwidgets.c

/* The GIMP -- an image manipulation program
 * Copyright (C) 1995-1997 Spencer Kimball and Peter Mattis
 *
 * gimppropwidgets.c
 * Copyright (C) 2002-2004  Michael Natterer <mitch@gimp.org>
 *                          Sven Neumann <sven@gimp.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#include "config.h"

#include <string.h>
#include <stdlib.h>

#include <gtk/gtk.h>

#include "libgimpcolor/gimpcolor.h"
#include "libgimpmath/gimpmath.h"
#include "libgimpbase/gimpbase.h"
#include "libgimpconfig/gimpconfig.h"
#include "libgimpwidgets/gimpwidgets.h"

#include "widgets-types.h"

#include "core/gimpviewable.h"

#include "gimpcolorpanel.h"
#include "gimpdnd.h"
#include "gimpview.h"
#include "gimppropwidgets.h"
#include "gimpwidgets-constructors.h"

#include "gimp-intl.h"


/*  utility function prototypes  */

static void         set_param_spec     (GObject     *object,
                                        GtkWidget   *widget,
                                        GParamSpec  *param_spec);
static GParamSpec * get_param_spec     (GObject     *object);

static GParamSpec * find_param_spec    (GObject     *object,
                                        const gchar *property_name,
                                        const gchar *strloc);
static GParamSpec * check_param_spec   (GObject     *object,
                                        const gchar *property_name,
                                        GType         type,
                                        const gchar *strloc);

static void         connect_notify     (GObject     *config,
                                        const gchar *property_name,
                                        GCallback    callback,
                                        gpointer     callback_data);


/****************/
/*  paint menu  */
/****************/

static void   gimp_prop_paint_menu_callback (GtkWidget   *widget,
                                             GObject     *config);
static void   gimp_prop_paint_menu_notify   (GObject     *config,
                                             GParamSpec  *param_spec,
                                             GtkWidget   *menu);

/**
 * gimp_prop_paint_mode_menu_new:
 * @config:           #GimpConfig object to which property is attached.
 * @property_name:    Name of Enum property.
 * @with_behind_mode: Whether to include "Behind" mode in the menu.
 *
 * Creates a #GimpPaintModeMenu widget to display and set the specified
 * Enum property, for which the enum must be #GimpLayerModeEffects.
 *
 * Return value: The newly created #GimpPaintModeMenu widget.
 *
 * Since GIMP 2.4
 */
GtkWidget *
gimp_prop_paint_mode_menu_new (GObject     *config,
                               const gchar *property_name,
                               gboolean     with_behind_mode)
{
  GParamSpec *param_spec;
  GtkWidget  *menu;
  gint        value;

  param_spec = check_param_spec (config, property_name,
                                 G_TYPE_PARAM_ENUM, G_STRFUNC);
  if (! param_spec)
    return NULL;

  g_object_get (config,
                property_name, &value,
                NULL);

  menu = gimp_paint_mode_menu_new (with_behind_mode);

  gimp_int_combo_box_connect (GIMP_INT_COMBO_BOX (menu),
                              value,
                              G_CALLBACK (gimp_prop_paint_menu_callback),
                              config);

  set_param_spec (G_OBJECT (menu), menu, param_spec);

  connect_notify (config, property_name,
                  G_CALLBACK (gimp_prop_paint_menu_notify),
                  menu);

  return menu;
}

static void
gimp_prop_paint_menu_callback (GtkWidget *widget,
                               GObject   *config)
{
  GParamSpec *param_spec;
  gint        value;

  param_spec = get_param_spec (G_OBJECT (widget));
  if (! param_spec)
    return;

  if (gimp_int_combo_box_get_active (GIMP_INT_COMBO_BOX (widget), &value))
    {
      g_object_set (config,
                    param_spec->name, value,
                    NULL);
    }
}

static void
gimp_prop_paint_menu_notify (GObject    *config,
                             GParamSpec *param_spec,
                             GtkWidget  *menu)
{
  gint value;

  g_object_get (config,
                param_spec->name, &value,
                NULL);

  g_signal_handlers_block_by_func (menu,
                                   gimp_prop_paint_menu_callback,
                                   config);

  gimp_int_combo_box_set_active (GIMP_INT_COMBO_BOX (menu), value);

  g_signal_handlers_unblock_by_func (menu,
                                     gimp_prop_paint_menu_callback,
                                     config);

}


/******************/
/*  color button  */
/******************/

static void   gimp_prop_color_button_callback (GtkWidget  *widget,
                                               GObject    *config);
static void   gimp_prop_color_button_notify   (GObject    *config,
                                               GParamSpec *param_spec,
                                               GtkWidget  *button);

/**
 * gimp_prop_color_button_new:
 * @config:        #GimpConfig object to which property is attached.
 * @property_name: Name of #GimpRGB property.
 * @title:         Title of the #GimpColorPanel that is to be created
 * @width:         Width of color button.
 * @height:        Height of color button.
 * @type:          How transparency is represented.
 *
 * Creates a #GimpColorPanel to set and display the value of a #GimpRGB
 * property.  Pressing the button brings up a color selector dialog.
 *
 * Return value:  A new #GimpColorPanel widget.
 *
 * Since GIMP 2.4
 */
GtkWidget *
gimp_prop_color_button_new (GObject           *config,
                            const gchar       *property_name,
                            const gchar       *title,
                            gint               width,
                            gint               height,
                            GimpColorAreaType  type)
{
  GParamSpec *param_spec;
  GtkWidget  *button;
  GimpRGB    *value;

  param_spec = check_param_spec (config, property_name,
                                 GIMP_TYPE_PARAM_RGB, G_STRFUNC);
  if (! param_spec)
    return NULL;

  g_object_get (config,
                property_name, &value,
                NULL);

  button = gimp_color_panel_new (title, value, type, width, height);

  g_free (value);

  set_param_spec (G_OBJECT (button), button, param_spec);

  g_signal_connect (button, "color-changed",
                    G_CALLBACK (gimp_prop_color_button_callback),
                    config);

  connect_notify (config, property_name,
                  G_CALLBACK (gimp_prop_color_button_notify),
                  button);

  return button;
}

static void
gimp_prop_color_button_callback (GtkWidget *button,
                                 GObject   *config)
{
  GParamSpec *param_spec;
  GimpRGB     value;

  param_spec = get_param_spec (G_OBJECT (button));
  if (! param_spec)
    return;

  gimp_color_button_get_color (GIMP_COLOR_BUTTON (button), &value);

  g_signal_handlers_block_by_func (config,
                                   gimp_prop_color_button_notify,
                                   button);

  g_object_set (config,
                param_spec->name, &value,
                NULL);

  g_signal_handlers_unblock_by_func (config,
                                     gimp_prop_color_button_notify,
                                     button);
}

static void
gimp_prop_color_button_notify (GObject    *config,
                               GParamSpec *param_spec,
                               GtkWidget  *button)
{
  GimpRGB *value;

  g_object_get (config,
                param_spec->name, &value,
                NULL);

  g_signal_handlers_block_by_func (button,
                                   gimp_prop_color_button_callback,
                                   config);

  gimp_color_button_set_color (GIMP_COLOR_BUTTON (button), value);

  g_free (value);

  g_signal_handlers_unblock_by_func (button,
                                     gimp_prop_color_button_callback,
                                     config);
}


/*************/
/*  view  */
/*************/

static void   gimp_prop_view_drop   (GtkWidget    *menu,
                                     gint          x,
                                     gint          y,
                                     GimpViewable *viewable,
                                     gpointer      data);
static void   gimp_prop_view_notify (GObject      *config,
                                     GParamSpec   *param_spec,
                                     GtkWidget    *view);

/**
 * gimp_prop_view_new:
 * @config:        #GimpConfig object to which property is attached.
 * @context:       a #Gimpcontext.
 * @property_name: Name of #GimpViewable property.
 * @size:          Width and height of preview display.
 *
 * Creates a widget to display the value of a #GimpViewable property.
 *
 * Return value:  A new #GimpView widget.
 *
 * Since GIMP 2.4
 */
GtkWidget *
gimp_prop_view_new (GObject     *config,
                    const gchar *property_name,
                    GimpContext *context,
                    gint         size)
{
  GParamSpec   *param_spec;
  GtkWidget    *view;
  GimpViewable *viewable;

  param_spec = check_param_spec (config, property_name,
                                 G_TYPE_PARAM_OBJECT, G_STRFUNC);
  if (! param_spec)
    return NULL;

  if (! g_type_is_a (param_spec->value_type, GIMP_TYPE_VIEWABLE))
    {
      g_warning ("%s: property '%s' of %s is not a GimpViewable",
                 G_STRFUNC, property_name,
                 g_type_name (G_TYPE_FROM_INSTANCE (config)));
      return NULL;
    }

  view = gimp_view_new_by_types (context,
                                 GIMP_TYPE_VIEW,
                                 param_spec->value_type,
                                 size, 0, FALSE);

  if (! view)
    {
      g_warning ("%s: cannot create view for type '%s'",
                 G_STRFUNC, g_type_name (param_spec->value_type));
      return NULL;
    }

  g_object_get (config,
                property_name, &viewable,
                NULL);

  if (viewable)
    {
      gimp_view_set_viewable (GIMP_VIEW (view), viewable);
      g_object_unref (viewable);
    }

  set_param_spec (G_OBJECT (view), view, param_spec);

  gimp_dnd_viewable_dest_add (view, param_spec->value_type,
                              gimp_prop_view_drop,
                              config);

  connect_notify (config, property_name,
                  G_CALLBACK (gimp_prop_view_notify),
                  view);

  return view;
}

static void
gimp_prop_view_drop (GtkWidget    *view,
                     gint          x,
                     gint          y,
                     GimpViewable *viewable,
                     gpointer      data)
{
  GObject    *config;
  GParamSpec *param_spec;

  param_spec = get_param_spec (G_OBJECT (view));
  if (! param_spec)
    return;

  config = G_OBJECT (data);

  g_object_set (config,
                param_spec->name, viewable,
                NULL);
}

static void
gimp_prop_view_notify (GObject      *config,
                       GParamSpec   *param_spec,
                       GtkWidget    *view)
{
  GimpViewable *viewable;

  g_object_get (config,
                param_spec->name, &viewable,
                NULL);

  gimp_view_set_viewable (GIMP_VIEW (view), viewable);

  if (viewable)
    g_object_unref (viewable);
}


/*******************************/
/*  private utility functions  */
/*******************************/

static GQuark param_spec_quark = 0;

static void
set_param_spec (GObject     *object,
                GtkWidget   *widget,
                GParamSpec  *param_spec)
{
  if (object)
    {
      if (! param_spec_quark)
        param_spec_quark = g_quark_from_static_string ("gimp-config-param-spec");

      g_object_set_qdata (object, param_spec_quark, param_spec);
    }

  if (widget)
    {
      const gchar *blurb = g_param_spec_get_blurb (param_spec);

      if (blurb)
        gimp_help_set_help_data (widget, gettext (blurb), NULL);
    }
}

static GParamSpec *
get_param_spec (GObject *object)
{
  if (! param_spec_quark)
    param_spec_quark = g_quark_from_static_string ("gimp-config-param-spec");

  return g_object_get_qdata (object, param_spec_quark);
}

static GParamSpec *
find_param_spec (GObject     *object,
                 const gchar *property_name,
                 const gchar *strloc)
{
  GParamSpec *param_spec;

  param_spec = g_object_class_find_property (G_OBJECT_GET_CLASS (object),
                                             property_name);

  if (! param_spec)
    g_warning ("%s: %s has no property named '%s'",
               strloc,
               g_type_name (G_TYPE_FROM_INSTANCE (object)),
               property_name);

  return param_spec;
}

static GParamSpec *
check_param_spec (GObject     *object,
                  const gchar *property_name,
                  GType        type,
                  const gchar *strloc)
{
  GParamSpec *param_spec;

  param_spec = find_param_spec (object, property_name, strloc);

  if (param_spec && ! g_type_is_a (G_TYPE_FROM_INSTANCE (param_spec), type))
    {
      g_warning ("%s: property '%s' of %s is not a %s",
                 strloc,
                 param_spec->name,
                 g_type_name (param_spec->owner_type),
                 g_type_name (type));
      return NULL;
    }

  return param_spec;
}

static void
connect_notify (GObject     *config,
                const gchar *property_name,
                GCallback    callback,
                gpointer     callback_data)
{
  gchar *notify_name;

  notify_name = g_strconcat ("notify::", property_name, NULL);

  g_signal_connect_object (config, notify_name, callback, callback_data, 0);

  g_free (notify_name);
}


typedef struct
{
  GObject     *config;
  const gchar *numerator_property;
  const gchar *denominator_property;
  const gchar *fixed_aspect_property;
  const gchar *width_property;
  const gchar *height_property;
} AspectData;

static void gimp_prop_numeric_entry_notify        (GObject       *config,
                                                   GParamSpec    *param_spec,
                                                   GtkEntry      *entry);

static void gimp_prop_numeric_entry_callback      (GtkWidget     *widget,
                                                   GObject       *config);

static gboolean gimp_prop_numeric_entry_focus_out (GtkWidget     *widget,
                                                   GdkEventFocus *event,
                                                   GObject       *config);
static void gimp_prop_aspect_ratio_flip           (GtkWidget     *widget,
                                                   gpointer       data);

/**
 * gimp_prop_aspect_ratio_new:
 * @config:               Object to which property is attached.
 * @numerator_property:   Name of double property controlled by the first entry.
 * @denominator_property: Name of double property controlled by the second entry.
 * @digits:               Number of digits after decimal point to display.
 *
 * Creates a pair of entries separated by a ":" label.  Intended to provide
 * a gui for setting an aspect ratio.
 *
 * Return value: A new #HBox, containing the entries and label.
 *
 * Since GIMP 2.4
 */
void
gimp_prop_aspect_ratio_new (GObject     *config,
                            const gchar *numerator_property,
                            const gchar *denominator_property,
                            const char  *fixed_aspect_property,
                            const gchar *width_property,
                            const gchar *height_property,
                            gint         digits,
                            GtkTable    *table,
                            gint         row0,
                            gint         col0)
{
  AspectData *aspect_data;
  GParamSpec *param_spec;
  GtkWidget  *label;
  GtkWidget  *entry;
  GtkWidget  *button;
  gdouble     numerator;
  gdouble     denominator;
  gchar       num_string[20];

  g_object_get (config,
                numerator_property,   &numerator,
                denominator_property, &denominator,
                NULL);

  aspect_data = g_new0 (AspectData, 1);
  aspect_data->config = config;
  aspect_data->numerator_property    = numerator_property;
  aspect_data->denominator_property  = denominator_property;
  aspect_data->fixed_aspect_property = fixed_aspect_property;
  aspect_data->width_property        = width_property;
  aspect_data->height_property       = height_property;

  /* numerator entry */
  param_spec = find_param_spec (config, numerator_property, G_STRFUNC);
  if (! param_spec)
    return;
  entry = gtk_entry_new ();
  gtk_entry_set_width_chars (GTK_ENTRY (entry), 5);
  sprintf (num_string, "%lg", numerator);
  gtk_entry_set_text (GTK_ENTRY (entry), num_string);
  gtk_table_attach_defaults (GTK_TABLE (table), entry,
                             col0, col0 + 1, row0, row0 + 1);
  set_param_spec (G_OBJECT (entry), entry, param_spec);
  g_signal_connect (entry, "activate",
                    G_CALLBACK (gimp_prop_numeric_entry_callback),
                    config);
  g_signal_connect (entry, "focus-out-event",
                    G_CALLBACK (gimp_prop_numeric_entry_focus_out),
                    config);
  connect_notify (config, numerator_property,
                  G_CALLBACK (gimp_prop_numeric_entry_notify),
                  entry);
  gtk_widget_show (entry);

  /* ":" label */
  label = gtk_label_new (":");
  gtk_table_attach_defaults (GTK_TABLE (table), label,
                             col0 + 1, col0 + 2, row0, row0 + 1);
  gtk_widget_show (label);

  /* denominator entry */
  param_spec = find_param_spec (config, denominator_property, G_STRFUNC);
  if (! param_spec)
    return;
  entry = gtk_entry_new ();
  gtk_entry_set_width_chars (GTK_ENTRY (entry), 5);
  sprintf (num_string, "%lg", denominator);
  gtk_entry_set_text (GTK_ENTRY (entry), num_string);
  gtk_table_attach_defaults (GTK_TABLE (table), entry,
                             col0 + 2, col0 + 3, row0, row0 + 1);
  set_param_spec (G_OBJECT (entry), entry, param_spec);
  g_signal_connect (entry, "activate",
                    G_CALLBACK (gimp_prop_numeric_entry_callback),
                    config);
  g_signal_connect (entry, "focus-out-event",
                    G_CALLBACK (gimp_prop_numeric_entry_focus_out),
                    config);
  connect_notify (config, denominator_property,
                  G_CALLBACK (gimp_prop_numeric_entry_notify),
                  entry);
  gtk_widget_show (entry);

  /* flip button */
  button = gtk_button_new_from_stock (GIMP_STOCK_FLIP_HORIZONTAL);
  gtk_button_set_use_stock (GTK_BUTTON (button), TRUE);
  gtk_table_attach_defaults (GTK_TABLE (table), button,
                             col0, col0 + 3, row0 + 1, row0 + 2);
  g_signal_connect (button, "pressed",
                    G_CALLBACK (gimp_prop_aspect_ratio_flip),
                    aspect_data);
  gtk_widget_show (button);
}

static void
gimp_prop_numeric_entry_notify (GObject       *config,
                                GParamSpec    *param_spec,
                                GtkEntry      *entry)
{
  gdouble value;
  gchar   text[20];

  g_object_get (config, param_spec->name, &value, NULL);

  sprintf (text, "%3lg", value);

  gtk_entry_set_text (entry, text);
}

static gboolean
gimp_prop_numeric_entry_focus_out (GtkWidget     *widget,
                                   GdkEventFocus *event,
                                   GObject       *config)
{
  gimp_prop_numeric_entry_callback (widget, config);

  return FALSE;
}

static void
gimp_prop_numeric_entry_callback (GtkWidget *widget,
                                  GObject   *config)
{
  GParamSpec  *param_spec;
  gdouble      value;

  g_return_if_fail (GTK_IS_ENTRY (widget));

  param_spec = get_param_spec (G_OBJECT (widget));
  if (! param_spec)
    return;

  /* we use strtod instead of g_ascii_strtod because it uses the locale,
     which is what we want here */
  value = strtod (gtk_entry_get_text (GTK_ENTRY (widget)), NULL);

  if (value != 0)
    g_object_set (config,
                  param_spec->name, value,
                  NULL);
  else
    g_message ("Invalid value entered for aspect ratio.");
}

static void
gimp_prop_aspect_ratio_flip (GtkWidget *widget,
                             gpointer   data)
{
  AspectData *aspect_data  = data;
  gdouble     numerator;
  gdouble     denominator;
  gdouble     height;
  gdouble     width;
  gboolean    fixed_aspect = FALSE;

  if (aspect_data->fixed_aspect_property)
    {
      g_object_get (aspect_data->config,
                    aspect_data->fixed_aspect_property, &fixed_aspect,
                    NULL);
    }

  g_object_get (aspect_data->config,
                aspect_data->numerator_property,   &numerator,
                aspect_data->denominator_property, &denominator,
                NULL);

  if (fixed_aspect)
    {
      if (aspect_data->width_property && aspect_data->height_property)
        {
          g_object_get (aspect_data->config,
                        aspect_data->width_property,  &width,
                        aspect_data->height_property, &height,
                        NULL);
        }
    }

  g_object_set (aspect_data->config,
                aspect_data->numerator_property,   denominator,
                aspect_data->denominator_property, numerator,
                NULL);

  if (fixed_aspect)
    {
      if (aspect_data->width_property && aspect_data->height_property)
        {
          g_object_set (aspect_data->config,
                        aspect_data->width_property,  height,
                        aspect_data->height_property, width,
                        NULL);
        }
    }
}