File: DataTransfer.h

package info (click to toggle)
chromium-browser 41.0.2272.118-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 2,189,132 kB
  • sloc: cpp: 9,691,462; ansic: 3,341,451; python: 712,689; asm: 518,779; xml: 208,926; java: 169,820; sh: 119,353; perl: 68,907; makefile: 28,311; yacc: 13,305; objc: 11,385; tcl: 3,186; cs: 2,225; sql: 2,217; lex: 2,215; lisp: 1,349; pascal: 1,256; awk: 407; ruby: 155; sed: 53; php: 14; exp: 11
file content (147 lines) | stat: -rw-r--r-- 5,506 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
/*
 * Copyright (C) 2001 Peter Kelly (pmk@post.com)
 * Copyright (C) 2001 Tobias Anton (anton@stud.fbi.fh-darmstadt.de)
 * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
 * 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
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * 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 DataTransfer_h
#define DataTransfer_h

#include "bindings/core/v8/ScriptWrappable.h"
#include "core/clipboard/DataTransferAccessPolicy.h"
#include "core/fetch/ImageResource.h"
#include "core/fetch/ResourcePtr.h"
#include "core/page/DragActions.h"
#include "platform/geometry/IntPoint.h"
#include "platform/heap/Handle.h"
#include "wtf/Forward.h"
#include "wtf/RefCounted.h"
#include "wtf/RefPtr.h"
#include "wtf/Vector.h"

namespace blink {

class DataObject;
class DataTransferItemList;
class DragImage;
class Element;
class ExceptionState;
class FileList;
class LocalFrame;
class Node;
class Range;

// Used for drag and drop and copy/paste.
// Drag and Drop: http://www.whatwg.org/specs/web-apps/current-work/multipage/dnd.html
// Clipboard API (copy/paste): http://dev.w3.org/2006/webapi/clipops/clipops.html
class DataTransfer : public RefCountedWillBeGarbageCollectedFinalized<DataTransfer>, public ScriptWrappable {
    DEFINE_WRAPPERTYPEINFO();
public:
    // Whether this transfer is serving a drag-drop or copy-paste request.
    enum DataTransferType {
        CopyAndPaste,
        DragAndDrop,
    };

    static PassRefPtrWillBeRawPtr<DataTransfer> create(DataTransferType, DataTransferAccessPolicy, PassRefPtrWillBeRawPtr<DataObject>);
    ~DataTransfer();

    bool isForCopyAndPaste() const { return m_transferType == CopyAndPaste; }
    bool isForDragAndDrop() const { return m_transferType == 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;
    void setData(const String& type, const String& data);

    // extensions beyond IE's API
    Vector<String> types() const;
    FileList* files() const;

    IntPoint dragLocation() const { return m_dragLoc; }
    void setDragImage(Element*, int x, int y, ExceptionState&);
    void clearDragImage();
    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, LocalFrame*) const;
    void declareAndWriteDragImage(Element*, const KURL&, const String& title);
    void writeURL(const KURL&, const String&);
    void writeRange(Range*, LocalFrame*);
    void writePlainText(const String&);

    bool hasData();

    void setAccessPolicy(DataTransferAccessPolicy);
    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&);

    PassRefPtrWillBeRawPtr<DataTransferItemList> items();

    PassRefPtrWillBeRawPtr<DataObject> dataObject() const;

    void trace(Visitor*);

private:
    DataTransfer(DataTransferType, DataTransferAccessPolicy, PassRefPtrWillBeRawPtr<DataObject>);

    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.
    DataTransferAccessPolicy m_policy;
    String m_dropEffect;
    String m_effectAllowed;
    DataTransferType m_transferType;
    RefPtrWillBeMember<DataObject> m_dataObject;

    IntPoint m_dragLoc;
    ResourcePtr<ImageResource> m_dragImage;
    RefPtrWillBeMember<Node> m_dragImageElement;
};

DragOperation convertDropZoneOperationToDragOperation(const String& dragOperation);
String convertDragOperationToDropZoneOperation(DragOperation);

} // namespace blink

#endif // DataTransfer_h