gdkpixbuf/org.gtkkn.bindings.gdkpixbuf/PixbufFormat

PixbufFormat

class PixbufFormat(pointer: <Error class: unknown class><<Error class: unknown class>>)

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.

Skipped during bindings generation

field mime_types: Fields with arrays are not supported
field extensions: Fields with arrays are not supported

Since

2.2

Constructors

PixbufFormat

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

Types

Companion

object Companion

Properties

description

val description: String?

a description of the image format

disabled

var disabled: Boolean

a boolean determining whether the loader is disabled`

domain

val domain: String?

the message domain for the description

flags

var flags: <Error class: unknown class>

a combination of GdkPixbufFormatFlags

gdkpixbufPixbufFormatPointer

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

license

val license: String?

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

name

val name: String?

the name of the image format

signature

val signature: PixbufModulePattern?

the signature of the module

Functions

copy

fun copy(): PixbufFormat

Creates a copy of format.

free

fun free()

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

getDescription

fun getDescription(): String

Returns a description of the format.

getExtensions

fun getExtensions(): List<String>

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

getLicense

fun getLicense(): String

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

getMimeTypes

fun getMimeTypes(): List<String>

Returns the mime types supported by the format.

getName

fun getName(): String

Returns the name of the format.

isDisabled

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.

isScalable

fun isScalable(): Boolean

Returns whether this image format is scalable.

isWritable

fun isWritable(): Boolean

Returns whether pixbufs can be saved in the given format.

setDisabled

fun setDisabled(disabled: Boolean)

Disables or enables an image format.