Skip to content

Commit

Permalink
docs: add missing documentation for clipboard methods (#23862)
Browse files Browse the repository at this point in the history
  • Loading branch information
virus-rpi authored Mar 5, 2025
1 parent 7faf1bf commit 16681fb
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions vlib/clipboard/x11/clipboard.c.v
Original file line number Diff line number Diff line change
Expand Up @@ -203,17 +203,20 @@ fn new_x11_clipboard(selection AtomType) &Clipboard {
return cb
}

// check_availability returns `true` if the clipboard is available for use.
pub fn (cb &Clipboard) check_availability() bool {
return cb.display != C.NULL
}

// free releases the clipboard resources.
pub fn (mut cb Clipboard) free() {
C.XDestroyWindow(cb.display, cb.window)
cb.window = Window(0)
// FIXME: program hangs when closing display
// XCloseDisplay(cb.display)
}

// clear clears the clipboard (sets it to an empty string).
pub fn (mut cb Clipboard) clear() {
cb.mutex.lock()
C.XSetSelectionOwner(cb.display, cb.selection, Window(0), C.CurrentTime)
Expand All @@ -223,6 +226,7 @@ pub fn (mut cb Clipboard) clear() {
cb.mutex.unlock()
}

// has_ownership returns `true` if the `Clipboard` has the content ownership.
pub fn (cb &Clipboard) has_ownership() bool {
return cb.is_owner
}
Expand All @@ -248,6 +252,7 @@ pub fn (mut cb Clipboard) set_text(text string) bool {
return cb.is_owner
}

// get_text returns the current entry as a `string` from the clipboard.
pub fn (mut cb Clipboard) get_text() string {
if cb.window == Window(0) {
return ''
Expand Down

0 comments on commit 16681fb

Please sign in to comment.