blob: 3dc1b22e4b9bee88a5ef32b320ac68eb7a9f2c9c [file] [log] [blame]
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#import <Cocoa/Cocoa.h>
#include <memory>
#include "base/files/file_path.h"
#include "base/mac/scoped_cftyperef.h"
#include "base/mac/scoped_nsobject.h"
#include "base/memory/weak_ptr.h"
#include "content/common/content_export.h"
#include "url/gurl.h"
namespace content {
struct DropData;
} // namespace content
namespace remote_cocoa {
namespace mojom {
class WebContentsNSViewHost;
} // namespace mojom
} // namespace remote_cocoa
// A class that handles tracking and event processing for a drag and drop
// originating from the content area.
@interface WebDragSource : NSObject {
// The host through which to communicate with the WebContentsImpl. Owns
// |self| and resets |host_| via clearHostAndWebContentsView.
remote_cocoa::mojom::WebContentsNSViewHost* host_;
// The view from which the drag was initiated. Weak reference.
// An instance of this class may outlive |contentsView_|. The destructor of
// |contentsView_| must set this ivar to |nullptr|.
NSView* contentsView_;
// Our drop data. Should only be initialized once.
std::unique_ptr<content::DropData> dropData_;
// The image to show as drag image. Can be nil.
base::scoped_nsobject<NSImage> dragImage_;
// The offset to draw |dragImage_| at.
NSPoint imageOffset_;
// Our pasteboard.
base::scoped_nsobject<NSPasteboard> pasteboard_;
// A mask of the allowed drag operations.
NSDragOperation dragOperationMask_;
// The file name to be saved to for a drag-out download.
base::FilePath downloadFileName_;
// The URL to download from for a drag-out download.
GURL downloadURL_;
// The file UTI associated with the file drag, if any.
base::ScopedCFTypeRef<CFStringRef> fileUTI_;
// Initialize a WebDragSource object for a drag (originating on the given
// contentsView and with the given dropData and pboard). Fill the pasteboard
// with data types appropriate for dropData.
- (id)initWithHost:(remote_cocoa::mojom::WebContentsNSViewHost*)host
dropData:(const content::DropData*)dropData
// Call when the web contents is gone.
- (void)clearHostAndWebContentsView;
// Returns a mask of the allowed drag operations.
- (NSDragOperation)draggingSourceOperationMaskForLocal:(BOOL)isLocal;
// Call when asked to do a lazy write to the pasteboard; hook up to
// -pasteboard:provideDataForType: (on the contentsView).
- (void)lazyWriteToPasteboard:(NSPasteboard*)pboard
// Start the drag (on the originally provided contentsView); can do this right
// after -initWithContentsView:....
- (void)startDrag;
// End the drag and clear the pasteboard; hook up to
// -draggedImage:endedAt:operation:.
- (void)endDragAt:(NSPoint)screenPoint
// Call to drag a promised file to the given path (should be called before
// -endDragAt:...); hook up to -namesOfPromisedFilesDroppedAtDestination:.
// Returns the file name (not including path) of the file deposited (or which
// will be deposited).
- (NSString*)dragPromisedFileTo:(NSString*)path;