Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: GdkContentProviderCtors

[233:14] static extends: object

Alternate constructors for GdkContentProvider. Usage: GdkContentProviderCtors.<name>(...). The primary constructor lives directly on GdkContentProvider.

Methods

  • newForBytes (string mime_type, object bytes)

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

    • @p mime_type is the mime type.
    • @p bytes is a GBytes with the data for @mime_type.
    • @r A new GdkContentProvider.
  • newTyped (int type, list varargs)

    Create a content provider that provides the value of the given @type. The value is provided using G_VALUE_COLLECT(), so the same rules apply as when calling g_object_new() or g_object_set().

    • @p type is Type of value to follow.
    • @p ... is value.
    • @r A new GdkContentProvider.
  • newUnion (list providers)

    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 c gdk_content_provider_new_union ((GdkContentProvider *[2]) { gdk_content_provider_new_typed (G_TYPE_FILE, file), gdk_content_provider_new_typed (GDK_TYPE_TEXTURE, texture) }, 2);
    • @p providers is The GdkContentProviders to present the union of.
    • @p n_providers is the number of providers.
    • @r A new GdkContentProvider.

class: GdkContentProviderContentchangedCallback

[292:7] extends: object

Generated low-level callback wrapper for GIR callback content-changed.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • GdkContentProviderContentchangedCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GdkContentProviderMeta

[362:14] static extends: object

Generated metadata helpers for ContentProvider class surfaces.

Methods

  • properties ()

    Returns property metadata for ContentProvider.

    • @r A list.
  • signals ()

    Returns signal metadata for ContentProvider.

    • @r A list.

class: GdkContentProvider

[18:7] extends: object

Provides content for the clipboard or for drag-and-drop operations in a number of formats. To create a GdkContentProvider, use [ctor@Gdk.ContentProvider.new_for_value] or [ctor@Gdk.ContentProvider.new_for_bytes]. GDK knows how to handle common text and image formats out-of-the-box. See [class@Gdk.ContentSerializer] and [class@Gdk.ContentDeserializer] if you want to add support for application-specific data formats.

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • GdkContentProvider (value = null)

    Create a content provider that provides the given @value.

    • @p value is a GValue.
  • toNativeHandle (Source)

    Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

    • @p Source is the raw handle, raw buffer, wrapper, or null.
    • @r A raw pointer carrier or null when no pointer is present.
  • getLib ()

    Returns the opened native library for this generated wrapper.

    • @r The opened native library.
  • handle ()

    Returns the wrapped NativeHandle.

    • @r The wrapped NativeHandle.
  • isNull ()

    Returns true when the wrapped handle is null.

    • @r A bool.
  • describe ()

    Returns a small string for debugging generated wrappers.

    • @r A string.
  • asObject ()

    Wraps this handle as GObject.

    • @r A GObject object.
  • connectSignal (string Name, CallbackObj)

    Connects one generated callback wrapper to a named signal.

    • @p Name is the signal name.
    • @p CallbackObj is the generated callback wrapper to connect.
    • @r The connected handler id.
  • disconnectSignalHandler (int HandlerId)

    Disconnects one retained signal handler id.

    • @p HandlerId is the signal handler id to disconnect.
    • @r None.
  • setOnContentchanged (callback Fn, UserData = null)

    Emitted whenever the content provided by this provider has changed.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (GdkContentProvider Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • content_changed ()

    Emits the ::content-changed signal.

    • @r None.
  • ref_formats ()

    Gets the formats that the provider can provide its current contents in.

    • @r The formats of the provider.
  • ref_storable_formats ()

    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 [method@Gdk.ContentProvider.ref_formats].

    • @r The storable formats of the provider.
  • write_mime_type_async (string mime_type, object stream, int io_priority, object cancellable, user_data)

    Asynchronously writes the contents of @provider to @stream in the given

    • @mime_type. The given mime type does not need to be listed in the formats returned by [method@Gdk.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.
    • @p mime_type is the mime type to provide the data in.
    • @p stream is the GOutputStream to write to.
    • @p io_priority is I/O priority of the request..
    • @p cancellable is optional GCancellable object, %NULL to ignore..
    • @p callback is callback to call when the request is satisfied.
    • @p user_data is the data to pass to callback function.
    • @r None.
  • write_mime_type_finish (object result)

    Finishes an asynchronous write operation. See [method@Gdk.ContentProvider.write_mime_type_async].

    • @p result is a GAsyncResult.
    • @r %TRUE if the operation was completed successfully. Otherwise @error will be set to describe the failure..