Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIClipboardCommands Interface Reference

An interface for embedding clients who wish to interact with the system-wide OS clipboard. More...

import "nsIClipboardCommands.idl";

Inheritance diagram for nsIClipboardCommands:
Inheritance graph
[legend]
Collaboration diagram for nsIClipboardCommands:
Collaboration graph
[legend]

List of all members.

Public Member Functions

boolean canCutSelection ()
 Returns whether there is a selection and it is not read-only.
boolean canCopySelection ()
 Returns whether there is a selection and it is copyable.
boolean canCopyLinkLocation ()
 Returns whether we can copy a link location.
boolean canCopyImageLocation ()
 Returns whether we can copy an image location.
boolean canCopyImageContents ()
 Returns whether we can copy an image's contents.
boolean canPaste ()
 Returns whether the current contents of the clipboard can be pasted and if the current selection is not read-only.
void cutSelection ()
 Cut the current selection onto the clipboard.
void copySelection ()
 Copy the current selection onto the clipboard.
void copyLinkLocation ()
 Copy the link location of the current selection (e.g., the |href| attribute of a selected |a| tag).
void copyImageLocation ()
 Copy the location of the selected image.
void copyImageContents ()
 Copy the contents of the selected image.
void paste ()
 Paste the contents of the clipboard into the current selection.
void selectAll ()
 Select the entire contents.
void selectNone ()
 Clear the current selection (if any).

Detailed Description

An interface for embedding clients who wish to interact with the system-wide OS clipboard.

Mozilla does not use a private clipboard, instead it places its data directly onto the system clipboard. The webshell implements this interface.

FROZEN

Definition at line 52 of file nsIClipboardCommands.idl.


Member Function Documentation

Returns whether we can copy an image's contents.

Returns:
true if an image is selected, false otherwise

Returns whether we can copy an image location.

Returns:
true if an image is selected, false otherwise.

Returns whether we can copy a link location.

Returns:
true if a link is selected, false otherwise.

Returns whether there is a selection and it is copyable.

Returns:
true if there is a selection, false otherwise.

Returns whether there is a selection and it is not read-only.

Returns:
true if the current selection can be cut, false otherwise.

Returns whether the current contents of the clipboard can be pasted and if the current selection is not read-only.

Returns:
true there is data to paste on the clipboard and the current selection is not read-only, false otherwise

Copy the contents of the selected image.

Copy the location of the selected image.

Copy the link location of the current selection (e.g., the |href| attribute of a selected |a| tag).

Copy the current selection onto the clipboard.

Cut the current selection onto the clipboard.

Paste the contents of the clipboard into the current selection.

Select the entire contents.

Clear the current selection (if any).

Insertion point ends up at beginning of current selection.


The documentation for this interface was generated from the following file: