clipboard

README

Clipboard for Go

Provide copying and pasting to the Clipboard for Go.

Build:

$ go get github.com/atotto/clipboard

Platforms:

• OSX
• Windows 7 (probably work on other Windows)
• Linux, Unix (requires 'xclip' or 'xsel' command to be installed)

Document:

• http://godoc.org/github.com/atotto/clipboard

Notes:

• Text string only
• UTF-8 text encoding only (no conversion)

TODO:

• Clipboard watcher(?)

Commands:

paste shell command:

$ go get github.com/atotto/clipboard/cmd/gopaste
$ # example:
$ gopaste > document.txt

copy shell command:

$ go get github.com/atotto/clipboard/cmd/gocopy
$ # example:
$ cat document.txt | gocopy

Documentation

Overview

Package clipboard read/write on clipboard

Example

package main

import (
	"fmt"

	"github.com/atotto/clipboard"
)

func main() {
	clipboard.WriteAll("日本語")
	text, _ := clipboard.ReadAll()
	fmt.Println(text)

}

Output:

日本語

Index

• Variables
• func ReadAll() (string, error)
• func Watch(interval time.Duration) (<-chan string, context.CancelFunc)
• func WriteAll(text string) error

Examples

• Package

Variables

var (
	Primary bool
)

var Unsupported bool

Unsupported might be set true during clipboard init, to help callers decide whether or not to offer clipboard options.

Functions

func ReadAll

func ReadAll() (string, error)

ReadAll read string from clipboard

func Watch

func Watch(interval time.Duration) (<-chan string, context.CancelFunc)

Watch returns a channel for new clipboard content whenever it changes. It will return current clipboard content if not empty when initialized. Interval is the time between clipboard checks. Take into account that clickboard checks need a few milliseconds as well.

func WriteAll

func WriteAll(text string) error

WriteAll write string to clipboard