gimp/libgimp/gimpprocedure-params.h

991 lines
40 KiB
C
Raw Normal View History

/* LIBGIMP - The GIMP Library
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* gimpprocedure-params.h
* Copyright (C) 2019 Michael Natterer <mitch@gimp.org>
*
* 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
* Library 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/>.
*/
#if !defined (__GIMP_H_INSIDE__) && !defined (GIMP_COMPILATION)
#error "Only <libgimp/gimp.h> can be included directly."
#endif
#ifndef __GIMP_PROCEDURE_PARAMS_H__
#define __GIMP_PROCEDURE_PARAMS_H__
G_BEGIN_DECLS
/* For information look into the C source or the html documentation */
/**
* SECTION: gimpprocedure-params
* @title: GimpProcedure-params
* @short_description: Macros and defines to add procedure arguments
* and return values.
*
* Macros and defines to add procedure arguments and return values.
**/
/* boolean */
#define GIMP_PROC_ARG_BOOLEAN(procedure, name, nick, blurb, default, flags) \
gimp_procedure_add_argument (procedure,\
g_param_spec_boolean (name, nick, blurb,\
default,\
flags))
#define GIMP_PROC_AUX_ARG_BOOLEAN(procedure, name, nick, blurb, default, flags) \
gimp_procedure_add_aux_argument (procedure,\
g_param_spec_boolean (name, nick, blurb,\
default,\
flags))
#define GIMP_PROC_VAL_BOOLEAN(procedure, name, nick, blurb, default, flags) \
gimp_procedure_add_return_value (procedure,\
g_param_spec_boolean (name, nick, blurb,\
default,\
flags))
#define GIMP_VALUES_GET_BOOLEAN(args, n) \
g_value_get_boolean (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_BOOLEAN(args, n, value) \
g_value_set_boolean (gimp_value_array_index (args, n), value)
/* int */
#define GIMP_PROC_ARG_INT(procedure, name, nick, blurb, min, max, default, flags) \
gimp_procedure_add_argument (procedure,\
g_param_spec_int (name, nick, blurb,\
min, max, default,\
flags))
#define GIMP_PROC_AUX_ARG_INT(procedure, name, nick, blurb, min, max, default, flags) \
gimp_procedure_add_aux_argument (procedure,\
g_param_spec_int (name, nick, blurb,\
min, max, default,\
flags))
#define GIMP_PROC_VAL_INT(procedure, name, nick, blurb, min, max, default, flags) \
gimp_procedure_add_return_value (procedure,\
g_param_spec_int (name, nick, blurb,\
min, max, default,\
flags))
#define GIMP_VALUES_GET_INT(args, n) \
g_value_get_int (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_INT(args, n, value) \
g_value_set_int (gimp_value_array_index (args, n), value)
/* uint */
#define GIMP_PROC_ARG_UINT(procedure, name, nick, blurb, min, max, default, flags) \
gimp_procedure_add_argument (procedure,\
g_param_spec_uint (name, nick, blurb,\
min, max, default,\
flags))
#define GIMP_PROC_AUX_ARG_UINT(procedure, name, nick, blurb, min, max, default, flags) \
gimp_procedure_add_aux_argument (procedure,\
g_param_spec_uint (name, nick, blurb,\
min, max, default,\
flags))
#define GIMP_PROC_VAL_UINT(procedure, name, nick, blurb, min, max, default, flags) \
gimp_procedure_add_return_value (procedure,\
g_param_spec_uint (name, nick, blurb,\
min, max, default,\
flags))
#define GIMP_VALUES_GET_UINT(args, n) \
g_value_get_uint (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_UINT(args, n, value) \
g_value_set_uint (gimp_value_array_index (args, n), value)
/* uchar */
#define GIMP_PROC_ARG_UCHAR(procedure, name, nick, blurb, min, max, default, flags) \
gimp_procedure_add_argument (procedure,\
g_param_spec_uchar (name, nick, blurb,\
min, max, default,\
flags))
#define GIMP_PROC_AUX_ARG_UCHAR(procedure, name, nick, blurb, min, max, default, flags) \
gimp_procedure_add_aux_argument (procedure,\
g_param_spec_uchar (name, nick, blurb,\
min, max, default,\
flags))
#define GIMP_PROC_VAL_UCHAR(procedure, name, nick, blurb, min, max, default, flags) \
gimp_procedure_add_return_value (procedure,\
g_param_spec_uchar (name, nick, blurb,\
min, max, default,\
flags))
#define GIMP_VALUES_GET_UCHAR(args, n) \
g_value_get_uchar (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_UCHAR(args, n, value) \
g_value_set_uchar (gimp_value_array_index (args, n), value)
/* unit */
#define GIMP_PROC_ARG_UNIT(procedure, name, nick, blurb, pixels, percent, default, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_unit (name, nick, blurb,\
pixels, percent, default,\
flags))
#define GIMP_PROC_AUX_ARG_UNIT(procedure, name, nick, blurb, pixels, percent, default, flags) \
gimp_procedure_add_aux_argument (procedure,\
gimp_param_spec_unit (name, nick, blurb,\
pixels, percent, default,\
flags))
#define GIMP_PROC_VAL_UNIT(procedure, name, nick, blurb, pixels, percent, default, flags) \
gimp_procedure_add_return_value (procedure,\
gimp_param_spec_unit (name, nick, blurb,\
pixels, percent, default,\
flags))
/* double */
#define GIMP_PROC_ARG_DOUBLE(procedure, name, nick, blurb, min, max, default, flags) \
gimp_procedure_add_argument (procedure,\
g_param_spec_double (name, nick, blurb,\
min, max, default,\
flags))
#define GIMP_PROC_AUX_ARG_DOUBLE(procedure, name, nick, blurb, min, max, default, flags) \
gimp_procedure_add_aux_argument (procedure,\
g_param_spec_double (name, nick, blurb,\
min, max, default,\
flags))
#define GIMP_PROC_VAL_DOUBLE(procedure, name, nick, blurb, min, max, default, flags) \
gimp_procedure_add_return_value (procedure,\
g_param_spec_double (name, nick, blurb,\
min, max, default,\
flags))
#define GIMP_VALUES_GET_DOUBLE(args, n) \
g_value_get_double (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_DOUBLE(args, n, value) \
g_value_set_double (gimp_value_array_index (args, n), value)
/* enum */
#define GIMP_PROC_ARG_ENUM(procedure, name, nick, blurb, enum_type, default, flags) \
gimp_procedure_add_argument (procedure,\
g_param_spec_enum (name, nick, blurb,\
enum_type, default,\
flags))
#define GIMP_PROC_AUX_ARG_ENUM(procedure, name, nick, blurb, enum_type, default, flags) \
gimp_procedure_add_aux_argument (procedure,\
g_param_spec_enum (name, nick, blurb,\
enum_type, default,\
flags))
#define GIMP_PROC_VAL_ENUM(procedure, name, nick, blurb, enum_type, default, flags) \
gimp_procedure_add_return_value (procedure,\
g_param_spec_enum (name, nick, blurb,\
enum_type, default,\
flags))
#define GIMP_VALUES_GET_ENUM(args, n) \
g_value_get_enum (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_ENUM(args, n, value) \
g_value_set_enum (gimp_value_array_index (args, n), value)
/* choice */
#define GIMP_PROC_ARG_CHOICE(procedure, name, nick, blurb, choice, default, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_choice (name, nick, blurb,\
choice, default,\
flags))
#define GIMP_PROC_AUX_ARG_CHOICE(procedure, name, nick, blurb, choice, default, flags) \
gimp_procedure_add_aux_argument (procedure,\
gimp_param_spec_choice (name, nick, blurb,\
choice, default,\
flags))
#define GIMP_PROC_VAL_CHOICE(procedure, name, nick, blurb, enum_type, default, flags) \
gimp_procedure_add_return_value (procedure,\
gimp_param_spec_choice (name, nick, blurb,\
choice, default,\
flags))
#define GIMP_VALUES_GET_CHOICE(args, n) \
g_value_get_int (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_CHOICE(args, n, value) \
g_value_set_int (gimp_value_array_index (args, n), value)
/* string */
#define GIMP_PROC_ARG_STRING(procedure, name, nick, blurb, default, flags) \
gimp_procedure_add_argument (procedure,\
g_param_spec_string (name, nick, blurb,\
default,\
flags))
#define GIMP_PROC_AUX_ARG_STRING(procedure, name, nick, blurb, default, flags) \
gimp_procedure_add_aux_argument (procedure,\
g_param_spec_string (name, nick, blurb,\
default,\
flags))
#define GIMP_PROC_VAL_STRING(procedure, name, nick, blurb, default, flags) \
gimp_procedure_add_return_value (procedure,\
g_param_spec_string (name, nick, blurb,\
default,\
flags))
#define GIMP_VALUES_GET_STRING(args, n) \
g_value_get_string (gimp_value_array_index (args, n))
#define GIMP_VALUES_DUP_STRING(args, n) \
g_value_dup_string (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_STRING(args, n, value) \
g_value_set_string (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_TAKE_STRING(args, n, value) \
g_value_take_string (gimp_value_array_index (args, n), value)
/* color */
/* TODO:
* 1. has_alpha is currently bogus and doesn't do anything yet.
* 2. Also wouldn't none_ok be useful for color arguments (accepting a NULL
* GeglColor)?
* 3. GEGL also provides a gegl_param_spec_color_from_string() allowing to
* initialize the default with a list of standard colors. Wouldn't it be
* interesting to also have this?
*/
#define GIMP_PROC_ARG_COLOR(procedure, name, nick, blurb, has_alpha, default, flags) \
gimp_procedure_add_argument (procedure,\
gegl_param_spec_color (name, nick, blurb,\
default, \
flags))
#define GIMP_PROC_AUX_ARG_COLOR(procedure, name, nick, blurb, has_alpha, default, flags) \
gimp_procedure_add_aux_argument (procedure,\
gegl_param_spec_color (name, nick, blurb,\
default, \
flags))
#define GIMP_PROC_VAL_COLOR(procedure, name, nick, blurb, has_alpha, default, flags) \
gimp_procedure_add_return_value (procedure,\
gegl_param_spec_color (name, nick, blurb,\
default, \
flags))
#define GIMP_VALUES_GET_COLOR(args, n, value) \
g_value_get_object (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_SET_COLOR(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* rgb */
#define GIMP_PROC_ARG_RGB(procedure, name, nick, blurb, has_alpha, default, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_rgb (name, nick, blurb,\
has_alpha, default, \
flags))
#define GIMP_PROC_AUX_ARG_RGB(procedure, name, nick, blurb, has_alpha, default, flags) \
gimp_procedure_add_aux_argument (procedure,\
gimp_param_spec_rgb (name, nick, blurb,\
has_alpha, default, \
flags))
#define GIMP_PROC_VAL_RGB(procedure, name, nick, blurb, has_alpha, default, flags) \
gimp_procedure_add_return_value (procedure,\
gimp_param_spec_rgb (name, nick, blurb,\
has_alpha, default, \
flags))
#define GIMP_VALUES_GET_RGB(args, n, value) \
gimp_value_get_rgb (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_SET_RGB(args, n, value) \
gimp_value_set_rgb (gimp_value_array_index (args, n), value)
/* parasite */
#define GIMP_PROC_ARG_PARASITE(procedure, name, nick, blurb, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_parasite (name, nick, blurb,\
flags))
#define GIMP_PROC_AUX_ARG_PARASITE(procedure, name, nick, blurb, flags) \
gimp_procedure_add_aux_argument (procedure,\
gimp_param_spec_parasite (name, nick, blurb,\
flags))
#define GIMP_PROC_VAL_PARASITE(procedure, name, nick, blurb, flags) \
gimp_procedure_add_return_value (procedure,\
gimp_param_spec_parasite (name, nick, blurb,\
flags))
#define GIMP_VALUES_GET_PARASITE(args, n) \
g_value_get_boxed (gimp_value_array_index (args, n))
#define GIMP_VALUES_DUP_PARASITE(args, n) \
g_value_dup_boxed (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_PARASITE(args, n, value) \
g_value_set_boxed (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_TAKE_PARASITE(args, n, value) \
g_value_take_boxed (gimp_value_array_index (args, n), value)
/* param */
#define GIMP_PROC_ARG_PARAM(procedure, name, nick, blurb, param_type, flags) \
gimp_procedure_add_argument (procedure,\
g_param_spec_param (name, nick, blurb, param_type, \
flags))
#define GIMP_PROC_AUX_ARG_PARAM(procedure, name, nick, blurb, param_type, flags) \
gimp_procedure_add_aux_argument (procedure,\
g_param_spec_param (name, nick, blurb, param_type, \
flags))
#define GIMP_PROC_VAL_PARAM(procedure, name, nick, blurb, param_type, flags) \
gimp_procedure_add_return_value (procedure,\
g_param_spec_param (name, nick, blurb, param_type, \
flags))
#define GIMP_VALUES_GET_PARAM(args, n) \
g_value_get_param (gimp_value_array_index (args, n))
#define GIMP_VALUES_DUP_PARAM(args, n) \
g_value_dup_param (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_PARAM(args, n, value) \
g_value_set_param (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_TAKE_PARAM(args, n, value) \
g_value_take_param (gimp_value_array_index (args, n), value)
/* bytes */
#define GIMP_PROC_ARG_BYTES(procedure, name, nick, blurb, flags) \
gimp_procedure_add_argument (procedure,\
g_param_spec_boxed (name, nick, blurb,\
G_TYPE_BYTES, flags))
#define GIMP_PROC_AUX_ARG_BYTES(procedure, name, nick, blurb, flags) \
gimp_procedure_add_aux_argument (procedure,\
g_param_spec_boxed (name, nick, blurb,\
G_TYPE_BYTES, flags))
#define GIMP_PROC_VAL_BYTES(procedure, name, nick, blurb, flags) \
gimp_procedure_add_return_value (procedure,\
g_param_spec_boxed (name, nick, blurb,\
G_TYPE_BYTES, flags))
#define GIMP_VALUES_GET_BYTES(args, n) \
g_value_get_boxed (gimp_value_array_index (args, n))
#define GIMP_VALUES_DUP_BYTES(args, n) \
g_value_dup_boxed (gimp_value_array_index (args, n))
app, libgimp*, pdb, plug-ins: reimplement generic inter-process transient window. Having windows ID as guint32 is a mistake. Different systems have different protocols. In Wayland in particular, Windows handles are exchanged as strings. What this commit does is the following: In core: - get_window_id() virtual function in core GimpProgress is changed to return a GBytes, as a generic "data" to represent a window differently on different systems. - All implementations of get_window_id() in various classes implementing this interface are updated accordingly: * GimpSubProgress * GimpDisplay returns the handle of its shell. * GimpDisplayShell now creates its window handle at construction with libgimpwidget's gimp_widget_set_native_handle() and simply return this handle every time it's requested. * GimpFileDialog also creates its window handle at construction with gimp_widget_set_native_handle(). - gimp_window_set_transient_for() in core is changed to take a GimpProgress as argument (instead of a guint32 ID), requests and process the ID itself, according to the running platform. In particular, the following were improved: * Unlike old code, it will work even if the window is not visible yet. In such a case, the function simply adds a signal handler to set transient at mapping. It makes it easier to use it at construction in a reliable way. * It now works for Wayland too, additionally to X11. - GimpPdbProgress now exchanges a GBytes too with the command GIMP_PROGRESS_COMMAND_GET_WINDOW. - display_get_window_id() in gimp-gui.h also returns a GBytes now. PDB/libgimp: - gimp_display_get_window_handle() and gimp_progress_get_window_handle() now return a GBytes to represent a window handle in an opaque way (depending on the running platform). In libgimp: - GimpProgress's get_window() virtual function changed to return a GBytes and renamed get_window_handle(). - In particular GimpProgressBar is the only implementation of get_window_handle(). It creates its handle at object construction with libgimpwidget's gimp_widget_set_native_handle() and the virtual method's implementation simply returns the GBytes. In libgimpUi: - gimp_ui_get_display_window() and gimp_ui_get_progress_window() were removed. We should not assume anymore that it is possible to create a GdkWindow to be used. For instance this is not possible with Wayland which has its own way to set a window transient with a string handle. - gimp_window_set_transient_for_display() and gimp_window_set_transient() now use an internal implementation similar to core gimp_window_set_transient_for(), with the same improvements (works even at construction when the window is not visible yet + works for Wayland too). In libgimpwidgets: - New gimp_widget_set_native_handle() is a helper function used both in core and libgimp* libraries for widgets which we want to be usable as possible parents. It takes care of getting the relevant window handle (depending on the running platform) and stores it in a given pointer, either immediately or after a callback once the widget is mapped. So it can be used at construction. Also it sets a handle for X11 or Wayland. In plug-ins: - Screenshot uses the new gimp_progress_get_window_handle() directly now in its X11 code path and creates out of it a GdkWindows itself with gdk_x11_window_foreign_new_for_display(). Our inter-process transient implementation only worked for X11, and with this commit, it works for Wayland too. There is code for Windows but it is currently disabled as it apparently hangs (there is a comment in-code which links to this old report: https://bugzilla.gnome.org/show_bug.cgi?id=359538). NikcDC tested yesterday with re-enabling the code and said they experienced a freeze. ;-( Finally there is no infrastructure yet to make this work on macOS and apparently there is no implementation of window handle in GDK for macOS that I could find. I'm not sure if macOS doesn't have this concept of setting transient on another processus's window or GDK is simply lacking the implementation.
2023-08-14 20:23:06 +08:00
#define GIMP_VALUES_SET_BYTES(args, n, value) \
g_value_set_boxed (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_TAKE_BYTES(args, n, value, length) \
g_value_take_boxed (gimp_value_array_index (args, n), value)
/* int32 array */
#define GIMP_PROC_ARG_INT32_ARRAY(procedure, name, nick, blurb, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_int32_array (name, nick, blurb,\
flags))
#define GIMP_PROC_AUX_ARG_INT32_ARRAY(procedure, name, nick, blurb, flags) \
gimp_procedure_add_aux_argument (procedure,\
gimp_param_spec_int32_array (name, nick, blurb,\
flags))
#define GIMP_PROC_VAL_INT32_ARRAY(procedure, name, nick, blurb, flags) \
gimp_procedure_add_return_value (procedure,\
gimp_param_spec_int32_array (name, nick, blurb,\
flags))
#define GIMP_VALUES_GET_INT32_ARRAY(args, n) \
gimp_value_get_int32_array (gimp_value_array_index (args, n))
#define GIMP_VALUES_DUP_INT32_ARRAY(args, n) \
gimp_value_dup_int32_array (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_INT32_ARRAY(args, n, value, length) \
gimp_value_set_int32_array (gimp_value_array_index (args, n), value, length)
#define GIMP_VALUES_TAKE_INT32_ARRAY(args, n, value, length) \
gimp_value_take_int32_array (gimp_value_array_index (args, n), value, length)
/* float array */
#define GIMP_PROC_ARG_FLOAT_ARRAY(procedure, name, nick, blurb, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_float_array (name, nick, blurb,\
flags))
#define GIMP_PROC_AUX_ARG_FLOAT_ARRAY(procedure, name, nick, blurb, flags) \
gimp_procedure_add_aux_argument (procedure,\
gimp_param_spec_float_array (name, nick, blurb,\
flags))
#define GIMP_PROC_VAL_FLOAT_ARRAY(procedure, name, nick, blurb, flags) \
gimp_procedure_add_return_value (procedure,\
gimp_param_spec_float_array (name, nick, blurb,\
flags))
#define GIMP_VALUES_GET_FLOAT_ARRAY(args, n) \
gimp_value_get_float_array (gimp_value_array_index (args, n))
#define GIMP_VALUES_DUP_FLOAT_ARRAY(args, n) \
gimp_value_dup_float_array (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_FLOAT_ARRAY(args, n, value, length) \
gimp_value_set_float_array (gimp_value_array_index (args, n), value, length)
#define GIMP_VALUES_TAKE_FLOAT_ARRAY(args, n, value, length) \
gimp_value_take_float_array (gimp_value_array_index (args, n), value, length)
/* string array (strv) */
#define GIMP_PROC_ARG_STRV(procedure, name, nick, blurb, flags) \
gimp_procedure_add_argument (procedure,\
g_param_spec_boxed (name, nick, blurb,\
G_TYPE_STRV, flags))
#define GIMP_PROC_AUX_ARG_STRV(procedure, name, nick, blurb, flags) \
gimp_procedure_add_aux_argument (procedure,\
g_param_spec_boxed (name, nick, blurb,\
G_TYPE_STRV, flags))
#define GIMP_PROC_VAL_STRV(procedure, name, nick, blurb, flags) \
gimp_procedure_add_return_value (procedure,\
g_param_spec_boxed (name, nick, blurb,\
G_TYPE_STRV, flags))
#define GIMP_VALUES_GET_STRV(args, n) \
g_value_get_boxed (gimp_value_array_index (args, n))
#define GIMP_VALUES_DUP_STRV(args, n) \
g_value_dup_boxed (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_STRV(args, n, value) \
g_value_set_boxed (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_TAKE_STRV(args, n, value) \
g_value_take_boxed (gimp_value_array_index (args, n), value)
/* rgb array */
#define GIMP_PROC_ARG_RGB_ARRAY(procedure, name, nick, blurb, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_rgb_array (name, nick, blurb,\
flags))
#define GIMP_PROC_AUX_ARG_RGB_ARRAY(procedure, name, nick, blurb, flags) \
gimp_procedure_add_aux_argument (procedure,\
gimp_param_spec_rgb_array (name, nick, blurb,\
flags))
#define GIMP_PROC_VAL_RGB_ARRAY(procedure, name, nick, blurb, flags) \
gimp_procedure_add_return_value (procedure,\
gimp_param_spec_rgb_array (name, nick, blurb,\
flags))
#define GIMP_VALUES_GET_RGB_ARRAY(args, n) \
gimp_value_get_rgb_array (gimp_value_array_index (args, n))
#define GIMP_VALUES_DUP_RGB_ARRAY(args, n) \
gimp_value_dup_rgb_array (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_RGB_ARRAY(args, n, value, length) \
gimp_value_set_rgb_array (gimp_value_array_index (args, n), value, length)
#define GIMP_VALUES_TAKE_RGB_ARRAY(args, n, value, length) \
gimp_value_take_rgb_array (gimp_value_array_index (args, n), value, length)
/* object array */
#define GIMP_PROC_ARG_OBJECT_ARRAY(procedure, name, nick, blurb, object_type, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_object_array (name, nick, blurb,\
object_type, flags))
#define GIMP_PROC_AUX_ARG_OBJECT_ARRAY(procedure, name, nick, blurb, object_type, flags) \
gimp_procedure_add_aux_argument (procedure,\
gimp_param_spec_object_array (name, nick, blurb,\
object_type, flags))
#define GIMP_PROC_VAL_OBJECT_ARRAY(procedure, name, nick, blurb, object_type, flags) \
gimp_procedure_add_return_value (procedure,\
gimp_param_spec_object_array (name, nick, blurb,\
object_type, flags))
#define GIMP_VALUES_GET_OBJECT_ARRAY(args, n) \
(gpointer) gimp_value_get_object_array (gimp_value_array_index (args, n))
#define GIMP_VALUES_DUP_OBJECT_ARRAY(args, n) \
(gpointer) gimp_value_dup_object_array (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_OBJECT_ARRAY(args, n, object_type, value, length) \
gimp_value_set_object_array (gimp_value_array_index (args, n),\
object_type, (gpointer) value, length)
#define GIMP_VALUES_TAKE_OBJECT_ARRAY(args, n, object_type, value, length) \
gimp_value_take_object_array (gimp_value_array_index (args, n),\
object_type, (gpointer) value, length)
/* display */
#define GIMP_PROC_ARG_DISPLAY(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_display (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_AUX_ARG_DISPLAY(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_aux_argument (procedure,\
gimp_param_spec_display (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_VAL_DISPLAY(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_return_value (procedure,\
gimp_param_spec_display (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_VALUES_GET_DISPLAY(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_DISPLAY_ID(args, n) \
gimp_display_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_DISPLAY(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* image */
#define GIMP_PROC_ARG_IMAGE(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_image (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_AUX_ARG_IMAGE(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_aux_argument (procedure,\
gimp_param_spec_image (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_VAL_IMAGE(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_return_value (procedure,\
gimp_param_spec_image (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_VALUES_GET_IMAGE(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_IMAGE_ID(args, n) \
gimp_image_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_IMAGE(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* item */
#define GIMP_PROC_ARG_ITEM(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_item (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_AUX_ARG_ITEM(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_aux_argument (procedure,\
gimp_param_spec_item (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_VAL_ITEM(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_return_value (procedure,\
gimp_param_spec_item (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_VALUES_GET_ITEM(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_ITEM_ID(args, n) \
gimp_item_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_ITEM(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* drawable */
#define GIMP_PROC_ARG_DRAWABLE(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_drawable (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_AUX_ARG_DRAWABLE(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_aux_argument (procedure,\
gimp_param_spec_drawable (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_VAL_DRAWABLE(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_return_value (procedure,\
gimp_param_spec_drawable (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_VALUES_GET_DRAWABLE(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_DRAWABLE_ID(args, n) \
gimp_item_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_DRAWABLE(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* layer */
#define GIMP_PROC_ARG_LAYER(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_layer (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_AUX_ARG_LAYER(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_aux_argument (procedure,\
gimp_param_spec_layer (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_VAL_LAYER(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_return_value (procedure,\
gimp_param_spec_layer (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_VALUES_GET_LAYER(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_LAYER_ID(args, n) \
gimp_item_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_LAYER(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* text layer */
#define GIMP_PROC_ARG_TEXT_LAYER(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_text_layer (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_AUX_ARG_TEXT_LAYER(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_aux_argument (procedure,\
gimp_param_spec_text_layer (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_VAL_TEXT_LAYER(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_return_value (procedure,\
gimp_param_spec_text_layer (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_VALUES_GET_TEXT_LAYER(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_TEXT_LAYER_ID(args, n) \
gimp_item_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_TEXT_LAYER(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* channel */
#define GIMP_PROC_ARG_CHANNEL(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_channel (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_AUX_ARG_CHANNEL(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_aux_argument (procedure,\
gimp_param_spec_channel (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_VAL_CHANNEL(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_return_value (procedure,\
gimp_param_spec_channe (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_VALUES_GET_CHANNEL(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_CHANNEL_ID(args, n) \
gimp_item_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_CHANNEL(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* layer mask */
#define GIMP_PROC_ARG_LAYER_MASK(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_layer_mask (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_AUX_ARG_LAYER_MASK(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_aux_argument (procedure,\
gimp_param_spec_layer_mask (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_VAL_LAYER_MASK(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_return_value (procedure,\
gimp_param_spec_layer_mask (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_VALUES_GET_LAYER_MASK(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_LAYER_MASK_ID(args, n) \
gimp_item_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_LAYER_MASK(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* selection */
#define GIMP_PROC_ARG_SELECTION(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_selection (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_AUX_ARG_SELECTION(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_aux_argument (procedure,\
gimp_param_spec_selection (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_VAL_SELECTION(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_return_value (procedure,\
gimp_param_spec_selection (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_VALUES_GET_SELECTION(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_SELECTION_ID(args, n) \
gimp_item_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_SELECTION(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* vectors */
#define GIMP_PROC_ARG_VECTORS(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_vectors (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_AUX_ARG_VECTORS(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_aux_argument (procedure,\
gimp_param_spec_vectors (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_PROC_VAL_VECTORS(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_return_value (procedure,\
gimp_param_spec_vectors (name, nick, blurb,\
none_ok,\
flags))
#define GIMP_VALUES_GET_VECTORS(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_VECTORS_ID(args, n) \
gimp_item_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_VECTORS(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* file */
#define GIMP_PROC_ARG_FILE(procedure, name, nick, blurb, flags) \
gimp_procedure_add_argument (procedure,\
g_param_spec_object (name, nick, blurb,\
G_TYPE_FILE,\
flags))
#define GIMP_PROC_AUX_ARG_FILE(procedure, name, nick, blurb, flags) \
gimp_procedure_add_aux_argument (procedure,\
g_param_spec_object (name, nick, blurb,\
G_TYPE_FILE,\
flags))
#define GIMP_PROC_VAL_FILE(procedure, name, nick, blurb, none_ok, flags) \
gimp_procedure_add_return_value (procedure,\
g_param_spec_object (name, nick, blurb,\
G_TYPE_FILE,\
flags))
#define GIMP_VALUES_GET_FILE(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_DUP_FILE(args, n) \
g_value_dup_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_FILE(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_TAKE_FILE(args, n, value) \
g_value_take_object (gimp_value_array_index (args, n), value)
/* Resource */
#define GIMP_PROC_ARG_RESOURCE(procedure, name, nick, blurb, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_resource (name, nick, blurb,\
GIMP_TYPE_RESOURCE,\
flags))
#define GIMP_PROC_ARG_BRUSH(procedure, name, nick, blurb, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_brush (name, nick, blurb,\
GIMP_TYPE_BRUSH,\
flags))
#define GIMP_PROC_ARG_FONT(procedure, name, nick, blurb, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_font (name, nick, blurb,\
GIMP_TYPE_FONT,\
flags))
#define GIMP_PROC_ARG_GRADIENT(procedure, name, nick, blurb, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_gradient (name, nick, blurb,\
GIMP_TYPE_GRADIENT,\
flags))
#define GIMP_PROC_ARG_PALETTE(procedure, name, nick, blurb, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_palette (name, nick, blurb,\
GIMP_TYPE_PALETTE,\
flags))
#define GIMP_PROC_ARG_PATTERN(procedure, name, nick, blurb, flags) \
gimp_procedure_add_argument (procedure,\
gimp_param_spec_pattern (name, nick, blurb,\
GIMP_TYPE_PATTERN,\
flags))
#define GIMP_VALUES_GET_RESOURCE(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_RESOURCE(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_GET_BRUSH(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_BRUSH(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_GET_FONT(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_FONT(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_GET_GRADIENT(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_GRADIENT(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_GET_PALETTE(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_PALETTE(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_GET_PATTERN(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_PATTERN(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
G_END_DECLS
#endif /* __GIMP_PROCEDURE_PARAMS_H__ */