Gimp.ExportOptions¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
|
Virtual Methods¶
- Inherited:
Properties¶
Name |
Type |
Flags |
Short Description |
|---|---|---|---|
r/w/c |
Signals¶
- Inherited:
Fields¶
- Inherited:
Class Details¶
- class Gimp.ExportOptions(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
A class holding generic export options.
Note: right now, GIMP does not provide any generic export option to manipulate, and there is practically no reason for you to create this object yourself. In Export PDB procedure, or again in functions such as [func`Gimp`.file_save], you may just pass
None.In the future, this object will enable to pass various generic options, such as ability to crop or resize images at export time.
- get_image(image)¶
- Parameters:
image (
Gimp.Image) – the image.- Returns:
An enum of
Gimp.ExportReturn.- image:
the image.
- Return type:
(
Gimp.ExportReturn, image:Gimp.Image)
Takes an image to be exported, possibly creating a temporary copy modified according to export settings in self (such as the capabilities of the export format).
If necessary, a copy is created, converted and modified, image changed to point to the new image and the procedure returns [enum`Gimp`.ExportReturn.EXPORT]. In this case, you must take care of deleting the created image using [method`Image`.delete] once the image has been exported, unless you were planning to display it with [ctor`Display`.new], or you will leak memory.
If [enum`Gimp`.ExportReturn.IGNORE] is returned, then image is still the original image. You should neither modify it, nor should you delete it in the end. If you wish to temporarily modify the image before export anyway, call [method`Image`.duplicate] when [enum`Gimp`.ExportReturn.IGNORE] was returned.
New in version 3.0.
Property Details¶
- Gimp.ExportOptions.props.capabilities¶
- Name:
capabilities- Type:
- Default Value:
0- Flags:
What [flags`ExportCapabilities`] are supported.
New in version 3.0.0.