gimp/app/undo.h

88 lines
3.7 KiB
C
Raw Normal View History

1997-11-25 06:05:25 +08:00
/* The GIMP -- an image manipulation program
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* 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.
1997-11-25 06:05:25 +08:00
*/
#ifndef __UNDO_H__
#define __UNDO_H__
Honest, guv, it's not a feature - it's a tightly integrated package of Mon Sep 20 12:51:30 EDT 1999 Austin Donnelly <austin@gimp.org> Honest, guv, it's not a feature - it's a tightly integrated package of undo system cleanups and fixes. NEW FILES: * app/undo_history.c: window showing recent undo (and redo) steps available. * app/undo_types.h: broken out of undo.h to fix circular includes. MODIFIED FILES: * app/Makefile.am: compile undo_history.c * app/channel.h: use enum for channel undo type, not just magic numbers. * app/layer.h: same for layer undos. * app/commands.c: edit_show_undo_history_cmd_callback() function to pull up undo history window. * app/commands.h: prototype for above. * app/gdisplay.c: make undo / redo menu items sensitive according to whether they would do anything. Would be easy to change the text to say what would be undone/redone, but I don't know the GTK. * app/gimpimage.c: new signal emitted by gimage: UNDO_EVENT. gimp_image_undo_event() function to emit it. * app/gimpimage.h: prototype for above. * app/gimpimageP.h: pushing_undo_group member is now an undo_type, not an int. Keep undo history widget here too (if created). * app/menus.c: add "Edit/Undo history..." to image menu. * app/undo.c: new types: enums undo_type and undo_state rather than ints and magic numbers. All undo_pop_* and undo_free_* functions made static. New static function undo_type_to_name(). Issue undo event signals on various important events (eg undo pushed, undo popped etc). undo_push() now takes a "dirties_image" arg to say whether image should be dirtied. Layer moves now dirty the image. A couple of g_return_if_fails () on undo_pop and undo_redo to assert we're not in the middle of an undo group. undo_get_{undo,redo}_name() to peek at names of top items on undo and redo stacks resp. undo_map_over_{undo,redo}_stack() to run a function for each item or group on stack. Layer and channel undos use symbolic names rather than 0 or 1. Array mapping undo types to names. * app/undo.h: split out undo types to undo_types.h. Prototypes for functions described above. undo_event_t enum. undo_history_new() prototype lives here too. Random other fixes: * app/gimpdrawable.c * app/image_render.c: default labels in switches to keep egcs happy. * app/nav_window.c: some fixes to (sort of) cope with image res != screen res. Still needs work to handle non-square pixels properly. * app/paths_dialog.c: bad idea to call gimp_image_dirty() directly. Even though it's currently commented out.
1999-09-21 01:15:20 +08:00
#include "undo_types.h"
#include "gimage.h"
1997-11-25 06:05:25 +08:00
/* Undo interface functions */
int undo_push_group_start (GImage *, UndoType);
1997-11-25 06:05:25 +08:00
int undo_push_group_end (GImage *);
int undo_push_image (GImage *, GimpDrawable *, int, int, int, int);
int undo_push_image_mod (GImage *, GimpDrawable *, int, int, int, int, void *, int);
1997-11-25 06:05:25 +08:00
int undo_push_mask (GImage *, void *);
int undo_push_layer_displace (GImage *, GimpLayer*);
1997-11-25 06:05:25 +08:00
int undo_push_transform (GImage *, void *);
int undo_push_paint (GImage *, void *);
comment typo fix, plus add %D* to default image-title-format string, so Fri Oct 1 12:46:12 1999 Austin Donnelly <austin@gimp.org> * gimprc.in: comment typo fix, plus add %D* to default image-title-format string, so people get a '*' in the titlebar if their image is dirty. * app/fileops.c: initialise filename before using it. * app/gdisplay.c: empty parameter list () is K&R - should be stronger (void) in ANSI C. * app/gimpdrawable.c: gimp_drawable_{dirty,clean} functions removed - no one uses them anyway. Parasite undo type is proper parasite undo type, not MISC_UNDO. * app/gimpdrawableP.h: drawable dirty bit removed. * app/gimpimage.c: don't change the resolution if there's no difference from the old one. Call gdisplay_shrink_wrap() to re-calculate scale factors and refresh the display on resolution change. Layer undo doesn't have sub-types anymore, uses main UndoType instead. * app/layer.h: Remove LayerUndoType * app/qmask.c: fix qmask undo so it actually works. * app/undo.h: new types for undo_push_layer{,_mask} and undo_push_qmask. * app/undo.c: change way group boundaries are represented: each Undo has a group_boundary boolean set to TRUE if this is the start or the end of a group, and the type of the Undo is the group's type. Within a group, each Undo keeps its own type. This allows pop funcs and free funcs to do type-specific things (eg needed by layer and channel stuff). Don't maintain per-drawable dirty flags anymore. Floating sel to layer and layer rename now uses meaningful undo types. * app/undo_types.h: more specific undo types: LAYER_{ADD,REMOVE}_UNDO, LAYER_MASK_{ADD,REMOVE}_UNDO, LAYER_RENAME_UNDO, and PARASITE_{ATTACH,DETACH}_UNDO. * app/undo_history.c: oops - undo stack was being placed into gtk list in wrong order. * app/edit_selection.c: push more descriptive LAYER_DISPLACE_UNDO rather than MISC_UNDO. * app/layers_dialog.c: better tagging of undo types
1999-10-02 02:43:24 +08:00
int undo_push_layer (GImage *, UndoType, void *);
1997-11-25 06:05:25 +08:00
int undo_push_layer_mod (GImage *, void *);
comment typo fix, plus add %D* to default image-title-format string, so Fri Oct 1 12:46:12 1999 Austin Donnelly <austin@gimp.org> * gimprc.in: comment typo fix, plus add %D* to default image-title-format string, so people get a '*' in the titlebar if their image is dirty. * app/fileops.c: initialise filename before using it. * app/gdisplay.c: empty parameter list () is K&R - should be stronger (void) in ANSI C. * app/gimpdrawable.c: gimp_drawable_{dirty,clean} functions removed - no one uses them anyway. Parasite undo type is proper parasite undo type, not MISC_UNDO. * app/gimpdrawableP.h: drawable dirty bit removed. * app/gimpimage.c: don't change the resolution if there's no difference from the old one. Call gdisplay_shrink_wrap() to re-calculate scale factors and refresh the display on resolution change. Layer undo doesn't have sub-types anymore, uses main UndoType instead. * app/layer.h: Remove LayerUndoType * app/qmask.c: fix qmask undo so it actually works. * app/undo.h: new types for undo_push_layer{,_mask} and undo_push_qmask. * app/undo.c: change way group boundaries are represented: each Undo has a group_boundary boolean set to TRUE if this is the start or the end of a group, and the type of the Undo is the group's type. Within a group, each Undo keeps its own type. This allows pop funcs and free funcs to do type-specific things (eg needed by layer and channel stuff). Don't maintain per-drawable dirty flags anymore. Floating sel to layer and layer rename now uses meaningful undo types. * app/undo_types.h: more specific undo types: LAYER_{ADD,REMOVE}_UNDO, LAYER_MASK_{ADD,REMOVE}_UNDO, LAYER_RENAME_UNDO, and PARASITE_{ATTACH,DETACH}_UNDO. * app/undo_history.c: oops - undo stack was being placed into gtk list in wrong order. * app/edit_selection.c: push more descriptive LAYER_DISPLACE_UNDO rather than MISC_UNDO. * app/layers_dialog.c: better tagging of undo types
1999-10-02 02:43:24 +08:00
int undo_push_layer_mask (GImage *, UndoType, void *);
int undo_push_layer_change (GImage *, GimpLayer *);
int undo_push_layer_reposition (GImage *, GimpLayer *);
int undo_push_channel (GImage *, UndoType, void *);
1997-11-25 06:05:25 +08:00
int undo_push_channel_mod (GImage *, void *);
int undo_push_fs_to_layer (GImage *, void *);
int undo_push_fs_rigor (GImage *, int);
int undo_push_fs_relax (GImage *, int);
int undo_push_gimage_mod (GImage *);
int undo_push_guide (GImage *, void *);
int undo_push_image_parasite (GImage *, void *);
int undo_push_drawable_parasite (GImage *, GimpDrawable *, void *);
int undo_push_image_parasite_remove (GImage *, const char *);
int undo_push_drawable_parasite_remove (GImage *, GimpDrawable *,
const char *);
comment typo fix, plus add %D* to default image-title-format string, so Fri Oct 1 12:46:12 1999 Austin Donnelly <austin@gimp.org> * gimprc.in: comment typo fix, plus add %D* to default image-title-format string, so people get a '*' in the titlebar if their image is dirty. * app/fileops.c: initialise filename before using it. * app/gdisplay.c: empty parameter list () is K&R - should be stronger (void) in ANSI C. * app/gimpdrawable.c: gimp_drawable_{dirty,clean} functions removed - no one uses them anyway. Parasite undo type is proper parasite undo type, not MISC_UNDO. * app/gimpdrawableP.h: drawable dirty bit removed. * app/gimpimage.c: don't change the resolution if there's no difference from the old one. Call gdisplay_shrink_wrap() to re-calculate scale factors and refresh the display on resolution change. Layer undo doesn't have sub-types anymore, uses main UndoType instead. * app/layer.h: Remove LayerUndoType * app/qmask.c: fix qmask undo so it actually works. * app/undo.h: new types for undo_push_layer{,_mask} and undo_push_qmask. * app/undo.c: change way group boundaries are represented: each Undo has a group_boundary boolean set to TRUE if this is the start or the end of a group, and the type of the Undo is the group's type. Within a group, each Undo keeps its own type. This allows pop funcs and free funcs to do type-specific things (eg needed by layer and channel stuff). Don't maintain per-drawable dirty flags anymore. Floating sel to layer and layer rename now uses meaningful undo types. * app/undo_types.h: more specific undo types: LAYER_{ADD,REMOVE}_UNDO, LAYER_MASK_{ADD,REMOVE}_UNDO, LAYER_RENAME_UNDO, and PARASITE_{ATTACH,DETACH}_UNDO. * app/undo_history.c: oops - undo stack was being placed into gtk list in wrong order. * app/edit_selection.c: push more descriptive LAYER_DISPLACE_UNDO rather than MISC_UNDO. * app/layers_dialog.c: better tagging of undo types
1999-10-02 02:43:24 +08:00
int undo_push_qmask (GImage *);
int undo_push_resolution (GImage *);
int undo_push_layer_rename (GImage *, GimpLayer *);
Dirty flag now correct in all cases. Can be displayed in image window Mon Aug 23 10:15:32 EDT 1999 Austin Donnelly <austin@gimp.org> Dirty flag now correct in all cases. Can be displayed in image window title too. See NOTE near gimp_image_dirty() for details. * app/fileops.c: gimp_image_clean_all() after reverting an image. * app/gdisplay.c: register handlers for gimage dirty and clean signals to update image title. New image-title-format expansion: %Dx expands to x if the image is dirty. * app/gdisplay_ops.c: gimage->dirty flags != 0 is the correct condition to test to see if an image is dirty. * app/gimpdrawable.c: gimp_image_dirty() should never be called except from an undo_push_* function. Call undo_push_cantundo() if you want to dirty the image but can't be bothered writing an undo handler (be ashamed of yourself!). * app/gimpimage.c: new gimage signal: clean. Emitted when an undo operation takes place. Gimage changes when either dirty or clean is emitted, so if you need to update previews etc, look for both! Move group_count into gimage structure, since leaving it as a static in undo.c is bad if two undo groups are started on different images at the same time. More changes of gimp_image_dirty() to undo_push_cantundo() (parasite-related, plus layer moves). See the NOTE on dirty counter near gimp_image_dirty() for the full story. gimp_image_dirty() and gimp_image_clean() simplified - counter can go negative. * app/gimpimageP.h: group_count moved from undo.c * app/layers_dialog.c: push undo for layer name change, rather than dirtying the image. * app/undo.c: layer rename undo functions added. undo_push_cantundo() convenience functions added. group_count made per-gimage since everything else is. When blowing away redo stack, make image infinitely dirty if redo info contained file save point. * app/undo.h: added undo_push_layer_rename() and undo_push_cantundo(). * TODO: added idea for undo history window.
1999-08-23 22:34:58 +08:00
int undo_push_cantundo (GImage *, const char *);
1997-11-25 06:05:25 +08:00
int undo_pop (GImage *);
int undo_redo (GImage *);
void undo_free (GImage *);
Honest, guv, it's not a feature - it's a tightly integrated package of Mon Sep 20 12:51:30 EDT 1999 Austin Donnelly <austin@gimp.org> Honest, guv, it's not a feature - it's a tightly integrated package of undo system cleanups and fixes. NEW FILES: * app/undo_history.c: window showing recent undo (and redo) steps available. * app/undo_types.h: broken out of undo.h to fix circular includes. MODIFIED FILES: * app/Makefile.am: compile undo_history.c * app/channel.h: use enum for channel undo type, not just magic numbers. * app/layer.h: same for layer undos. * app/commands.c: edit_show_undo_history_cmd_callback() function to pull up undo history window. * app/commands.h: prototype for above. * app/gdisplay.c: make undo / redo menu items sensitive according to whether they would do anything. Would be easy to change the text to say what would be undone/redone, but I don't know the GTK. * app/gimpimage.c: new signal emitted by gimage: UNDO_EVENT. gimp_image_undo_event() function to emit it. * app/gimpimage.h: prototype for above. * app/gimpimageP.h: pushing_undo_group member is now an undo_type, not an int. Keep undo history widget here too (if created). * app/menus.c: add "Edit/Undo history..." to image menu. * app/undo.c: new types: enums undo_type and undo_state rather than ints and magic numbers. All undo_pop_* and undo_free_* functions made static. New static function undo_type_to_name(). Issue undo event signals on various important events (eg undo pushed, undo popped etc). undo_push() now takes a "dirties_image" arg to say whether image should be dirtied. Layer moves now dirty the image. A couple of g_return_if_fails () on undo_pop and undo_redo to assert we're not in the middle of an undo group. undo_get_{undo,redo}_name() to peek at names of top items on undo and redo stacks resp. undo_map_over_{undo,redo}_stack() to run a function for each item or group on stack. Layer and channel undos use symbolic names rather than 0 or 1. Array mapping undo types to names. * app/undo.h: split out undo types to undo_types.h. Prototypes for functions described above. undo_event_t enum. undo_history_new() prototype lives here too. Random other fixes: * app/gimpdrawable.c * app/image_render.c: default labels in switches to keep egcs happy. * app/nav_window.c: some fixes to (sort of) cope with image res != screen res. Still needs work to handle non-square pixels properly. * app/paths_dialog.c: bad idea to call gimp_image_dirty() directly. Even though it's currently commented out.
1999-09-21 01:15:20 +08:00
const char *undo_get_undo_name (GImage *);
const char *undo_get_redo_name (GImage *);
/* Stack peeking functions */
typedef int (*undo_map_fn) (const char *undoitemname, void *data);
void undo_map_over_undo_stack (GImage *, undo_map_fn, void *data);
void undo_map_over_redo_stack (GImage *, undo_map_fn, void *data);
/* Not really appropriate here, since undo_history_new is not defined
* in undo.c, but it saves on having a full header file for just one
* function prototype. */
GtkWidget *undo_history_new (GImage *gimage);
/* Argument to undo_event signal emitted by gimages: */
typedef enum {
UNDO_PUSHED, /* a new undo has been added to the undo stack */
UNDO_EXPIRED, /* an undo has been freed from the undo stack */
UNDO_POPPED, /* an undo has been executed and moved to redo stack */
UNDO_REDO, /* a redo has been executed and moved to undo stack */
UNDO_FREE /* all undo and redo info has been cleared */
} undo_event_t;
1997-11-25 06:05:25 +08:00
#endif /* __UNDO_H__ */