Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIClipboard Interface Reference

import "nsIClipboard.idl";

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

List of all members.

Public Member Functions

void setData (in nsITransferable aTransferable, in nsIClipboardOwner anOwner, in long aWhichClipboard)
 Given a transferable, set the data on the native clipboard.
void getData (in nsITransferable aTransferable, in long aWhichClipboard)
 Given a transferable, get the clipboard data.
void emptyClipboard (in long aWhichClipboard)
 This empties the clipboard and notifies the clipboard owner.
boolean hasDataMatchingFlavors (in nsISupportsArray aFlavorList, in long aWhichClipboard)
 This provides a way to give correct UI feedback about, for instance, a paste should be allowed.
boolean supportsSelectionClipboard ()
 Allows clients to determine if the implementation supports the concept of a separate clipboard for selection.

Public Attributes

const long kSelectionClipboard = 0
const long kGlobalClipboard = 1

Detailed Description

Definition at line 48 of file nsIClipboard.idl.


Member Function Documentation

void nsIClipboard::emptyClipboard ( in long  aWhichClipboard)

This empties the clipboard and notifies the clipboard owner.

This empties the "logical" clipboard. It does not clear the native clipboard.

Parameters:
aWhichClipboardSpecifies the clipboard to which this operation applies.
Returns:
NS_OK if successful.
void nsIClipboard::getData ( in nsITransferable  aTransferable,
in long  aWhichClipboard 
)

Given a transferable, get the clipboard data.

Parameters:
aTransferableThe transferable
aWhichClipboardSpecifies the clipboard to which this operation applies.
Returns:
NS_Ok if no errors
boolean nsIClipboard::hasDataMatchingFlavors ( in nsISupportsArray  aFlavorList,
in long  aWhichClipboard 
)

This provides a way to give correct UI feedback about, for instance, a paste should be allowed.

It does NOT actually retreive the data and should be a very inexpensive call. All it does is check if there is data on the clipboard matching any of the flavors in the given list.

- nsISupportsCString's in a nsISupportsArray (for JavaScript).

Parameters:
aWhichClipboardSpecifies the clipboard to which this operation applies. - if data is present matching one of
Returns:
NS_OK if successful.
void nsIClipboard::setData ( in nsITransferable  aTransferable,
in nsIClipboardOwner  anOwner,
in long  aWhichClipboard 
)

Given a transferable, set the data on the native clipboard.

Parameters:
aTransferableThe transferable
anOwnerThe owner of the transferable
aWhichClipboardSpecifies the clipboard to which this operation applies.
Returns:
NS_Ok if no errors

Allows clients to determine if the implementation supports the concept of a separate clipboard for selection.

- true if

Returns:
NS_OK if successful.

Member Data Documentation

Definition at line 51 of file nsIClipboard.idl.

Definition at line 50 of file nsIClipboard.idl.


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