Class
GimpProcedure
Description [src]
class Gimp.Procedure : GObject.Object {
parent_instance: GObject
}Procedures are registered functions which can be run across GIMP ecosystem. They can be created by plug-ins and can then run by the core application when called from menus (or through other interaction depending on specific procedure subclasses).
A plug-in can also run procedures created by the core, but also the ones
created by other plug-ins (see GimpPDB).
Constructors
gimp_procedure_new
Creates a new procedure named name which will call run_func when invoked.
since: 3.0
Instance methods
gimp_procedure_add_boolean_aux_argument
Add a new boolean auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_brush_aux_argument
Add a new GimpBrush auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_channel_aux_argument
Add a new GimpChannel auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_choice_aux_argument
Add a new GimpChoice auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_color_aux_argument
Add a new GeglColor auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_color_from_string_argument
Add a new GeglColor argument to procedure from a string representation.
since: 3.0
gimp_procedure_add_color_from_string_aux_argument
Add a new GeglColor auxiliary argument to procedure from a string representation.
since: 3.0
gimp_procedure_add_color_from_string_return_value
Add a new GeglColor return value to procedure from a string representation.
since: 3.0
gimp_procedure_add_core_object_array_argument
Add a new object array argument to procedure.
since: 3.0
gimp_procedure_add_core_object_array_aux_argument
Add a new object array auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_core_object_array_return_value
Add a new object array return value to procedure.
since: 3.0
gimp_procedure_add_display_aux_argument
Add a new GimpDisplay auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_double_argument
Add a new floating-point in double precision argument to procedure.
since: 3.0
gimp_procedure_add_double_array_aux_argument
Add a new double array auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_double_array_return_value
Add a new double array return value to procedure.
since: 3.0
gimp_procedure_add_double_aux_argument
Add a new floating-point in double precision auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_double_return_value
Add a new floating-point in double precision return value to procedure.
since: 3.0
gimp_procedure_add_drawable_aux_argument
Add a new GimpDrawable auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_drawable_return_value
Add a new GimpDrawable return value to procedure.
since: 3.0
gimp_procedure_add_gradient_aux_argument
Add a new GimpGradient auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_gradient_return_value
Add a new GimpGradient return value to procedure.
since: 3.0
gimp_procedure_add_group_layer_aux_argument
Add a new GimpGroupLayer auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_group_layer_return_value
Add a new GimpGroupLayer return value to procedure.
since: 3.0
gimp_procedure_add_image_aux_argument
Add a new GimpImage auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_int32_array_aux_argument
Add a new integer array auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_int32_array_return_value
Add a new integer array return value to procedure.
since: 3.0
gimp_procedure_add_layer_aux_argument
Add a new GimpLayer auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_layer_mask_aux_argument
Add a new GimpLayerMask auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_layer_mask_return_value
Add a new GimpLayerMask return value to procedure.
since: 3.0
gimp_procedure_add_menu_path
Adds a menu path to the procedure. Only procedures which have a menu label can add a menu path.
since: 3.0
gimp_procedure_add_palette_aux_argument
Add a new GimpPalette auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_parasite_aux_argument
Add a new GimpParasite auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_parasite_return_value
Add a new GimpParasite return value to procedure.
since: 3.0
gimp_procedure_add_pattern_aux_argument
Add a new GimpPattern auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_resource_aux_argument
Add a new GimpResource auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_resource_return_value
Add a new GimpResource return value to procedure.
since: 3.0
gimp_procedure_add_selection_aux_argument
Add a new GimpSelection auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_selection_return_value
Add a new GimpSelection return value to procedure.
since: 3.0
gimp_procedure_add_string_array_aux_argument
Add a new string array auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_string_array_return_value
Add a new string array return value to procedure.
since: 3.0
gimp_procedure_add_text_layer_aux_argument
Add a new GimpTextLayer auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_text_layer_return_value
Add a new GimpTextLayer return value to procedure.
since: 3.0
gimp_procedure_add_uint_aux_argument
Add a new unsigned integer auxiliary argument to procedure.
since: 3.0
gimp_procedure_add_uint_return_value
Add a new unsigned integer return value to procedure.
since: 3.0
gimp_procedure_create_config
Create a GimpConfig with properties that match procedure‘s arguments, to be
used in gimp_procedure_run_config() method.
since: 3.0
gimp_procedure_find_argument
Searches the procedure‘s arguments for a GParamSpec called name.
since: 3.0
gimp_procedure_find_aux_argument
Searches the procedure‘s auxiliary arguments for a GParamSpec
called name.
since: 3.0
gimp_procedure_find_return_value
Searches the procedure‘s return values for a GParamSpec called
name.
since: 3.0
gimp_procedure_get_icon_pixbuf
Gets the GdkPixbuf of the icon if an icon was set this way for
procedure.
since: 3.0
gimp_procedure_get_icon_type
Gets the type of data set as procedure‘s icon. Depending on the
result, you can call the relevant specific function, such as
gimp_procedure_get_icon_name().
since: 3.0
gimp_procedure_get_image_types
This function retrieves the list of image types the procedure can operate on. See gimp_procedure_set_image_types().
since: 3.0
gimp_procedure_persistent_ready
Notify the main GIMP application that the persistent procedure has been properly initialized and is ready to run.
since: 3.0
gimp_procedure_run
Runs the procedure named procedure_name with arguments given as
list of (name, value) pairs, terminated by NULL.
since: 3.0
gimp_procedure_run_config
Runs procedure, calling the run_func given in gimp_procedure_new().
since: 3.0
gimp_procedure_run_valist
Runs procedure with arguments names and values, given in the order as passed
to gimp_procedure_run().
since: 3.0
gimp_procedure_set_argument_sync
When the procedure’s run() function exits, a GimpProcedure‘s arguments
or auxiliary arguments can be automatically synced with a GimpParasite of
the GimpImage the procedure is running on.
since: 3.0
gimp_procedure_set_icon_file
Sets the icon for procedure to the contents of an image file.
since: 3.0
gimp_procedure_set_icon_name
Sets the icon for procedure to the icon referenced by icon_name.
since: 3.0
gimp_procedure_set_image_types
This is a comma separated list of image types, or actually drawable types, that this procedure can deal with. Wildcards are possible here, so you could say “RGB” instead of “RGB, RGBA” or “” for all image types.
since: 3.0
gimp_procedure_set_menu_label
Sets the label to use for the procedure‘s menu entry, The
location(s) where to register in the menu hierarchy is chosen using gimp_procedure_add_menu_path().
since: 3.0
gimp_procedure_set_sensitivity_mask
Sets the case when procedure is supposed to be sensitive or not.
Note that it will be used by the core to determine whether to show a
procedure as sensitive (hence forbid running it otherwise), yet it
will not forbid thid-party plug-ins for instance to run manually your
registered procedure. Therefore you should still handle non-supported
cases appropriately by returning with GIMP_PDB_EXECUTION_ERROR and a
suitable error message.
since: 3.0
Signals
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Class structure
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
);
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
);
}Class members
parent_class: GObjectClass- No description available.
install: void (* install) ( GimpProcedure* procedure )- No description available.
uninstall: void (* uninstall) ( GimpProcedure* procedure )- No description available.
run: GimpValueArray* (* run) ( GimpProcedure* procedure, const GimpValueArray* args )- No description available.
create_config: GimpProcedureConfig* (* create_config) ( GimpProcedure* procedure, GParamSpec** args, gint n_args )- No description available.
set_sensitivity: gboolean (* set_sensitivity) ( GimpProcedure* procedure, gint sensitivity_mask )- No description available.
_gimp_reserved0: void (* _gimp_reserved0) ( void )- No description available.
_gimp_reserved1: void (* _gimp_reserved1) ( void )- No description available.
_gimp_reserved2: void (* _gimp_reserved2) ( void )- No description available.
_gimp_reserved3: void (* _gimp_reserved3) ( void )- No description available.
_gimp_reserved4: void (* _gimp_reserved4) ( void )- No description available.
_gimp_reserved5: void (* _gimp_reserved5) ( void )- No description available.
_gimp_reserved6: void (* _gimp_reserved6) ( void )- No description available.
_gimp_reserved7: void (* _gimp_reserved7) ( void )- No description available.
_gimp_reserved8: void (* _gimp_reserved8) ( void )- No description available.
_gimp_reserved9: void (* _gimp_reserved9) ( void )- No description available.