kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-05-22 12:33:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update clipboard module

Browse Source
This commit is contained in:
Milan Burda
2016-03-25 21:11:04 +01:00
parent 1bde04c781
commit e4ca24ac33
3 changed files with 58 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
github-electron/github-electron.clipboard.d.ts vendored
View File

@@ -6,37 +6,71 @@
/// <reference path="github-electron.native-image.d.ts" />
declare namespace Electron {
/**
* The clipboard module provides methods to perform copy and paste operations.
*/
interface Clipboard {
/**
* @returns The contents of the clipboard as plain text.
*/
readText(type?: string): string;
readText(type?: ClipboardType): string;
/**
* Writes the text into the clipboard as plain text.
*/
writeText(text: string, type?: string): void;
writeText(text: string, type?: ClipboardType): void;
/**
* @returns The contents of the clipboard as markup.
*/
readHtml(type?: ClipboardType): string;
/**
* Writes markup to the clipboard.
*/
writeHtml(markup: string, type?: ClipboardType): void;
/**
* @returns The contents of the clipboard as a NativeImage.
*/
readImage(type?: string): NativeImage;
readImage(type?: ClipboardType): NativeImage;
/**
* Writes the image into the clipboard.
*/
writeImage(image: NativeImage, type?: string): void;
writeImage(image: NativeImage, type?: ClipboardType): void;
/**
* @returns The contents of the clipboard as RTF.
*/
readRtf(type?: ClipboardType): string;
/**
* Writes the text into the clipboard in RTF.
*/
writeRtf(text: string, type?: ClipboardType): void;
/**
* Clears everything in clipboard.
*/
clear(type?: string): void;
clear(type?: ClipboardType): void;
/**
* @returns Array available formats for the clipboard type.
*/
availableFormats(type?: ClipboardType): string[];
/**
* Returns whether the clipboard supports the format of specified data.
* Note: This API is experimental and could be removed in future.
* @returns Whether the clipboard has data in the specified format.
*/
has(format: string, type?: string): boolean;
has(format: string, type?: ClipboardType): boolean;
/**
* Reads the data in the clipboard of the specified format.
* Note: This API is experimental and could be removed in future.
*/
read(format: string, type?: string): any;
read(format: string, type?: ClipboardType): any;
/**
* Writes data to the clipboard.
*/
write(data: {
text?: string;
rtf?: string;
html?: string;
image?: NativeImage;
}, type?: ClipboardType): void;
}
type ClipboardType = '' | 'selection';
}