content/base/public/nsCopySupport.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef nsCopySupport_h__
  39 #define nsCopySupport_h__
  40
  41 #include "nscore.h"
  42
  43 class nsISelection;
  44 class nsIDocument;
  45 class nsIImageLoadingContent;
  46 class nsIContent;
  47 class nsITransferable;
  48 class nsACString;
  49 class nsAString;
  50 class nsIDOMNode;
  51
  52 class nsCopySupport
  53 {
  54   // class of static helper functions for copy support
  55   public:
  56     static nsresult HTMLCopy(nsISelection *aSel, nsIDocument *aDoc, PRInt16 aClipboardID);
  57     static nsresult DoHooks(nsIDocument *aDoc, nsITransferable *aTrans,
  58                             PRBool *aDoPutOnClipboard);
  59     static nsresult IsPlainTextContext(nsISelection *aSel, nsIDocument *aDoc, PRBool *aIsPlainTextContext);
  60
  61     // Get the selection, or entire document, in the format specified by the mime type
  62     // (text/html or text/plain). If aSel is non-null, use it, otherwise get the entire
  63     // doc.
  64     static nsresult GetContents(const nsACString& aMimeType, PRUint32 aFlags, nsISelection *aSel, nsIDocument *aDoc, nsAString& outdata);
  65
  66     static nsresult ImageCopy(nsIImageLoadingContent* aImageElement,
  67                               PRInt32 aCopyFlags);
  68
  69     // Given the current selection, find the target that
  70     // before[copy,cut,paste] and [copy,cut,paste] events will fire on.
  71     static nsresult GetClipboardEventTarget(nsISelection *aSel,
  72                                             nsIDOMNode **aEventTarget);
  73 };
  74
  75 #endif