diff options
Diffstat (limited to 'chromium/ash/session_state_delegate.h')
-rw-r--r-- | chromium/ash/session_state_delegate.h | 123 |
1 files changed, 123 insertions, 0 deletions
diff --git a/chromium/ash/session_state_delegate.h b/chromium/ash/session_state_delegate.h new file mode 100644 index 00000000000..91c6229133e --- /dev/null +++ b/chromium/ash/session_state_delegate.h @@ -0,0 +1,123 @@ +// Copyright (c) 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. + +#ifndef ASH_SESSION_STATE_DELEGATE_H_ +#define ASH_SESSION_STATE_DELEGATE_H_ + +#include <string> +#include <vector> + +#include "ash/ash_export.h" +#include "base/strings/string16.h" + +namespace aura { +class Window; +} // namespace aura + +namespace gfx { +class ImageSkia; +} // namespace gfx + +namespace ash { + +class SessionStateObserver; + +// The index for the multi-profile item to use. The list is always LRU sorted +// So that the index #0 is the currently active user. +typedef int MultiProfileIndex; + +// A list of user_id. +typedef std::vector<std::string> UserIdList; + +// Delegate for checking and modifying the session state. +class ASH_EXPORT SessionStateDelegate { + public: + // Defines the cycle direction for |CycleActiveUser|. + enum CycleUser { + CYCLE_TO_NEXT_USER = 0, // Cycle to the next user. + CYCLE_TO_PREVIOUS_USER, // Cycle to the previous user. + }; + + virtual ~SessionStateDelegate() {}; + + // Returns the maximum possible number of logged in users. + virtual int GetMaximumNumberOfLoggedInUsers() const = 0; + + // Returns the number of signed in users. If 0 is returned, there is either + // no session in progress or no active user. + virtual int NumberOfLoggedInUsers() const = 0; + + // Returns |true| if the session has been fully started for the active user. + // When a user becomes active, the profile and browser UI are not immediately + // available. Only once this method starts returning |true| is the browser + // startup complete and both profile and UI are fully available. + virtual bool IsActiveUserSessionStarted() const = 0; + + // Returns true if the screen can be locked. + virtual bool CanLockScreen() const = 0; + + // Returns true if the screen is currently locked. + virtual bool IsScreenLocked() const = 0; + + // Returns true if the screen should be locked when the system is about to + // suspend. + virtual bool ShouldLockScreenBeforeSuspending() const = 0; + + // Locks the screen. The locking happens asynchronously. + virtual void LockScreen() = 0; + + // Unlocks the screen. + virtual void UnlockScreen() = 0; + + // Returns |true| if user session blocked by some overlying UI. It can be + // login screen, lock screen or screen for adding users into multi-profile + // session. + virtual bool IsUserSessionBlocked() const = 0; + + // Gets the displayed name for the user with the given |index|. + // Note that |index| can at maximum be |NumberOfLoggedInUsers() - 1|. + virtual const base::string16 GetUserDisplayName( + MultiProfileIndex index) const = 0; + + // Gets the display email address for the user with the given |index|. + // The display email address might contains some periods in the email name + // as well as capitalized letters. For example: "Foo.Bar@mock.com". + // Note that |index| can at maximum be |NumberOfLoggedInUsers() - 1|. + virtual const std::string GetUserEmail(MultiProfileIndex index) const = 0; + + // Gets the user id (sanitized email address) for the user with the given + // |index|. The function would return something like "foobar@mock.com". + // Note that |index| can at maximum be |NumberOfLoggedInUsers() - 1|. + virtual const std::string GetUserID(MultiProfileIndex index) const = 0; + + // Gets the avatar image for the user with the given |index|. + // Note that |index| can at maximum be |NumberOfLoggedInUsers() - 1|. + virtual const gfx::ImageSkia& GetUserImage(MultiProfileIndex index) const = 0; + + // Returns a list of all logged in users. + virtual void GetLoggedInUsers(UserIdList* users) = 0; + + // Switches to another active user with |user_id| + // (if that user has already signed in). + virtual void SwitchActiveUser(const std::string& user_id) = 0; + + // Switches the active user to the next or previous user, with the same + // ordering as GetLoggedInUsers. + virtual void CycleActiveUser(CycleUser cycle_user) = 0; + + // Adds or removes sessions state observer. + virtual void AddSessionStateObserver(SessionStateObserver* observer) = 0; + virtual void RemoveSessionStateObserver(SessionStateObserver* observer) = 0; + + // Transfers the visibility of a window to another user. Returns true when + // transfer was done. This could fail if the |window| belongs to no one and + // is therefore shown on the desktop of every user. + virtual bool TransferWindowToDesktopOfUser( + aura::Window* window, + ash::MultiProfileIndex index) = 0; +}; + +} // namespace ash + +#endif // ASH_SESSION_STATE_DELEGATE_H_ |