docshell/base/nsIClipboardCommands.idl@6474c204b198 (annotated)
docshell/base/nsIClipboardCommands.idl
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- |
| michael@0 | 2 | * |
| michael@0 | 3 | * This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 4 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 5 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 6 | |
| michael@0 | 7 | #include "nsISupports.idl" |
| michael@0 | 8 | |
| michael@0 | 9 | /** |
| michael@0 | 10 | * An interface for embedding clients who wish to interact with |
| michael@0 | 11 | * the system-wide OS clipboard. Mozilla does not use a private |
| michael@0 | 12 | * clipboard, instead it places its data directly onto the system |
| michael@0 | 13 | * clipboard. The webshell implements this interface. |
| michael@0 | 14 | */ |
| michael@0 | 15 | |
| michael@0 | 16 | [scriptable, uuid(b8100c90-73be-11d2-92a5-00105a1b0d64)] |
| michael@0 | 17 | interface nsIClipboardCommands : nsISupports { |
| michael@0 | 18 | |
| michael@0 | 19 | /** |
| michael@0 | 20 | * Returns whether there is a selection and it is not read-only. |
| michael@0 | 21 | * |
| michael@0 | 22 | * @return <code>true</code> if the current selection can be cut, |
| michael@0 | 23 | * <code>false</code> otherwise. |
| michael@0 | 24 | */ |
| michael@0 | 25 | boolean canCutSelection(); |
| michael@0 | 26 | |
| michael@0 | 27 | /** |
| michael@0 | 28 | * Returns whether there is a selection and it is copyable. |
| michael@0 | 29 | * |
| michael@0 | 30 | * @return <code>true</code> if there is a selection, |
| michael@0 | 31 | * <code>false</code> otherwise. |
| michael@0 | 32 | */ |
| michael@0 | 33 | boolean canCopySelection(); |
| michael@0 | 34 | |
| michael@0 | 35 | /** |
| michael@0 | 36 | * Returns whether we can copy a link location. |
| michael@0 | 37 | * |
| michael@0 | 38 | * @return <code>true</code> if a link is selected, |
| michael@0 | 39 | * <code>false</code> otherwise. |
| michael@0 | 40 | */ |
| michael@0 | 41 | boolean canCopyLinkLocation(); |
| michael@0 | 42 | |
| michael@0 | 43 | /** |
| michael@0 | 44 | * Returns whether we can copy an image location. |
| michael@0 | 45 | * |
| michael@0 | 46 | * @return <code>true</code> if an image is selected, |
| michael@0 | 47 | <code>false</code> otherwise. |
| michael@0 | 48 | */ |
| michael@0 | 49 | boolean canCopyImageLocation(); |
| michael@0 | 50 | |
| michael@0 | 51 | /** |
| michael@0 | 52 | * Returns whether we can copy an image's contents. |
| michael@0 | 53 | * |
| michael@0 | 54 | * @return <code>true</code> if an image is selected, |
| michael@0 | 55 | * <code>false</code> otherwise |
| michael@0 | 56 | */ |
| michael@0 | 57 | boolean canCopyImageContents(); |
| michael@0 | 58 | |
| michael@0 | 59 | /** |
| michael@0 | 60 | * Returns whether the current contents of the clipboard can be |
| michael@0 | 61 | * pasted and if the current selection is not read-only. |
| michael@0 | 62 | * |
| michael@0 | 63 | * @return <code>true</code> there is data to paste on the clipboard |
| michael@0 | 64 | * and the current selection is not read-only, |
| michael@0 | 65 | * <code>false</code> otherwise |
| michael@0 | 66 | */ |
| michael@0 | 67 | boolean canPaste(); |
| michael@0 | 68 | |
| michael@0 | 69 | /** |
| michael@0 | 70 | * Cut the current selection onto the clipboard. |
| michael@0 | 71 | */ |
| michael@0 | 72 | void cutSelection(); |
| michael@0 | 73 | |
| michael@0 | 74 | /** |
| michael@0 | 75 | * Copy the current selection onto the clipboard. |
| michael@0 | 76 | */ |
| michael@0 | 77 | void copySelection(); |
| michael@0 | 78 | |
| michael@0 | 79 | /** |
| michael@0 | 80 | * Copy the link location of the current selection (e.g., |
| michael@0 | 81 | * the |href| attribute of a selected |a| tag). |
| michael@0 | 82 | */ |
| michael@0 | 83 | void copyLinkLocation(); |
| michael@0 | 84 | |
| michael@0 | 85 | /** |
| michael@0 | 86 | * Copy the location of the selected image. |
| michael@0 | 87 | */ |
| michael@0 | 88 | void copyImageLocation(); |
| michael@0 | 89 | |
| michael@0 | 90 | /** |
| michael@0 | 91 | * Copy the contents of the selected image. |
| michael@0 | 92 | */ |
| michael@0 | 93 | void copyImageContents(); |
| michael@0 | 94 | |
| michael@0 | 95 | /** |
| michael@0 | 96 | * Paste the contents of the clipboard into the current selection. |
| michael@0 | 97 | */ |
| michael@0 | 98 | void paste(); |
| michael@0 | 99 | |
| michael@0 | 100 | /** |
| michael@0 | 101 | * Select the entire contents. |
| michael@0 | 102 | */ |
| michael@0 | 103 | void selectAll(); |
| michael@0 | 104 | |
| michael@0 | 105 | /** |
| michael@0 | 106 | * Clear the current selection (if any). Insertion point ends up |
| michael@0 | 107 | * at beginning of current selection. |
| michael@0 | 108 | */ |
| michael@0 | 109 | void selectNone(); |
| michael@0 | 110 | |
| michael@0 | 111 | }; |
