blob: dfe22710e7643811e229de083cdc141da673e1a7 [file] [log] [blame]
* Copyright (C) 2001 Peter Kelly (
* Copyright (C) 2001 Tobias Anton (
* Copyright (C) 2006 Samuel Weinig (
* Copyright (C) 2003, 2004, 2005, 2006, 2008 Apple Inc. All rights reserved.
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* Library General Public License for more details.
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
#ifndef Clipboard_h
#define Clipboard_h
#include "bindings/v8/ScriptWrappable.h"
#include "core/dom/ClipboardAccessPolicy.h"
#include "core/fetch/ResourcePtr.h"
#include "core/page/DragActions.h"
#include "platform/geometry/IntPoint.h"
#include "wtf/Forward.h"
#include "wtf/RefCounted.h"
#include "wtf/RefPtr.h"
#include "wtf/Vector.h"
namespace WebCore {
class ChromiumDataObject;
class DataTransferItemList;
class DragImage;
class Element;
class ExceptionState;
class FileList;
class Frame;
class ImageResource;
class Node;
class Range;
// State available during IE's events for drag and drop and copy/paste
class Clipboard : public RefCounted<Clipboard>, public ScriptWrappable {
// Whether this clipboard is serving a drag-drop or copy-paste request.
enum ClipboardType {
static PassRefPtr<Clipboard> create(ClipboardType, ClipboardAccessPolicy, PassRefPtr<ChromiumDataObject>);
bool isForCopyAndPaste() const { return m_clipboardType == CopyAndPaste; }
bool isForDragAndDrop() const { return m_clipboardType == DragAndDrop; }
String dropEffect() const { return dropEffectIsUninitialized() ? "none" : m_dropEffect; }
void setDropEffect(const String&);
bool dropEffectIsUninitialized() const { return m_dropEffect == "uninitialized"; }
String effectAllowed() const { return m_effectAllowed; }
void setEffectAllowed(const String&);
void clearData(const String& type = String());
String getData(const String& type) const;
bool setData(const String& type, const String& data);
// extensions beyond IE's API
Vector<String> types() const;
PassRefPtr<FileList> files() const;
IntPoint dragLocation() const { return m_dragLoc; }
void setDragImage(Element*, int x, int y, ExceptionState&);
ImageResource* dragImageResource() const { return m_dragImage.get(); }
void setDragImageResource(ImageResource*, const IntPoint&);
Node* dragImageElement() const { return m_dragImageElement.get(); }
void setDragImageElement(Node*, const IntPoint&);
PassOwnPtr<DragImage> createDragImage(IntPoint& dragLocation, Frame*) const;
void declareAndWriteDragImage(Element*, const KURL&, const String& title);
void writeURL(const KURL&, const String&);
void writeRange(Range*, Frame*);
void writePlainText(const String&);
bool hasData();
void setAccessPolicy(ClipboardAccessPolicy);
bool canReadTypes() const;
bool canReadData() const;
bool canWriteData() const;
// Note that the spec doesn't actually allow drag image modification outside the dragstart
// event. This capability is maintained for backwards compatiblity for ports that have
// supported this in the past. On many ports, attempting to set a drag image outside the
// dragstart operation is a no-op anyway.
bool canSetDragImage() const;
DragOperation sourceOperation() const;
DragOperation destinationOperation() const;
void setSourceOperation(DragOperation);
void setDestinationOperation(DragOperation);
bool hasDropZoneType(const String&);
PassRefPtr<DataTransferItemList> items();
PassRefPtr<ChromiumDataObject> dataObject() const;
Clipboard(ClipboardType, ClipboardAccessPolicy, PassRefPtr<ChromiumDataObject>);
void setDragImage(ImageResource*, Node*, const IntPoint&);
bool hasFileOfType(const String&) const;
bool hasStringOfType(const String&) const;
// Instead of using this member directly, prefer to use the can*() methods above.
ClipboardAccessPolicy m_policy;
String m_dropEffect;
String m_effectAllowed;
ClipboardType m_clipboardType;
RefPtr<ChromiumDataObject> m_dataObject;
IntPoint m_dragLoc;
ResourcePtr<ImageResource> m_dragImage;
RefPtr<Node> m_dragImageElement;
DragOperation convertDropZoneOperationToDragOperation(const String& dragOperation);
String convertDragOperationToDropZoneOperation(DragOperation);
} // namespace WebCore
#endif // Clipboard_h