gimp/app/tools/gimptoolcontrol.h
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

151 lines
8.3 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.
*/
#ifndef __GIMP_TOOL_CONTROL_H__
#define __GIMP_TOOL_CONTROL_H__
#include "core/gimpobject.h"
#define GIMP_TYPE_TOOL_CONTROL (gimp_tool_control_get_type ())
#define GIMP_TOOL_CONTROL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_TOOL_CONTROL, GimpToolControl))
#define GIMP_TOOL_CONTROL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_TOOL_CONTROL, GimpToolControlClass))
#define GIMP_IS_TOOL_CONTROL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_TOOL_CONTROL))
#define GIMP_IS_TOOL_CONTROL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_TOOL_CONTROL))
#define GIMP_TOOL_CONTROL_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_TOOL_CONTROL, GimpToolControlClass))
typedef struct _GimpToolControlClass GimpToolControlClass;
struct _GimpToolControl
{
GimpObject parent_instance;
gboolean active; /* state of tool activity */
gint paused_count; /* paused control count */
gboolean scroll_lock; /* allow scrolling or not */
gboolean auto_snap_to; /* snap to guides automatically */
gint snap_offset_x;
gint snap_offset_y;
gint snap_width;
gint snap_height;
gboolean preserve; /* Preserve this tool across drawable *
* changes */
GimpDirtyMask dirty_mask; /* if preserve is FALSE, cancel the *
* tool on these events */
gboolean handle_empty_image; /* invoke the tool on images without *
* active drawable */
GimpMotionMode motion_mode; /* how to process motion events before *
* they are forwarded to the tool */
GimpCursorType cursor;
GimpToolCursorType tool_cursor;
GimpCursorModifier cursor_modifier;
GimpCursorType toggle_cursor;
GimpToolCursorType toggle_tool_cursor;
GimpCursorModifier toggle_cursor_modifier;
gboolean toggled;
};
struct _GimpToolControlClass
{
GimpObjectClass parent_class;
};
GType gimp_tool_control_get_type (void) G_GNUC_CONST;
void gimp_tool_control_pause (GimpToolControl *control);
void gimp_tool_control_resume (GimpToolControl *control);
gboolean gimp_tool_control_is_paused (GimpToolControl *control);
void gimp_tool_control_activate (GimpToolControl *control);
void gimp_tool_control_halt (GimpToolControl *control);
gboolean gimp_tool_control_is_active (GimpToolControl *control);
void gimp_tool_control_set_toggle (GimpToolControl *control,
gboolean toggled);
gboolean gimp_tool_control_is_toggled (GimpToolControl *control);
void gimp_tool_control_set_preserve (GimpToolControl *control,
gboolean preserve);
gboolean gimp_tool_control_preserve (GimpToolControl *control);
void gimp_tool_control_set_dirty_mask (GimpToolControl *control,
GimpDirtyMask dirty_mask);
GimpDirtyMask gimp_tool_control_dirty_mask (GimpToolControl *control);
void gimp_tool_control_set_scroll_lock (GimpToolControl *control,
gboolean scroll_lock);
gboolean gimp_tool_control_scroll_lock (GimpToolControl *control);
void gimp_tool_control_set_motion_mode (GimpToolControl *control,
GimpMotionMode motion_mode);
GimpMotionMode gimp_tool_control_motion_mode (GimpToolControl *control);
void gimp_tool_control_set_handles_empty_image (GimpToolControl *control,
gboolean handle_empty);
gboolean gimp_tool_control_handles_empty_image (GimpToolControl *control);
void gimp_tool_control_set_snap_to (GimpToolControl *control,
gboolean snap_to);
gboolean gimp_tool_control_auto_snap_to (GimpToolControl *control);
void gimp_tool_control_set_snap_offsets (GimpToolControl *control,
gint offset_x,
gint offset_y,
gint width,
gint height);
void gimp_tool_control_snap_offsets (GimpToolControl *control,
gint *offset_x,
gint *offset_y,
gint *width,
gint *height);
GimpCursorType gimp_tool_control_get_cursor (GimpToolControl *control);
void gimp_tool_control_set_cursor (GimpToolControl *control,
GimpCursorType cursor);
GimpToolCursorType gimp_tool_control_get_tool_cursor (GimpToolControl *control);
void gimp_tool_control_set_tool_cursor (GimpToolControl *control,
GimpToolCursorType cursor);
GimpCursorModifier gimp_tool_control_get_cursor_modifier (GimpToolControl *control);
void gimp_tool_control_set_cursor_modifier (GimpToolControl *control,
GimpCursorModifier cmodifier);
GimpCursorType gimp_tool_control_get_toggle_cursor (GimpToolControl *control);
void gimp_tool_control_set_toggle_cursor (GimpToolControl *control,
GimpCursorType cursor);
GimpToolCursorType gimp_tool_control_get_toggle_tool_cursor (GimpToolControl *control);
void gimp_tool_control_set_toggle_tool_cursor (GimpToolControl *control,
GimpToolCursorType cursor);
GimpCursorModifier gimp_tool_control_get_toggle_cursor_modifier (GimpToolControl *control);
void gimp_tool_control_set_toggle_cursor_modifier (GimpToolControl *control,
GimpCursorModifier cmodifier);
#endif /* __GIMP_TOOL_CONTROL_H__ */