Commit 436e53d3 authored by Michael Natterer's avatar Michael Natterer 😴

pdb: improve docs about which procedures are affected by context settings

Also add some double blank lines so they show up as single blank
lines in the generated docs, which improves readablility.
parent e02a03a6
......@@ -3493,6 +3493,7 @@ register_context_procs (GimpPDB *pdb)
"gimp-context-set-line-width",
"Set the line width setting.",
"This procedure modifies the line width setting for stroking lines.\n"
"\n"
"This setting affects the following procedures: 'gimp-drawable-edit-stroke-selection', 'gimp-drawable-edit-stroke-item'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
......@@ -3542,6 +3543,7 @@ register_context_procs (GimpPDB *pdb)
"gimp-context-set-line-width-unit",
"Set the line width unit setting.",
"This procedure modifies the line width unit setting for stroking lines.\n"
"\n"
"This setting affects the following procedures: 'gimp-drawable-edit-stroke-selection', 'gimp-drawable-edit-stroke-item'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
......@@ -3592,6 +3594,7 @@ register_context_procs (GimpPDB *pdb)
"gimp-context-set-line-cap-style",
"Set the line cap style setting.",
"This procedure modifies the line cap style setting for stroking lines.\n"
"\n"
"This setting affects the following procedures: 'gimp-drawable-edit-stroke-selection', 'gimp-drawable-edit-stroke-item'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
......@@ -3641,6 +3644,7 @@ register_context_procs (GimpPDB *pdb)
"gimp-context-set-line-join-style",
"Set the line join style setting.",
"This procedure modifies the line join style setting for stroking lines.\n"
"\n"
"This setting affects the following procedures: 'gimp-drawable-edit-stroke-selection', 'gimp-drawable-edit-stroke-item'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
......@@ -3690,6 +3694,7 @@ register_context_procs (GimpPDB *pdb)
"Set the line miter limit setting.",
"This procedure modifies the line miter limit setting for stroking lines.\n"
"A mitered join is converted to a bevelled join if the miter would extend to a distance of more than (miter-limit * line-width) from the actual join point.\n"
"\n"
"This setting affects the following procedures: 'gimp-drawable-edit-stroke-selection', 'gimp-drawable-edit-stroke-item'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
......@@ -3737,6 +3742,7 @@ register_context_procs (GimpPDB *pdb)
"gimp-context-set-line-dash-offset",
"Set the line dash offset setting.",
"This procedure modifies the line dash offset setting for stroking lines.\n"
"\n"
"This setting affects the following procedures: 'gimp-drawable-edit-stroke-selection', 'gimp-drawable-edit-stroke-item'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
......@@ -3789,7 +3795,9 @@ register_context_procs (GimpPDB *pdb)
"gimp-context-set-line-dash-pattern",
"Set the line dash pattern setting.",
"This procedure modifies the line dash pattern setting for stroking lines.\n"
"\n"
"The unit of the dash pattern segments is the actual line width used for the stroke operation, in other words a segment length of 1.0 results in a square segment shape (or gap shape).\n"
"\n"
"This setting affects the following procedures: 'gimp-drawable-edit-stroke-selection-', 'gimp-drawable-edit-stroke-item'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
......@@ -4715,7 +4723,8 @@ register_context_procs (GimpPDB *pdb)
"gimp-context-set-antialias",
"Set the antialias setting.",
"This procedure modifies the antialias setting. If antialiasing is turned on, the edges of selected region will contain intermediate values which give the appearance of a sharper, less pixelized edge. This should be set as TRUE most of the time unless a binary-only selection is wanted.\n"
"This setting affects the following procedures: 'gimp-image-select-color', 'gimp-image-select-contiguous-color', 'gimp-image-select-round-rectangle', 'gimp-image-select-ellipse', 'gimp-image-select-polygon', 'gimp-image-select-item'.",
"\n"
"This setting affects the following procedures: 'gimp-image-select-color', 'gimp-image-select-contiguous-color', 'gimp-image-select-round-rectangle', 'gimp-image-select-ellipse', 'gimp-image-select-polygon', 'gimp-image-select-item', 'gimp-drawable-edit-bucket-fill'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2010",
......@@ -4762,6 +4771,7 @@ register_context_procs (GimpPDB *pdb)
"gimp-context-set-feather",
"Set the feather setting.",
"This procedure modifies the feather setting. If the feather option is enabled, selections will be blurred before combining. The blur is a gaussian blur; its radii can be controlled using 'gimp-context-set-feather-radius'.\n"
"\n"
"This setting affects the following procedures: 'gimp-image-select-color', 'gimp-image-select-contiguous-color', 'gimp-image-select-rectangle', 'gimp-image-select-round-rectangle', 'gimp-image-select-ellipse', 'gimp-image-select-polygon', 'gimp-image-select-item'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
......@@ -4815,6 +4825,7 @@ register_context_procs (GimpPDB *pdb)
"gimp-context-set-feather-radius",
"Set the feather radius setting.",
"This procedure modifies the feather radius setting.\n"
"\n"
"This setting affects all procedures that are affected by 'gimp-context-set-feather'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
......@@ -4868,7 +4879,8 @@ register_context_procs (GimpPDB *pdb)
"gimp-context-set-sample-merged",
"Set the sample merged setting.",
"This procedure modifies the sample merged setting. If an operation depends on the colors of the pixels present in a drawable, like when doing a seed fill, this setting controls whether the pixel data from the specified drawable is used ('sample-merged' is FALSE), or the pixel data from the composite image ('sample-merged' is TRUE. This is equivalent to sampling for colors after merging all visible layers).\n"
"This setting affects the following procedures: 'gimp-image-select-color', 'gimp-image-select-contiguous-color'.",
"\n"
"This setting affects the following procedures: 'gimp-image-select-color', 'gimp-image-select-contiguous-color', 'gimp-drawable-edit-bucket-fill'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2011",
......@@ -4916,7 +4928,8 @@ register_context_procs (GimpPDB *pdb)
"gimp-context-set-sample-criterion",
"Set the sample criterion setting.",
"This procedure modifies the sample criterion setting. If an operation depends on the colors of the pixels present in a drawable, like when doing a seed fill, this setting controls how color similarity is determined. SELECT_CRITERION_COMPOSITE is the default value.\n"
"This setting affects the following procedures: 'gimp-image-select-color', 'gimp-image-select-contiguous-color'.",
"\n"
"This setting affects the following procedures: 'gimp-image-select-color', 'gimp-image-select-contiguous-color', 'gimp-drawable-edit-bucket-fill'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2011",
......@@ -4964,7 +4977,8 @@ register_context_procs (GimpPDB *pdb)
"gimp-context-set-sample-threshold",
"Set the sample threshold setting.",
"This procedure modifies the sample threshold setting. If an operation depends on the colors of the pixels present in a drawable, like when doing a seed fill, this setting controls what is \"sufficiently close\" to be considered a similar color. If the sample threshold has not been set explicitly, the default threshold set in gimprc will be used.\n"
"This setting affects the following procedures: 'gimp-image-select-color', 'gimp-image-select-contiguous-color'.",
"\n"
"This setting affects the following procedures: 'gimp-image-select-color', 'gimp-image-select-contiguous-color', 'gimp-drawable-edit-bucket-fill'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2011",
......@@ -5057,7 +5071,8 @@ register_context_procs (GimpPDB *pdb)
"gimp-context-set-sample-transparent",
"Set the sample transparent setting.",
"This procedure modifies the sample transparent setting. If an operation depends on the colors of the pixels present in a drawable, like when doing a seed fill, this setting controls whether transparency is considered to be a unique selectable color. When this setting is TRUE, transparent areas can be selected or filled.\n"
"This setting affects the following procedures: 'gimp-image-select-color', 'gimp-image-select-contiguous-color'.",
"\n"
"This setting affects the following procedures: 'gimp-image-select-color', 'gimp-image-select-contiguous-color', 'gimp-drawable-edit-bucket-fill'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2011",
......@@ -5104,6 +5119,7 @@ register_context_procs (GimpPDB *pdb)
"gimp-context-set-diagonal-neighbors",
"Set the diagonal neighbors setting.",
"This procedure modifies the diagonal neighbors setting. If the affected region of an operation is based on a seed point, like when doing a seed fill, then, when this setting is TRUE, all eight neighbors of each pixel are considered when calculating the affected region; in contrast, when this setting is FALSE, only the four orthogonal neighbors of each pixel are considered.\n"
"\n"
"This setting affects the following procedures: 'gimp-image-select-contiguous-color', 'gimp-drawable-edit-bucket-fill'.",
"Ell",
"Ell",
......@@ -5151,7 +5167,9 @@ register_context_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-context-set-distance-metric",
"Set the distance metric used in some computations.",
"This procedure modifies the distance metric used in some computations, such as 'gimp-drawable-edit-gradient-fill'. In particular, it does not change the metric used in generic distance computation on canvas, as in the Measure tool.",
"This procedure modifies the distance metric used in some computations, such as 'gimp-drawable-edit-gradient-fill'. In particular, it does not change the metric used in generic distance computation on canvas, as in the Measure tool.\n"
"\n"
"This setting affects the following procedures: 'gimp-drawable-edit-gradient-fill'.",
"Jehan",
"Jehan",
"2018",
......@@ -5200,6 +5218,7 @@ register_context_procs (GimpPDB *pdb)
"gimp-context-set-interpolation",
"Set the interpolation type.",
"This procedure modifies the interpolation setting.\n"
"\n"
"This setting affects affects the following procedures: 'gimp-item-transform-flip', 'gimp-item-transform-perspective', 'gimp-item-transform-rotate', 'gimp-item-transform-scale', 'gimp-item-transform-shear', 'gimp-item-transform-2d', 'gimp-item-transform-matrix', 'gimp-image-scale', 'gimp-layer-scale'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
......@@ -5249,6 +5268,7 @@ register_context_procs (GimpPDB *pdb)
"gimp-context-set-transform-direction",
"Set the transform direction.",
"This procedure modifies the transform direction setting.\n"
"\n"
"This setting affects affects the following procedures: 'gimp-item-transform-flip', 'gimp-item-transform-perspective', 'gimp-item-transform-rotate', 'gimp-item-transform-scale', 'gimp-item-transform-shear', 'gimp-item-transform-2d', 'gimp-item-transform-matrix'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
......@@ -5298,6 +5318,7 @@ register_context_procs (GimpPDB *pdb)
"gimp-context-set-transform-resize",
"Set the transform resize type.",
"This procedure modifies the transform resize setting. When transforming pixels, if the result of a transform operation has a different size than the original area, this setting determines how the resulting area is sized.\n"
"\n"
"This setting affects affects the following procedures: 'gimp-item-transform-flip', 'gimp-item-transform-flip-simple', 'gimp-item-transform-perspective', 'gimp-item-transform-rotate', 'gimp-item-transform-rotate-simple', 'gimp-item-transform-scale', 'gimp-item-transform-shear', 'gimp-item-transform-2d', 'gimp-item-transform-matrix'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
......
......@@ -387,6 +387,7 @@ register_drawable_edit_procs (GimpPDB *pdb)
"gimp-drawable-edit-clear",
"Clear selected area of drawable.",
"This procedure clears the specified drawable. If the drawable has an alpha channel, the cleared pixels will become transparent. If the drawable does not have an alpha channel, cleared pixels will be set to the background color. This procedure only affects regions within a selection if there is a selection active.\n"
"\n"
"This procedure is affected by the following context setters: 'gimp-context-set-background'.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
......@@ -411,6 +412,7 @@ register_drawable_edit_procs (GimpPDB *pdb)
"gimp-drawable-edit-fill",
"Fill selected area of drawable.",
"This procedure fills the specified drawable according to fill mode. This procedure only affects regions within a selection if there is a selection active. If you want to fill the whole drawable, regardless of the selection, use 'gimp-drawable-fill'.\n"
"\n"
"This procedure is affected by the following context setters: 'gimp-context-set-opacity', 'gimp-context-set-paint-mode', 'gimp-context-set-foreground', 'gimp-context-set-background', 'gimp-context-set-pattern'.",
"Spencer Kimball & Peter Mattis & Raphael Quinet",
"Spencer Kimball & Peter Mattis",
......@@ -443,6 +445,7 @@ register_drawable_edit_procs (GimpPDB *pdb)
"Fill the area by a seed fill starting at the specified coordinates.",
"This procedure does a seed fill at the specified coordinates, using various parameters from the current context.\n"
"In the case of merged sampling, the x and y coordinates are relative to the image's origin; otherwise, they are relative to the drawable's origin.\n"
"\n"
"This procedure is affected by the following context setters: 'gimp-context-set-opacity', 'gimp-context-set-paint-mode', 'gimp-context-set-foreground', 'gimp-context-set-background', 'gimp-context-set-pattern', 'gimp-context-set-sample-threshold', 'gimp-context-set-sample-merged', 'gimp-context-set-sample-criterion', 'gimp-context-set-diagonal-neighbors', 'gimp-context-set-antialias'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
......@@ -486,6 +489,7 @@ register_drawable_edit_procs (GimpPDB *pdb)
"gimp-drawable-edit-gradient-fill",
"Draw a gradient between the starting and ending coordinates with the specified gradient type.",
"This tool requires information on the gradient type. It creates the specified variety of gradient using the starting and ending coordinates as defined for each gradient type. For shapeburst gradient types, the context's distance metric is also relevant and can be updated with 'gimp-context-set-distance-metric'.\n"
"\n"
"This procedure is affected by the following context setters: 'gimp-context-set-opacity', 'gimp-context-set-paint-mode', 'gimp-context-set-foreground', 'gimp-context-set-background', 'gimp-context-set-gradient' and all gradient property settings, 'gimp-context-set-distance-metric'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
......@@ -571,7 +575,8 @@ register_drawable_edit_procs (GimpPDB *pdb)
"gimp-drawable-edit-stroke-selection",
"Stroke the current selection",
"This procedure strokes the current selection, painting along the selection boundary with the active paint method and brush, or using a plain line with configurable properties. The paint is applied to the specified drawable regardless of the active selection.\n"
"This procedure is affected by the following context setters: 'gimp-context-set-opacity', 'gimp-context-set-paint-mode', 'gimp-context-set-foreground', 'gimp-context-set-brush' and all brush property settings, 'gimp-context-set-gradient' and all gradient property settings",
"\n"
"This procedure is affected by the following context setters: 'gimp-context-set-opacity', 'gimp-context-set-paint-mode', 'gimp-context-set-paint-method', 'gimp-context-set-stroke-method', 'gimp-context-set-foreground', 'gimp-context-set-brush' and all brush property settings, 'gimp-context-set-gradient' and all gradient property settings, 'gimp-context-set-line-width' and all line property settings.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
......@@ -595,7 +600,8 @@ register_drawable_edit_procs (GimpPDB *pdb)
"gimp-drawable-edit-stroke-item",
"Stroke the specified item",
"This procedure strokes the specified item, painting along its outline (e.g. along a path, or along a channel's boundary), with the active paint method and brush, or using a plain line with configurable properties.\n"
"This procedure is affected by the following context setters: 'gimp-context-set-opacity', 'gimp-context-set-paint-mode', 'gimp-context-set-foreground', 'gimp-context-set-brush' and all brush property settings, 'gimp-context-set-gradient' and all gradient property settings",
"\n"
"This procedure is affected by the following context setters: 'gimp-context-set-opacity', 'gimp-context-set-paint-mode', 'gimp-context-set-paint-method', 'gimp-context-set-stroke-method', 'gimp-context-set-foreground', 'gimp-context-set-brush' and all brush property settings, 'gimp-context-set-gradient' and all gradient property settings, 'gimp-context-set-line-width' and all line property settings.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2018",
......
......@@ -366,7 +366,9 @@ register_image_select_procs (GimpPDB *pdb)
"gimp-image-select-color",
"Create a selection by selecting all pixels (in the specified drawable) with the same (or similar) color to that specified.",
"This tool creates a selection over the specified image. A by-color selection is determined by the supplied color under the constraints of the current context settings. Essentially, all pixels (in the drawable) that have color sufficiently close to the specified color (as determined by the threshold and criterion context values) are included in the selection. To select transparent regions, the color specified must also have minimum alpha.\n"
"\n"
"This procedure is affected by the following context setters: 'gimp-context-set-antialias', 'gimp-context-set-feather', 'gimp-context-set-feather-radius', 'gimp-context-set-sample-merged', 'gimp-context-set-sample-criterion', 'gimp-context-set-sample-threshold', 'gimp-context-set-sample-transparent'.\n"
"\n"
"In the case of a merged sampling, the supplied drawable is ignored.",
"David Gowers",
"David Gowers",
......@@ -411,7 +413,9 @@ register_image_select_procs (GimpPDB *pdb)
"gimp-image-select-contiguous-color",
"Create a selection by selecting all pixels around specified coordinates with the same (or similar) color to that at the coordinates.",
"This tool creates a contiguous selection over the specified image. A contiguous color selection is determined by a seed fill under the constraints of the current context settings. Essentially, the color at the specified coordinates (in the drawable) is measured and the selection expands outwards from that point to any adjacent pixels which are not significantly different (as determined by the threshold and criterion context settings). This process continues until no more expansion is possible. If antialiasing is turned on, the final selection mask will contain intermediate values based on close misses to the threshold bar at pixels along the seed fill boundary.\n"
"\n"
"This procedure is affected by the following context setters: 'gimp-context-set-antialias', 'gimp-context-set-feather', 'gimp-context-set-feather-radius', 'gimp-context-set-sample-merged', 'gimp-context-set-sample-criterion', 'gimp-context-set-sample-threshold', 'gimp-context-set-sample-transparent', 'gimp-context-set-diagonal-neighbors'.\n"
"\n"
"In the case of a merged sampling, the supplied drawable is ignored. If the sample is merged, the specified coordinates are relative to the image origin; otherwise, they are relative to the drawable's origin.",
"David Gowers",
"David Gowers",
......@@ -461,6 +465,7 @@ register_image_select_procs (GimpPDB *pdb)
"gimp-image-select-rectangle",
"Create a rectangular selection over the specified image;",
"This tool creates a rectangular selection over the specified image. The rectangular region can be either added to, subtracted from, or replace the contents of the previous selection mask.\n"
"\n"
"This procedure is affected by the following context setters: 'gimp-context-set-feather', 'gimp-context-set-feather-radius'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
......@@ -516,6 +521,7 @@ register_image_select_procs (GimpPDB *pdb)
"gimp-image-select-round-rectangle",
"Create a rectangular selection with round corners over the specified image;",
"This tool creates a rectangular selection with round corners over the specified image. The rectangular region can be either added to, subtracted from, or replace the contents of the previous selection mask.\n"
"\n"
"This procedure is affected by the following context setters: 'gimp-context-set-antialias', 'gimp-context-set-feather', 'gimp-context-set-feather-radius'.",
"Martin Nordholts",
"Martin Nordholts",
......@@ -583,6 +589,7 @@ register_image_select_procs (GimpPDB *pdb)
"gimp-image-select-ellipse",
"Create an elliptical selection over the specified image.",
"This tool creates an elliptical selection over the specified image. The elliptical region can be either added to, subtracted from, or replace the contents of the previous selection mask.\n"
"\n"
"This procedure is affected by the following context setters: 'gimp-context-set-antialias', 'gimp-context-set-feather', 'gimp-context-set-feather-radius'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
......@@ -638,6 +645,7 @@ register_image_select_procs (GimpPDB *pdb)
"gimp-image-select-polygon",
"Create a polygonal selection over the specified image.",
"This tool creates a polygonal selection over the specified image. The polygonal region can be either added to, subtracted from, or replace the contents of the previous selection mask. The polygon is specified through an array of floating point numbers and its length. The length of array must be 2n, where n is the number of points. Each point is defined by 2 floating point values which correspond to the x and y coordinates. If the final point does not connect to the starting point, a connecting segment is automatically added.\n"
"\n"
"This procedure is affected by the following context setters: 'gimp-context-set-antialias', 'gimp-context-set-feather', 'gimp-context-set-feather-radius'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
......@@ -680,6 +688,7 @@ register_image_select_procs (GimpPDB *pdb)
"gimp-image-select-item",
"Transforms the specified item into a selection",
"This procedure renders the item's outline into the current selection of the image the item belongs to. What exactly the item's outline is depends on the item type: for layers, it's the layer's alpha channel, for vectors the vector's shape.\n"
"\n"
"This procedure is affected by the following context setters: 'gimp-context-set-antialias', 'gimp-context-set-feather', 'gimp-context-set-feather-radius'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
......
......@@ -672,6 +672,7 @@ gimp_context_get_line_width (void)
* Set the line width setting.
*
* This procedure modifies the line width setting for stroking lines.
*
* This setting affects the following procedures:
* gimp_drawable_edit_stroke_selection(),
* gimp_drawable_edit_stroke_item().
......@@ -737,6 +738,7 @@ gimp_context_get_line_width_unit (void)
*
* This procedure modifies the line width unit setting for stroking
* lines.
*
* This setting affects the following procedures:
* gimp_drawable_edit_stroke_selection(),
* gimp_drawable_edit_stroke_item().
......@@ -802,6 +804,7 @@ gimp_context_get_line_cap_style (void)
*
* This procedure modifies the line cap style setting for stroking
* lines.
*
* This setting affects the following procedures:
* gimp_drawable_edit_stroke_selection(),
* gimp_drawable_edit_stroke_item().
......@@ -867,6 +870,7 @@ gimp_context_get_line_join_style (void)
*
* This procedure modifies the line join style setting for stroking
* lines.
*
* This setting affects the following procedures:
* gimp_drawable_edit_stroke_selection(),
* gimp_drawable_edit_stroke_item().
......@@ -935,6 +939,7 @@ gimp_context_get_line_miter_limit (void)
* A mitered join is converted to a bevelled join if the miter would
* extend to a distance of more than (miter-limit * line-width) from
* the actual join point.
*
* This setting affects the following procedures:
* gimp_drawable_edit_stroke_selection(),
* gimp_drawable_edit_stroke_item().
......@@ -1000,6 +1005,7 @@ gimp_context_get_line_dash_offset (void)
*
* This procedure modifies the line dash offset setting for stroking
* lines.
*
* This setting affects the following procedures:
* gimp_drawable_edit_stroke_selection(),
* gimp_drawable_edit_stroke_item().
......@@ -1080,9 +1086,11 @@ gimp_context_get_line_dash_pattern (gint *num_dashes,
*
* This procedure modifies the line dash pattern setting for stroking
* lines.
*
* The unit of the dash pattern segments is the actual line width used
* for the stroke operation, in other words a segment length of 1.0
* results in a square segment shape (or gap shape).
*
* This setting affects the following procedures:
* gimp_drawable_edit_stroke_selection_(),
* gimp_drawable_edit_stroke_item().
......@@ -2389,10 +2397,12 @@ gimp_context_get_antialias (void)
* values which give the appearance of a sharper, less pixelized edge.
* This should be set as TRUE most of the time unless a binary-only
* selection is wanted.
*
* This setting affects the following procedures:
* gimp_image_select_color(), gimp_image_select_contiguous_color(),
* gimp_image_select_round_rectangle(), gimp_image_select_ellipse(),
* gimp_image_select_polygon(), gimp_image_select_item().
* gimp_image_select_polygon(), gimp_image_select_item(),
* gimp_drawable_edit_bucket_fill().
*
* Returns: TRUE on success.
*
......@@ -2457,6 +2467,7 @@ gimp_context_get_feather (void)
* is enabled, selections will be blurred before combining. The blur is
* a gaussian blur; its radii can be controlled using
* gimp_context_set_feather_radius().
*
* This setting affects the following procedures:
* gimp_image_select_color(), gimp_image_select_contiguous_color(),
* gimp_image_select_rectangle(), gimp_image_select_round_rectangle(),
......@@ -2535,6 +2546,7 @@ gimp_context_get_feather_radius (gdouble *feather_radius_x,
* Set the feather radius setting.
*
* This procedure modifies the feather radius setting.
*
* This setting affects all procedures that are affected by
* gimp_context_set_feather().
*
......@@ -2606,8 +2618,10 @@ gimp_context_get_sample_merged (void)
* pixel data from the composite image ('sample-merged' is TRUE. This
* is equivalent to sampling for colors after merging all visible
* layers).
*
* This setting affects the following procedures:
* gimp_image_select_color(), gimp_image_select_contiguous_color().
* gimp_image_select_color(), gimp_image_select_contiguous_color(),
* gimp_drawable_edit_bucket_fill().
*
* Returns: TRUE on success.
*
......@@ -2673,8 +2687,10 @@ gimp_context_get_sample_criterion (void)
* like when doing a seed fill, this setting controls how color
* similarity is determined. SELECT_CRITERION_COMPOSITE is the default
* value.
*
* This setting affects the following procedures:
* gimp_image_select_color(), gimp_image_select_contiguous_color().
* gimp_image_select_color(), gimp_image_select_contiguous_color(),
* gimp_drawable_edit_bucket_fill().
*
* Returns: TRUE on success.
*
......@@ -2741,8 +2757,10 @@ gimp_context_get_sample_threshold (void)
* \"sufficiently close\" to be considered a similar color. If the
* sample threshold has not been set explicitly, the default threshold
* set in gimprc will be used.
*
* This setting affects the following procedures:
* gimp_image_select_color(), gimp_image_select_contiguous_color().
* gimp_image_select_color(), gimp_image_select_contiguous_color(),
* gimp_drawable_edit_bucket_fill().
*
* Returns: TRUE on success.
*
......@@ -2871,8 +2889,10 @@ gimp_context_get_sample_transparent (void)
* like when doing a seed fill, this setting controls whether
* transparency is considered to be a unique selectable color. When
* this setting is TRUE, transparent areas can be selected or filled.
*
* This setting affects the following procedures:
* gimp_image_select_color(), gimp_image_select_contiguous_color().
* gimp_image_select_color(), gimp_image_select_contiguous_color(),
* gimp_drawable_edit_bucket_fill().
*
* Returns: TRUE on success.
*
......@@ -2939,6 +2959,7 @@ gimp_context_get_diagonal_neighbors (void)
* neighbors of each pixel are considered when calculating the affected
* region; in contrast, when this setting is FALSE, only the four
* orthogonal neighbors of each pixel are considered.
*
* This setting affects the following procedures:
* gimp_image_select_contiguous_color(),
* gimp_drawable_edit_bucket_fill().
......@@ -3008,6 +3029,9 @@ gimp_context_get_distance_metric (void)
* particular, it does not change the metric used in generic distance
* computation on canvas, as in the Measure tool.
*
* This setting affects the following procedures:
* gimp_drawable_edit_gradient_fill().
*
* Returns: TRUE on success.
*
* Since: 2.10
......@@ -3072,6 +3096,7 @@ gimp_context_get_interpolation (void)
* Set the interpolation type.
*
* This procedure modifies the interpolation setting.
*
* This setting affects affects the following procedures:
* gimp_item_transform_flip(), gimp_item_transform_perspective(),
* gimp_item_transform_rotate(), gimp_item_transform_scale(),
......@@ -3141,6 +3166,7 @@ gimp_context_get_transform_direction (void)
* Set the transform direction.
*
* This procedure modifies the transform direction setting.
*
* This setting affects affects the following procedures:
* gimp_item_transform_flip(), gimp_item_transform_perspective(),
* gimp_item_transform_rotate(), gimp_item_transform_scale(),
......@@ -3212,6 +3238,7 @@ gimp_context_get_transform_resize (void)
* transforming pixels, if the result of a transform operation has a
* different size than the original area, this setting determines how
* the resulting area is sized.
*
* This setting affects affects the following procedures:
* gimp_item_transform_flip(), gimp_item_transform_flip_simple(),
* gimp_item_transform_perspective(), gimp_item_transform_rotate(),
......
......@@ -45,6 +45,7 @@
* drawable does not have an alpha channel, cleared pixels will be set
* to the background color. This procedure only affects regions within
* a selection if there is a selection active.
*
* This procedure is affected by the following context setters:
* gimp_context_set_background().
*
......@@ -80,6 +81,7 @@ gimp_drawable_edit_clear (gint32 drawable_ID)
* This procedure only affects regions within a selection if there is a
* selection active. If you want to fill the whole drawable, regardless
* of the selection, use gimp_drawable_fill().
*
* This procedure is affected by the following context setters:
* gimp_context_set_opacity(), gimp_context_set_paint_mode(),
* gimp_context_set_foreground(), gimp_context_set_background(),
......@@ -122,6 +124,7 @@ gimp_drawable_edit_fill (gint32 drawable_ID,
* In the case of merged sampling, the x and y coordinates are relative
* to the image's origin; otherwise, they are relative to the
* drawable's origin.
*
* This procedure is affected by the following context setters:
* gimp_context_set_opacity(), gimp_context_set_paint_mode(),
* gimp_context_set_foreground(), gimp_context_set_background(),
......@@ -181,6 +184,7 @@ gimp_drawable_edit_bucket_fill (gint32 drawable_ID,
* coordinates as defined for each gradient type. For shapeburst
* gradient types, the context's distance metric is also relevant and
* can be updated with gimp_context_set_distance_metric().
*
* This procedure is affected by the following context setters:
* gimp_context_set_opacity(), gimp_context_set_paint_mode(),
* gimp_context_set_foreground(), gimp_context_set_background(),
......@@ -240,11 +244,14 @@ gimp_drawable_edit_gradient_fill (gint32 drawable_ID,
* selection boundary with the active paint method and brush, or using
* a plain line with configurable properties. The paint is applied to
* the specified drawable regardless of the active selection.
*
* This procedure is affected by the following context setters:
* gimp_context_set_opacity(), gimp_context_set_paint_mode(),
* gimp_context_set_paint_method(), gimp_context_set_stroke_method(),
* gimp_context_set_foreground(), gimp_context_set_brush() and all
* brush property settings, gimp_context_set_gradient() and all
* gradient property settings
* gradient property settings, gimp_context_set_line_width() and all
* line property settings.
*
* Returns: TRUE on success.
**/
......@@ -278,11 +285,14 @@ gimp_drawable_edit_stroke_selection (gint32 drawable_ID)
* outline (e.g. along a path, or along a channel's boundary), with the
* active paint method and brush, or using a plain line with
* configurable properties.
*
* This procedure is affected by the following context setters:
* gimp_context_set_opacity(), gimp_context_set_paint_mode(),
* gimp_context_set_paint_method(), gimp_context_set_stroke_method(),
* gimp_context_set_foreground(), gimp_context_set_brush() and all
* brush property settings, gimp_context_set_gradient() and all
* gradient property settings
* gradient property settings, gimp_context_set_line_width() and all
* line property settings.
*
* Returns: TRUE on success.
*
......
......@@ -51,12 +51,14 @@
* (as determined by the threshold and criterion context values) are
* included in the selection. To select transparent regions, the color
* specified must also have minimum alpha.
*
* This procedure is affected by the following context setters:
* gimp_context_set_antialias(), gimp_context_set_feather(),
* gimp_context_set_feather_radius(), gimp_context_set_sample_merged(),
* gimp_context_set_sample_criterion(),
* gimp_context_set_sample_threshold(),
* gimp_context_set_sample_transparent().
*
* In the case of a merged sampling, the supplied drawable is ignored.
*
* Returns: TRUE on success.
......@@ -111,6 +113,7 @@ gimp_image_select_color (gint32 image_ID,
* the final selection mask will contain intermediate values based on
* close misses to the threshold bar at pixels along the seed fill
* boundary.
*
* This procedure is affected by the following context setters:
* gimp_context_set_antialias(), gimp_context_set_feather(),
* gimp_context_set_feather_radius(), gimp_context_set_sample_merged(),
......@@ -118,6 +121,7 @@ gimp_image_select_color (gint32 image_ID,
* gimp_context_set_sample_threshold(),
* gimp_context_set_sample_transparent(),
* gimp_context_set_diagonal_neighbors().
*
* In the case of a merged sampling, the supplied drawable is ignored.
* If the sample is merged, the specified coordinates are relative to
* the image origin; otherwise, they are relative to the drawable's
......@@ -168,6 +172,7 @@ gimp_image_select_contiguous_color (gint32 image_ID,
* This tool creates a rectangular selection over the specified image.
* The rectangular region can be either added to, subtracted from, or
* replace the contents of the previous selection mask.
*
* This procedure is affected by the following context setters:
* gimp_context_set_feather(), gimp_context_set_feather_radius().
*
......@@ -222,6 +227,7 @@ gimp_image_select_rectangle (gint32 image_ID,
* the specified image. The rectangular region can be either added to,
* subtracted from, or replace the contents of the previous selection
* mask.
*
* This procedure is affected by the following context setters:
* gimp_context_set_antialias(), gimp_context_set_feather(),
* gimp_context_set_feather_radius().
......@@ -277,6 +283,7 @@ gimp_image_select_round_rectangle (gint32 image_ID,
* This tool creates an elliptical selection over the specified image.
* The elliptical region can be either added to, subtracted from, or
* replace the contents of the previous selection mask.
*
* This procedure is affected by the following context setters:
* gimp_context_set_antialias(), gimp_context_set_feather(),
* gimp_context_set_feather_radius().
......@@ -331,6 +338,7 @@ gimp_image_select_ellipse (gint32 image_ID,
* Each point is defined by 2 floating point values which correspond to
* the x and y coordinates. If the final point does not connect to the
* starting point, a connecting segment is automatically added.
*
* This procedure is affected by the following context setters:
* gimp_context_set_antialias(), gimp_context_set_feather(),
* gimp_context_set_feather_radius().
......@@ -376,6 +384,7 @@ gimp_image_select_polygon (gint32 image_ID,
* of the image the item belongs to. What exactly the item's outline is
* depends on the item type: for layers, it's the layer's alpha
* channel, for vectors the vector's shape.
*
* This procedure is affected by the following context setters:
* gimp_context_set_antialias(), gimp_context_set_feather(),
* gimp_context_set_feather_radius().
......
......@@ -521,6 +521,7 @@ sub context_set_line_width {
$help = <<'HELP';
This procedure modifies the line width setting for stroking lines.
This setting affects the following procedures:
gimp_drawable_edit_stroke_selection(), gimp_drawable_edit_stroke_item().
HELP
......@@ -580,6 +581,7 @@ sub context_set_line_width_unit {
$help = <<'HELP';
This procedure modifies the line width unit setting for stroking lines.
This setting affects the following procedures:
gimp_drawable_edit_stroke_selection(), gimp_drawable_edit_stroke_item().
HELP
......@@ -639,6 +641,7 @@ sub context_set_line_cap_style {
$help = <<'HELP';
This procedure modifies the line cap style setting for stroking lines.
This setting affects the following procedures:
gimp_drawable_edit_stroke_selection(), gimp_drawable_edit_stroke_item().
HELP
......@@ -698,6 +701,7 @@ sub context_set_line_join_style {
$help = <<'HELP';
This procedure modifies the line join style setting for stroking lines.
This setting affects the following procedures:
gimp_drawable_edit_stroke_selection(), gimp_drawable_edit_stroke_item().
HELP
......@@ -761,6 +765,7 @@ A mitered join is converted to a bevelled join if the miter would
extend to a distance of more than (miter-limit * line-width) from the
actual join point.
This setting affects the following procedures:
gimp_drawable_edit_stroke_selection(), gimp_drawable_edit_stroke_item().
HELP
......@@ -820,6 +825,7 @@ sub context_set_line_dash_offset {
$help = <<'HELP';
This procedure modifies the line dash offset setting for stroking lines.
This setting affects the following procedures:
gimp_drawable_edit_stroke_selection(), gimp_drawable_edit_stroke_item().
HELP
......@@ -880,10 +886,12 @@ sub context_set_line_dash_pattern {
$help = <<'HELP';
This procedure modifies the line dash pattern setting for stroking lines.
The unit of the dash pattern segments is the actual line width used
for the stroke operation, in other words a segment length of 1.0
results in a square segment shape (or gap shape).
This setting affects the following procedures:
gimp_drawable_edit_stroke_selection_(), gimp_drawable_edit_stroke_item().
HELP
......@@ -2101,10 +2109,12 @@ values which give the appearance of a sharper, less pixelized edge.
This should be set as TRUE most of the time unless a binary-only
selection is wanted.
This setting affects the following procedures:
gimp_image_select_color(), gimp_image_select_contiguous_color(),
gimp_image_select_round_rectangle(), gimp_image_select_ellipse(),
gimp_image_select_polygon(), gimp_image_select_item().
gimp_image_select_polygon(), gimp_image_select_item(),
gimp_drawable_edit_bucket_fill().
HELP
&mitch_pdb_misc('2010', '2.8');
......@@ -2159,6 +2169,7 @@ enabled, selections will be blurred before combining. The blur is a
gaussian blur; its radii can be controlled using
gimp_context_set_feather_radius().
This setting affects the following procedures:
gimp_image_select_color(), gimp_image_select_contiguous_color(),
gimp_image_select_rectangle(), gimp_image_select_round_rectangle(),
......@@ -2218,6 +2229,7 @@ sub context_set_feather_radius {
$help = <<'HELP';
This procedure modifies the feather radius setting.
This setting affects all procedures that are affected
by gimp_context_set_feather().
HELP
......@@ -2279,8 +2291,10 @@ the specified drawable is used ('sample-merged' is FALSE), or the
pixel data from the composite image ('sample-merged' is TRUE. This is
equivalent to sampling for colors after merging all visible layers).
This setting affects the following procedures:
gimp_image_select_color(), gimp_image_select_contiguous_color().
gimp_image_select_color(), gimp_image_select_contiguous_color(),
gimp_drawable_edit_bucket_fill().
HELP
&mitch_pdb_misc('2011', '2.8');
......@@ -2335,8 +2349,10 @@ depends on the colors of the pixels present in a drawable, like when
doing a seed fill, this setting controls how color similarity is
determined. SELECT_CRITERION_COMPOSITE is the default value.
This setting affects the following procedures:
gimp_image_select_color(), gimp_image_select_contiguous_color().
gimp_image_select_color(), gimp_image_select_contiguous_color(),
gimp_drawable_edit_bucket_fill().
HELP
&mitch_pdb_misc('2011', '2.8');
......@@ -2392,8 +2408,10 @@ doing a seed fill, this setting controls what is "sufficiently close"
to be considered a similar color. If the sample threshold has not been
set explicitly, the default threshold set in gimprc will be used.
This setting affects the following procedures:
gimp_image_select_color(), gimp_image_select_contiguous_color().
gimp_image_select_color(), gimp_image_select_contiguous_color(),
gimp_drawable_edit_bucket_fill().
HELP
&mitch_pdb_misc('2011', '2.8');
......@@ -2505,8 +2523,10 @@ like when doing a seed fill, this setting controls whether
transparency is considered to be a unique selectable color. When this
setting is TRUE, transparent areas can be selected or filled.
This setting affects the following procedures:
gimp_image_select_color(), gimp_image_select_contiguous_color().
gimp_image_select_color(), gimp_image_select_contiguous_color(),
gimp_drawable_edit_bucket_fill().
HELP
&mitch_pdb_misc('2011', '2.8');
......@@ -2566,6 +2586,7 @@ are considered when calculating the affected region; in contrast, when
this setting is FALSE, only the four orthogonal neighbors of each pixel
are considered.
This setting affects the following procedures:
gimp_image_select_contiguous_color(), gimp_drawable_edit_bucket_fill().
HELP
......@@ -2625,6 +2646,10 @@ This procedure modifies the distance metric used in some computations,
such as gimp_drawable_edit_gradient_fill(). In particular, it does not
change the metric used in generic distance computation on canvas, as
in the Measure tool.
This setting affects the following procedures:
gimp_drawable_edit_gradient_fill().
HELP
&jehan_pdb_misc('2018', '2.10');
......@@ -2680,6 +2705,7 @@ sub context_set_interpolation {
$help = <<'HELP';
This procedure modifies the interpolation setting.
This setting affects affects the following procedures:
gimp_item_transform_flip(), gimp_item_transform_perspective(),
gimp_item_transform_rotate(), gimp_item_transform_scale(),
......@@ -2738,6 +2764,7 @@ sub context_set_transform_direction {
$help = <<'HELP';
This procedure modifies the transform direction setting.
This setting affects affects the following procedures:
gimp_item_transform_flip(), gimp_item_transform_perspective(),
gimp_item_transform_rotate(), gimp_item_transform_scale(),
......@@ -2799,6 +2826,7 @@ pixels, if the result of a transform operation has a different size
than the original area, this setting determines how the resulting area
is sized.
This setting affects affects the following procedures:
gimp_item_transform_flip(), gimp_item_transform_flip_simple(),
gimp_item_transform_perspective(), gimp_item_transform_rotate(),
......
......@@ -26,6 +26,7 @@ drawable does not have an alpha channel, cleared pixels will be set to
the background color. This procedure only affects regions within a
selection if there is a selection active.
This procedure is affected by the following context setters:
gimp_context_set_background().
HELP
......@@ -65,6 +66,7 @@ mode. This procedure only affects regions within a selection if there
is a selection active. If you want to fill the whole drawable,
regardless of the selection, use gimp_drawable_fill().
This procedure is affected by the following context setters:
gimp_context_set_opacity(), gimp_context_set_paint_mode(),
gimp_context_set_foreground(), gimp_context_set_background(),
......@@ -127,6 +129,7 @@ In the case of merged sampling, the x and y coordinates are relative
to the image's origin; otherwise, they are relative to the drawable's
origin.
This procedure is affected by the following context setters:
gimp_context_set_opacity(), gimp_context_set_paint_mode(),
gimp_context_set_foreground(), gimp_context_set_background(),
......@@ -202,6 +205,7 @@ coordinates as defined for each gradient type. For shapeburst
gradient types, the context's distance metric is also relevant and can
be updated with gimp_context_set_distance_metric().
This procedure is affected by the following context setters:
gimp_context_set_opacity(), gimp_context_set_paint_mode(),
gimp_context_set_foreground(), gimp_context_set_background(),
......@@ -309,11 +313,14 @@ selection boundary with the active paint method and brush, or using a
plain line with configurable properties. The paint is applied to the
specified drawable regardless of the active selection.