OLD | NEW |
---|---|
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 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 | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef CHROME_BROWSER_UI_WEBUI_SIGNIN_LOGIN_UI_SERVICE_H_ | 5 #ifndef CHROME_BROWSER_UI_WEBUI_SIGNIN_LOGIN_UI_SERVICE_H_ |
6 #define CHROME_BROWSER_UI_WEBUI_SIGNIN_LOGIN_UI_SERVICE_H_ | 6 #define CHROME_BROWSER_UI_WEBUI_SIGNIN_LOGIN_UI_SERVICE_H_ |
7 #pragma once | 7 #pragma once |
8 | 8 |
9 #include "base/basictypes.h" | 9 #include "base/basictypes.h" |
10 #include "base/observer_list.h" | |
10 #include "chrome/browser/profiles/profile_keyed_service.h" | 11 #include "chrome/browser/profiles/profile_keyed_service.h" |
11 | 12 |
12 class Browser; | 13 class Browser; |
13 | 14 |
14 // The LoginUIService helps track per-profile information for the login UI - | 15 // The LoginUIService helps track per-profile information for the login UI - |
15 // for example, whether there is login UI currently on-screen. | 16 // for example, whether there is login UI currently on-screen. |
16 class LoginUIService : public ProfileKeyedService { | 17 class LoginUIService : public ProfileKeyedService { |
17 public: | 18 public: |
18 // Various UI components implement this API to allow LoginUIService to | 19 // Various UI components implement this API to allow LoginUIService to |
19 // manipulate their associated login UI. | 20 // manipulate their associated login UI. |
20 class LoginUI { | 21 class LoginUI { |
21 public: | 22 public: |
22 // Invoked when the login UI should be brought to the foreground. | 23 // Invoked when the login UI should be brought to the foreground. |
23 virtual void FocusUI() = 0; | 24 virtual void FocusUI() = 0; |
24 | 25 |
25 // Invoked when the login UI should be closed. This can be invoked if the | 26 // Invoked when the login UI should be closed. This can be invoked if the |
26 // user takes an action that should display new login UI. | 27 // user takes an action that should display new login UI. |
27 virtual void CloseUI() = 0; | 28 virtual void CloseUI() = 0; |
28 protected: | 29 protected: |
29 virtual ~LoginUI() {} | 30 virtual ~LoginUI() {} |
30 }; | 31 }; |
31 | 32 |
33 // Interface for obervers of LoginUIService. | |
34 class Observer { | |
35 public: | |
36 // Called when a new login UI is shown. | |
37 virtual void OnLoginUIShown(LoginUI* ui) = 0; | |
James Hawkins
2012/07/10 20:41:15
nit: Document |ui|, e.g. can it ever be NULL or is
Munjal (Google)
2012/07/10 20:53:59
Done.
| |
38 | |
39 // Called when a login UI is closed. | |
40 virtual void OnLoginUIClosed(LoginUI* ui) = 0; | |
41 | |
42 protected: | |
43 virtual ~Observer() {} | |
44 }; | |
45 | |
32 LoginUIService(); | 46 LoginUIService(); |
33 virtual ~LoginUIService(); | 47 virtual ~LoginUIService(); |
34 | 48 |
35 // Gets the currently active login UI, or null if no login UI is active. | 49 // Gets the currently active login UI, or null if no login UI is active. |
36 LoginUI* current_login_ui() const { | 50 LoginUI* current_login_ui() const { |
37 return ui_; | 51 return ui_; |
38 } | 52 } |
39 | 53 |
54 // |observer| The observer to add or remove. | |
James Hawkins
2012/07/10 20:41:15
nit: Must it be non-NULL?
Munjal (Google)
2012/07/10 20:53:59
Done.
| |
55 void AddObserver(Observer* observer); | |
56 void RemoveObserver(Observer* observer); | |
57 | |
40 // Sets the currently active login UI. It is illegal to call this if there is | 58 // Sets the currently active login UI. It is illegal to call this if there is |
41 // already login UI visible. | 59 // already login UI visible. |
42 void SetLoginUI(LoginUI* ui); | 60 void SetLoginUI(LoginUI* ui); |
43 | 61 |
44 // Called when login UI is closed. If the passed UI is the current login UI, | 62 // Called when login UI is closed. If the passed UI is the current login UI, |
45 // sets current_login_ui() to null. | 63 // sets current_login_ui() to null. |
46 void LoginUIClosed(LoginUI* ui); | 64 void LoginUIClosed(LoginUI* ui); |
47 | 65 |
48 // Brings the login UI to the foreground, or if there is no login UI, | 66 // Brings the login UI to the foreground, or if there is no login UI, |
49 // navigates to the login UI page in the given browser. | 67 // navigates to the login UI page in the given browser. |
50 // Virtual for mocking purposes. | 68 // Virtual for mocking purposes. |
51 virtual void ShowLoginUI(Browser* browser); | 69 virtual void ShowLoginUI(Browser* browser); |
52 | 70 |
53 private: | 71 private: |
54 // Weak pointer to the currently active login UI, or null if none. | 72 // Weak pointer to the currently active login UI, or null if none. |
55 LoginUI* ui_; | 73 LoginUI* ui_; |
56 | 74 |
75 // List of observers. | |
76 ObserverList<Observer> observer_list_; | |
77 | |
57 DISALLOW_COPY_AND_ASSIGN(LoginUIService); | 78 DISALLOW_COPY_AND_ASSIGN(LoginUIService); |
58 }; | 79 }; |
59 | 80 |
60 #endif // CHROME_BROWSER_UI_WEBUI_SIGNIN_LOGIN_UI_SERVICE_H_ | 81 #endif // CHROME_BROWSER_UI_WEBUI_SIGNIN_LOGIN_UI_SERVICE_H_ |
OLD | NEW |