gdkpixbuf/org.gtkkn.bindings.gdkpixbuf/PixbufFormat

PixbufFormat

class PixbufFormat(pointer: <Error class: unknown class><<Error class: unknown class>>, cleaner: <Error class: unknown class>? = null)

A GdkPixbufFormat contains information about the image format accepted by a module.

Only modules should access the fields directly, applications should use the gdk_pixbuf_format_* family of functions.

Since

2.2

Constructors

constructor()

Allocate a new PixbufFormat.

constructor(scope: <Error class: unknown class>)

Allocate a new PixbufFormat using the provided AutofreeScope.

constructor(name: String?, signature: PixbufModulePattern?, domain: String?, description: String?, flags: <Error class: unknown class>, disabled: Boolean, license: String?)

Allocate a new PixbufFormat.

constructor(name: String?, signature: PixbufModulePattern?, domain: String?, description: String?, flags: <Error class: unknown class>, disabled: Boolean, license: String?, scope: <Error class: unknown class>)

Allocate a new PixbufFormat using the provided AutofreeScope.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>, cleaner: <Error class: unknown class>? = null)

Types

object Companion

Properties

var description: String?

a description of the image format

var disabled: Boolean

a boolean determining whether the loader is disabled`

var domain: String?

the message domain for the description

val extensions: List<String>?

typical filename extensions for the image format

var flags: <Error class: unknown class>

a combination of GdkPixbufFormatFlags

gdkpixbufPixbufFormatPointer

val gdkpixbufPixbufFormatPointer: <Error class: unknown class><<Error class: unknown class>>

var license: String?

a string containing license information, typically set to shorthands like "GPL", "LGPL", etc.

val mimeTypes: List<String>?

the MIME types for the image format

var name: String?

the name of the image format

var signature: PixbufModulePattern?

the signature of the module

Functions

fun copy(): PixbufFormat?

Creates a copy of format.

fun free()

Frees the resources allocated when copying a GdkPixbufFormat using gdk_pixbuf_format_copy()

fun getDescription(): String?

Returns a description of the format.

fun getExtensions(): List<String>?

Returns the filename extensions typically used for files in the given format.

fun getLicense(): String?

Returns information about the license of the image loader for the format.

fun getMimeTypes(): List<String>?

Returns the mime types supported by the format.

fun getName(): String?

Returns the name of the format.

fun isDisabled(): Boolean

Returns whether this image format is disabled.

isSaveOptionSupported

fun isSaveOptionSupported(optionKey: String): Boolean

Returns TRUE if the save option specified by @option_key is supported when saving a pixbuf using the module implementing @format.

fun isScalable(): Boolean

Returns whether this image format is scalable.

fun isWritable(): Boolean

Returns whether pixbufs can be saved in the given format.

fun setDisabled(disabled: Boolean)

Disables or enables an image format.

open override fun toString(): String