blob: 6cffcda68c4d4ed2edebfd6d91f3b7a5175d723c [file] [log] [blame]
// Copyright 2017 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 <memory>
#include <string>
#include <vector>
#include "ash/ash_export.h"
#include "ash/lock_screen_action/lock_screen_action_background_observer.h"
#include "ash/login/login_screen_controller_observer.h"
#include "ash/login/ui/login_data_dispatcher.h"
#include "ash/public/cpp/kiosk_app_menu.h"
#include "ash/public/interfaces/login_screen.mojom.h"
#include "ash/shutdown_controller.h"
#include "ash/system/locale/locale_update_controller.h"
#include "ash/tray_action/tray_action_observer.h"
#include "base/scoped_observer.h"
#include "ui/views/controls/button/button.h"
#include "ui/views/view.h"
namespace gfx {
class ImageSkia;
namespace session_manager {
enum class SessionState;
namespace ash {
class LockScreenActionBackgroundController;
enum class LockScreenActionBackgroundState;
class LoginScreenController;
class TrayAction;
class KioskAppsButton;
// LoginShelfView contains the shelf buttons visible outside of an active user
// session. ShelfView and LoginShelfView should never be shown together.
// This view is attached as a LoginDataDispatcher::Observer when the LockScreen
// is instantiated in kLogin mode. It cannot attach itself because it does not
// know when the Login is instantiated.
class ASH_EXPORT LoginShelfView : public views::View,
public views::ButtonListener,
public TrayActionObserver,
public LockScreenActionBackgroundObserver,
public ShutdownController::Observer,
public LoginScreenControllerObserver,
public LoginDataDispatcher::Observer,
public LocaleChangeObserver {
enum ButtonId {
kShutdown = 1, // Shut down the device.
kRestart, // Restart the device.
kSignOut, // Sign out the active user session.
kCloseNote, // Close the lock screen note.
kCancel, // Cancel multiple user sign-in.
kBrowseAsGuest, // Use in guest mode.
kAddUser, // Add a new user.
kApps, // Show list of available kiosk apps.
kParentAccess // Unlock child device with Parent Access Code.
// Stores and notifies UiUpdate test callbacks.
class TestUiUpdateDelegate {
virtual ~TestUiUpdateDelegate();
virtual void OnUiUpdate() = 0;
explicit LoginShelfView(
LockScreenActionBackgroundController* lock_screen_action_background);
~LoginShelfView() override;
// ShelfWidget observes SessionController for higher-level UI changes and
// then notifies LoginShelfView to update its own UI.
void UpdateAfterSessionChange();
// Sets the contents of the kiosk app menu, as well as the callback used when
// a menu item is selected.
void SetKioskApps(
const std::vector<KioskAppMenuEntry>& kiosk_apps,
const base::RepeatingCallback<void(const KioskAppMenuEntry&)>&
// Sets the state of the login dialog.
void SetLoginDialogState(mojom::OobeDialogState state);
// Sets if the guest button on the login shelf can be shown. Even if set to
// true the button may still not be visible.
void SetAllowLoginAsGuest(bool allow_guest);
// Sets whether parent access button can be shown on the login shelf.
void SetShowParentAccessButton(bool show);
// Sets if the guest button on the login shelf can be shown during gaia
// signin screen.
void SetShowGuestButtonInOobe(bool show);
// Sets whether users can be added from the login screen.
void SetAddUserButtonEnabled(bool enable_add_user);
// Sets whether shutdown button is enabled in the login screen.
void SetShutdownButtonEnabled(bool enable_shutdown_button);
// views::View:
const char* GetClassName() const override;
void OnFocus() override;
void AboutToRequestFocusFromTabTraversal(bool reverse) override;
void GetAccessibleNodeData(ui::AXNodeData* node_data) override;
// views::ButtonListener:
void ButtonPressed(views::Button* sender, const ui::Event& event) override;
gfx::Rect get_button_union_bounds() const { return button_union_bounds_; }
// Test API. Returns true if request was successful (i.e. button was
// clickable).
bool LaunchAppForTesting(const std::string& app_id);
bool SimulateAddUserButtonForTesting();
bool SimulateGuestButtonForTesting();
// Adds test delegate. Delegate will become owned by LoginShelfView.
void InstallTestUiUpdateDelegate(
std::unique_ptr<TestUiUpdateDelegate> delegate);
TestUiUpdateDelegate* test_ui_update_delegate() {
return test_ui_update_delegate_.get();
// TrayActionObserver:
void OnLockScreenNoteStateChanged(mojom::TrayActionState state) override;
// LockScreenActionBackgroundObserver:
void OnLockScreenActionBackgroundStateChanged(
LockScreenActionBackgroundState state) override;
// ShutdownController::Observer:
void OnShutdownPolicyChanged(bool reboot_on_shutdown) override;
// LoginScreenControllerObserver:
void OnOobeDialogStateChanged(mojom::OobeDialogState state) override;
// LoginDataDispatcher::Observer:
void OnUsersChanged(
const std::vector<mojom::LoginUserInfoPtr>& users) override;
// LocaleChangeObserver:
void OnLocaleChanged() override;
bool LockScreenActionBackgroundAnimating() const;
// Updates the visibility of buttons based on state changes, e.g. shutdown
// policy updates, session state changes etc.
void UpdateUi();
// Updates the color of all buttons. Uses dark colors if |use_dark_colors| is
// true, light colors otherwise.
void UpdateButtonColors(bool use_dark_colors);
// Updates the total bounds of all buttons.
void UpdateButtonUnionBounds();
mojom::OobeDialogState dialog_state_ = mojom::OobeDialogState::HIDDEN;
bool allow_guest_ = true;
bool allow_guest_in_oobe_ = false;
bool show_parent_access_ = false;
// When the Gaia screen is active during Login, the guest-login button should
// appear if there are no user views.
bool login_screen_has_users_ = false;
LockScreenActionBackgroundController* lock_screen_action_background_;
ScopedObserver<TrayAction, TrayActionObserver> tray_action_observer_;
ScopedObserver<ShutdownController, ShutdownController::Observer>
ScopedObserver<LoginScreenController, LoginScreenControllerObserver>
ScopedObserver<LocaleUpdateController, LocaleChangeObserver>
// The kiosk app button will only be created for the primary display's login
// shelf.
KioskAppsButton* kiosk_apps_button_ = nullptr;
// This is used in tests to wait until UI is updated.
std::unique_ptr<TestUiUpdateDelegate> test_ui_update_delegate_;
// The bounds of all the buttons that this view is showing. Useful for
// letting events that target the "empty space" pass through. These
// coordinates are local to the view.
gfx::Rect button_union_bounds_;
} // namespace ash