#include <ghostty/vt/terminal.h>

Data Fields
GhosttyClipboardLocation	location
const GhosttyClipboardContent *	contents
size_t	contents_len
GhosttyString	name
bool	granted
bool	can_remember
const void *	ctx
GhosttyClipboardWriteReplyFn	reply

Detailed Description

A synchronous request to write clipboard contents.

The request and everything it points to, including the contents array and its strings, are borrowed. They are only valid until the callback returns.

All entries in contents are representations of the same logical value and must be committed atomically. A contents_len of zero requests that the destination be cleared. This is distinct from a content entry whose data has zero length.

The write is answered by calling reply with this request and a GhosttyClipboardWriteReply. This must happen within the clipboard write request callback. This struct is only valid during that time. Calling reply more than once is safely ignored. Returning without replying denies the write.

This struct has a frozen layout and will never gain fields. It is 64 bytes on 64-bit targets and 32 bytes on wasm32. If a later version of libghostty-vt has more to report, it will add a new option with a new struct, and this callback will keep receiving this struct unchanged.

Examples: c-vt-effects/src/main.c.

Definition at line 873 of file terminal.h.

Field Documentation

◆ can_remember

bool can_remember

True if the program supplied a session password, so you may offer to remember the decision through GhosttyClipboardWriteReply::remember. When false, remember is ignored.

Definition at line 900 of file terminal.h.