1 files changed, 101 insertions, 0 deletions
diff --git a/dom/base/nsCopySupport.h b/dom/base/nsCopySupport.h
new file mode 100644
index 000000000..c03a16047
--- /dev/null
+++ b/dom/base/nsCopySupport.h
@@ -0,0 +1,101 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef nsCopySupport_h__
+#define nsCopySupport_h__
+
+#include "nsError.h"
+#include "nsIDocument.h"
+#include "mozilla/EventForwards.h"
+
+class nsINode;
+class nsISelection;
+class nsIDocument;
+class nsIImageLoadingContent;
+class nsIContent;
+class nsITransferable;
+class nsACString;
+class nsAString;
+class nsIPresShell;
+class nsILoadContext;
+
+class nsCopySupport
+{
+  // class of static helper functions for copy support
+  public:
+    static nsresult ClearSelectionCache();
+    static nsresult HTMLCopy(nsISelection *aSel, nsIDocument *aDoc,
+                             int16_t aClipboardID, bool aWithRubyAnnotation);
+    static nsresult DoHooks(nsIDocument *aDoc, nsITransferable *aTrans,
+                            bool *aDoPutOnClipboard);
+
+    // Get the selection, or entire document, in the format specified by the mime type
+    // (text/html or text/plain). If aSel is non-null, use it, otherwise get the entire
+    // doc.
+    static nsresult GetContents(const nsACString& aMimeType, uint32_t aFlags, nsISelection *aSel, nsIDocument *aDoc, nsAString& outdata);
+    
+    static nsresult ImageCopy(nsIImageLoadingContent* aImageElement,
+                              nsILoadContext* aLoadContext,
+                              int32_t aCopyFlags);
+
+    // Get the selection as a transferable. Similar to HTMLCopy except does
+    // not deal with the clipboard.
+    static nsresult GetTransferableForSelection(nsISelection* aSelection,
+                                                nsIDocument* aDocument,
+                                                nsITransferable** aTransferable);
+
+    // Same as GetTransferableForSelection, but doesn't skip invisible content.
+    static nsresult GetTransferableForNode(nsINode* aNode,
+                                           nsIDocument* aDoc,
+                                           nsITransferable** aTransferable);
+    /**
+     * Retrieve the selection for the given document. If the current focus
+     * within the document has its own selection, aSelection will be set to it
+     * and this focused content node returned. Otherwise, aSelection will be
+     * set to the document's selection and null will be returned.
+     */
+    static nsIContent* GetSelectionForCopy(nsIDocument* aDocument,
+                                           nsISelection** aSelection);
+
+    /**
+     * Returns true if a copy operation is currently permitted based on the
+     * current focus and selection within the specified document.
+     */
+    static bool CanCopy(nsIDocument* aDocument);
+
+    /**
+     * Fires a cut, copy or paste event, on the given presshell, depending
+     * on the value of aEventMessage, which should be either eCut, eCopy or
+     * ePaste, and perform the default copy action if the event was not
+     * cancelled.
+     *
+     * If aSelection is specified, then this selection is used as the target
+     * of the operation. Otherwise, GetSelectionForCopy is used to retrieve
+     * the current selection.
+     *
+     * This will fire a cut, copy or paste event at the node at the start
+     * point of the selection. If a cut or copy event is not cancelled, the
+     * selection is copied to the clipboard and true is returned. Paste events
+     * have no default behaviour but true will be returned. It is expected
+     * that the caller will execute any needed default paste behaviour. Also,
+     * note that this method only copies text to the clipboard, the caller is
+     * responsible for removing the content during a cut operation if true is
+     * returned.
+     *
+     * aClipboardType specifies which clipboard to use, from nsIClipboard.
+     *
+     * If aActionTaken is non-NULL, it will be set to true if an action was
+     * taken, whether it be the default action or the default being prevented.
+     *
+     * If the event is cancelled or an error occurs, false will be returned.
+     */
+    static bool FireClipboardEvent(mozilla::EventMessage aEventMessage,
+                                   int32_t aClipboardType,
+                                   nsIPresShell* aPresShell,
+                                   nsISelection* aSelection,
+                                   bool* aActionTaken = nullptr);
+};
+
+#endif