class Gdk::ContentFormats

Overview

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 Gdk#Drag, Gdk#Drop, Gdk#Clipboard or 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, Gdk#ContentSerializer and 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 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 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 Gdk#ContentFormatsBuilder structure is meant to help in this endeavor.

Defined in:

auto/gdk-4.0/content_formats.cr

Constructors

Class Method Summary

Instance Method Summary

Constructor Detail

def self.new(pointer : Pointer(Void), transfer : GICrystal::Transfer) #

def self.new(mime_types : Enumerable(String)?) #

def self.new(*mime_types : String) #

def self.new_for_gtype(type : UInt64) : self #

Class Method Detail

def self.g_type : UInt64 #

Returns the type id (GType) registered in GLib type system.


def self.parse(string : String) : Gdk::ContentFormats? #

Instance Method Detail

def ==(other : self) : Bool #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def contain_gtype(type : UInt64) : Bool #

def contain_mime_type(mime_type : String) : Bool #

def finalize #

def gtypes : Enumerable(UInt64)? #

def match(second : Gdk::ContentFormats) : Bool #

def match_gtype(second : Gdk::ContentFormats) : UInt64 #

def match_mime_type(second : Gdk::ContentFormats) : String? #

def mime_types : Enumerable(String)? #

def print(string : GLib::String) : Nil #

def ref : Gdk::ContentFormats #

def to_string : String #

def to_unsafe : Pointer(Void) #

def union(second : Gdk::ContentFormats) : Gdk::ContentFormats #

def union_deserialize_gtypes : Gdk::ContentFormats #

def union_deserialize_mime_types : Gdk::ContentFormats #

def union_serialize_gtypes : Gdk::ContentFormats #

def union_serialize_mime_types : Gdk::ContentFormats #

def unref : Nil #