share_action.h | Explore in Territory

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

#ifndef CHROME_BROWSER_SHARESHEET_SHARE_ACTION_SHARE_ACTION_H_
#define CHROME_BROWSER_SHARESHEET_SHARE_ACTION_SHARE_ACTION_H_

#include <string>

#include "base/functional/callback.h"
#include "chrome/browser/sharesheet/sharesheet_types.h"
#include "components/services/app_service/public/cpp/intent.h"
#include "ui/base/accelerators/accelerator.h"
#include "ui/views/view.h"

namespace gfx {
struct VectorIcon;
}  // namespace gfx

namespace sharesheet {

class SharesheetController;

// An interface implemented by each ShareAction.
class ShareAction {
 public:
  virtual ~ShareAction() = default;

  virtual ShareActionType GetActionType() const = 0;

  virtual const std::u16string GetActionName() = 0;

  virtual const gfx::VectorIcon& GetActionIcon() = 0;

  // LaunchAction should synchronously create all UI needed and fill
  // the |root_view|. Methods on |controller| can be used to inform
  // the sharesheet about the lifecycle of the ShareAction.
  //
  // |root_view| is a container within the larger share_sheet which should act
  // as the parent view for ShareAction views. It is guaranteed that
  // |root_view| and |controller| will stay alive and visible until either
  // ShareAction::OnClosing is called, or the ShareAction calls
  // |controller|->ShareActionCompleted(). If HasActionView() returns false,
  // |root_view| will be a nullptr.
  //
  // |intent| contains the data (including the file URLs) for the share action
  // to parse and interpret if needed for its UI and functionality.
  virtual void LaunchAction(SharesheetController* controller,
                            views::View* root_view,
                            apps::IntentPtr intent) = 0;

  // OnClosing informs the ShareAction when the sharesheet with |controller| is
  // closed. This occurs when the user presses the back button out of the share
  // action view or closes the sharesheet. All processes in ShareAction should
  // shutdown when OnClosing is called, and not use |root_view| or |controller|
  // once the method completes as they will be destroyed.
  virtual void OnClosing(SharesheetController* controller) = 0;

  // Return true if the action has its own view that should be shown after the
  // action has been selected. Returns false by default.
  virtual bool HasActionView();

  // Return true if the action should be shown on the sharesheet. By default,
  // the actions are only visible if the files don't contain a Google Drive
  // hosted document.
  virtual bool ShouldShowAction(const apps::IntentPtr& intent,
                                bool contains_hosted_document);

  // Invoked when the accelerator has been pressed.
  // ShareAction should return true if the accelerator has been processed and
  // false otherwise. If not processed, the Sharesheet will close.
  virtual bool OnAcceleratorPressed(const ui::Accelerator& accelerator);

  // Only called for shares started with ShowNearbyShareBubbleForArc. This
  // interface should not be needed by other ShareActions. Invoked to indicate
  // that resource cleanup is required. |callback| will perform any necessary
  // resource cleanup for data that is passed through the intent. If |callback|
  // is set, ShareAction must run |callback| when it has finished using the
  // intent data to ensure this cleanup occurs.
  virtual void SetActionCleanupCallbackForArc(
      base::OnceCallback<void()> callback);
};

}  // namespace sharesheet

#endif  // CHROME_BROWSER_SHARESHEET_SHARE_ACTION_SHARE_ACTION_H_
chromium/chrome/browser/sharesheet/share_action/share_action.h
