ContentProvider

open class ContentProvider : GLibObject.Object, ContentProviderProtocol

The ContentProvider type acts as a reference-counted owner of an underlying GdkContentProvider instance. It provides the methods that can operate on this data type through ContentProviderProtocol conformance. Use ContentProvider as a strong reference or owner of a GdkContentProvider instance.

A GdkContentProvider is used to provide content for the clipboard or for drag-and-drop operations in a number of formats.

To create a GdkContentProvider, use [ctorGdk.ContentProvider.new_for_value] or [ctorGdk.ContentProvider.new_for_bytes].

GDK knows how to handle common text and image formats out-of-the-box. See [classGdk.ContentSerializer] and [classGdk.ContentDeserializer] if you want to add support for application-specific data formats.

Show on GitHub 
  • Designated initialiser from the underlying `C` data type.

    This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the ContentProvider instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafeMutablePointer<GdkContentProvider>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the ContentProvider instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafePointer<GdkContentProvider>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the ContentProvider instance.

    Declaration

    Swift

    @inlinable
override public init!(gpointer op: gpointer?)

    Parameters

    op

    gpointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gconstpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the ContentProvider instance.

    Declaration

    Swift

    @inlinable
override public init!(gconstpointer op: gconstpointer?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the ContentProvider instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafePointer<GdkContentProvider>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the ContentProvider instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafeMutablePointer<GdkContentProvider>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from the underlying C data type. Will retain GdkContentProvider. i.e., ownership is transferred to the ContentProvider instance.

    Declaration

    Swift

    @inlinable
public init(retaining op: UnsafeMutablePointer<GdkContentProvider>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Reference intialiser for a related type that implements ContentProviderProtocol Will retain GdkContentProvider.

    Declaration

    Swift

    @inlinable
public init<T>(contentProvider other: T) where T : ContentProviderProtocol

    Parameters

    other

    an instance of a related type that implements ContentProviderProtocol
    Show on GitHub

  • Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ContentProviderProtocol.

    Declaration

    Swift

    @inlinable
override public init<T>(cPointer p: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe typed, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ContentProviderProtocol.

    Declaration

    Swift

    @inlinable
override public init<T>(retainingCPointer cPointer: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ContentProviderProtocol.

    Declaration

    Swift

    @inlinable
override public init(raw p: UnsafeRawPointer)

    Parameters

    p

    raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ContentProviderProtocol.

    Declaration

    Swift

    @inlinable
override public init(retainingRaw raw: UnsafeRawPointer)
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ContentProviderProtocol.

    Declaration

    Swift

    @inlinable
public required init(raw p: UnsafeMutableRawPointer)

    Parameters

    p

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ContentProviderProtocol.

    Declaration

    Swift

    @inlinable
required public init(retainingRaw raw: UnsafeMutableRawPointer)

    Parameters

    raw

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ContentProviderProtocol.

    Declaration

    Swift

    @inlinable
override public init(opaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ContentProviderProtocol.

    Declaration

    Swift

    @inlinable
override public init(retainingOpaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Create a content provider that provides the given bytes as data for the given mime_type.

    Declaration

    Swift

    @inlinable
public init<BytesT>(bytes mimeType: UnsafePointer<CChar>!, bytes: BytesT) where BytesT : BytesProtocol
    Show on GitHub

  • Create a content provider that provides the given value.

    Declaration

    Swift

    @inlinable
public init<ValueT>(value: ValueT) where ValueT : ValueProtocol
    Show on GitHub

  • Creates a content provider that represents all the given providers.

    Whenever data needs to be written, the union provider will try the given providers in the given order and the first one supporting a format will be chosen to provide it.

    This allows an easy way to support providing data in different formats. For example, an image may be provided by its file and by the image contents with a call such as

    gdk_content_provider_new_union ((GdkContentProvider *[2]) {
                                  gdk_content_provider_new_typed (G_TYPE_FILE, file),
                                  gdk_content_provider_new_typed (G_TYPE_TEXTURE, texture)
                                }, 2);

    Declaration

    Swift

    @inlinable
public init(union providers: UnsafeMutablePointer<UnsafeMutablePointer<GdkContentProvider>?>! = nil, nProviders: Int)
    Show on GitHub

  • Create a content provider that provides the given bytes as data for the given mime_type.

    Declaration

    Swift

    @inlinable
public static func newFor<BytesT>(bytes mimeType: UnsafePointer<CChar>!, bytes: BytesT) -> ContentProvider! where BytesT : BytesProtocol
    Show on GitHub

  • Create a content provider that provides the given value.

    Declaration

    Swift

    @inlinable
public static func newFor<ValueT>(value: ValueT) -> ContentProvider! where ValueT : ValueProtocol
    Show on GitHub

  • Creates a content provider that represents all the given providers.

    Whenever data needs to be written, the union provider will try the given providers in the given order and the first one supporting a format will be chosen to provide it.

    This allows an easy way to support providing data in different formats. For example, an image may be provided by its file and by the image contents with a call such as

    gdk_content_provider_new_union ((GdkContentProvider *[2]) {
                                  gdk_content_provider_new_typed (G_TYPE_FILE, file),
                                  gdk_content_provider_new_typed (G_TYPE_TEXTURE, texture)
                                }, 2);

    Declaration

    Swift

    @inlinable
public static func new(union providers: UnsafeMutablePointer<UnsafeMutablePointer<GdkContentProvider>?>! = nil, nProviders: Int) -> ContentProvider!
    Show on GitHub