web_contents_view_cocoa.h

// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CONTENT_APP_SHIM_REMOTE_COCOA_WEB_CONTENTS_VIEW_COCOA_H_
#define CONTENT_APP_SHIM_REMOTE_COCOA_WEB_CONTENTS_VIEW_COCOA_H_

#include "base/mac/scoped_nsobject.h"
#include "base/memory/raw_ptr.h"
#include "content/common/content_export.h"
#include "content/common/web_contents_ns_view_bridge.mojom.h"
#import "ui/base/cocoa/base_view.h"
#import "ui/base/cocoa/views_hostable.h"

namespace content {
struct DropData;
}  // namespace content

namespace remote_cocoa {
class DroppedScreenShotCopierMac;
namespace mojom {
class WebContentsNSViewHost;
}  // namespace mojom
}  // namespace remote_cocoa

@class WebDragSource;

CONTENT_EXPORT
@interface WebContentsViewCocoa
    : BaseView <ViewsHostable, NSDraggingSource, NSDraggingDestination> {
 @private
  // Instances of this class are owned by both `_host` and AppKit. The `_host`
  // must call `-setHost:nil` in its destructor.
  raw_ptr<remote_cocoa::mojom::WebContentsNSViewHost> _host;

  // The interface exported to views::Views that embed this as a sub-view.
  raw_ptr<ui::ViewsHostableView> _viewsHostableView;

  BOOL _mouseDownCanMoveWindow;

  // Utility to copy screenshots to a usable directory for PWAs. This utility
  // will maintain a temporary directory for such screenshot files until this
  // WebContents is destroyed.
  // https://crbug.com/1148078
  std::unique_ptr<remote_cocoa::DroppedScreenShotCopierMac>
      _droppedScreenShotCopier;

  // Drag variables.
  base::scoped_nsobject<WebDragSource> _dragSource;
  NSDragOperation _dragOperation;
  NSPoint _dragOffset;
  CGFloat _dragImageHeight;
}

// Set or un-set the mojo interface through which to communicate with the
// browser process.
- (void)setHost:(remote_cocoa::mojom::WebContentsNSViewHost*)host;

- (void)setMouseDownCanMoveWindow:(BOOL)canMove;

// Enable the workaround for https://crbug.com/1148078. This is called by
// in-PWA-process instances, to limit the workaround's effect to just PWAs.
- (void)enableDroppedScreenShotCopier;

// Private interface.
// TODO(ccameron): Document these functions.
- (instancetype)initWithViewsHostableView:(ui::ViewsHostableView*)v;
- (void)registerDragTypes;
- (void)startDragWithDropData:(const content::DropData&)dropData
            dragOperationMask:(NSDragOperation)operationMask
                        image:(NSImage*)image
                       offset:(NSPoint)offset;
- (void)clearViewsHostableView;
- (void)viewDidBecomeFirstResponder:(NSNotification*)notification;

// API exposed for testing.

// Used to set the web contents's visibility status to occluded after a delay.
- (void)performDelayedSetWebContentsOccluded;

// Returns YES if the WCVC is scheduled to set its web contents's to the
// occluded state.
- (BOOL)willSetWebContentsOccludedAfterDelayForTesting;

// Updates the WCVC's web contents's visibility state. The update may occur
// immediately or in the near future.
- (void)updateWebContentsVisibility:(remote_cocoa::mojom::Visibility)visibility;

@end

@interface NSWindow (WebContentsViewCocoa)
// Returns all the WebContentsViewCocoas in the window.
- (NSArray<WebContentsViewCocoa*>*)webContentsViewCocoa;
// Returns YES if the window contains at least one WebContentsViewCocoa.
- (BOOL)containsWebContentsViewCocoa;
@end

#endif  // CONTENT_APP_SHIM_REMOTE_COCOA_WEB_CONTENTS_VIEW_COCOA_H_