src/chrome/browser/ui/webui/signin/login_ui_service.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_UI_WEBUI_SIGNIN_LOGIN_UI_SERVICE_H_
   6 #define CHROME_BROWSER_UI_WEBUI_SIGNIN_LOGIN_UI_SERVICE_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/observer_list.h"
  10 #include "base/strings/string16.h"
  11 #include "components/keyed_service/core/keyed_service.h"
  12
  13 class Browser;
  14 class Profile;
  15
  16 // The LoginUIService helps track per-profile information for the login related
  17 // UIs - for example, whether there is login UI currently on-screen.
  18 class LoginUIService : public KeyedService {
  19  public:
  20   // Various UI components implement this API to allow LoginUIService to
  21   // manipulate their associated login UI.
  22   class LoginUI {
  23    public:
  24     // Invoked when the login UI should be brought to the foreground.
  25     virtual void FocusUI() = 0;
  26
  27     // Invoked when the login UI should be closed. This can be invoked if the
  28     // user takes an action that should display new login UI.
  29     virtual void CloseUI() = 0;
  30    protected:
  31     virtual ~LoginUI() {}
  32   };
  33
  34   // Interface for obervers of LoginUIService.
  35   class Observer {
  36    public:
  37     // Called when a new login UI is shown.
  38     // |ui| The login UI that was just shown. Will never be null.
  39     virtual void OnLoginUIShown(LoginUI* ui) {}
  40
  41     // Called when a login UI is closed.
  42     // |ui| The login UI that was just closed; will never be null.
  43     virtual void OnLoginUIClosed(LoginUI* ui) {}
  44
  45     // Called when the sync confirmation UI is closed. |configure_sync_first|
  46     // is true if the user has requested to configure the sync settings before
  47     // sync starts.
  48     virtual void OnSyncConfirmationUIClosed(bool configure_sync_first) {}
  49
  50    protected:
  51     virtual ~Observer() {}
  52   };
  53
  54   explicit LoginUIService(Profile* profile);
  55   virtual ~LoginUIService();
  56
  57   // Gets the currently active login UI, or null if no login UI is active.
  58   LoginUI* current_login_ui() const {
  59     return ui_;
  60   }
  61
  62   // |observer| The observer to add or remove; cannot be NULL.
  63   void AddObserver(Observer* observer);
  64   void RemoveObserver(Observer* observer);
  65
  66   // Sets the currently active login UI. It is illegal to call this if there is
  67   // already login UI visible.
  68   void SetLoginUI(LoginUI* ui);
  69
  70   // Called when login UI is closed. If the passed UI is the current login UI,
  71   // sets current_login_ui() to null.
  72   void LoginUIClosed(LoginUI* ui);
  73
  74   // Called when the sync settings confirmation UI is closed.
  75   void SyncConfirmationUIClosed(bool configure_sync_first);
  76
  77   // Delegate to an existing login dialog if one exists.
  78   // If not, we make a new popup dialog window, and set it to
  79   // chrome://signin to ask the user to sign in to chrome.
  80   void ShowLoginPopup();
  81
  82   // Displays login results.
  83   void DisplayLoginResult(Browser* browser, const base::string16& message);
  84
  85   // Gets the last login result set through |DisplayLoginResult|.
  86   const base::string16& GetLastLoginResult();
  87
  88  private:
  89   // Weak pointer to the currently active login UI, or null if none.
  90   LoginUI* ui_;
  91   Profile* profile_;
  92
  93   // List of observers.
  94   ObserverList<Observer> observer_list_;
  95
  96   base::string16 last_login_result_;
  97
  98   DISALLOW_COPY_AND_ASSIGN(LoginUIService);
  99 };
 100
 101 #endif  // CHROME_BROWSER_UI_WEBUI_SIGNIN_LOGIN_UI_SERVICE_H_