From e02eaeffcefe6b74574290d65ac7da1ce31c343b Mon Sep 17 00:00:00 2001 From: Sven Neumann Date: Sat, 25 Mar 2000 19:18:07 +0000 Subject: [PATCH] fixed a few PDB help strings and included a missing header file --Sven --- ChangeLog | 8 ++++++ app/dialogs/info-dialog.c | 1 + app/gimage_cmds.c | 50 ++++++++++++++++++------------------- app/gui/info-dialog.c | 1 + app/info_dialog.c | 1 + tools/pdbgen/pdb/gimage.pdb | 30 ++++++++++++++++------ tools/pdbgen/pdb/image.pdb | 30 ++++++++++++++++------ 7 files changed, 82 insertions(+), 39 deletions(-) diff --git a/ChangeLog b/ChangeLog index cc3f625ef6..944813a126 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2000-03-25 Sven Neumann + + * tools/pdbgen/pdb/gimage.pdb + * app/gimage_cmds.c: corrected the description and help for the + gimp_image_component_* functions. + + * app/info_dialog.h: include dialog_handler.h + 2000-03-25 Sven Neumann * app/app_procs.c: use gtk_exit(0) instead of gtk_main_quit() diff --git a/app/dialogs/info-dialog.c b/app/dialogs/info-dialog.c index ba87eb9116..639a0e1bfe 100644 --- a/app/dialogs/info-dialog.c +++ b/app/dialogs/info-dialog.c @@ -19,6 +19,7 @@ #include #include "appenv.h" +#include "dialog_handler.h" #include "gimprc.h" #include "info_dialog.h" #include "interface.h" diff --git a/app/gimage_cmds.c b/app/gimage_cmds.c index 3e1b7182c3..8817a4fe3f 100644 --- a/app/gimage_cmds.c +++ b/app/gimage_cmds.c @@ -2755,7 +2755,7 @@ static ProcArg image_get_active_layer_outargs[] = static ProcRecord image_get_active_layer_proc = { "gimp_image_get_active_layer", - "Returns the active layer of the specified image.", + "Returns if the specified image's active layer.", "If there is an active layer, its ID will be returned, otherwise, -1. If a channel is currently active, then no layer will be. If a layer mask is active, then this will return the associated layer.", "Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis", @@ -2806,7 +2806,7 @@ static ProcArg image_set_active_layer_inargs[] = static ProcRecord image_set_active_layer_proc = { "gimp_image_set_active_layer", - "Set the active layer of the specified image.", + "Sets if the specified image's active layer.", "If the layer exists, it is set as the active layer in the image. Any previous active layer or channel is set to inactive. An exception is a previously existing floating selection, in which case this procedure will return an execution error.", "Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis", @@ -2863,7 +2863,7 @@ static ProcArg image_get_active_channel_outargs[] = static ProcRecord image_get_active_channel_proc = { "gimp_image_get_active_channel", - "Returns the active channel of the specified image.", + "Returns if the specified image's active channel.", "If there is an active channel, this will return the channel ID, otherwise, -1.", "Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis", @@ -2914,7 +2914,7 @@ static ProcArg image_set_active_channel_inargs[] = static ProcRecord image_set_active_channel_proc = { "gimp_image_set_active_channel", - "Set the active channel of the specified image.", + "Sets if the specified image's active channel.", "If the channel exists, it is set as the active channel in the image. Any previous active channel or channel is set to inactive. An exception is a previously existing floating selection, in which case this procedure will return an execution error.", "Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis", @@ -2971,7 +2971,7 @@ static ProcArg image_get_selection_outargs[] = static ProcRecord image_get_selection_proc = { "gimp_image_get_selection", - "Returns the selection of the specified image.", + "Returns if the specified image's selection.", "This will always return a valid ID for a selection--which is represented as a channel internally.", "Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis", @@ -3044,8 +3044,8 @@ static ProcArg image_get_component_active_outargs[] = static ProcRecord image_get_component_active_proc = { "gimp_image_get_component_active", - "Returns the image component is active of the specified image.", - "This procedure returns the specified image's image component (i.e. Red, Green, Blue intensity channels in an RGB image) is active or inactive--whether or not it can be modified. If the specified component is not valid for the image type, and error is returned.", + "Returns if the specified image's image component is active.", + "This procedure returns if the specified image's image component (i.e. Red, Green, Blue intensity channels in an RGB image) is active or inactive--whether or not it can be modified. If the specified component is not valid for the image type, an error is returned.", "Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis", "1995-1996", @@ -3113,8 +3113,8 @@ static ProcArg image_set_component_active_inargs[] = static ProcRecord image_set_component_active_proc = { "gimp_image_set_component_active", - "Set the image component is active of the specified image.", - "This procedure sets the specified image's image component (i.e. Red, Green, Blue intensity channels in an RGB image) is active or inactive--whether or not it can be modified. If the specified component is not valid for the image type, and error is returned.", + "Sets if the specified image's image component is active.", + "This procedure sets if the specified image's image component (i.e. Red, Green, Blue intensity channels in an RGB image) is active or inactive--whether or not it can be modified. If the specified component is not valid for the image type, an error is returned.", "Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis", "1995-1996", @@ -3186,8 +3186,8 @@ static ProcArg image_get_component_visible_outargs[] = static ProcRecord image_get_component_visible_proc = { "gimp_image_get_component_visible", - "Returns the image component is visible of the specified image.", - "This procedure returns the specified image's image component (i.e. Red, Green, Blue intensity channels in an RGB image) is visible or invisible--whether or not it can be seen. If the specified component is not valid for the image type, and error is returned.", + "Returns if the specified image's image component is visible.", + "This procedure returns if the specified image's image component (i.e. Red, Green, Blue intensity channels in an RGB image) is visible or invisible--whether or not it can be seen. If the specified component is not valid for the image type, an error is returned.", "Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis", "1995-1996", @@ -3255,8 +3255,8 @@ static ProcArg image_set_component_visible_inargs[] = static ProcRecord image_set_component_visible_proc = { "gimp_image_set_component_visible", - "Set the image component is visible of the specified image.", - "This procedure sets the specified image's image component (i.e. Red, Green, Blue intensity channels in an RGB image) is visible or invisible--whether or not it can be seen. If the specified component is not valid for the image type, and error is returned.", + "Sets if the specified image's image component is visible.", + "This procedure sets if the specified image's image component (i.e. Red, Green, Blue intensity channels in an RGB image) is visible or invisible--whether or not it can be seen. If the specified component is not valid for the image type, an error is returned.", "Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis", "1995-1996", @@ -3308,8 +3308,8 @@ static ProcArg image_get_filename_outargs[] = static ProcRecord image_get_filename_proc = { "gimp_image_get_filename", - "Returns the filename of the specified image.", - "This procedure returns the specified image's filename--if it was loaded or has since been saved. Otherwise, returns NULL.", + "Returns if the specified image's filename.", + "This procedure returns if the specified image's filename--if it was loaded or has since been saved. Otherwise, returns NULL.", "Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis", "1995-1996", @@ -3359,8 +3359,8 @@ static ProcArg image_set_filename_inargs[] = static ProcRecord image_set_filename_proc = { "gimp_image_set_filename", - "Set the filename of the specified image.", - "This procedure sets the specified image's filename.", + "Sets if the specified image's filename.", + "This procedure sets if the specified image's filename.", "Spencer Kimball & Peter Mattis", "Spencer Kimball & Peter Mattis", "1995-1996", @@ -3420,8 +3420,8 @@ static ProcArg image_get_resolution_outargs[] = static ProcRecord image_get_resolution_proc = { "gimp_image_get_resolution", - "Returns the resolution of the specified image.", - "This procedure returns the specified image's resolution in dots per inch. This value is independent of any of the layers in this image.", + "Returns if the specified image's resolution.", + "This procedure returns if the specified image's resolution in dots per inch. This value is independent of any of the layers in this image.", "Austin Donnelly", "Austin Donnelly", "1998", @@ -3486,8 +3486,8 @@ static ProcArg image_set_resolution_inargs[] = static ProcRecord image_set_resolution_proc = { "gimp_image_set_resolution", - "Set the resolution of the specified image.", - "This procedure sets the specified image's resolution in dots per inch. This value is independent of any of the layers in this image. No scaling or resizing is performed.", + "Sets if the specified image's resolution.", + "This procedure sets if the specified image's resolution in dots per inch. This value is independent of any of the layers in this image. No scaling or resizing is performed.", "Austin Donnelly", "Austin Donnelly", "1998", @@ -3539,8 +3539,8 @@ static ProcArg image_get_unit_outargs[] = static ProcRecord image_get_unit_proc = { "gimp_image_get_unit", - "Returns the unit of the specified image.", - "This procedure returns the specified image's unit. This value is independent of any of the layers in this image. See the gimp_unit_* procedure definitions for the valid range of unit IDs and a description of the unit system.", + "Returns if the specified image's unit.", + "This procedure returns if the specified image's unit. This value is independent of any of the layers in this image. See the gimp_unit_* procedure definitions for the valid range of unit IDs and a description of the unit system.", "Michael Natterer", "Michael Natterer", "1998", @@ -3590,8 +3590,8 @@ static ProcArg image_set_unit_inargs[] = static ProcRecord image_set_unit_proc = { "gimp_image_set_unit", - "Set the unit of the specified image.", - "This procedure sets the specified image's unit. No scaling or resizing is performed. This value is independent of any of the layers in this image. See the gimp_unit_* procedure definitions for the valid range of unit IDs and a description of the unit system.", + "Sets if the specified image's unit.", + "This procedure sets if the specified image's unit. No scaling or resizing is performed. This value is independent of any of the layers in this image. See the gimp_unit_* procedure definitions for the valid range of unit IDs and a description of the unit system.", "Michael Natterer", "Michael Natterer", "1998", diff --git a/app/gui/info-dialog.c b/app/gui/info-dialog.c index ba87eb9116..639a0e1bfe 100644 --- a/app/gui/info-dialog.c +++ b/app/gui/info-dialog.c @@ -19,6 +19,7 @@ #include #include "appenv.h" +#include "dialog_handler.h" #include "gimprc.h" #include "info_dialog.h" #include "interface.h" diff --git a/app/info_dialog.c b/app/info_dialog.c index ba87eb9116..639a0e1bfe 100644 --- a/app/info_dialog.c +++ b/app/info_dialog.c @@ -19,6 +19,7 @@ #include #include "appenv.h" +#include "dialog_handler.h" #include "gimprc.h" #include "info_dialog.h" #include "interface.h" diff --git a/tools/pdbgen/pdb/gimage.pdb b/tools/pdbgen/pdb/gimage.pdb index 7fcf3f0333..3600c9eef8 100644 --- a/tools/pdbgen/pdb/gimage.pdb +++ b/tools/pdbgen/pdb/gimage.pdb @@ -114,9 +114,9 @@ HELP sub image_get_prop_proc { my ($prop, $type, $desc, $func) = @_; - $blurb = "Returns the $desc of the specified image."; + $blurb = "Returns if the specified image's $desc."; - $help = "This procedure returns the specified image's $desc. "; + $help = "This procedure returns if the specified image's $desc. "; &std_pdb_misc; @@ -148,9 +148,9 @@ sub image_get_prop_proc { sub image_set_prop_proc { my ($prop, $type, $desc, $func) = @_; - $blurb = "Set the $desc of the specified image."; + $blurb = "Sets if the specified image's $desc."; - $help = "This procedure sets the specified image's $desc. "; + $help = "This procedure sets if the specified image's $desc. "; &std_pdb_misc; @@ -897,7 +897,15 @@ sub image_undo_thaw { $date = '1999'; $help = <<'HELP'; -This procedure thaws the image's undo stack, allowing subsequent operations to store their undo steps. This is generally called in conjunction with 'gimp_image_undo_freeze' to temporarily freeze an image undo stack. 'gimp_image_undo_thaw' does NOT free the undo stack as 'gimp_image_undo_enable' does, so is suited for situations where one wishes to leave the undo stack in the same state in which one found it despite non-destructively playing with the image in the meantime. An example would be in-situ plugin previews. Balancing freezes and thaws and ensuring image consistancy is the responsibility of the caller. +This procedure thaws the image's undo stack, allowing subsequent operations to +store their undo steps. This is generally called in conjunction with +'gimp_image_undo_freeze' to temporarily freeze an image undo stack. +'gimp_image_undo_thaw' does NOT free the undo stack as +'gimp_image_undo_enable' does, so is suited for situations where one wishes to +leave the undo stack in the same state in which one found it despite +non-destructively playing with the image in the meantime. An example would be +in-situ plugin previews. Balancing freezes and thaws and ensuring image +consistancy is the responsibility of the caller. HELP @inargs = ( &std_image_arg ); @@ -918,7 +926,15 @@ sub image_undo_freeze { $date = '1999'; $help = <<'HELP'; -This procedure freezes the image's undo stack, allowing subsequent operations to ignore their undo steps. This is generally called in conjunction with 'gimp_image_undo_thaw' to temporarily disable an image undo stack. This is advantageous because saving undo steps can be time and memory intensive. 'gimp_image_undo_{freeze,thaw}' and 'gimp_image_undo_{disable,enable}' differ in that the former does not free up all undo steps when undo is thawed, so is more suited to interactive in-situ previews. It is important in this case that the image is back to the same state it was frozen in before thawing, else 'undo' behaviour is undefined. +This procedure freezes the image's undo stack, allowing subsequent operations +to ignore their undo steps. This is generally called in conjunction with +'gimp_image_undo_thaw' to temporarily disable an image undo stack. This is +advantageous because saving undo steps can be time and memory intensive. +'gimp_image_undo_{freeze,thaw}' and 'gimp_image_undo_{disable,enable}' differ +in that the former does not free up all undo steps when undo is thawed, so is +more suited to interactive in-situ previews. It is important in this case +that the image is back to the same state it was frozen in before thawing, else +'undo' behaviour is undefined. HELP @inargs = ( &std_image_arg ); @@ -1106,7 +1122,7 @@ my $comp_help = <<'CODE'; $help =~ s/\. $/ /; $help .= <