S or /
Python APIs

Module talon.clip

from talon import clip
FunctionsClasses

Functions

NameReference
has_mode

Check if a clipboard mode is supported.

mime_items(*, mode: str | None = None, tries: int | None = None, formats: list[str] | None = None) -> list[MimeData] | None
mime(*, mode: str | None = None, tries: int | None = None, formats: list[str] | None = None) -> MimeData | None
set_mime(mime: MimeData | list[MimeData] | None, *, mode: str | None = None) -> None
text

Get the text contents of the clipboard.

set_text

Set the text contents of the clipboard.

get() -> str | None
set(s: str)
image

Get the image contents of the clipboard.

set_image

Set the image contents of the clipboard.

clear

Clear the clipboard.

serial(*, mode: str | None = None) -> int
await_change(timeout: float = 0.5, *, after: int | None = None, old: MimeData | None = None, mode: str | None = None, formats: list[str] | None = None) -> MimeData | None
revert

Restore the old contents of the clipboard after running a block:

capture

Capture a change in the clipboard, then restore the old text contents:

Classes

NameReference
NoChange
ChangePromisedata · complete · mime · text · get

Functions

Sourcehas_mode§

def has_mode(mode: str) -> bool

Check if a clipboard mode is supported.

Useful modes: “main”, “select”, “find”

mime_items§

def mime_items(*, mode: str | None = None, tries: int | None = None, formats: list[str] | None = None) -> list[MimeData] | None

mime§

def mime(*, mode: str | None = None, tries: int | None = None, formats: list[str] | None = None) -> MimeData | None

set_mime§

def set_mime(mime: MimeData | list[MimeData] | None, *, mode: str | None = None) -> None

Sourcetext§

def text(*, mode: str | None = None) -> str | None

Get the text contents of the clipboard.

Example

from talon import clip

text = clip.text()
print(text)

Sourceset_text§

def set_text(s: str, *, mode: str | None = None) -> None

Set the text contents of the clipboard.

Example

from talon import clip

clip.set_text("Hello from Talon")

get§

def get() -> str | None

set§

def set(s: str)

Sourceimage§

def image(*, mode: str | None = None) -> skia.Image | None

Get the image contents of the clipboard.

Sourceset_image§

def set_image(image: skia.Image, *, mode: str | None = None) -> None

Set the image contents of the clipboard.

Sourceclear§

def clear(*, mode: str | None = None) -> None

Clear the clipboard.

serial§

def serial(*, mode: str | None = None) -> int

await_change§

def await_change(timeout: float = 0.5, *, after: int | None = None, old: MimeData | None = None, mode: str | None = None, formats: list[str] | None = None) -> MimeData | None

Sourcerevert§

def revert(*, old: MimeData | None = None, mode: str | None = None) -> Generator[None]

Restore the old contents of the clipboard after running a block:

from talon import clip

with clip.revert():
    clip.set_text("this will only be set temporarily")

Sourcecapture§

def capture(timeout: float = 0.5, *, inc: int = 0, mode: str | None = None, formats: list[str] | None = None) -> Generator[talon.clip.ChangePromise]

Capture a change in the clipboard, then restore the old text contents:

from talon import actions, clip

with clip.capture() as s:
    actions.edit.copy()
print(s.get())