/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * The contents of this file are subject to the Mozilla Public
 * License Version 1.1 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of
 * the License at http://www.mozilla.org/MPL/
 * 
 * Software distributed under the License is distributed on an "AS
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * rights and limitations under the License.
 * 
 * The Original Code is the Mozilla browser.
 * 
 * The Initial Developer of the Original Code is Netscape
 * Communications, Inc.  Portions created by Netscape are
 * Copyright (C) 1999, Mozilla.  All Rights Reserved.
 * 
 * Contributor(s):
 */

#include "nsISupports.idl"

/**
 * @status UNDER_REVIEW
 */

[scriptable, uuid(b8100c90-73be-11d2-92a5-00105a1b0d64)]
interface nsIClipboardCommands : nsISupports {
	/**
	 * Returns whether there is a selection and it is not read-only.
	 */
	boolean canCutSelection();

	/**
	 * Returns whether there is a selection and it is copyable.
	 */
	boolean canCopySelection();

	/**
	 * Returns whether the current contents of the clipboard can be
	 * pasted and if the current selection is not read-only.
	 */
	boolean canPaste();

	/**
	 * Cut the current selection onto the clipboard.
	 */
	void cutSelection();

	/**
	 * Copy the current selection onto the clipboard.
	 */
	void copySelection();
	
	/**
	 * Copy the URL of the current selection, say for an <IMG> inside an <A>
	 */
	void copyLinkLocation();

	/**
	 * Paste the contents of the clipboard into the current selection.
	 */
	void paste();

	/**
	 * Select the entire contents.
	 */
	void selectAll();

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