GIMP Library Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# gimpedit

## Name

gimpedit --

## Synopsis

    gboolean    gimp_edit_cut                   (gint32 drawable_ID);
    gboolean    gimp_edit_copy                  (gint32 drawable_ID);
    gint32      gimp_edit_paste                 (gint32 drawable_ID,
                                                 gboolean paste_into);
    gboolean    gimp_edit_clear                 (gint32 drawable_ID);
    gboolean    gimp_edit_fill                  (gint32 drawable_ID,
                                                 GimpFillType fill_type);
    gboolean    gimp_edit_stroke                (gint32 drawable_ID);

## Description

## Details

### gimp_edit_cut ()

    gboolean    gimp_edit_cut                   (gint32 drawable_ID);

Cut from the specified drawable.

If there is a selection in the image, then the area specified by the selection is cut from the specified drawable and placed in an internal GIMP edit buffer. It can subsequently be retrieved using the 'gimp-edit-paste' command. If there is no selection, then the specified drawable will be removed and its contents stored in the internal GIMP edit buffer. The drawable MUST belong to the specified image, or an error is returned.

`drawable_ID` : | The drawable to cut from.
Returns : | TRUE on success.

### gimp_edit_copy ()

    gboolean    gimp_edit_copy                  (gint32 drawable_ID);

Copy from the specified drawable.

If there is a selection in the image, then the area specified by the selection is copied from the specified drawable and placed in an internal GIMP edit buffer. It can subsequently be retrieved using the 'gimp-edit-paste' command. If there is no selection, then the specified drawable's contents will be stored in the internal GIMP edit buffer. The drawable MUST belong to the specified image, or an error is returned.

`drawable_ID` : | The drawable to copy from.
Returns : | TRUE on success.

### gimp_edit_paste ()

    gint32      gimp_edit_paste                 (gint32 drawable_ID,
                                                 gboolean paste_into);

Paste buffer to the specified drawable.

This procedure pastes a copy of the internal GIMP edit buffer to the specified drawable. The GIMP edit buffer will be empty unless a call was previously made to either 'gimp-edit-cut' or 'gimp-edit-copy'. The \"paste_into\" option specifies whether to clear the current image selection, or to paste the buffer \"behind\" the selection. This allows the selection to act as a mask for the pasted buffer. Anywhere that the selection mask is non-zero, the pasted buffer will show through. The pasted buffer will be a new layer in the image which is designated as the image floating selection. If the image has a floating selection at the time of pasting, the old floating selection will be anchored to it's drawable before the new floating selection is added. This procedure returns the new floating layer. The resulting floating selection will already be attached to the specified drawable, and a subsequent call to floating_sel_attach is not needed.

`drawable_ID` : | The drawable to paste to.
`paste_into` : | Clear selection, or paste behind it?
Returns : | The new floating selection.

### gimp_edit_clear ()

    gboolean    gimp_edit_clear                 (gint32 drawable_ID);

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.

`drawable_ID` : | The drawable to clear from.
Returns : | TRUE on success.

### gimp_edit_fill ()

    gboolean    gimp_edit_fill                  (gint32 drawable_ID,
                                                 GimpFillType fill_type);

Fill selected area of drawable.

This procedure fills the specified drawable with the fill mode. If the fill mode is foreground, the current foreground color is used. If the fill mode is background, the current background color is used. Other fill modes should not be used. This procedure only affects regions within a selection if there is a selection active.

`drawable_ID` : | The drawable to fill to.
`fill_type` : | The type of fill.
Returns : | TRUE on success.

### gimp_edit_stroke ()

    gboolean    gimp_edit_stroke                (gint32 drawable_ID);

Stroke the current selection

This procedure strokes the current selection, painting along the selection boundary with the active brush and foreground color. The paint is applied to the specified drawable regardless of the active selection.

`drawable_ID` : | The drawable to stroke to.
Returns : | TRUE on success.

<<< Previous Page | Home | Up | Next Page >>>
gimpdrawable | gimpfileops