gimp/app/core/gimpguide.c

407 lines
13 KiB
C

/* GIMP - The GNU Image Manipulation Program
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* GimpGuide
* Copyright (C) 2003 Henrik Brix Andersen <brix@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 3 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, see <http://www.gnu.org/licenses/>.
*/
#include "config.h"
#include <cairo.h>
#include <gegl.h>
#include <gdk-pixbuf/gdk-pixbuf.h>
#include <gio/gio.h>
#include "libgimpbase/gimpbase.h"
#include "libgimpcolor/gimpcolor.h"
#include "libgimpconfig/gimpconfig.h"
#include "core-types.h"
#include "gimpguide.h"
#include "gimpmarshal.h"
enum
{
REMOVED,
LAST_SIGNAL
};
enum
{
PROP_0,
PROP_ID,
PROP_ORIENTATION,
PROP_POSITION,
PROP_NORMAL_FOREGROUND,
PROP_NORMAL_BACKGROUND,
PROP_ACTIVE_FOREGROUND,
PROP_ACTIVE_BACKGROUND,
PROP_LINE_WIDTH
};
struct _GimpGuidePrivate
{
guint32 guide_ID;
GimpOrientationType orientation;
gint position;
GimpRGB normal_foreground;
GimpRGB normal_background;
GimpRGB active_foreground;
GimpRGB active_background;
gdouble line_width;
gboolean custom;
};
static void gimp_guide_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec);
static void gimp_guide_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec);
G_DEFINE_TYPE (GimpGuide, gimp_guide, G_TYPE_OBJECT)
static guint gimp_guide_signals[LAST_SIGNAL] = { 0 };
static void
gimp_guide_class_init (GimpGuideClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
gimp_guide_signals[REMOVED] =
g_signal_new ("removed",
G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET (GimpGuideClass, removed),
NULL, NULL,
gimp_marshal_VOID__VOID,
G_TYPE_NONE, 0);
object_class->get_property = gimp_guide_get_property;
object_class->set_property = gimp_guide_set_property;
klass->removed = NULL;
g_object_class_install_property (object_class, PROP_ID,
g_param_spec_uint ("id", NULL, NULL,
0, G_MAXUINT32, 0,
G_PARAM_CONSTRUCT_ONLY |
GIMP_PARAM_READWRITE));
GIMP_CONFIG_INSTALL_PROP_ENUM (object_class, PROP_ORIENTATION,
"orientation", NULL,
GIMP_TYPE_ORIENTATION_TYPE,
GIMP_ORIENTATION_UNKNOWN,
0);
GIMP_CONFIG_INSTALL_PROP_INT (object_class, PROP_POSITION,
"position", NULL,
GIMP_GUIDE_POSITION_UNDEFINED,
GIMP_MAX_IMAGE_SIZE,
GIMP_GUIDE_POSITION_UNDEFINED,
0);
g_object_class_install_property (object_class, PROP_NORMAL_FOREGROUND,
g_param_spec_boxed ("normal-foreground", NULL, NULL,
GIMP_TYPE_RGB,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
g_object_class_install_property (object_class, PROP_NORMAL_BACKGROUND,
g_param_spec_boxed ("normal-background", NULL, NULL,
GIMP_TYPE_RGB,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
g_object_class_install_property (object_class, PROP_ACTIVE_FOREGROUND,
g_param_spec_boxed ("active-foreground", NULL, NULL,
GIMP_TYPE_RGB,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
g_object_class_install_property (object_class, PROP_ACTIVE_BACKGROUND,
g_param_spec_boxed ("active-background", NULL, NULL,
GIMP_TYPE_RGB,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
g_object_class_install_property (object_class, PROP_LINE_WIDTH,
g_param_spec_double ("line-width", NULL, NULL,
0, GIMP_MAX_IMAGE_SIZE,
1.0,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
g_type_class_add_private (klass, sizeof (GimpGuidePrivate));
}
static void
gimp_guide_init (GimpGuide *guide)
{
guide->priv = G_TYPE_INSTANCE_GET_PRIVATE (guide, GIMP_TYPE_GUIDE,
GimpGuidePrivate);
}
static void
gimp_guide_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec)
{
GimpGuide *guide = GIMP_GUIDE (object);
switch (property_id)
{
case PROP_ID:
g_value_set_uint (value, guide->priv->guide_ID);
break;
case PROP_ORIENTATION:
g_value_set_enum (value, guide->priv->orientation);
break;
case PROP_POSITION:
g_value_set_int (value, guide->priv->position);
break;
case PROP_NORMAL_FOREGROUND:
g_value_set_boxed (value, &guide->priv->normal_foreground);
break;
case PROP_NORMAL_BACKGROUND:
g_value_set_boxed (value, &guide->priv->normal_background);
break;
case PROP_ACTIVE_FOREGROUND:
g_value_set_boxed (value, &guide->priv->active_foreground);
break;
case PROP_ACTIVE_BACKGROUND:
g_value_set_boxed (value, &guide->priv->active_background);
break;
case PROP_LINE_WIDTH:
g_value_set_double (value, guide->priv->line_width);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
}
static void
gimp_guide_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec)
{
GimpGuide *guide = GIMP_GUIDE (object);
switch (property_id)
{
case PROP_ID:
guide->priv->guide_ID = g_value_get_uint (value);
break;
case PROP_ORIENTATION:
guide->priv->orientation = g_value_get_enum (value);
break;
case PROP_POSITION:
guide->priv->position = g_value_get_int (value);
break;
case PROP_NORMAL_FOREGROUND:
{
GimpRGB *color = g_value_get_boxed (value);
guide->priv->normal_foreground = *color;
}
break;
case PROP_NORMAL_BACKGROUND:
{
GimpRGB *color = g_value_get_boxed (value);
guide->priv->normal_background = *color;
}
break;
case PROP_ACTIVE_FOREGROUND:
{
GimpRGB *color = g_value_get_boxed (value);
guide->priv->active_foreground = *color;
}
break;
case PROP_ACTIVE_BACKGROUND:
{
GimpRGB *color = g_value_get_boxed (value);
guide->priv->active_background = *color;
}
break;
case PROP_LINE_WIDTH:
guide->priv->line_width = g_value_get_double (value);
if (guide->priv->line_width != 1.0)
guide->priv->custom = TRUE;
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
}
GimpGuide *
gimp_guide_new (GimpOrientationType orientation,
guint32 guide_ID)
{
const GimpRGB normal_fg = { 0.0, 0.0, 0.0, 1.0 };
const GimpRGB normal_bg = { 0.0, 0.5, 1.0, 1.0 };
const GimpRGB active_fg = { 0.0, 0.0, 0.0, 1.0 };
const GimpRGB active_bg = { 1.0, 0.0, 0.0, 1.0 };
return g_object_new (GIMP_TYPE_GUIDE,
"id", guide_ID,
"orientation", orientation,
"normal-foreground", &normal_fg,
"normal-background", &normal_bg,
"active-foreground", &active_fg,
"active-background", &active_bg,
"line-width", 1.0,
NULL);
}
/**
* gimp_guide_custom_new:
* @orientation: the #GimpOrientationType
* @guide_ID: the unique guide ID
* @normal_foreground: foreground color for normal state
* @normal_background: background color for normal state
* @active_foreground: foreground color for active state
* @active_background: background color for active state
* @line_width: the width of the guide line
*
* This function returns a new guide and will flag it as "custom".
* Custom guides are used for purpose "other" than the basic guides
* a user can create oneself, for instance as symmetry guides, to
* drive GEGL ops, etc.
* They are not saved in the XCF file. If an op, a symmetry or a plugin
* wishes to save its state, it has to do it internally.
*
* Returns: the custom #GimpGuide.
**/
GimpGuide *
gimp_guide_custom_new (GimpOrientationType orientation,
guint32 guide_ID,
GimpRGB *normal_foreground,
GimpRGB *normal_background,
GimpRGB *active_foreground,
GimpRGB *active_background,
gdouble line_width)
{
GimpGuide *guide;
guide = g_object_new (GIMP_TYPE_GUIDE,
"id", guide_ID,
"orientation", orientation,
"normal-foreground", normal_foreground,
"normal-background", normal_background,
"active-foreground", active_foreground,
"active-background", active_background,
"line-width", line_width,
NULL);
guide->priv->custom = TRUE;
return guide;
}
guint32
gimp_guide_get_ID (GimpGuide *guide)
{
g_return_val_if_fail (GIMP_IS_GUIDE (guide), 0);
return guide->priv->guide_ID;
}
GimpOrientationType
gimp_guide_get_orientation (GimpGuide *guide)
{
g_return_val_if_fail (GIMP_IS_GUIDE (guide), GIMP_ORIENTATION_UNKNOWN);
return guide->priv->orientation;
}
void
gimp_guide_set_orientation (GimpGuide *guide,
GimpOrientationType orientation)
{
g_return_if_fail (GIMP_IS_GUIDE (guide));
guide->priv->orientation = orientation;
g_object_notify (G_OBJECT (guide), "orientation");
}
gint
gimp_guide_get_position (GimpGuide *guide)
{
g_return_val_if_fail (GIMP_IS_GUIDE (guide), GIMP_GUIDE_POSITION_UNDEFINED);
return guide->priv->position;
}
void
gimp_guide_set_position (GimpGuide *guide,
gint position)
{
g_return_if_fail (GIMP_IS_GUIDE (guide));
guide->priv->position = position;
g_object_notify (G_OBJECT (guide), "position");
}
void
gimp_guide_removed (GimpGuide *guide)
{
g_return_if_fail (GIMP_IS_GUIDE (guide));
g_signal_emit (guide, gimp_guide_signals[REMOVED], 0);
}
void
gimp_guide_get_normal_style (GimpGuide *guide,
GimpRGB *foreground,
GimpRGB *background)
{
*foreground = guide->priv->normal_foreground;
*background = guide->priv->normal_background;
}
void
gimp_guide_get_active_style (GimpGuide *guide,
GimpRGB *foreground,
GimpRGB *background)
{
*foreground = guide->priv->active_foreground;
*background = guide->priv->active_background;
}
gdouble
gimp_guide_get_line_width (GimpGuide *guide)
{
return guide->priv->line_width;
}
gboolean
gimp_guide_is_custom (GimpGuide *guide)
{
return guide->priv->custom;
}