blob: 6763090a9d4338c6b34b8580829639b7d3ec62a7 [file] [log] [blame]
// Copyright 2013 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.
#include <stdint.h>
#include "ash/ash_export.h"
#include "ash/display/window_tree_host_manager.h"
#include "base/callback.h"
#include "base/gtest_prod_util.h"
#include "base/macros.h"
#include "base/memory/weak_ptr.h"
#include "base/timer/timer.h"
#include "ui/display/display_observer.h"
#include "ui/gfx/geometry/size.h"
#include "ui/message_center/public/cpp/notification_delegate.h"
namespace ash {
FORWARD_DECLARE_TEST(DisplayPrefsTest, PreventStore);
// A class which manages the notification of display resolution change and
// also manages the timeout in case the new resolution is unusable.
class ASH_EXPORT ResolutionNotificationController
: public display::DisplayObserver,
public WindowTreeHostManager::Observer,
public message_center::NotificationObserver {
~ResolutionNotificationController() override;
// If |display_id| is not the internal display, Prepare a resolution change
// notification for |display_id| from |old_resolution| to |new_resolution|,
// which offers a button to revert the change in case something goes wrong.
// The notification times out if there's only one display connected and the
// user is trying to modify its resolution. In that case, the timeout has to
// be set since the user cannot make any changes if something goes wrong.
// Then call DisplayManager::SetDisplayMode() to apply the resolution change,
// and return the result; true if success, false otherwise.
// In case SetDisplayMode() fails, the prepared notification will be
// discarded.
// If |display_id| is the internal display, the resolution change is applied
// directly without preparing the confirm/revert notification (this kind of
// notification is only useful for external displays).
// This method does not create a notification itself. The notification will be
// created the next OnDisplayConfigurationChanged(), which will be called
// asynchronously after the resolution change is requested by this method.
// |accept_callback| will be called when the user accepts the resoltion change
// by closing the notification bubble or clicking on the accept button (if
// any).
bool PrepareNotificationAndSetDisplayMode(
int64_t display_id,
const display::ManagedDisplayMode& old_resolution,
const display::ManagedDisplayMode& new_resolution,
base::OnceClosure accept_callback) WARN_UNUSED_RESULT;
// Returns true if the notification is visible or scheduled to be visible and
// the notification times out.
bool DoesNotificationTimeout();
// message_center::NotificationObserver
void Close(bool by_user) override;
void Click(const base::Optional<int>& button_index,
const base::Optional<base::string16>& reply) override;
friend class ResolutionNotificationControllerTest;
FRIEND_TEST_ALL_PREFIXES(ResolutionNotificationControllerTest, Timeout);
FRIEND_TEST_ALL_PREFIXES(DisplayPrefsTest, PreventStore);
// A struct to bundle the data for a single resolution change.
struct ResolutionChangeInfo;
static const int kTimeoutInSec;
static const char kNotificationId[];
// Create a new notification, or update its content if it already exists.
// |enable_spoken_feedback| is set to false when the notification is updated
// during the countdown so the update isn't necessarily read by the spoken
// feedback.
void CreateOrUpdateNotification(bool enable_spoken_feedback);
// Called when the user accepts the display resolution change. Set
// |close_notification| to true when the notification should be removed.
void AcceptResolutionChange(bool close_notification);
// Called when the user wants to revert the display resolution change.
void RevertResolutionChange(bool display_was_removed);
// Called every second for timeout.
void OnTimerTick();
// display::DisplayObserver overrides:
void OnDisplayRemoved(const display::Display& old_display) override;
// WindowTreeHostManager::Observer overrides:
void OnDisplayConfigurationChanged() override;
static void SuppressTimerForTest();
std::unique_ptr<ResolutionChangeInfo> change_info_;
base::WeakPtrFactory<ResolutionNotificationController> weak_factory_;
} // namespace ash