// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef ASH_APP_LIST_APP_LIST_VIEW_DELEGATE_H_
#define ASH_APP_LIST_APP_LIST_VIEW_DELEGATE_H_
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "ash/app_list/app_list_metrics.h"
#include "ash/assistant/ui/assistant_view_delegate.h"
#include "ash/public/cpp/app_list/app_list_client.h"
#include "ash/public/cpp/app_list/app_list_types.h"
#include "ash/public/cpp/ash_public_export.h"
#include "base/functional/callback_forward.h"
#include "base/memory/weak_ptr.h"
#include "chromeos/ash/services/assistant/public/cpp/assistant_enums.h"
#include "ui/base/ui_base_types.h"
#include "ui/gfx/geometry/point.h"
#include "ui/gfx/geometry/rect.h"
#include "url/gurl.h"
namespace ui {
class SimpleMenuModel;
} // namespace ui
namespace ash {
class AppListNotifier;
enum class AppListViewState;
struct AppLaunchedMetricParams;
// Wrapper for AppListControllerImpl, used by various app list views.
class ASH_PUBLIC_EXPORT AppListViewDelegate {
public:
virtual ~AppListViewDelegate() = default;
// Returns the AppListNotifier instance. The notifier is owned by the
// AppListClient, and may be nullptr if no client has been set for the
// delegate.
virtual AppListNotifier* GetNotifier() = 0;
// Creates a `ScopedIphSession` for interacting with LauncherSearchHelpUi
// feature. A caller must show an IPH UI after this returns a session. This
// returns nullptr if `feature_engagement::Tracker::ShouldTriggerHelpUI`
// returns false.
virtual std::unique_ptr<ScopedIphSession>
CreateLauncherSearchIphSession() = 0;
// Invoked to start a new Google Assistant session.
virtual void StartAssistant(assistant::AssistantEntryPoint entry_point) = 0;
// Invoked to end a Google Assistant session.
virtual void EndAssistant(assistant::AssistantExitPoint exit_point) = 0;
// Returns the search categories that are available for users to choose if
// they want to have the results in the categories displayed in launcher
// search.
virtual std::vector<AppListSearchControlCategory> GetToggleableCategories()
const = 0;
// Invoked to start a new search. This collects a list of search results
// matching the raw query, which is an unhandled string typed into the search
// box by the user.
virtual void StartSearch(const std::u16string& raw_query) = 0;
// Starts zero state search to load suggested content shown in productivity
// launcher. Called when the tablet mode productivity launcher visibility
// starts changing to visible. `callback` is called when the zero state search
// completes, or times out (i.e. takes more time than `timeout`).
virtual void StartZeroStateSearch(base::OnceClosure callback,
base::TimeDelta timeout) = 0;
// Invoked to open the search result and log a click. If the result is
// represented by a SuggestedChipView or is a zero state result,
// |suggested_index| is the index of the view in the list of suggestions.
// |launch_type| is either kAppSearchResult or kSearchResult and is used to
// determine which histograms to log to. |launch_as_default|: True if the
// result is launched as the default result by user pressing ENTER key.
virtual void OpenSearchResult(const std::string& result_id,
int event_flags,
AppListLaunchedFrom launched_from,
AppListLaunchType launch_type,
int suggestion_index,
bool launch_as_default) = 0;
// Called to invoke a custom action on a result with |result_id|.
virtual void InvokeSearchResultAction(const std::string& result_id,
SearchResultActionType action) = 0;
// Returns the context menu model for a ChromeSearchResult with |result_id|,
// or nullptr if there is currently no menu for the result.
// Note the returned menu model is owned by that result.
using GetContextMenuModelCallback =
base::OnceCallback<void(std::unique_ptr<ui::SimpleMenuModel>)>;
// Invoked when the app list is shown.
virtual void ViewShown(int64_t display_id) = 0;
// Invoked to dismiss app list. This may leave the view open but hidden from
// the user.
virtual void DismissAppList() = 0;
// Invoked when the app list is closing.
virtual void ViewClosing() = 0;
// Activates (opens) the item.
virtual void ActivateItem(const std::string& id,
int event_flags,
AppListLaunchedFrom launched_from,
bool is_app_above_the_fold) = 0;
// Returns the context menu model for a ChromeAppListItem with |id|, or
// nullptr if there is currently no menu for the item (e.g. during install).
// `item_context` indicates which piece of UI is showing the item (e.g. apps
// grid or recent apps). Note the returned menu model is owned by that item.
virtual void GetContextMenuModel(const std::string& id,
AppListItemContext item_context,
GetContextMenuModelCallback callback) = 0;
// Show wallpaper context menu from the specified onscreen location.
virtual void ShowWallpaperContextMenu(const gfx::Point& onscreen_location,
ui::MenuSourceType source_type) = 0;
// Returns True if the last event passing through app list was a key event.
// This is stored in the controller and managed by the presenter.
virtual bool KeyboardTraversalEngaged() = 0;
// Checks if we are allowed to process events on the app list main view and
// its descendants.
virtual bool CanProcessEventsOnApplistViews() = 0;
// Returns whether the app list should dismiss immediately. For example, when
// the assistant takes a screenshot the app list is closed immediately so it
// doesn't appear in the screenshot.
virtual bool ShouldDismissImmediately() = 0;
// Returns the AssistantViewDelegate.
virtual AssistantViewDelegate* GetAssistantViewDelegate() = 0;
// Called if a search result has its visibility updated and wants to
// be notified (i.e. its notify_visibility_change() returns true).
virtual void OnSearchResultVisibilityChanged(const std::string& id,
bool visibility) = 0;
// Returns true if the Assistant feature is allowed and enabled.
virtual bool IsAssistantAllowedAndEnabled() const = 0;
// Gets the app list page currently shown in the fullscreen app list, as
// reported from the app list view using `OnAppListPageChanged()`.
virtual AppListState GetCurrentAppListPage() const = 0;
// Called when the page shown in the app list contents view is updated.
virtual void OnAppListPageChanged(AppListState page) = 0;
// Gets the current app list view state, as reported by app list view using
// `OnViewStateChanged()`. Tracked for fullscreen app list view only.
virtual AppListViewState GetAppListViewState() const = 0;
// Called when the app list view state is updated.
virtual void OnViewStateChanged(AppListViewState state) = 0;
// Called when the app list state transition animation is completed.
virtual void OnStateTransitionAnimationCompleted(
AppListViewState state,
bool was_animation_interrupted) = 0;
// Fills the given AppLaunchedMetricParams with info known by the delegate.
virtual void GetAppLaunchedMetricParams(
AppLaunchedMetricParams* metric_params) = 0;
// Adjusts the bounds by snapping it to the edge of the display in pixel
// space. This prevents 1px gaps on displays with non-integer scale factors.
virtual gfx::Rect SnapBoundsToDisplayEdge(const gfx::Rect& bounds) = 0;
// Returns whether the app list is visible on the display. This checks that
// the app list windows is open and not obstructed by another window.
virtual bool AppListTargetVisibility() const = 0;
// Gets the current shelf height (or width for side-shelf) from the
// ShelfConfig.
virtual int GetShelfSize() = 0;
// Gets the tablet mode shelf insets from the ShelfConfig.
virtual int GetSystemShelfInsetsInTabletMode() = 0;
// Returns whether tablet mode is currently enabled.
virtual bool IsInTabletMode() const = 0;
// Loads the icon of an app item identified by `app_id`.
virtual void LoadIcon(const std::string& app_id) = 0;
// Whether the controller has a valid profile, and hence a valid data model.
// Returns false during startup and shutdown.
virtual bool HasValidProfile() const = 0;
// Whether the user wants to hide the continue section and recent apps. Used
// by productivity launcher only.
virtual bool ShouldHideContinueSection() const = 0;
// Sets whether the user wants to hide the continue section and recent apps.
// Used by productivity launcher only.
virtual void SetHideContinueSection(bool hide) = 0;
// Returns whether the search category `category` is enabled.
virtual bool IsCategoryEnabled(AppListSearchControlCategory category) = 0;
// Sets the preference of displaying `category` to users to `enabled`.
virtual void SetCategoryEnabled(AppListSearchControlCategory category,
bool enabled) = 0;
// Records metrics regarding the apps visibiity from the launcher's default
// state. For example, for scrollable apps grid view, an item view would be
// above the fold if it is visible without scrolling.
virtual void RecordAppsDefaultVisibility(
const std::vector<std::string>& apps_above_the_fold,
const std::vector<std::string>& apps_below_the_fold,
bool is_apps_collections_page) = 0;
};
} // namespace ash
#endif // ASH_APP_LIST_APP_LIST_VIEW_DELEGATE_H_
Codebase Browser
chromium