392f00baf5
Turn all ID param specs into object param specs (e.g. GimpParamImageID becomes GimpParamImage) and convert between IDs and objects in gimpgpparams.c directly above the the wire protocol, so all of app/, libgimp/ and plug-ins/ can deal directly with objects down to the lowest level and not care about IDs. Use the actual object param specs for procedure arguments and return values again instead of a plain g_param_spec_object() and bring back the none_ok parameter. This implies changing the PDB type checking functions to work on pure integers instead of IDs (one can't check whether object creation is possible if performing that check requires the object to already exist). For example gimp_foo_is_valid() becomes gimp_foo_id_is_valid() and is not involved in automatic object creation magic at the protocol level. Added wrappers which still say gimp_foo_is_valid() and take the respective objects. Adapted all code, and it all becomes nicer and less convoluted, even the generated PDB wrappers in app/ and libgimp/.
466 lines
15 KiB
C
466 lines
15 KiB
C
/* LIBGIMP - The GIMP Library
|
|
* Copyright (C) 1995-2003 Peter Mattis and Spencer Kimball
|
|
*
|
|
* gimpdisplay_pdb.c
|
|
*
|
|
* This library is free software: you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 3 of the License, or (at your option) any later version.
|
|
*
|
|
* This library 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
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library. If not, see
|
|
* <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/* NOTE: This file is auto-generated by pdbgen.pl */
|
|
|
|
#include "config.h"
|
|
|
|
#include "gimp.h"
|
|
|
|
|
|
/**
|
|
* SECTION: gimpdisplay
|
|
* @title: gimpdisplay
|
|
* @short_description: Functions to create, delete and flush displays (views) on an image.
|
|
*
|
|
* Functions to create, delete and flush displays (views) on an image.
|
|
**/
|
|
|
|
|
|
/**
|
|
* gimp_display_id_is_valid:
|
|
* @display_id: The display ID to check.
|
|
*
|
|
* Returns TRUE if the display ID is valid.
|
|
*
|
|
* This procedure checks if the given display ID is valid and refers to
|
|
* an existing display.
|
|
*
|
|
* Returns: Whether the display ID is valid.
|
|
*
|
|
* Since: 3.0
|
|
**/
|
|
gboolean
|
|
gimp_display_id_is_valid (gint display_id)
|
|
{
|
|
GimpPDB *pdb = gimp_get_pdb ();
|
|
GimpValueArray *args;
|
|
GimpValueArray *return_vals;
|
|
gboolean valid = FALSE;
|
|
|
|
args = gimp_value_array_new_from_types (NULL,
|
|
G_TYPE_INT, display_id,
|
|
G_TYPE_NONE);
|
|
|
|
if (pdb)
|
|
return_vals = gimp_pdb_run_procedure_array (pdb,
|
|
"gimp-display-id-is-valid",
|
|
args);
|
|
else
|
|
return_vals = gimp_run_procedure_array ("gimp-display-id-is-valid",
|
|
args);
|
|
gimp_value_array_unref (args);
|
|
|
|
if (g_value_get_enum (gimp_value_array_index (return_vals, 0)) == GIMP_PDB_SUCCESS)
|
|
valid = g_value_get_boolean (gimp_value_array_index (return_vals, 1));
|
|
|
|
gimp_value_array_unref (return_vals);
|
|
|
|
return valid;
|
|
}
|
|
|
|
/**
|
|
* gimp_display_new:
|
|
* @image: The image.
|
|
*
|
|
* Create a new display for the specified image.
|
|
*
|
|
* Creates a new display for the specified image. If the image already
|
|
* has a display, another is added. Multiple displays are handled
|
|
* transparently by GIMP. The newly created display is returned and can
|
|
* be subsequently destroyed with a call to gimp_display_delete(). This
|
|
* procedure only makes sense for use with the GIMP UI, and will result
|
|
* in an execution error if called when GIMP has no UI.
|
|
*
|
|
* Returns: (transfer none): The new display.
|
|
**/
|
|
GimpDisplay *
|
|
gimp_display_new (GimpImage *image)
|
|
{
|
|
GimpPDB *pdb = gimp_get_pdb ();
|
|
GimpValueArray *args;
|
|
GimpValueArray *return_vals;
|
|
GimpDisplay *display = NULL;
|
|
|
|
args = gimp_value_array_new_from_types (NULL,
|
|
GIMP_TYPE_IMAGE, image,
|
|
G_TYPE_NONE);
|
|
|
|
if (pdb)
|
|
return_vals = gimp_pdb_run_procedure_array (pdb,
|
|
"gimp-display-new",
|
|
args);
|
|
else
|
|
return_vals = gimp_run_procedure_array ("gimp-display-new",
|
|
args);
|
|
gimp_value_array_unref (args);
|
|
|
|
if (g_value_get_enum (gimp_value_array_index (return_vals, 0)) == GIMP_PDB_SUCCESS)
|
|
display = g_value_get_object (gimp_value_array_index (return_vals, 1));
|
|
|
|
gimp_value_array_unref (return_vals);
|
|
|
|
return display;
|
|
}
|
|
|
|
/**
|
|
* _gimp_display_new: (skip)
|
|
* @image_ID: The image.
|
|
*
|
|
* Create a new display for the specified image.
|
|
*
|
|
* Creates a new display for the specified image. If the image already
|
|
* has a display, another is added. Multiple displays are handled
|
|
* transparently by GIMP. The newly created display is returned and can
|
|
* be subsequently destroyed with a call to gimp_display_delete(). This
|
|
* procedure only makes sense for use with the GIMP UI, and will result
|
|
* in an execution error if called when GIMP has no UI.
|
|
*
|
|
* Returns: The new display.
|
|
**/
|
|
gint32
|
|
_gimp_display_new (gint32 image_ID)
|
|
{
|
|
GimpPDB *pdb = gimp_get_pdb ();
|
|
GimpValueArray *args;
|
|
GimpValueArray *return_vals;
|
|
gint32 display_ID = -1;
|
|
|
|
args = gimp_value_array_new_from_types (NULL,
|
|
GIMP_TYPE_IMAGE, gimp_image_get_by_id (image_ID),
|
|
G_TYPE_NONE);
|
|
|
|
if (pdb)
|
|
return_vals = gimp_pdb_run_procedure_array (pdb,
|
|
"gimp-display-new",
|
|
args);
|
|
else
|
|
return_vals = gimp_run_procedure_array ("gimp-display-new",
|
|
args);
|
|
gimp_value_array_unref (args);
|
|
|
|
if (g_value_get_enum (gimp_value_array_index (return_vals, 0)) == GIMP_PDB_SUCCESS)
|
|
display_ID = gimp_display_get_id (g_value_get_object (gimp_value_array_index (return_vals, 1)));
|
|
|
|
gimp_value_array_unref (return_vals);
|
|
|
|
return display_ID;
|
|
}
|
|
|
|
/**
|
|
* gimp_display_delete:
|
|
* @display: The display to delete.
|
|
*
|
|
* Delete the specified display.
|
|
*
|
|
* This procedure removes the specified display. If this is the last
|
|
* remaining display for the underlying image, then the image is
|
|
* deleted also. Note that the display is closed no matter if the image
|
|
* is dirty or not. Better save the image before calling this
|
|
* procedure.
|
|
*
|
|
* Returns: TRUE on success.
|
|
**/
|
|
gboolean
|
|
gimp_display_delete (GimpDisplay *display)
|
|
{
|
|
GimpPDB *pdb = gimp_get_pdb ();
|
|
GimpValueArray *args;
|
|
GimpValueArray *return_vals;
|
|
gboolean success = TRUE;
|
|
|
|
args = gimp_value_array_new_from_types (NULL,
|
|
GIMP_TYPE_DISPLAY, display,
|
|
G_TYPE_NONE);
|
|
|
|
if (pdb)
|
|
return_vals = gimp_pdb_run_procedure_array (pdb,
|
|
"gimp-display-delete",
|
|
args);
|
|
else
|
|
return_vals = gimp_run_procedure_array ("gimp-display-delete",
|
|
args);
|
|
gimp_value_array_unref (args);
|
|
|
|
success = g_value_get_enum (gimp_value_array_index (return_vals, 0)) == GIMP_PDB_SUCCESS;
|
|
|
|
gimp_value_array_unref (return_vals);
|
|
|
|
return success;
|
|
}
|
|
|
|
/**
|
|
* _gimp_display_delete: (skip)
|
|
* @display_ID: The display to delete.
|
|
*
|
|
* Delete the specified display.
|
|
*
|
|
* This procedure removes the specified display. If this is the last
|
|
* remaining display for the underlying image, then the image is
|
|
* deleted also. Note that the display is closed no matter if the image
|
|
* is dirty or not. Better save the image before calling this
|
|
* procedure.
|
|
*
|
|
* Returns: TRUE on success.
|
|
**/
|
|
gboolean
|
|
_gimp_display_delete (gint32 display_ID)
|
|
{
|
|
GimpPDB *pdb = gimp_get_pdb ();
|
|
GimpValueArray *args;
|
|
GimpValueArray *return_vals;
|
|
gboolean success = TRUE;
|
|
|
|
args = gimp_value_array_new_from_types (NULL,
|
|
GIMP_TYPE_DISPLAY, gimp_display_get_by_id (display_ID),
|
|
G_TYPE_NONE);
|
|
|
|
if (pdb)
|
|
return_vals = gimp_pdb_run_procedure_array (pdb,
|
|
"gimp-display-delete",
|
|
args);
|
|
else
|
|
return_vals = gimp_run_procedure_array ("gimp-display-delete",
|
|
args);
|
|
gimp_value_array_unref (args);
|
|
|
|
success = g_value_get_enum (gimp_value_array_index (return_vals, 0)) == GIMP_PDB_SUCCESS;
|
|
|
|
gimp_value_array_unref (return_vals);
|
|
|
|
return success;
|
|
}
|
|
|
|
/**
|
|
* gimp_display_get_window_handle:
|
|
* @display: The display to get the window handle from.
|
|
*
|
|
* Get a handle to the native window for an image display.
|
|
*
|
|
* This procedure returns a handle to the native window for a given
|
|
* image display. For example in the X backend of GDK, a native window
|
|
* handle is an Xlib XID. A value of 0 is returned for an invalid
|
|
* display or if this function is unimplemented for the windowing
|
|
* system that is being used.
|
|
*
|
|
* Returns: The native window handle or 0.
|
|
*
|
|
* Since: 2.4
|
|
**/
|
|
gint
|
|
gimp_display_get_window_handle (GimpDisplay *display)
|
|
{
|
|
GimpPDB *pdb = gimp_get_pdb ();
|
|
GimpValueArray *args;
|
|
GimpValueArray *return_vals;
|
|
gint window = 0;
|
|
|
|
args = gimp_value_array_new_from_types (NULL,
|
|
GIMP_TYPE_DISPLAY, display,
|
|
G_TYPE_NONE);
|
|
|
|
if (pdb)
|
|
return_vals = gimp_pdb_run_procedure_array (pdb,
|
|
"gimp-display-get-window-handle",
|
|
args);
|
|
else
|
|
return_vals = gimp_run_procedure_array ("gimp-display-get-window-handle",
|
|
args);
|
|
gimp_value_array_unref (args);
|
|
|
|
if (g_value_get_enum (gimp_value_array_index (return_vals, 0)) == GIMP_PDB_SUCCESS)
|
|
window = g_value_get_int (gimp_value_array_index (return_vals, 1));
|
|
|
|
gimp_value_array_unref (return_vals);
|
|
|
|
return window;
|
|
}
|
|
|
|
/**
|
|
* _gimp_display_get_window_handle: (skip)
|
|
* @display_ID: The display to get the window handle from.
|
|
*
|
|
* Get a handle to the native window for an image display.
|
|
*
|
|
* This procedure returns a handle to the native window for a given
|
|
* image display. For example in the X backend of GDK, a native window
|
|
* handle is an Xlib XID. A value of 0 is returned for an invalid
|
|
* display or if this function is unimplemented for the windowing
|
|
* system that is being used.
|
|
*
|
|
* Returns: The native window handle or 0.
|
|
*
|
|
* Since: 2.4
|
|
**/
|
|
gint
|
|
_gimp_display_get_window_handle (gint32 display_ID)
|
|
{
|
|
GimpPDB *pdb = gimp_get_pdb ();
|
|
GimpValueArray *args;
|
|
GimpValueArray *return_vals;
|
|
gint window = 0;
|
|
|
|
args = gimp_value_array_new_from_types (NULL,
|
|
GIMP_TYPE_DISPLAY, gimp_display_get_by_id (display_ID),
|
|
G_TYPE_NONE);
|
|
|
|
if (pdb)
|
|
return_vals = gimp_pdb_run_procedure_array (pdb,
|
|
"gimp-display-get-window-handle",
|
|
args);
|
|
else
|
|
return_vals = gimp_run_procedure_array ("gimp-display-get-window-handle",
|
|
args);
|
|
gimp_value_array_unref (args);
|
|
|
|
if (g_value_get_enum (gimp_value_array_index (return_vals, 0)) == GIMP_PDB_SUCCESS)
|
|
window = g_value_get_int (gimp_value_array_index (return_vals, 1));
|
|
|
|
gimp_value_array_unref (return_vals);
|
|
|
|
return window;
|
|
}
|
|
|
|
/**
|
|
* gimp_displays_flush:
|
|
*
|
|
* Flush all internal changes to the user interface
|
|
*
|
|
* This procedure takes no arguments and returns nothing except a
|
|
* success status. Its purpose is to flush all pending updates of image
|
|
* manipulations to the user interface. It should be called whenever
|
|
* appropriate.
|
|
*
|
|
* Returns: TRUE on success.
|
|
**/
|
|
gboolean
|
|
gimp_displays_flush (void)
|
|
{
|
|
GimpPDB *pdb = gimp_get_pdb ();
|
|
GimpValueArray *args;
|
|
GimpValueArray *return_vals;
|
|
gboolean success = TRUE;
|
|
|
|
args = gimp_value_array_new_from_types (NULL,
|
|
G_TYPE_NONE);
|
|
|
|
if (pdb)
|
|
return_vals = gimp_pdb_run_procedure_array (pdb,
|
|
"gimp-displays-flush",
|
|
args);
|
|
else
|
|
return_vals = gimp_run_procedure_array ("gimp-displays-flush",
|
|
args);
|
|
gimp_value_array_unref (args);
|
|
|
|
success = g_value_get_enum (gimp_value_array_index (return_vals, 0)) == GIMP_PDB_SUCCESS;
|
|
|
|
gimp_value_array_unref (return_vals);
|
|
|
|
return success;
|
|
}
|
|
|
|
/**
|
|
* gimp_displays_reconnect:
|
|
* @old_image: The old image (must have at least one display).
|
|
* @new_image: The new image (must not have a display).
|
|
*
|
|
* Reconnect displays from one image to another image.
|
|
*
|
|
* This procedure connects all displays of the old_image to the
|
|
* new_image. If the old_image has no display or new_image already has
|
|
* a display the reconnect is not performed and the procedure returns
|
|
* without success. You should rarely need to use this function.
|
|
*
|
|
* Returns: TRUE on success.
|
|
**/
|
|
gboolean
|
|
gimp_displays_reconnect (GimpImage *old_image,
|
|
GimpImage *new_image)
|
|
{
|
|
GimpPDB *pdb = gimp_get_pdb ();
|
|
GimpValueArray *args;
|
|
GimpValueArray *return_vals;
|
|
gboolean success = TRUE;
|
|
|
|
args = gimp_value_array_new_from_types (NULL,
|
|
GIMP_TYPE_IMAGE, old_image,
|
|
GIMP_TYPE_IMAGE, new_image,
|
|
G_TYPE_NONE);
|
|
|
|
if (pdb)
|
|
return_vals = gimp_pdb_run_procedure_array (pdb,
|
|
"gimp-displays-reconnect",
|
|
args);
|
|
else
|
|
return_vals = gimp_run_procedure_array ("gimp-displays-reconnect",
|
|
args);
|
|
gimp_value_array_unref (args);
|
|
|
|
success = g_value_get_enum (gimp_value_array_index (return_vals, 0)) == GIMP_PDB_SUCCESS;
|
|
|
|
gimp_value_array_unref (return_vals);
|
|
|
|
return success;
|
|
}
|
|
|
|
/**
|
|
* _gimp_displays_reconnect: (skip)
|
|
* @old_image_ID: The old image (must have at least one display).
|
|
* @new_image_ID: The new image (must not have a display).
|
|
*
|
|
* Reconnect displays from one image to another image.
|
|
*
|
|
* This procedure connects all displays of the old_image to the
|
|
* new_image. If the old_image has no display or new_image already has
|
|
* a display the reconnect is not performed and the procedure returns
|
|
* without success. You should rarely need to use this function.
|
|
*
|
|
* Returns: TRUE on success.
|
|
**/
|
|
gboolean
|
|
_gimp_displays_reconnect (gint32 old_image_ID,
|
|
gint32 new_image_ID)
|
|
{
|
|
GimpPDB *pdb = gimp_get_pdb ();
|
|
GimpValueArray *args;
|
|
GimpValueArray *return_vals;
|
|
gboolean success = TRUE;
|
|
|
|
args = gimp_value_array_new_from_types (NULL,
|
|
GIMP_TYPE_IMAGE, gimp_image_get_by_id (old_image_ID),
|
|
GIMP_TYPE_IMAGE, gimp_image_get_by_id (new_image_ID),
|
|
G_TYPE_NONE);
|
|
|
|
if (pdb)
|
|
return_vals = gimp_pdb_run_procedure_array (pdb,
|
|
"gimp-displays-reconnect",
|
|
args);
|
|
else
|
|
return_vals = gimp_run_procedure_array ("gimp-displays-reconnect",
|
|
args);
|
|
gimp_value_array_unref (args);
|
|
|
|
success = g_value_get_enum (gimp_value_array_index (return_vals, 0)) == GIMP_PDB_SUCCESS;
|
|
|
|
gimp_value_array_unref (return_vals);
|
|
|
|
return success;
|
|
}
|