clipboard（クリップボード）

システムのクリップボードでコピー＆ペースト操作を実行します。

ヒント：開発デバッグには、Clipboard Viewer（Win / Mac）ツールの使用がお勧めです。これにより、開発プロセスがスムーズになります。

await eagle.clipboard.writeText('Example string');

console.log(await eagle.clipboard.readText());

---

メソッド

clear()

クリップボードの内容をクリアします。

eagle.clipboard.writeText('Example string');
eagle.clipboard.clear();
console.log(eagle.clipboard.readText());	// undefined

---

has(format)

現在のクリップボードの内容に指定したフォーマットが含まれているかどうかを確認します。

• format string - 指定された形式

• 戻り値 boolean - 指定された形式が含まれているかどうか

console.log(eagle.clipboard.has('public/utf8-plain-text'));	// false

const buffer = Buffer.from('writeBuffer', 'utf8');
eagle.clipboard.writeBuffer('public/utf8-plain-text', buffer);

console.log(clipboard.has('public/utf8-plain-text'));	// true

---

writeText(text)

textをプレーンテキストとしてクリップボードに書き込みます。

• text string - 書き込むテキスト

eagle.clipboard.writeText('Example string');
console.log(eagle.clipboard.readText());	// 'Example string'

---

readText()

現在のクリップボードからプレーンテキストを取得します。

• 戻り値 string

console.log(await eagle.clipboard.readText());

---

writeBuffer(format, buffer)

bufferをformatタイプとしてクリップボードに書き込みます。

• format string - クリップボード形式

• buffer Buffer - 書き込むBufferフォーマットの内容

const buffer = Buffer.from('writeBuffer', 'utf8');
eagle.clipboard.writeBuffer('public/utf8-plain-text', buffer);

---

readBuffer(format)

クリップボードからformatタイプの内容を読み込みます。

• 戻り値 Buffer

const buffer = Buffer.from('this is binary', 'utf8');
eagle.clipboard.writeBuffer('public/utf8-plain-text', buffer);

const out = eagle.clipboard.readBuffer('public/utf8-plain-text');

console.log(buffer.equals(out));	// true

---

writeImage(image)

imageをクリップボードに書き込みます。

• image NativeImage - クリップボードに書き込む画像

let img = nativeImage.createFromPath('path_to_img_file');
eagle.clipboard.writeImage(img);

---

readImage()

クリップボードから画像形式のコンテンツを読み取ります。

• 返り値 NativeImage

let input = nativeImage.createFromPath('path_to_img_file');
eagle.clipboard.writeImage(input);

let output = eagle.clipboard.readImage();

---

writeHTML(markup)

markup を HTML 形式でクリップボードに書き込みます。

• markup 文字列

eagle.clipboard.writeHTML('<b>Hi</b>');
console.log(eagle.clipboard.readHTML());	// <b>Hi</b>

---

readHTML()

クリップボードから HTML 形式のコンテンツを読み取ります。

• 返り値 文字列

eagle.clipboard.writeHTML('<b>Hi</b>');
console.log(eagle.clipboard.readHTML());	// <b>Hi</b>

---

copyFiles(paths)

指定されたファイルをクリップボードにコピーし、ファイルマネージャで貼り付けが可能です。

• paths 文字列の配列 - クリップボードにコピーするファイルのパス。

eagle.clipboard.copyFiles([
    'path_to_file',
    'path_to_file2'
]);

---