ContentFormats

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

The GdkContentFormats structure is used to advertise and negotiate the format of content.

You will encounter GdkContentFormats when interacting with objects controlling operations that pass data between different widgets, window or application, like class@Gdk.Drag, class@Gdk.Drop, class@Gdk.Clipboard or class@Gdk.ContentProvider.

GDK supports content in 2 forms: GType and mime type. Using GTypes is meant only for in-process content transfers. Mime types are meant to be used for data passing both in-process and out-of-process. The details of how data is passed is described in the documentation of the actual implementations. To transform between the two forms, class@Gdk.ContentSerializer and class@Gdk.ContentDeserializer are used.

A GdkContentFormats describes a set of possible formats content can be exchanged in. It is assumed that this set is ordered. GTypes are more important than mime types. Order between different GTypes or mime types is the order they were added in, most important first. Functions that care about order, such as method@Gdk.ContentFormats.union, will describe in their documentation how they interpret that order, though in general the order of the first argument is considered the primary order of the result, followed by the order of further arguments.

For debugging purposes, the function method@Gdk.ContentFormats.to_string exists. It will print a comma-separated list of formats from most important to least important.

GdkContentFormats is an immutable struct. After creation, you cannot change the types it represents. Instead, new GdkContentFormats have to be created. The struct@Gdk.ContentFormatsBuilder structure is meant to help in this endeavor.

Skipped during bindings generation

  • parameter n_gtypes: n_gtypes: Out parameter is not supported

  • parameter n_mime_types: n_mime_types: Out parameter is not supported

Constructors

Link copied to clipboard
constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val gdkContentFormatsPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

Link copied to clipboard
fun containGtype(type: <Error class: unknown class>): Boolean

Checks if a given GType is part of the given @formats.

Link copied to clipboard

Checks if a given mime type is part of the given @formats.

Link copied to clipboard

Checks if @first and @second have any matching formats.

Link copied to clipboard
fun matchGtype(second: ContentFormats): <Error class: unknown class>

Finds the first GType from @first that is also contained in @second.

Link copied to clipboard

Finds the first mime type from @first that is also contained in @second.

Link copied to clipboard
fun print(string: <Error class: unknown class>)

Prints the given @formats into a string for human consumption.

Link copied to clipboard

Increases the reference count of a GdkContentFormats by one.

Link copied to clipboard
open override fun toString(): String

Prints the given @formats into a human-readable string.

Link copied to clipboard

Append all missing types from @second to @first, in the order they had in @second.

Link copied to clipboard

Add GTypes for mime types in @formats for which deserializers are registered.

Link copied to clipboard

Add mime types for GTypes in @formats for which deserializers are registered.

Link copied to clipboard

Add GTypes for the mime types in @formats for which serializers are registered.

Link copied to clipboard

Add mime types for GTypes in @formats for which serializers are registered.

Link copied to clipboard
fun unref()

Decreases the reference count of a GdkContentFormats by one.