Struct xpcom::interfaces::nsIClipboardCommands [] [src]

#[repr(C)]
pub struct nsIClipboardCommands { /* fields omitted */ }

interface nsIClipboardCommands : nsISupports

/**
 * 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.
 */

Methods

impl nsIClipboardCommands
[src]

[src]

Cast this nsIClipboardCommands to one of its base interfaces.

impl nsIClipboardCommands
[src]

[src]

/**
   * Returns whether there is a selection and it is not read-only.
   *
   * @return <code>true</code> if the current selection can be cut,
   *          <code>false</code> otherwise.
   */

boolean canCutSelection ();

[src]

/**
   * Returns whether there is a selection and it is copyable.
   *
   * @return <code>true</code> if there is a selection,
   *          <code>false</code> otherwise.
   */

boolean canCopySelection ();

[src]

/**
   * Returns whether we can copy a link location.
   *
   * @return <code>true</code> if a link is selected,
   *           <code>false</code> otherwise.
   */

boolean canCopyLinkLocation ();

[src]

/**
   * Returns whether we can copy an image location.
   *
   * @return <code>true</code> if an image is selected,
              <code>false</code> otherwise.
   */

boolean canCopyImageLocation ();

[src]

/**
   * Returns whether we can copy an image's contents.
   *
   * @return <code>true</code> if an image is selected,
   *          <code>false</code> otherwise
   */

boolean canCopyImageContents ();

[src]

/**
   * Returns whether the current contents of the clipboard can be
   * pasted and if the current selection is not read-only.
   *
   * @return <code>true</code> there is data to paste on the clipboard
   *          and the current selection is not read-only,
   *          <code>false</code> otherwise
   */

boolean canPaste ();

[src]

/**
   * Cut the current selection onto the clipboard.
   */

void cutSelection ();

[src]

/**
   * Copy the current selection onto the clipboard.
   */

void copySelection ();

[src]

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

void copyLinkLocation ();

[src]

/**
   * Copy the location of the selected image.
   */

void copyImageLocation ();

[src]

/**
   * Copy the contents of the selected image.
   */

void copyImageContents ();

[src]

/**
   * Paste the contents of the clipboard into the current selection.
   */

void paste ();

[src]

/**
   * Select the entire contents.
   */

void selectAll ();

[src]

/**
   * Clear the current selection (if any). Insertion point ends up
   * at beginning of current selection.
   */

void selectNone ();

Methods from Deref<Target = nsISupports>

[src]

Cast this nsISupports to one of its base interfaces.

[src]

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

[src]

[noscript,notxpcom] nsrefcnt AddRef ();

[src]

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsIClipboardCommands
[src]

IID: nsIID = nsID(3088059536, 29630, 4562, [146, 165, 0, 16, 90, 27, 13, 100])

[src]

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise. Read more

impl RefCounted for nsIClipboardCommands
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIClipboardCommands
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.