.. _stdlib_clipboard_core:

================
System clipboard
================

.. das:module:: clipboard_core

The clipboard module provides synchronous access to the operating system's
text clipboard. Text is always exchanged as UTF-8, including supplementary
Unicode characters such as emoji.

All public symbols are in the ``clipboard`` module. Require the promoted
wrapper rather than the internal ``clipboard_core`` module:

.. code-block:: das

    require clipboard/clipboard

    [export]
    def main() {
        if (clipboard_set_text("Hello, UTF-8") == ClipboardStatus.ok) {
            var text : string
            if (clipboard_get_text(text) == ClipboardStatus.ok) {
                print("{text}\n")
            }
        }
    }

Use ``clipboard_capabilities`` before enabling clipboard UI. Unsupported
targets, unavailable desktop sessions, transient contention, and invalid
UTF-8 are reported through ``ClipboardStatus``; the API does not substitute a
process-local clipboard.



++++++++++++
Type aliases
++++++++++++

.. _alias-ClipboardCapabilities:

.. das:attribute:: bitfield ClipboardCapabilities

bitfield<read_text;write_text;clear;synchronous;read_rich_text;write_rich_text;read_image;write_image> aka ClipboardCapabilities

.. _alias-ClipboardFormats:

.. das:attribute:: bitfield ClipboardFormats

bitfield<plain_text;markdown;html;uri_list;image_rgba8> aka ClipboardFormats


++++++++++++
Enumerations
++++++++++++

.. _enum-clipboard-ClipboardStatus:

.. das:attribute:: ClipboardStatus

enum ClipboardStatus


++++++++++
Structures
++++++++++

.. _struct-clipboard-ClipboardImage:

.. das:attribute:: ClipboardImage

struct ClipboardImage

.. _struct-clipboard-ClipboardContent:

.. das:attribute:: ClipboardContent

struct ClipboardContent

.. _struct-clipboard-ClipboardMemory:

.. das:attribute:: ClipboardMemory

struct ClipboardMemory


++++++++++++++++++++++
UTF-8 system clipboard
++++++++++++++++++++++

  *  :ref:`clipboard_capabilities () : ClipboardCapabilities <function-clipboard_clipboard_capabilities>`
  *  :ref:`clipboard_clear () : ClipboardStatus <function-clipboard_clipboard_clear>`
  *  :ref:`clipboard_clone_content (content: ClipboardContent) : ClipboardContent <function-clipboard_clipboard_clone_content_ClipboardContent>`
  *  :ref:`clipboard_content_has_data (content: ClipboardContent) : bool <function-clipboard_clipboard_content_has_data_ClipboardContent>`
  *  :ref:`clipboard_dispose_content (var content: ClipboardContent) <function-clipboard_clipboard_dispose_content_ClipboardContent>`
  *  :ref:`clipboard_get_content (var content: ClipboardContent) : ClipboardStatus <function-clipboard_clipboard_get_content_ClipboardContent>`
  *  :ref:`clipboard_get_text (var text: string&) : ClipboardStatus <function-clipboard_clipboard_get_text_string_ref_>`
  *  :ref:`clipboard_memory_clear (var memory: ClipboardMemory) <function-clipboard_clipboard_memory_clear_ClipboardMemory>`
  *  :ref:`clipboard_memory_dispose (var memory: ClipboardMemory) <function-clipboard_clipboard_memory_dispose_ClipboardMemory>`
  *  :ref:`clipboard_memory_read (memory: ClipboardMemory; var content: ClipboardContent) : ClipboardStatus <function-clipboard_clipboard_memory_read_ClipboardMemory_ClipboardContent>`
  *  :ref:`clipboard_memory_write (var memory: ClipboardMemory; content: ClipboardContent) : ClipboardStatus <function-clipboard_clipboard_memory_write_ClipboardMemory_ClipboardContent>`
  *  :ref:`clipboard_set_content (content: ClipboardContent) : ClipboardStatus <function-clipboard_clipboard_set_content_ClipboardContent>`
  *  :ref:`clipboard_set_text (text: string) : ClipboardStatus <function-clipboard_clipboard_set_text_string>`
  *  :ref:`clipboard_validate_content (content: ClipboardContent) : ClipboardStatus <function-clipboard_clipboard_validate_content_ClipboardContent>`

.. _function-clipboard_clipboard_capabilities:

.. das:function:: clipboard_capabilities() : ClipboardCapabilities

def clipboard_capabilities () : ClipboardCapabilities

.. _function-clipboard_clipboard_clear:

.. das:function:: clipboard_clear() : ClipboardStatus

def clipboard_clear () : ClipboardStatus

.. _function-clipboard_clipboard_clone_content_ClipboardContent:

.. das:function:: clipboard_clone_content(content: ClipboardContent) : ClipboardContent

def clipboard_clone_content (content: ClipboardContent) : ClipboardContent

:Arguments: * **content** :  :ref:`ClipboardContent <struct-clipboard-ClipboardContent>`

.. _function-clipboard_clipboard_content_has_data_ClipboardContent:

.. das:function:: clipboard_content_has_data(content: ClipboardContent) : bool

def clipboard_content_has_data (content: ClipboardContent) : bool

:Arguments: * **content** :  :ref:`ClipboardContent <struct-clipboard-ClipboardContent>`

.. _function-clipboard_clipboard_dispose_content_ClipboardContent:

.. das:function:: clipboard_dispose_content(content: ClipboardContent)

def clipboard_dispose_content (var content: ClipboardContent)

:Arguments: * **content** :  :ref:`ClipboardContent <struct-clipboard-ClipboardContent>`

.. _function-clipboard_clipboard_get_content_ClipboardContent:

.. das:function:: clipboard_get_content(content: ClipboardContent) : ClipboardStatus

def clipboard_get_content (var content: ClipboardContent) : ClipboardStatus

:Arguments: * **content** :  :ref:`ClipboardContent <struct-clipboard-ClipboardContent>`

.. _function-clipboard_clipboard_get_text_string_ref_:

.. das:function:: clipboard_get_text(text: string&) : ClipboardStatus

def clipboard_get_text (var text: string&) : ClipboardStatus

:Arguments: * **text** : string\ &

.. _function-clipboard_clipboard_memory_clear_ClipboardMemory:

.. das:function:: clipboard_memory_clear(memory: ClipboardMemory)

def clipboard_memory_clear (var memory: ClipboardMemory)

:Arguments: * **memory** :  :ref:`ClipboardMemory <struct-clipboard-ClipboardMemory>`

.. _function-clipboard_clipboard_memory_dispose_ClipboardMemory:

.. das:function:: clipboard_memory_dispose(memory: ClipboardMemory)

def clipboard_memory_dispose (var memory: ClipboardMemory)

:Arguments: * **memory** :  :ref:`ClipboardMemory <struct-clipboard-ClipboardMemory>`

.. _function-clipboard_clipboard_memory_read_ClipboardMemory_ClipboardContent:

.. das:function:: clipboard_memory_read(memory: ClipboardMemory; content: ClipboardContent) : ClipboardStatus

def clipboard_memory_read (memory: ClipboardMemory; var content: ClipboardContent) : ClipboardStatus

:Arguments: * **memory** :  :ref:`ClipboardMemory <struct-clipboard-ClipboardMemory>`

            * **content** :  :ref:`ClipboardContent <struct-clipboard-ClipboardContent>`

.. _function-clipboard_clipboard_memory_write_ClipboardMemory_ClipboardContent:

.. das:function:: clipboard_memory_write(memory: ClipboardMemory; content: ClipboardContent) : ClipboardStatus

def clipboard_memory_write (var memory: ClipboardMemory; content: ClipboardContent) : ClipboardStatus

:Arguments: * **memory** :  :ref:`ClipboardMemory <struct-clipboard-ClipboardMemory>`

            * **content** :  :ref:`ClipboardContent <struct-clipboard-ClipboardContent>`

.. _function-clipboard_clipboard_set_content_ClipboardContent:

.. das:function:: clipboard_set_content(content: ClipboardContent) : ClipboardStatus

def clipboard_set_content (content: ClipboardContent) : ClipboardStatus

:Arguments: * **content** :  :ref:`ClipboardContent <struct-clipboard-ClipboardContent>`

.. _function-clipboard_clipboard_set_text_string:

.. das:function:: clipboard_set_text(text: string) : ClipboardStatus

def clipboard_set_text (text: string) : ClipboardStatus

:Arguments: * **text** : string

.. _function-clipboard_clipboard_validate_content_ClipboardContent:

.. das:function:: clipboard_validate_content(content: ClipboardContent) : ClipboardStatus

def clipboard_validate_content (content: ClipboardContent) : ClipboardStatus

:Arguments: * **content** :  :ref:`ClipboardContent <struct-clipboard-ClipboardContent>`