ContentProviderProtocol

public protocol ContentProviderProtocol : ObjectProtocol

The ContentProviderProtocol protocol exposes the methods and properties of an underlying GdkContentProvider instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see ContentProvider. Alternatively, use ContentProviderRef as a lighweight, unowned reference if you already have an instance you just want to use.

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

ptr
Untyped pointer to the underlying GdkContentProvider instance.
Declaration
Swift

var ptr: UnsafeMutableRawPointer! { get }
Show on GitHub
content_provider_ptr Default implementation
Typed pointer to the underlying GdkContentProvider instance.

Default Implementation

Return the stored, untyped pointer as a typed pointer to the GdkContentProvider instance.
Declaration
Swift

var content_provider_ptr: UnsafeMutablePointer<GdkContentProvider>! { get }
Show on GitHub
init(raw:)
Required Initialiser for types conforming to ContentProviderProtocol
Declaration
Swift

init(raw: UnsafeMutableRawPointer)
Show on GitHub

ContentProvider Class


                    
                    
                    bind(property:to:_:flags:transformFrom:transformTo:)

Extension method

Bind a ContentProviderPropertyName source property to a given target object.

Declaration

Swift

@discardableResult
@inlinable
func bind<Q, T>(property source_property: ContentProviderPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

Parameters

`source_property`	the source property to bind
`target`	the target object to bind to
`target_property`	the target property to bind to
`flags`	the flags to pass to the `Binding`
`transform_from`	`ValueTransformer` to use for forward transformation
`transform_to`	`ValueTransformer` to use for backwards transformation

Return Value

binding reference or nil in case of an error

Show on GitHub


                    
                    
                    get(property:)

Extension method

Get the value of a ContentProvider property

Declaration

Swift

@inlinable
func get(property: ContentProviderPropertyName) -> GLibObject.Value

Parameters


                                property

the property to get the value for

Return Value

the value of the named property

Show on GitHub


                    
                    
                    set(property:value:)

Extension method

Set the value of a ContentProvider property. Note that this will only have an effect on properties that are writable and not construct-only!

Declaration

Swift

@inlinable
func set(property: ContentProviderPropertyName, value v: GLibObject.Value)

Parameters


                                property

the property to get the value for

Return Value

the value of the named property

Show on GitHub

ContentProvider signals


                    
                    
                    connect(signal:flags:handler:)

Extension method

Connect a Swift signal handler to the given, typed ContentProviderSignalName signal

Declaration

Swift

@discardableResult
@inlinable
func connect(signal s: ContentProviderSignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int

Parameters

`signal`	The signal to connect
`flags`	The connection flags to use
`data`	A pointer to user data to provide to the callback
`destroyData`	A `GClosureNotify` C function to destroy the data pointed to by `userData`
`handler`	The Swift signal handler (function or callback) to invoke on the given signal

Return Value

The signal handler ID (always greater than 0 for successful connections)

Show on GitHub


                    
                    
                    connect(signal:flags:data:destroyData:signalHandler:)

Extension method

Connect a C signal handler to the given, typed ContentProviderSignalName signal

Declaration

Swift

@discardableResult
@inlinable
func connect(signal s: ContentProviderSignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int

Parameters

`signal`	The signal to connect
`flags`	The connection flags to use
`data`	A pointer to user data to provide to the callback
`destroyData`	A `GClosureNotify` C function to destroy the data pointed to by `userData`
`signalHandler`	The C function to be called on the given signal

Return Value

The signal handler ID (always greater than 0 for successful connections)

Show on GitHub


                    
                    
                    onContentChanged(flags:handler:)

Extension method

Emitted whenever the content provided by this provider has changed.

Note

This represents the underlying content-changed signal

Declaration

Swift

@discardableResult
@inlinable
func onContentChanged(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ContentProviderRef) -> Void) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`handler`	The signal handler to call Run the given callback whenever the `contentChanged` signal is emitted

Show on GitHub

contentChangedSignal Extension method
Typed content-changed signal for using the connect(signal:) methods
Declaration
Swift

static var contentChangedSignal: ContentProviderSignalName { get }
Show on GitHub


                    
                    
                    onNotifyFormats(flags:handler:)

Extension method

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this: (C Language Example):

g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

It is important to note that you must use canonical parameter names as detail strings for the notify signal.

Note

This represents the underlying notify::formats signal

Declaration

Swift

@discardableResult
@inlinable
func onNotifyFormats(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ContentProviderRef, _ pspec: ParamSpecRef) -> Void) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`pspec`	the `GParamSpec` of the property which changed.
`handler`	The signal handler to call Run the given callback whenever the `notifyFormats` signal is emitted

Show on GitHub

notifyFormatsSignal Extension method
Typed notify::formats signal for using the connect(signal:) methods
Declaration
Swift

static var notifyFormatsSignal: ContentProviderSignalName { get }
Show on GitHub


                    
                    
                    onNotifyStorableFormats(flags:handler:)

Extension method

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this: (C Language Example):

g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

It is important to note that you must use canonical parameter names as detail strings for the notify signal.

Note

This represents the underlying notify::storable-formats signal

Declaration

Swift

@discardableResult
@inlinable
func onNotifyStorableFormats(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ContentProviderRef, _ pspec: ParamSpecRef) -> Void) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`pspec`	the `GParamSpec` of the property which changed.
`handler`	The signal handler to call Run the given callback whenever the `notifyStorableFormats` signal is emitted

Show on GitHub

notifyStorableFormatsSignal Extension method
Typed notify::storable-formats signal for using the connect(signal:) methods
Declaration
Swift

static var notifyStorableFormatsSignal: ContentProviderSignalName { get }
Show on GitHub

ContentProvider Class: ContentProviderProtocol extension (methods and fields)

contentChanged() Extension method
Emits the content-changed signal.
Declaration
Swift

@inlinable func contentChanged()
Show on GitHub
get(value:) Extension method
Gets the contents of provider stored in value.

The value will have been initialized to the GType the value should be provided in. This given GType does not need to be listed in the formats returned by [methodGdk.ContentProvider.ref_formats]. However, if the given GType is not supported, this operation can fail and G_IO_ERROR_NOT_SUPPORTED will be reported.
Declaration
Swift

@inlinable func get<ValueT>(value: ValueT) throws -> Bool where ValueT : ValueProtocol
Show on GitHub
refFormats() Extension method
Gets the formats that the provider can provide its current contents in.
Declaration
Swift

@inlinable func refFormats() -> ContentFormatsRef!
Show on GitHub
refStorableFormats() Extension method
Gets the formats that the provider suggests other applications to store the data in.

An example of such an application would be a clipboard manager.

This can be assumed to be a subset of [methodGdk.ContentProvider.ref_formats].
Declaration
Swift

@inlinable func refStorableFormats() -> ContentFormatsRef!
Show on GitHub
writeMimeTypeAsync(mimeType:stream:ioPriority:cancellable:callback:userData:) Extension method
Asynchronously writes the contents of provider to stream in the given mime_type.

When the operation is finished callback will be called. You must then call [methodGdk.ContentProvider.write_mime_type_finish] to get the result of the operation.

The given mime type does not need to be listed in the formats returned by [methodGdk.ContentProvider.ref_formats]. However, if the given GType is not supported, G_IO_ERROR_NOT_SUPPORTED will be reported.

The given stream will not be closed.
Declaration
Swift

@inlinable func writeMimeTypeAsync<OutputStreamT>(mimeType: UnsafePointer<CChar>!, stream: OutputStreamT, ioPriority: Int, cancellable: GIO.CancellableRef? = nil, callback: GAsyncReadyCallback? = nil, userData: gpointer! = nil) where OutputStreamT : OutputStreamProtocol
Show on GitHub
writeMimeTypeAsync(mimeType:stream:ioPriority:cancellable:callback:userData:) Extension method
Asynchronously writes the contents of provider to stream in the given mime_type.

When the operation is finished callback will be called. You must then call [methodGdk.ContentProvider.write_mime_type_finish] to get the result of the operation.

The given mime type does not need to be listed in the formats returned by [methodGdk.ContentProvider.ref_formats]. However, if the given GType is not supported, G_IO_ERROR_NOT_SUPPORTED will be reported.

The given stream will not be closed.
Declaration
Swift

@inlinable func writeMimeTypeAsync<CancellableT, OutputStreamT>(mimeType: UnsafePointer<CChar>!, stream: OutputStreamT, ioPriority: Int, cancellable: CancellableT?, callback: GAsyncReadyCallback? = nil, userData: gpointer! = nil) where CancellableT : CancellableProtocol, OutputStreamT : OutputStreamProtocol
Show on GitHub
writeMimeTypeFinish(result:) Extension method
Finishes an asynchronous write operation.

See [methodGdk.ContentProvider.write_mime_type_async].
Declaration
Swift

@inlinable func writeMimeTypeFinish<AsyncResultT>(result: AsyncResultT) throws -> Bool where AsyncResultT : AsyncResultProtocol
Show on GitHub
parent Extension method
Undocumented
Declaration
Swift

@inlinable var parent: GObject { get }
Show on GitHub

ContentProviderProtocol

Declaration

Default Implementation

Declaration

Declaration

ContentProvider Class

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

ContentProvider signals

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

ContentProvider Class: ContentProviderProtocol extension (methods and fields)

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration