Raxol.Terminal.Clipboard (Raxol v2.0.1)

View Source

Provides a high-level interface for clipboard operations.

This module offers a unified API for clipboard operations across different terminal environments. It supports:

  • Copying content to clipboard
  • Pasting content from clipboard
  • Clearing clipboard contents
  • Multiple clipboard formats

Clipboard Formats

The module supports different clipboard formats:

  • "text" - Plain text (default)
  • "html" - HTML content
  • "rtf" - Rich Text Format
  • Custom formats as needed

Usage

# Copy text to clipboard
Clipboard.copy("Hello, World!")

# Copy HTML content
Clipboard.copy("<b>Hello</b>", "html")

# Paste from clipboard
{:ok, content} = Clipboard.paste()

# Clear clipboard
Clipboard.clear()

Summary

Functions

clear()

Clears the clipboard contents.

copy(content, format \\ "text")

Copies content to the clipboard.

get_content(clipboard)

Gets the content from a clipboard instance.

get_selection(clipboard)

Gets the selection content from a clipboard instance.

paste(format \\ "text")

Pastes content from the clipboard.

set_content(clipboard, content)

Sets the content of a clipboard instance.

set_selection(clipboard, content)

Sets the selection content of a clipboard instance.

Functions

clear()

@spec clear() :: :ok

Clears the clipboard contents.

Returns

  • :ok - Clipboard cleared successfully

Examples

iex> Clipboard.copy("Hello, World!")
iex> Clipboard.clear()
iex> Clipboard.paste()
{:error, :empty_clipboard}

copy(content, format \\ "text")

@spec copy(String.t(), String.t()) :: :ok

Copies content to the clipboard.

Parameters

  • content - The content to copy
  • format - The clipboard format (default: "text")

Returns

  • :ok - Content copied successfully

Examples

iex> Clipboard.copy("Hello, World!")
:ok

iex> Clipboard.copy("<b>Hello</b>", "html")
:ok

get_content(clipboard)

@spec get_content(Raxol.Terminal.Clipboard.Manager.t()) :: String.t()

Gets the content from a clipboard instance.

Parameters

  • clipboard - The clipboard instance

Returns

  • String.t() - The clipboard content

Examples

iex> clipboard = Manager.new()
iex> clipboard = Manager.set_content(clipboard, "Hello, World!")
iex> Clipboard.get_content(clipboard)
"Hello, World!"

get_selection(clipboard)

@spec get_selection(Raxol.Terminal.Clipboard.Manager.t()) :: {:ok, String.t()}

Gets the selection content from a clipboard instance.

Parameters

  • clipboard - The clipboard instance

Returns

  • {:ok, String.t()} - Selection content retrieved successfully
  • {:error, reason} - Failed to get selection content

Examples

iex> clipboard = Manager.new()
iex> {:ok, content} = Clipboard.get_selection(clipboard)
iex> content
""

paste(format \\ "text")

@spec paste(String.t()) :: {:ok, String.t()} | {:error, :empty_clipboard}

Pastes content from the clipboard.

Parameters

  • format - The clipboard format to paste (default: "text")

Returns

  • {:ok, content} - Content pasted successfully
  • {:error, :empty_clipboard} - Clipboard is empty

Examples

iex> Clipboard.copy("Hello, World!")
iex> Clipboard.paste()
{:ok, "Hello, World!"}

iex> Clipboard.clear()
iex> Clipboard.paste()
{:error, :empty_clipboard}

set_content(clipboard, content)

@spec set_content(Raxol.Terminal.Clipboard.Manager.t(), String.t()) ::
  {:ok, Raxol.Terminal.Clipboard.Manager.t()}

Sets the content of a clipboard instance.

Parameters

  • clipboard - The clipboard instance
  • content - The content to set

Returns

  • {:ok, Manager.t()} - Content set successfully
  • {:error, reason} - Failed to set content

Examples

iex> clipboard = Manager.new()
iex> {:ok, clipboard} = Clipboard.set_content(clipboard, "Hello, World!")
iex> Clipboard.get_content(clipboard)
"Hello, World!"

set_selection(clipboard, content)

@spec set_selection(Raxol.Terminal.Clipboard.Manager.t(), String.t()) ::
  {:ok, Raxol.Terminal.Clipboard.Manager.t()}

Sets the selection content of a clipboard instance.

Parameters

  • clipboard - The clipboard instance
  • content - The selection content to set

Returns

  • {:ok, Manager.t()} - Selection content set successfully
  • {:error, reason} - Failed to set selection content

Examples

iex> clipboard = Manager.new()
iex> {:ok, clipboard} = Clipboard.set_selection(clipboard, "Selected text")
iex> {:ok, content} = Clipboard.get_selection(clipboard)
iex> content
"Selected text"