dallasgroot/Gimp
dallasgroot/Gimp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

app, libgimp, pdb: fix docs of gimp_file_load() and gimp_image_is_dirty().

Browse source 
See commit 822c26f709. We decided to solve #14463 by having
gimp_file_load() always force-clean the image and reset the undo stack.
Therefore fix the docs again.
This commit is contained in:
Jehan 2025-10-24 02:56:08 +02:00
parent 9cbc928758
commit 313445b4cf
6 changed files with 17 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
app/pdb/file-cmds.c
View file

@ -419,7 +419,7 @@ register_file_procs (GimpPDB *pdb)
"gimp-file-load");
gimp_procedure_set_static_help (procedure,
"Loads an image file by invoking the right load handler.",
"This procedure invokes the correct file load handler using magic if possible, and falling back on the file's extension and/or prefix if not. Note that the loaded image will be marked as dirty, which can be changed by calling [method@Gimp.Image.clean_all].",
"This procedure invokes the correct file load handler using magic if possible, and falling back on the file's extension and/or prefix if not. Note that the loaded image will be marked as clean.",
NULL);
gimp_procedure_set_static_attribution (procedure,
"Josh MacDonald",

4
app/pdb/image-cmds.c
View file

@ -4658,7 +4658,9 @@ register_image_procs (GimpPDB *pdb)
"gimp-image-is-dirty");
gimp_procedure_set_static_help (procedure,
"Checks if the image has unsaved changes.",
"This procedure checks the specified image's dirty count to see if it needs to be saved. Note that saving the image does not automatically set the dirty count to 0, you need to call [method@Gimp.Image.clean_all] after calling a save procedure to make the image clean. When loading an image using e.g. [func@Gimp.file_load] the image will be marked as dirty too.",
"This procedure checks the specified image's dirty count to see if it needs to be saved. Note that saving the image does not automatically set the dirty count to 0, you need to call [method@Gimp.Image.clean_all] after calling a save procedure to make the image clean.\n"
"\n"
"When loading an image using e.g. [func@Gimp.file_load] the image will be marked as clean, but loading an image calling directly the accurate file format procedure may return a dirty image.",
NULL);
gimp_procedure_set_static_attribution (procedure,
"Spencer Kimball & Peter Mattis",

3
libgimp/gimpfile_pdb.c
View file

@ -45,8 +45,7 @@
*
* This procedure invokes the correct file load handler using magic if
* possible, and falling back on the file's extension and/or prefix if
* not. Note that the loaded image will be marked as dirty, which can
* be changed by calling [method@Gimp.Image.clean_all].
* not. Note that the loaded image will be marked as clean.
*
* Returns: (transfer none): The output image.
**/

7
libgimp/gimpimage_pdb.c
View file

@ -2084,8 +2084,11 @@ gimp_image_clean_all (GimpImage *image)
* needs to be saved. Note that saving the image does not automatically
* set the dirty count to 0, you need to call
* [method@Gimp.Image.clean_all] after calling a save procedure to make
* the image clean. When loading an image using e.g.
* [func@Gimp.file_load] the image will be marked as dirty too.
* the image clean.
*
* When loading an image using e.g. [func@Gimp.file_load] the image
* will be marked as clean, but loading an image calling directly the
* accurate file format procedure may return a dirty image.
*
* Returns: TRUE if the image has unsaved changes.
**/

3
pdb/groups/file.pdb
View file

@ -23,8 +23,7 @@ sub file_load {
$help = <<'HELP';
This procedure invokes the correct file load handler using magic if
possible, and falling back on the file's extension and/or prefix if
not. Note that the loaded image will be marked as dirty, which can be
changed by calling [method@Gimp.Image.clean_all].
not. Note that the loaded image will be marked as clean.
HELP
&josh_pdb_misc('1997');

8
pdb/groups/image.pdb
View file

@ -1796,8 +1796,12 @@ sub image_is_dirty {
This procedure checks the specified image's dirty count to see if it
needs to be saved. Note that saving the image does not automatically
set the dirty count to 0, you need to call [method@Gimp.Image.clean_all] after
calling a save procedure to make the image clean. When loading an image using
e.g. [func@Gimp.file_load] the image will be marked as dirty too.
calling a save procedure to make the image clean.
When loading an image using e.g. [func@Gimp.file_load] the image will be
marked as clean, but loading an image calling directly the accurate file
format procedure may return a dirty image.
HELP
&std_pdb_misc;