set_support_comment


Description:

[ Version ( since = "3.0" ) ]
public void set_support_comment (bool supports)

Determine whether this supports exporting a comment.

By default, it won't (so there is usually no reason to run this function with false).

This will have several consequences:

  • Automatically adds a standard argument "include-comment" in the end of the argument list of this, with relevant blurb and description.
  • If used with other gimp_export_procedure_set_support_*() functions, they will always be ordered the same (the order of the calls don't matter), keeping all export procedures consistent.
  • Generated GimpExportProcedureDialog will contain the metadata options, once again always in the same order and with consistent GUI style across plug-ins.
  • API from [class@ProcedureConfig] will automatically process these properties to decide whether to export a given metadata or not.

By default, the value will be [func@export_comment].

Parameters:

this

a Procedure.

supports

whether a comment can be stored.