/* GIMP - The GNU Image Manipulation Program * Copyright (C) 1995 Spencer Kimball and Peter Mattis * * gimpprocedure.h * Copyright (C) 2019 Michael Natterer * * 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 * . */ #if !defined (__GIMP_H_INSIDE__) && !defined (GIMP_COMPILATION) #error "Only can be included directly." #endif #ifndef __GIMP_PROCEDURE_H__ #define __GIMP_PROCEDURE_H__ G_BEGIN_DECLS /* For information look into the C source or the html documentation */ /** * GimpRunFunc: * @procedure: the #GimpProcedure that runs. * @config: the @procedure's arguments in a config object. * @run_data: (closure): the run_data given in gimp_procedure_new(). * * The run function is run during the lifetime of the GIMP session, * each time a plug-in procedure is called. * * Returns: (transfer full): the @procedure's return values. * * Since: 3.0 **/ typedef GimpValueArray * (* GimpRunFunc) (GimpProcedure *procedure, GimpProcedureConfig *config, gpointer run_data); /** * GimpArgumentSync: * @GIMP_ARGUMENT_SYNC_NONE: Don't sync this argument * @GIMP_ARGUMENT_SYNC_PARASITE: Sync this argument with an image parasite * * Methods of syncing procedure arguments. * * Since: 3.0 **/ typedef enum { GIMP_ARGUMENT_SYNC_NONE, GIMP_ARGUMENT_SYNC_PARASITE } GimpArgumentSync; #define GIMP_TYPE_PROCEDURE (gimp_procedure_get_type ()) G_DECLARE_DERIVABLE_TYPE (GimpProcedure, gimp_procedure, GIMP, PROCEDURE, GObject) /** * GimpProcedureClass: * @install: called to install the procedure with the main GIMP * application. This is an implementation detail and must never * be called by any plug-in code. * @uninstall: called to uninstall the procedure from the main GIMP * application. This is an implementation detail and must never * be called by any plug-in code. * @run: called when the procedure is executed via gimp_procedure_run(). * the default implementation simply calls the procedure's #GimpRunFunc, * #GimpProcedure subclasses are free to modify the passed @args and * call their own, subclass-specific run functions. * @create_config: called when a #GimpConfig object is created using * gimp_procedure_create_config(). * * Since: 3.0 **/ struct _GimpProcedureClass { GObjectClass parent_class; void (* install) (GimpProcedure *procedure); void (* uninstall) (GimpProcedure *procedure); GimpValueArray * (* run) (GimpProcedure *procedure, const GimpValueArray *args); GimpProcedureConfig * (* create_config) (GimpProcedure *procedure, GParamSpec **args, gint n_args); gboolean (* set_sensitivity) (GimpProcedure *procedure, gint sensitivity_mask); /* Padding for future expansion */ /*< private >*/ void (*_gimp_reserved0) (void); void (*_gimp_reserved1) (void); void (*_gimp_reserved2) (void); void (*_gimp_reserved3) (void); void (*_gimp_reserved4) (void); void (*_gimp_reserved5) (void); void (*_gimp_reserved6) (void); void (*_gimp_reserved7) (void); void (*_gimp_reserved8) (void); void (*_gimp_reserved9) (void); }; GimpProcedure * gimp_procedure_new (GimpPlugIn *plug_in, const gchar *name, GimpPDBProcType proc_type, GimpRunFunc run_func, gpointer run_data, GDestroyNotify run_data_destroy); GimpPlugIn * gimp_procedure_get_plug_in (GimpProcedure *procedure); const gchar * gimp_procedure_get_name (GimpProcedure *procedure); GimpPDBProcType gimp_procedure_get_proc_type (GimpProcedure *procedure); void gimp_procedure_set_image_types (GimpProcedure *procedure, const gchar *image_types); const gchar * gimp_procedure_get_image_types (GimpProcedure *procedure); void gimp_procedure_set_sensitivity_mask (GimpProcedure *procedure, gint sensitivity_mask); gint gimp_procedure_get_sensitivity_mask (GimpProcedure *procedure); void gimp_procedure_set_menu_label (GimpProcedure *procedure, const gchar *menu_label); const gchar * gimp_procedure_get_menu_label (GimpProcedure *procedure); void gimp_procedure_add_menu_path (GimpProcedure *procedure, const gchar *menu_path); GList * gimp_procedure_get_menu_paths (GimpProcedure *procedure); void gimp_procedure_set_icon_name (GimpProcedure *procedure, const gchar *icon_name); void gimp_procedure_set_icon_file (GimpProcedure *procedure, GFile *file); void gimp_procedure_set_icon_pixbuf (GimpProcedure *procedure, GdkPixbuf *pixbuf); GimpIconType gimp_procedure_get_icon_type (GimpProcedure *procedure); const gchar * gimp_procedure_get_icon_name (GimpProcedure *procedure); GFile * gimp_procedure_get_icon_file (GimpProcedure *procedure); GdkPixbuf * gimp_procedure_get_icon_pixbuf (GimpProcedure *procedure); void gimp_procedure_set_documentation (GimpProcedure *procedure, const gchar *blurb, const gchar *help, const gchar *help_id); const gchar * gimp_procedure_get_blurb (GimpProcedure *procedure); const gchar * gimp_procedure_get_help (GimpProcedure *procedure); const gchar * gimp_procedure_get_help_id (GimpProcedure *procedure); void gimp_procedure_set_attribution (GimpProcedure *procedure, const gchar *authors, const gchar *copyright, const gchar *date); const gchar * gimp_procedure_get_authors (GimpProcedure *procedure); const gchar * gimp_procedure_get_copyright (GimpProcedure *procedure); const gchar * gimp_procedure_get_date (GimpProcedure *procedure); GParamSpec * gimp_procedure_find_argument (GimpProcedure *procedure, const gchar *name); GParamSpec * gimp_procedure_find_aux_argument (GimpProcedure *procedure, const gchar *name); GParamSpec * gimp_procedure_find_return_value (GimpProcedure *procedure, const gchar *name); GParamSpec ** gimp_procedure_get_arguments (GimpProcedure *procedure, gint *n_arguments); GParamSpec ** gimp_procedure_get_aux_arguments (GimpProcedure *procedure, gint *n_arguments); GParamSpec ** gimp_procedure_get_return_values (GimpProcedure *procedure, gint *n_return_values); void gimp_procedure_set_argument_sync (GimpProcedure *procedure, const gchar *arg_name, GimpArgumentSync sync); GimpArgumentSync gimp_procedure_get_argument_sync (GimpProcedure *procedure, const gchar *arg_name); GimpValueArray * gimp_procedure_new_return_values (GimpProcedure *procedure, GimpPDBStatusType status, GError *error); GimpValueArray * gimp_procedure_run (GimpProcedure *procedure, const gchar *first_arg_name, ...) G_GNUC_NULL_TERMINATED; GimpValueArray * gimp_procedure_run_valist (GimpProcedure *procedure, const gchar *first_arg_name, va_list args); GimpValueArray * gimp_procedure_run_config (GimpProcedure *procedure, GimpProcedureConfig *config); void gimp_procedure_persistent_ready (GimpProcedure *procedure); GimpProcedureConfig * gimp_procedure_create_config (GimpProcedure *procedure); gboolean gimp_procedure_is_internal (GimpProcedure *procedure); /* Internal use */ G_GNUC_INTERNAL GParamSpec * _gimp_procedure_add_argument (GimpProcedure *procedure, GParamSpec *pspec); G_GNUC_INTERNAL GParamSpec * _gimp_procedure_add_aux_argument (GimpProcedure *procedure, GParamSpec *pspec); G_GNUC_INTERNAL GParamSpec * _gimp_procedure_add_return_value (GimpProcedure *procedure, GParamSpec *pspec); G_GNUC_INTERNAL GimpProcedureConfig * _gimp_procedure_create_run_config (GimpProcedure *procedure); G_GNUC_INTERNAL GimpValueArray * _gimp_procedure_run_array (GimpProcedure *procedure, GimpValueArray *args); G_GNUC_INTERNAL gint _gimp_procedure_get_ref_count (GimpProcedure *procedure, GObject *object); G_END_DECLS #endif /* __GIMP_PROCEDURE_H__ */