pdb: deprecate drawable API that got replaced by item API

This commit is contained in:
Michael Natterer 2010-07-09 11:25:35 +02:00
parent 056a3bf256
commit 3c2dcf2df5
4 changed files with 103 additions and 215 deletions

View file

@ -1335,12 +1335,12 @@ register_drawable_procs (GimpPDB *pdb)
"gimp-drawable-is-valid");
gimp_procedure_set_static_strings (procedure,
"gimp-drawable-is-valid",
"Returns TRUE if the drawable is valid.",
"This procedure checks if the given drawable ID is valid and refers to an existing drawable.",
"This procedure is deprecated! Use 'gimp-item-is-valid' instead.",
"This procedure is deprecated! Use 'gimp-item-is-valid' instead.",
"Sven Neumann <sven@gimp.org>",
"Sven Neumann",
"2007",
NULL);
"gimp-item-is-valid");
gimp_procedure_add_argument (procedure,
gimp_param_spec_drawable_id ("drawable",
"drawable",
@ -1364,12 +1364,12 @@ register_drawable_procs (GimpPDB *pdb)
"gimp-drawable-is-layer");
gimp_procedure_set_static_strings (procedure,
"gimp-drawable-is-layer",
"Returns whether the drawable is a layer.",
"This procedure returns TRUE if the specified drawable is a layer.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
NULL);
"This procedure is deprecated! Use 'gimp-item-is-layer' instead.",
"This procedure is deprecated! Use 'gimp-item-is-layer' instead.",
"",
"",
"",
"gimp-item-is-layer");
gimp_procedure_add_argument (procedure,
gimp_param_spec_drawable_id ("drawable",
"drawable",
@ -1422,12 +1422,12 @@ register_drawable_procs (GimpPDB *pdb)
"gimp-drawable-is-layer-mask");
gimp_procedure_set_static_strings (procedure,
"gimp-drawable-is-layer-mask",
"Returns whether the drawable is a layer mask.",
"This procedure returns TRUE if the specified drawable is a layer mask.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
NULL);
"This procedure is deprecated! Use 'gimp-item-is-layer-mask' instead.",
"This procedure is deprecated! Use 'gimp-item-is-layer-mask' instead.",
"",
"",
"",
"gimp-item-is-layer-mask");
gimp_procedure_add_argument (procedure,
gimp_param_spec_drawable_id ("drawable",
"drawable",
@ -1451,12 +1451,12 @@ register_drawable_procs (GimpPDB *pdb)
"gimp-drawable-is-channel");
gimp_procedure_set_static_strings (procedure,
"gimp-drawable-is-channel",
"Returns whether the drawable is a channel.",
"This procedure returns TRUE if the specified drawable is a channel.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
NULL);
"This procedure is deprecated! Use 'gimp-item-is-channel' instead.",
"This procedure is deprecated! Use 'gimp-item-is-channel' instead.",
"",
"",
"",
"gimp-item-is-channel");
gimp_procedure_add_argument (procedure,
gimp_param_spec_drawable_id ("drawable",
"drawable",
@ -1784,12 +1784,12 @@ register_drawable_procs (GimpPDB *pdb)
"gimp-drawable-delete");
gimp_procedure_set_static_strings (procedure,
"gimp-drawable-delete",
"Delete a drawable.",
"This procedure deletes the specified drawable. This must not be done if the image containing this drawable was already deleted or if the drawable was already removed from the image. The only case in which this procedure is useful is if you want to get rid of a drawable which has not yet been added to an image.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
NULL);
"This procedure is deprecated! Use 'gimp-item-delete' instead.",
"This procedure is deprecated! Use 'gimp-item-delete' instead.",
"",
"",
"",
"gimp-item-delete");
gimp_procedure_add_argument (procedure,
gimp_param_spec_drawable_id ("drawable",
"drawable",
@ -1807,12 +1807,12 @@ register_drawable_procs (GimpPDB *pdb)
"gimp-drawable-get-image");
gimp_procedure_set_static_strings (procedure,
"gimp-drawable-get-image",
"Returns the drawable's image.",
"This procedure returns the drawable's image.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
NULL);
"This procedure is deprecated! Use 'gimp-item-get-image' instead.",
"This procedure is deprecated! Use 'gimp-item-get-image' instead.",
"",
"",
"",
"gimp-item-get-image");
gimp_procedure_add_argument (procedure,
gimp_param_spec_drawable_id ("drawable",
"drawable",
@ -1865,12 +1865,12 @@ register_drawable_procs (GimpPDB *pdb)
"gimp-drawable-get-name");
gimp_procedure_set_static_strings (procedure,
"gimp-drawable-get-name",
"Get the name of the specified drawable.",
"This procedure returns the specified drawable's name.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
NULL);
"This procedure is deprecated! Use 'gimp-item-get-name' instead.",
"This procedure is deprecated! Use 'gimp-item-get-name' instead.",
"",
"",
"",
"gimp-item-get-name");
gimp_procedure_add_argument (procedure,
gimp_param_spec_drawable_id ("drawable",
"drawable",
@ -1895,12 +1895,12 @@ register_drawable_procs (GimpPDB *pdb)
"gimp-drawable-set-name");
gimp_procedure_set_static_strings (procedure,
"gimp-drawable-set-name",
"Set the name of the specified drawable.",
"This procedure sets the specified drawable's name.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
NULL);
"This procedure is deprecated! Use 'gimp-item-set-name' instead.",
"This procedure is deprecated! Use 'gimp-item-set-name' instead.",
"",
"",
"",
"gimp-item-set-name");
gimp_procedure_add_argument (procedure,
gimp_param_spec_drawable_id ("drawable",
"drawable",
@ -1925,12 +1925,12 @@ register_drawable_procs (GimpPDB *pdb)
"gimp-drawable-get-visible");
gimp_procedure_set_static_strings (procedure,
"gimp-drawable-get-visible",
"Get the visibility of the specified drawable.",
"This procedure returns the specified drawable's visibility.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
NULL);
"This procedure is deprecated! Use 'gimp-item-get-visible' instead.",
"This procedure is deprecated! Use 'gimp-item-get-visible' instead.",
"",
"",
"",
"gimp-item-get-visible");
gimp_procedure_add_argument (procedure,
gimp_param_spec_drawable_id ("drawable",
"drawable",
@ -1954,12 +1954,12 @@ register_drawable_procs (GimpPDB *pdb)
"gimp-drawable-set-visible");
gimp_procedure_set_static_strings (procedure,
"gimp-drawable-set-visible",
"Set the visibility of the specified drawable.",
"This procedure sets the specified drawable's visibility.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
NULL);
"This procedure is deprecated! Use 'gimp-item-set-visible' instead.",
"This procedure is deprecated! Use 'gimp-item-set-visible' instead.",
"",
"",
"",
"gimp-item-set-visible");
gimp_procedure_add_argument (procedure,
gimp_param_spec_drawable_id ("drawable",
"drawable",
@ -1983,12 +1983,12 @@ register_drawable_procs (GimpPDB *pdb)
"gimp-drawable-get-linked");
gimp_procedure_set_static_strings (procedure,
"gimp-drawable-get-linked",
"Get the linked state of the specified drawable.",
"This procedure returns the specified drawable's linked state.",
"This procedure is deprecated! Use 'gimp-item-get-linked' instead.",
"This procedure is deprecated! Use 'gimp-item-get-linked' instead.",
"Wolfgang Hofer",
"Wolfgang Hofer",
"1998",
NULL);
"gimp-item-get-linked");
gimp_procedure_add_argument (procedure,
gimp_param_spec_drawable_id ("drawable",
"drawable",
@ -2012,12 +2012,12 @@ register_drawable_procs (GimpPDB *pdb)
"gimp-drawable-set-linked");
gimp_procedure_set_static_strings (procedure,
"gimp-drawable-set-linked",
"Set the linked state of the specified drawable.",
"This procedure sets the specified drawable's linked state.",
"This procedure is deprecated! Use 'gimp-item-set-linked' instead.",
"This procedure is deprecated! Use 'gimp-item-set-linked' instead.",
"Wolfgang Hofer",
"Wolfgang Hofer",
"1998",
NULL);
"gimp-item-set-linked");
gimp_procedure_add_argument (procedure,
gimp_param_spec_drawable_id ("drawable",
"drawable",
@ -2041,12 +2041,12 @@ register_drawable_procs (GimpPDB *pdb)
"gimp-drawable-get-tattoo");
gimp_procedure_set_static_strings (procedure,
"gimp-drawable-get-tattoo",
"Get the tattoo of the specified drawable.",
"This procedure returns the specified drawable's tattoo. A tattoo is a unique and permanent identifier attached to a drawable that can be used to uniquely identify a drawable within an image even between sessions.",
"This procedure is deprecated! Use 'gimp-item-get-tattoo' instead.",
"This procedure is deprecated! Use 'gimp-item-get-tattoo' instead.",
"Jay Cox",
"Jay Cox",
"1998",
NULL);
"gimp-item-get-tattoo");
gimp_procedure_add_argument (procedure,
gimp_param_spec_drawable_id ("drawable",
"drawable",
@ -2070,12 +2070,12 @@ register_drawable_procs (GimpPDB *pdb)
"gimp-drawable-set-tattoo");
gimp_procedure_set_static_strings (procedure,
"gimp-drawable-set-tattoo",
"Set the tattoo of the specified drawable.",
"This procedure sets the specified drawable's tattoo. A tattoo is a unique and permanent identifier attached to a drawable that can be used to uniquely identify a drawable within an image even between sessions.",
"This procedure is deprecated! Use 'gimp-item-set-tattoo' instead.",
"This procedure is deprecated! Use 'gimp-item-set-tattoo' instead.",
"Jay Cox",
"Jay Cox",
"1998",
NULL);
"gimp-item-set-tattoo");
gimp_procedure_add_argument (procedure,
gimp_param_spec_drawable_id ("drawable",
"drawable",

View file

@ -43,10 +43,7 @@
* gimp_drawable_is_valid:
* @drawable_ID: The drawable to check.
*
* Returns TRUE if the drawable is valid.
*
* This procedure checks if the given drawable ID is valid and refers
* to an existing drawable.
* This procedure is deprecated! Use gimp_item_is_valid() instead.
*
* Returns: Whether the drawable ID is valid.
*
@ -76,9 +73,7 @@ gimp_drawable_is_valid (gint32 drawable_ID)
* gimp_drawable_is_layer:
* @drawable_ID: The drawable.
*
* Returns whether the drawable is a layer.
*
* This procedure returns TRUE if the specified drawable is a layer.
* This procedure is deprecated! Use gimp_item_is_layer() instead.
*
* Returns: TRUE if the drawable is a layer, FALSE otherwise.
*/
@ -139,10 +134,7 @@ gimp_drawable_is_text_layer (gint32 drawable_ID)
* gimp_drawable_is_layer_mask:
* @drawable_ID: The drawable.
*
* Returns whether the drawable is a layer mask.
*
* This procedure returns TRUE if the specified drawable is a layer
* mask.
* This procedure is deprecated! Use gimp_item_is_layer_mask() instead.
*
* Returns: TRUE if the drawable is a layer mask, FALSE otherwise.
*/
@ -170,9 +162,7 @@ gimp_drawable_is_layer_mask (gint32 drawable_ID)
* gimp_drawable_is_channel:
* @drawable_ID: The drawable.
*
* Returns whether the drawable is a channel.
*
* This procedure returns TRUE if the specified drawable is a channel.
* This procedure is deprecated! Use gimp_item_is_channel() instead.
*
* Returns: TRUE if the drawable is a channel, FALSE otherwise.
*/
@ -523,13 +513,7 @@ gimp_drawable_offsets (gint32 drawable_ID,
* gimp_drawable_delete:
* @drawable_ID: The drawable to delete.
*
* Delete a drawable.
*
* This procedure deletes the specified drawable. This must not be done
* if the image containing this drawable was already deleted or if the
* drawable was already removed from the image. The only case in which
* this procedure is useful is if you want to get rid of a drawable
* which has not yet been added to an image.
* This procedure is deprecated! Use gimp_item_delete() instead.
*
* Returns: TRUE on success.
*/
@ -556,9 +540,7 @@ gimp_drawable_delete (gint32 drawable_ID)
* gimp_drawable_get_image:
* @drawable_ID: The drawable.
*
* Returns the drawable's image.
*
* This procedure returns the drawable's image.
* This procedure is deprecated! Use gimp_item_get_image() instead.
*
* Returns: The drawable's image.
*/
@ -616,9 +598,7 @@ gimp_drawable_set_image (gint32 drawable_ID,
* gimp_drawable_get_name:
* @drawable_ID: The drawable.
*
* Get the name of the specified drawable.
*
* This procedure returns the specified drawable's name.
* This procedure is deprecated! Use gimp_item_get_name() instead.
*
* Returns: The drawable name.
*/
@ -647,9 +627,7 @@ gimp_drawable_get_name (gint32 drawable_ID)
* @drawable_ID: The drawable.
* @name: The new drawable name.
*
* Set the name of the specified drawable.
*
* This procedure sets the specified drawable's name.
* This procedure is deprecated! Use gimp_item_set_name() instead.
*
* Returns: TRUE on success.
*/
@ -678,9 +656,7 @@ gimp_drawable_set_name (gint32 drawable_ID,
* gimp_drawable_get_visible:
* @drawable_ID: The drawable.
*
* Get the visibility of the specified drawable.
*
* This procedure returns the specified drawable's visibility.
* This procedure is deprecated! Use gimp_item_get_visible() instead.
*
* Returns: The drawable visibility.
*/
@ -709,9 +685,7 @@ gimp_drawable_get_visible (gint32 drawable_ID)
* @drawable_ID: The drawable.
* @visible: The new drawable visibility.
*
* Set the visibility of the specified drawable.
*
* This procedure sets the specified drawable's visibility.
* This procedure is deprecated! Use gimp_item_set_visible() instead.
*
* Returns: TRUE on success.
*/
@ -740,9 +714,7 @@ gimp_drawable_set_visible (gint32 drawable_ID,
* gimp_drawable_get_linked:
* @drawable_ID: The drawable.
*
* Get the linked state of the specified drawable.
*
* This procedure returns the specified drawable's linked state.
* This procedure is deprecated! Use gimp_item_get_linked() instead.
*
* Returns: The drawable linked state (for moves).
*/
@ -771,9 +743,7 @@ gimp_drawable_get_linked (gint32 drawable_ID)
* @drawable_ID: The drawable.
* @linked: The new drawable linked state.
*
* Set the linked state of the specified drawable.
*
* This procedure sets the specified drawable's linked state.
* This procedure is deprecated! Use gimp_item_set_linked() instead.
*
* Returns: TRUE on success.
*/
@ -802,12 +772,7 @@ gimp_drawable_set_linked (gint32 drawable_ID,
* gimp_drawable_get_tattoo:
* @drawable_ID: The drawable.
*
* Get the tattoo of the specified drawable.
*
* This procedure returns the specified drawable's tattoo. A tattoo is
* a unique and permanent identifier attached to a drawable that can be
* used to uniquely identify a drawable within an image even between
* sessions.
* This procedure is deprecated! Use gimp_item_get_tattoo() instead.
*
* Returns: The drawable tattoo.
*/
@ -836,12 +801,7 @@ gimp_drawable_get_tattoo (gint32 drawable_ID)
* @drawable_ID: The drawable.
* @tattoo: The new drawable tattoo.
*
* Set the tattoo of the specified drawable.
*
* This procedure sets the specified drawable's tattoo. A tattoo is a
* unique and permanent identifier attached to a drawable that can be
* used to uniquely identify a drawable within an image even between
* sessions.
* This procedure is deprecated! Use gimp_item_set_tattoo() instead.
*
* Returns: TRUE on success.
*/

View file

@ -28,11 +28,15 @@ G_BEGIN_DECLS
/* For information look into the C source or the html documentation */
#ifndef GIMP_DISABLE_DEPRECATED
gboolean gimp_drawable_is_valid (gint32 drawable_ID);
gboolean gimp_drawable_is_layer (gint32 drawable_ID);
#endif /* GIMP_DISABLE_DEPRECATED */
gboolean gimp_drawable_is_text_layer (gint32 drawable_ID);
#ifndef GIMP_DISABLE_DEPRECATED
gboolean gimp_drawable_is_layer_mask (gint32 drawable_ID);
gboolean gimp_drawable_is_channel (gint32 drawable_ID);
#endif /* GIMP_DISABLE_DEPRECATED */
GimpImageType gimp_drawable_type (gint32 drawable_ID);
GimpImageType gimp_drawable_type_with_alpha (gint32 drawable_ID);
gboolean gimp_drawable_has_alpha (gint32 drawable_ID);
@ -45,12 +49,11 @@ gint gimp_drawable_height (gint32
gboolean gimp_drawable_offsets (gint32 drawable_ID,
gint *offset_x,
gint *offset_y);
#ifndef GIMP_DISABLE_DEPRECATED
gboolean gimp_drawable_delete (gint32 drawable_ID);
gint32 gimp_drawable_get_image (gint32 drawable_ID);
#ifndef GIMP_DISABLE_DEPRECATED
gboolean gimp_drawable_set_image (gint32 drawable_ID,
gint32 image_ID);
#endif /* GIMP_DISABLE_DEPRECATED */
gchar* gimp_drawable_get_name (gint32 drawable_ID);
gboolean gimp_drawable_set_name (gint32 drawable_ID,
const gchar *name);
@ -63,6 +66,7 @@ gboolean gimp_drawable_set_linked (gint32
gint gimp_drawable_get_tattoo (gint32 drawable_ID);
gboolean gimp_drawable_set_tattoo (gint32 drawable_ID,
gint tattoo);
#endif /* GIMP_DISABLE_DEPRECATED */
gboolean gimp_drawable_mask_bounds (gint32 drawable_ID,
gint *x1,
gint *y1,

View file

@ -17,13 +17,7 @@
# "Perlized" from C source by Manish Singh <yosh@gimp.org>
sub drawable_is_valid {
$blurb = 'Returns TRUE if the drawable is valid.';
$help = <<'HELP';
This procedure checks if the given drawable ID is valid and refers to an
existing drawable.
HELP
&std_pdb_deprecated('gimp-item-is-valid');
&neo_pdb_misc('2007', '2.4');
@inargs = (
@ -294,11 +288,7 @@ CODE
}
sub drawable_get_image {
$blurb = "Returns the drawable's image.";
$help = "This procedure returns the drawable's image.";
&std_pdb_misc;
&std_pdb_deprecated('gimp-item-get-image');
@inargs = (
{ name => 'drawable', type => 'drawable',
@ -607,13 +597,7 @@ CODE
}
sub drawable_is_layer {
$blurb = 'Returns whether the drawable is a layer.';
$help = <<HELP;
This procedure returns TRUE if the specified drawable is a layer.
HELP
&std_pdb_misc;
&std_pdb_deprecated('gimp-item-is-layer');
@inargs = (
{ name => 'drawable', type => 'drawable',
@ -663,13 +647,7 @@ CODE
}
sub drawable_is_layer_mask {
$blurb = 'Returns whether the drawable is a layer mask.';
$help = <<HELP;
This procedure returns TRUE if the specified drawable is a layer mask.
HELP
&std_pdb_misc;
&std_pdb_deprecated('gimp-item-is-layer-mask');
@inargs = (
{ name => 'drawable', type => 'drawable',
@ -691,13 +669,7 @@ CODE
}
sub drawable_is_channel {
$blurb = 'Returns whether the drawable is a channel.';
$help = <<HELP;
This procedure returns TRUE if the specified drawable is a channel.
HELP
&std_pdb_misc;
&std_pdb_deprecated('gimp-item-is-channel');
@inargs = (
{ name => 'drawable', type => 'drawable',
@ -719,11 +691,7 @@ CODE
}
sub drawable_get_name {
$blurb = "Get the name of the specified drawable.";
$help = "This procedure returns the specified drawable's name.";
&std_pdb_misc;
&std_pdb_deprecated('gimp-item-get-name');
@inargs = (
{ name => 'drawable', type => 'drawable',
@ -745,11 +713,7 @@ CODE
}
sub drawable_set_name {
$blurb = "Set the name of the specified drawable.";
$help = "This procedure sets the specified drawable's name.";
&std_pdb_misc;
&std_pdb_deprecated('gimp-item-set-name');
@inargs = (
{ name => 'drawable', type => 'drawable',
@ -768,11 +732,7 @@ CODE
}
sub drawable_get_visible {
$blurb = "Get the visibility of the specified drawable.";
$help = "This procedure returns the specified drawable's visibility.";
&std_pdb_misc;
&std_pdb_deprecated('gimp-item-get-visible');
@inargs = (
{ name => 'drawable', type => 'drawable',
@ -794,11 +754,7 @@ CODE
}
sub drawable_set_visible {
$blurb = "Set the visibility of the specified drawable.";
$help = "This procedure sets the specified drawable's visibility.";
&std_pdb_misc;
&std_pdb_deprecated('gimp-item-set-visible');
@inargs = (
{ name => 'drawable', type => 'drawable',
@ -817,10 +773,7 @@ CODE
}
sub drawable_get_linked {
$blurb = "Get the linked state of the specified drawable.";
$help = "This procedure returns the specified drawable's linked state.";
&std_pdb_deprecated('gimp-item-get-linked');
&wolfgang_pdb_misc('1998');
@inargs = (
@ -843,10 +796,7 @@ CODE
}
sub drawable_set_linked {
$blurb = "Set the linked state of the specified drawable.";
$help = "This procedure sets the specified drawable's linked state.";
&std_pdb_deprecated('gimp-item-set-linked');
&wolfgang_pdb_misc('1998');
@inargs = (
@ -866,15 +816,7 @@ CODE
}
sub drawable_get_tattoo {
$blurb = "Get the tattoo of the specified drawable.";
$help = <<'HELP';
This procedure returns the specified drawable's tattoo. A tattoo is a
unique and permanent identifier attached to a drawable that can be
used to uniquely identify a drawable within an image even between
sessions.
HELP
&std_pdb_deprecated('gimp-item-get-tattoo');
&jay_pdb_misc('1998');
@inargs = (
@ -897,15 +839,7 @@ CODE
}
sub drawable_set_tattoo {
$blurb = "Set the tattoo of the specified drawable.";
$help = <<'HELP';
This procedure sets the specified drawable's tattoo. A tattoo is a
unique and permanent identifier attached to a drawable that can be
used to uniquely identify a drawable within an image even between
sessions.
HELP
&std_pdb_deprecated('gimp-item-set-tattoo');
&jay_pdb_misc('1998');
@inargs = (
@ -1272,17 +1206,7 @@ CODE
}
sub drawable_delete {
$blurb = 'Delete a drawable.';
$help = <<'HELP';
This procedure deletes the specified drawable. This must not be done if the
image containing this drawable was already deleted or if the drawable was
already removed from the image. The only case in which this procedure is
useful is if you want to get rid of a drawable which has not yet been
added to an image.
HELP
&std_pdb_misc;
&std_pdb_deprecated('gimp-item-delete');
@inargs = (
{ name => 'drawable', type => 'drawable',