gimp/app/tools/gimptoolcontrol.c
Michael Natterer 4b582b481a Replaced the concept of having a boolean indicating if an undo step
2004-07-29  Michael Natterer  <mitch@gimp.org>

	Replaced the concept of having a boolean indicating if an undo
	step dirties the image by a bitfield indicating which parts
	of the image are dirtied:

	* app/core/core-enums.[ch]: reordered two values in enum
	GimpUndoType, added GIMP_DIRTY_IMAGE_SIZE to enum GimpDirtyMask.

	The values of GimpDirtyMask are still questionable and will
	probably change...

	* app/core/gimpimage.[ch]: removed signal "undo_start" and added
	a GimpDirtyMask parameter to the "dirty" and "clean" signals.

	* app/core/gimpimage-undo.[ch] (gimp_image_undo_push): replaced
	"gboolean dirties_image" by "GimpDirtyMask dirty_mask" and pass
	it to gimp_image_dirty().

	(gimp_image_undo_group_start): added *ugly* code which tries to
	figure GimpDirtyMask from the group's GimpUndoType and store it in
	the GimpUndoGroup. Call gimp_image_dirty() instead of the removed
	gimp_image_undo_start(). This means the undo group now dirties the
	image just like one of its undo steps, but that's no problem since
	undoing cleans it in the same way.

	* app/core/gimpundo.[ch]: s/dirties_image/dirty_mask/g

	(gimp_undo_pop): emit clean/dirty signals *before* performing the
	actual undo step so listeners can detach from the image before it
	is changed by undo.

	* app/core/gimpimage-undo-push.c (gimp_image_undo_push_*): pass a
	GimpDirtyMask instead of TRUE/FALSE to gimp_image_undo_push().

	* app/core/gimpimagemap.[ch]: removed "gboolean interactive"
	because it makes no sense to use GimpImageMap noninteractively.
	Don't freeze()/thaw() undo while the image_map is active which
	fixes many ways of trashing the image's undo state but probably
	introduces new ways of doing evil things.

	* app/display/gimpdisplay-foreach.c
	* app/display/gimpdisplayshell-handlers.c: changed according
	to the GimpImage::clean()/dirty() signal changes. Small fixes
	in the quit dialog's dirty image container.

	* app/tools/gimptoolcontrol.[ch]: added member and API to
	set/get the dirty_mask.

	* app/tools/gimpcroptool.c
	* app/tools/gimpimagemaptool.c
	* app/tools/gimpiscissorstool.c
	* app/tools/gimptexttool.c
	* app/tools/gimptransformtool.c: whenever setting "preserve" to
	FALSE, also set a "dirty_mask" which specifies on which image
	changes the tool wants to be canceled.

	* app/tools/tool_manager.c: removed "undo_start" connection and
	connect to both "dirty" *and* "clean" to check if the active_tool
	needs to be canceled. Cancel the tool only if the dirty_mask
	passed in the signal has common bits with the tool's dirty_mask.

	Fixes bug #109561 and probably opens some new ones...
2004-07-29 14:16:21 +00:00

403 lines
10 KiB
C

/* The GIMP -- an image manipulation program
* Copyright (C) 1995-2002 Spencer Kimball, Peter Mattis and others
*
* 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 <gtk/gtk.h>
#include "tools-types.h"
#include "gimptoolcontrol.h"
static void gimp_tool_control_class_init (GimpToolControlClass *klass);
static void gimp_tool_control_init (GimpToolControl *tool);
static GimpObjectClass *parent_class = NULL;
GType
gimp_tool_control_get_type (void)
{
static GType tool_control_type = 0;
if (! tool_control_type)
{
static const GTypeInfo tool_control_info =
{
sizeof (GimpToolControlClass),
(GBaseInitFunc) NULL,
(GBaseFinalizeFunc) NULL,
(GClassInitFunc) gimp_tool_control_class_init,
NULL, /* class_finalize */
NULL, /* class_data */
sizeof (GimpToolControl),
0, /* n_preallocs */
(GInstanceInitFunc) gimp_tool_control_init,
};
tool_control_type = g_type_register_static (GIMP_TYPE_OBJECT,
"GimpToolControl",
&tool_control_info, 0);
}
return tool_control_type;
}
static void
gimp_tool_control_class_init (GimpToolControlClass *klass)
{
parent_class = g_type_class_peek_parent (klass);
}
static void
gimp_tool_control_init (GimpToolControl *control)
{
control->active = FALSE;
control->paused_count = 0;
control->toggled = FALSE;
control->scroll_lock = FALSE;
control->auto_snap_to = TRUE;
control->snap_offset_x = 0;
control->snap_offset_y = 0;
control->snap_width = 0;
control->snap_height = 0;
control->preserve = TRUE;
control->dirty_mask = GIMP_DIRTY_NONE;
control->handle_empty_image = FALSE;
control->motion_mode = GIMP_MOTION_MODE_HINT;
control->cursor = GIMP_CURSOR_MOUSE;
control->tool_cursor = GIMP_TOOL_CURSOR_NONE;
control->cursor_modifier = GIMP_CURSOR_MODIFIER_NONE;
control->toggle_cursor = GIMP_CURSOR_MOUSE;
control->toggle_tool_cursor = GIMP_TOOL_CURSOR_NONE;
control->toggle_cursor_modifier = GIMP_CURSOR_MODIFIER_NONE;
}
void
gimp_tool_control_pause (GimpToolControl *control)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
control->paused_count++;
}
void
gimp_tool_control_resume (GimpToolControl *control)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
control->paused_count--;
}
gboolean
gimp_tool_control_is_paused (GimpToolControl *control)
{
g_return_val_if_fail (GIMP_IS_TOOL_CONTROL (control), FALSE);
return control->paused_count > 0;
}
void
gimp_tool_control_activate (GimpToolControl *control)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
#ifdef GIMP_UNSTABLE
g_return_if_fail (control->active == FALSE);
#endif
control->active = TRUE;
}
void
gimp_tool_control_halt (GimpToolControl *control)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
#ifdef GIMP_UNSTABLE
g_return_if_fail (control->active == TRUE);
#endif
control->active = FALSE;
}
gboolean
gimp_tool_control_is_active (GimpToolControl *control)
{
g_return_val_if_fail (GIMP_IS_TOOL_CONTROL (control), FALSE);
return control->active;
}
void
gimp_tool_control_set_toggle (GimpToolControl *control,
gboolean toggled)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
control->toggled = toggled ? TRUE : FALSE;
}
void
gimp_tool_control_set_handles_empty_image (GimpToolControl *control,
gboolean handle_empty)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
control->handle_empty_image = handle_empty ? TRUE : FALSE;
}
void
gimp_tool_control_set_snap_to (GimpToolControl *control,
gboolean snap_to)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
control->auto_snap_to = snap_to ? TRUE : FALSE;
}
void
gimp_tool_control_set_snap_offsets (GimpToolControl *control,
gint offset_x,
gint offset_y,
gint width,
gint height)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
control->snap_offset_x = offset_x;
control->snap_offset_y = offset_y;
control->snap_width = width;
control->snap_height = height;
}
void
gimp_tool_control_set_motion_mode (GimpToolControl *control,
GimpMotionMode motion_mode)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
control->motion_mode = motion_mode;
}
void
gimp_tool_control_set_preserve (GimpToolControl *control,
gboolean preserve)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
control->preserve = preserve ? TRUE : FALSE;
}
void
gimp_tool_control_set_dirty_mask (GimpToolControl *control,
GimpDirtyMask dirty_mask)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
control->dirty_mask = dirty_mask;
}
void
gimp_tool_control_set_cursor (GimpToolControl *control,
GimpCursorType cursor)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
control->cursor = cursor;
}
void
gimp_tool_control_set_tool_cursor (GimpToolControl *control,
GimpToolCursorType cursor)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
control->tool_cursor = cursor;
}
void
gimp_tool_control_set_cursor_modifier (GimpToolControl *control,
GimpCursorModifier cmodifier)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
control->cursor_modifier = cmodifier;
}
void
gimp_tool_control_set_toggle_cursor (GimpToolControl *control,
GimpCursorType cursor)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
control->toggle_cursor = cursor;
}
void
gimp_tool_control_set_toggle_tool_cursor (GimpToolControl *control,
GimpToolCursorType cursor)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
control->toggle_tool_cursor = cursor;
}
void
gimp_tool_control_set_toggle_cursor_modifier (GimpToolControl *control,
GimpCursorModifier cmodifier)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
control->toggle_cursor_modifier = cmodifier;
}
void
gimp_tool_control_set_scroll_lock (GimpToolControl *control,
gboolean scroll_lock)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
control->scroll_lock = scroll_lock ? TRUE : FALSE;
}
GimpMotionMode
gimp_tool_control_motion_mode (GimpToolControl *control)
{
g_return_val_if_fail (GIMP_IS_TOOL_CONTROL (control), GIMP_MOTION_MODE_HINT);
return control->motion_mode;
}
gboolean
gimp_tool_control_handles_empty_image (GimpToolControl *control)
{
g_return_val_if_fail (GIMP_IS_TOOL_CONTROL (control), FALSE);
return control->handle_empty_image;
}
gboolean
gimp_tool_control_auto_snap_to (GimpToolControl *control)
{
g_return_val_if_fail (GIMP_IS_TOOL_CONTROL (control), FALSE);
return control->auto_snap_to;
}
void
gimp_tool_control_snap_offsets (GimpToolControl *control,
gint *offset_x,
gint *offset_y,
gint *width,
gint *height)
{
g_return_if_fail (GIMP_IS_TOOL_CONTROL (control));
if (offset_x) *offset_x = control->snap_offset_x;
if (offset_y) *offset_y = control->snap_offset_y;
if (width) *width = control->snap_width;
if (height) *height = control->snap_height;
}
gboolean
gimp_tool_control_preserve (GimpToolControl *control)
{
g_return_val_if_fail (GIMP_IS_TOOL_CONTROL (control), FALSE);
return control->preserve;
}
GimpDirtyMask
gimp_tool_control_dirty_mask (GimpToolControl *control)
{
g_return_val_if_fail (GIMP_IS_TOOL_CONTROL (control), GIMP_DIRTY_NONE);
return control->dirty_mask;
}
gboolean
gimp_tool_control_scroll_lock (GimpToolControl *control)
{
g_return_val_if_fail (GIMP_IS_TOOL_CONTROL (control), FALSE);
return control->scroll_lock;
}
gboolean
gimp_tool_control_is_toggled (GimpToolControl *control)
{
g_return_val_if_fail (GIMP_IS_TOOL_CONTROL (control), FALSE);
return control->toggled;
}
GimpCursorType
gimp_tool_control_get_cursor (GimpToolControl *control)
{
g_return_val_if_fail (GIMP_IS_TOOL_CONTROL (control), FALSE);
return control->cursor;
}
GimpCursorType
gimp_tool_control_get_toggle_cursor (GimpToolControl *control)
{
g_return_val_if_fail (GIMP_IS_TOOL_CONTROL (control), FALSE);
return control->toggle_cursor;
}
GimpToolCursorType
gimp_tool_control_get_tool_cursor (GimpToolControl *control)
{
g_return_val_if_fail (GIMP_IS_TOOL_CONTROL (control), FALSE);
return control->tool_cursor;
}
GimpToolCursorType
gimp_tool_control_get_toggle_tool_cursor (GimpToolControl *control)
{
g_return_val_if_fail (GIMP_IS_TOOL_CONTROL (control), FALSE);
return control->toggle_tool_cursor;
}
GimpCursorModifier
gimp_tool_control_get_cursor_modifier (GimpToolControl *control)
{
g_return_val_if_fail (GIMP_IS_TOOL_CONTROL (control), FALSE);
return control->cursor_modifier;
}
GimpCursorModifier
gimp_tool_control_get_toggle_cursor_modifier (GimpToolControl *control)
{
g_return_val_if_fail (GIMP_IS_TOOL_CONTROL (control), FALSE);
return control->toggle_cursor_modifier;
}