Procedure

---

Object Hierarchy:

Description:

Content:

Properties:

• public string name { get; construct; }
• public PlugIn plug_in { get; construct; }
• public PDBProcType procedure_type { get; construct; }

Creation methods:

• public Procedure (PlugIn plug_in, string name, PDBProcType proc_type, owned RunFunc run_func)
  Creates a new procedure named name which will call run_func when invoked.

Methods:

• public void add_boolean_argument (string name, string nick, string? blurb, bool value, ParamFlags flags)
  Add a new boolean argument to this.
• public void add_boolean_aux_argument (string name, string nick, string? blurb, bool value, ParamFlags flags)
  Add a new boolean auxiliary argument to this.
• public void add_boolean_return_value (string name, string nick, string? blurb, bool value, ParamFlags flags)
  Add a new boolean return value to this .
• public void add_brush_argument (string name, string nick, string? blurb, bool none_ok, Brush? default_value, bool default_to_context, ParamFlags flags)
  Add a new Brush argument to this.
• public void add_brush_aux_argument (string name, string nick, string? blurb, Brush? default_value, bool default_to_context, ParamFlags flags)
  Add a new Brush auxiliary argument to this.
• public void add_brush_return_value (string name, string nick, string? blurb, ParamFlags flags)
  Add a new Brush return value to this.
• public void add_bytes_argument (string name, string nick, string? blurb, ParamFlags flags)
  Add a new Bytes argument to this.
• public void add_bytes_aux_argument (string name, string nick, string? blurb, ParamFlags flags)
  Add a new Bytes auxiliary argument to this.
• public void add_bytes_return_value (string name, string nick, string? blurb, ParamFlags flags)
  Add a new Bytes return value to this.
• public void add_channel_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Channel argument to this.
• public void add_channel_aux_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Channel auxiliary argument to this.
• public void add_channel_return_value (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Channel return value to this.
• public void add_choice_argument (string name, string nick, string? blurb, owned Choice choice, string value, ParamFlags flags)
  Add a new Choice argument to this.
• public void add_choice_aux_argument (string name, string nick, string? blurb, Choice choice, string value, ParamFlags flags)
  Add a new Choice auxiliary argument to this.
• public void add_choice_return_value (string name, string nick, string? blurb, Choice choice, string value, ParamFlags flags)
  Add a new Choice return value to this.
• public void add_color_argument (string name, string nick, string? blurb, bool has_alpha, Color value, ParamFlags flags)
  Add a new Color argument to this.
• public void add_color_aux_argument (string name, string nick, string? blurb, bool has_alpha, Color value, ParamFlags flags)
  Add a new Color auxiliary argument to this.
• public void add_color_from_string_argument (string name, string nick, string? blurb, bool has_alpha, string value, ParamFlags flags)
  Add a new Color argument to this from a string representation.
• public void add_color_from_string_aux_argument (string name, string nick, string? blurb, bool has_alpha, string value, ParamFlags flags)
  Add a new Color auxiliary argument to this from a string representation.
• public void add_color_from_string_return_value (string name, string nick, string? blurb, bool has_alpha, string value, ParamFlags flags)
  Add a new Color return value to this from a string representation.
• public void add_color_return_value (string name, string nick, string? blurb, bool has_alpha, Color value, ParamFlags flags)
  Add a new Color return value to this.
• public void add_core_object_array_argument (string name, string nick, string? blurb, Type object_type, ParamFlags flags)
  Add a new object array argument to this .
• public void add_core_object_array_aux_argument (string name, string nick, string? blurb, Type object_type, ParamFlags flags)
  Add a new object array auxiliary argument to this.
• public void add_core_object_array_return_value (string name, string nick, string? blurb, Type object_type, ParamFlags flags)
  Add a new object array return value to this .
• public void add_display_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Display argument to this.
• public void add_display_aux_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Display auxiliary argument to this.
• public void add_display_return_value (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Display return value to this.
• public void add_double_argument (string name, string nick, string? blurb, double min, double max, double value, ParamFlags flags)
  Add a new floating-point in double precision argument to this.
• public void add_double_array_argument (string name, string nick, string? blurb, ParamFlags flags)
  Add a new double array argument to this .
• public void add_double_array_aux_argument (string name, string nick, string? blurb, ParamFlags flags)
  Add a new double array auxiliary argument to this.
• public void add_double_array_return_value (string name, string nick, string? blurb, ParamFlags flags)
  Add a new double array return value to this .
• public void add_double_aux_argument (string name, string nick, string? blurb, double min, double max, double value, ParamFlags flags)
  Add a new floating-point in double precision auxiliary argument to this.
• public void add_double_return_value (string name, string nick, string? blurb, double min, double max, double value, ParamFlags flags)
  Add a new floating-point in double precision return value to this.
• public void add_drawable_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Drawable argument to this.
• public void add_drawable_aux_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Drawable auxiliary argument to this.
• public void add_drawable_return_value (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Drawable return value to this.
• public void add_enum_argument (string name, string nick, string? blurb, Type enum_type, int value, ParamFlags flags)
  Add a new enum argument to this.
• public void add_enum_aux_argument (string name, string nick, string? blurb, Type enum_type, int value, ParamFlags flags)
  Add a new enum auxiliary argument to this .
• public void add_enum_return_value (string name, string nick, string? blurb, Type enum_type, int value, ParamFlags flags)
  Add a new enum return value to this.
• public void add_file_argument (string name, string nick, string? blurb, FileChooserAction action, bool none_ok, File? default_file, ParamFlags flags)
  Add a new File argument to this.
• public void add_file_aux_argument (string name, string nick, string? blurb, FileChooserAction action, bool none_ok, File? default_file, ParamFlags flags)
  Add a new File auxiliary argument to this.
• public void add_file_return_value (string name, string nick, string? blurb, ParamFlags flags)
  Add a new File return value to this.
• public void add_font_argument (string name, string nick, string? blurb, bool none_ok, Font? default_value, bool default_to_context, ParamFlags flags)
  Add a new Font argument to this.
• public void add_font_aux_argument (string name, string nick, string? blurb, Font? default_value, bool default_to_context, ParamFlags flags)
  Add a new Font auxiliary argument to this.
• public void add_font_return_value (string name, string nick, string? blurb, ParamFlags flags)
  Add a new Font return value to this.
• public void add_gradient_argument (string name, string nick, string? blurb, bool none_ok, Gradient? default_value, bool default_to_context, ParamFlags flags)
  Add a new Gradient argument to this.
• public void add_gradient_aux_argument (string name, string nick, string? blurb, Gradient? default_value, bool default_to_context, ParamFlags flags)
  Add a new Gradient auxiliary argument to this.
• public void add_gradient_return_value (string name, string nick, string? blurb, ParamFlags flags)
  Add a new Gradient return value to this.
• public void add_group_layer_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new [class@GroupLayer] argument to this.
• public void add_group_layer_aux_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new [class@GroupLayer] auxiliary argument to this.
• public void add_group_layer_return_value (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new [class@GroupLayer] return value to this.
• public void add_image_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Image argument to this.
• public void add_image_aux_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Image auxiliary argument to this.
• public void add_image_return_value (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Image return value to this.
• public void add_int32_array_argument (string name, string nick, string? blurb, ParamFlags flags)
  Add a new integer array argument to this .
• public void add_int32_array_aux_argument (string name, string nick, string? blurb, ParamFlags flags)
  Add a new integer array auxiliary argument to this.
• public void add_int32_array_return_value (string name, string nick, string? blurb, ParamFlags flags)
  Add a new integer array return value to this.
• public void add_int_argument (string name, string nick, string? blurb, int min, int max, int value, ParamFlags flags)
  Add a new integer argument to this.
• public void add_int_aux_argument (string name, string nick, string? blurb, int min, int max, int value, ParamFlags flags)
  Add a new integer auxiliary argument to this.
• public void add_int_return_value (string name, string nick, string? blurb, int min, int max, int value, ParamFlags flags)
  Add a new integer return value to this .
• public void add_item_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Item argument to this.
• public void add_item_aux_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Item auxiliary argument to this.
• public void add_item_return_value (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Item return value to this.
• public void add_layer_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Layer argument to this.
• public void add_layer_aux_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Layer auxiliary argument to this.
• public void add_layer_mask_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new LayerMask argument to this.
• public void add_layer_mask_aux_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new LayerMask auxiliary argument to this.
• public void add_layer_mask_return_value (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new LayerMask return value to this.
• public void add_layer_return_value (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Layer return value to this.
• public void add_link_layer_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new LinkLayer argument to this.
• public void add_link_layer_aux_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new LinkLayer auxiliary argument to this.
• public void add_link_layer_return_value (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new LinkLayer return value to this.
• public void add_menu_path (string menu_path)
  Adds a menu path to the procedure.
• public void add_palette_argument (string name, string nick, string? blurb, bool none_ok, Palette? default_value, bool default_to_context, ParamFlags flags)
  Add a new Palette argument to this.
• public void add_palette_aux_argument (string name, string nick, string? blurb, Palette? default_value, bool default_to_context, ParamFlags flags)
  Add a new Palette auxiliary argument to this.
• public void add_palette_return_value (string name, string nick, string? blurb, ParamFlags flags)
  Add a new Palette return value to this.
• public void add_param_argument (string name, string nick, string? blurb, Type param_type, ParamFlags flags)
  Add a new param argument to this.
• public void add_param_aux_argument (string name, string nick, string? blurb, Type param_type, ParamFlags flags)
  Add a new param auxiliary argument to this .
• public void add_param_return_value (string name, string nick, string? blurb, Type param_type, ParamFlags flags)
  Add a new param return value to this .
• public void add_parasite_argument (string name, string nick, string? blurb, ParamFlags flags)
  Add a new Parasite argument to this.
• public void add_parasite_aux_argument (string name, string nick, string? blurb, ParamFlags flags)
  Add a new Parasite auxiliary argument to this.
• public void add_parasite_return_value (string name, string nick, string? blurb, ParamFlags flags)
  Add a new Parasite return value to this.
• public void add_path_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Path argument to this.
• public void add_path_aux_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Path auxiliary argument to this.
• public void add_path_return_value (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Path return value to this.
• public void add_pattern_argument (string name, string nick, string? blurb, bool none_ok, Pattern? default_value, bool default_to_context, ParamFlags flags)
  Add a new Pattern argument to this.
• public void add_pattern_aux_argument (string name, string nick, string? blurb, Pattern? default_value, bool default_to_context, ParamFlags flags)
  Add a new Pattern auxiliary argument to this.
• public void add_pattern_return_value (string name, string nick, string? blurb, ParamFlags flags)
  Add a new Pattern return value to this.
• public void add_resource_argument (string name, string nick, string? blurb, bool none_ok, Resource? default_value, ParamFlags flags)
  Add a new Resource argument to this.
• public void add_resource_aux_argument (string name, string nick, string? blurb, Resource? default_value, ParamFlags flags)
  Add a new Resource auxiliary argument to this.
• public void add_resource_return_value (string name, string nick, string? blurb, ParamFlags flags)
  Add a new Resource return value to this.
• public void add_selection_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Selection argument to this.
• public void add_selection_aux_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Selection auxiliary argument to this.
• public void add_selection_return_value (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new Selection return value to this.
• public void add_string_argument (string name, string nick, string? blurb, string value, ParamFlags flags)
  Add a new string argument to this.
• public void add_string_array_argument (string name, string nick, string? blurb, ParamFlags flags)
  Add a new string array argument to this .
• public void add_string_array_aux_argument (string name, string nick, string? blurb, ParamFlags flags)
  Add a new string array auxiliary argument to this.
• public void add_string_array_return_value (string name, string nick, string? blurb, ParamFlags flags)
  Add a new string array return value to this .
• public void add_string_aux_argument (string name, string nick, string? blurb, string value, ParamFlags flags)
  Add a new string auxiliary argument to this .
• public void add_string_return_value (string name, string nick, string? blurb, string value, ParamFlags flags)
  Add a new string return value to this .
• public void add_text_layer_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new TextLayer argument to this.
• public void add_text_layer_aux_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new TextLayer auxiliary argument to this.
• public void add_text_layer_return_value (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new TextLayer return value to this.
• public void add_uint_argument (string name, string nick, string? blurb, uint min, uint max, uint value, ParamFlags flags)
  Add a new unsigned integer argument to this .
• public void add_uint_aux_argument (string name, string nick, string? blurb, uint min, uint max, uint value, ParamFlags flags)
  Add a new unsigned integer auxiliary argument to this.
• public void add_uint_return_value (string name, string nick, string? blurb, uint min, uint max, uint value, ParamFlags flags)
  Add a new unsigned integer return value to this.
• public void add_unit_argument (string name, string nick, string? blurb, bool show_pixels, bool show_percent, Unit value, ParamFlags flags)
  Add a new Unit argument to this.
• public void add_unit_aux_argument (string name, string nick, string? blurb, bool show_pixels, bool show_percent, Unit value, ParamFlags flags)
  Add a new Unit auxiliary argument to this.
• public void add_unit_return_value (string name, string nick, string? blurb, bool show_pixels, bool show_percent, Unit value, ParamFlags flags)
  Add a new Unit return value to this.
• public void add_vector_layer_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new VectorLayer argument to this.
• public void add_vector_layer_aux_argument (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new VectorLayer auxiliary argument to this.
• public void add_vector_layer_return_value (string name, string nick, string? blurb, bool none_ok, ParamFlags flags)
  Add a new VectorLayer return value to this.
• public ProcedureConfig create_config ()
  Create a Config with properties that match this's arguments, to be used in [method@Procedure.
• public unowned ParamSpec find_argument (string name)
  Searches the this's arguments for a ParamSpec called name.
• public unowned ParamSpec find_aux_argument (string name)
  Searches the this's auxiliary arguments for a ParamSpec called name.
• public unowned ParamSpec find_return_value (string name)
  Searches the this's return values for a ParamSpec called name.
• public ArgumentSync get_argument_sync (string arg_name)
• public unowned ParamSpec[] get_arguments ()
• public unowned string get_authors ()
• public unowned ParamSpec[] get_aux_arguments ()
• public unowned string get_blurb ()
• public unowned string get_copyright ()
• public unowned string get_date ()
• public unowned string get_help ()
• public unowned string get_help_id ()
• public unowned File? get_icon_file ()
  Gets the file of the icon if one was set for this.
• public unowned string? get_icon_name ()
  Gets the name of the icon if one was set for this.
• public unowned Pixbuf? get_icon_pixbuf ()
  Gets the Pixbuf of the icon if an icon was set this way for this.
• public IconType get_icon_type ()
  Gets the type of data set as this's icon.
• public unowned string get_image_types ()
  This function retrieves the list of image types the procedure can operate on.
• public unowned string get_menu_label ()
• public unowned List<string> get_menu_paths ()
• public unowned string get_name ()
• public unowned PlugIn get_plug_in ()
• public PDBProcType get_proc_type ()
• public unowned ParamSpec[] get_return_values ()
• public int get_sensitivity_mask ()
• public virtual void install ()
  called to install the procedure with the main GIMP application.
• public bool is_internal ()
  Provide the information if this is an internal procedure.
• public ValueArray new_return_values (PDBStatusType status, owned Error? error)
  Format the expected return values from procedures.
• public void persistent_ready ()
  Notify the main GIMP application that the persistent procedure has been properly initialized and is ready to run.
• public virtual ValueArray run (ValueArray args)
  Runs the procedure named procedure_name with arguments given as list of `(name, value)` pairs, terminated by null.
• public ValueArray run_config (ProcedureConfig? config)
  Runs this, calling the run_func given in [ctor@Procedure.
• public void set_argument_sync (string arg_name, ArgumentSync sync)
  When the procedure's run function exits, a Procedure's arguments or auxiliary arguments can be automatically synced with a Parasite of the Image the procedure is running on.
• public void set_attribution (string authors, string copyright, string date)
  Sets various attribution strings on this .
• public void set_documentation (string blurb, string? help, string? help_id)
  Sets various documentation strings on this :
• public void set_icon_file (File? file)
  Sets the icon for this to the contents of an image file.
• public void set_icon_name (string? icon_name)
  Sets the icon for this to the icon referenced by icon_name.
• public void set_icon_pixbuf (Pixbuf? pixbuf)
  Sets the icon for this to pixbuf.
• public void set_image_types (string image_types)
  This is a comma separated list of image types, or actually drawable types, that this procedure can deal with.
• public void set_menu_label (string menu_label)
  Sets the label to use for the this's menu entry, The location(s) where to register in the menu hierarchy is chosen using add_menu_path.
• public virtual bool set_sensitivity (int sensitivity_mask)
• public void set_sensitivity_mask (int sensitivity_mask)
  Sets the cases when this is supposed to be sensitive or not.
• public virtual void uninstall ()
  called to uninstall the procedure from the main GIMP application.

Inherited Members: